Home

Welcome to the official wiki for rtl-text-tools a complete, zero-dependency text processing toolkit for Right-to-Left (RTL) languages like Arabic, Persian, Hebrew, and Urdu.

Whether you are fixing reversed brackets, converting Latin digits to local numerals, or ensuring plain-text emails render correctly, this library has you covered. It works all the way back to IE11 with maximum browser compatibility.

🚀 The "TL;DR" (Don't be overwhelmed!)

Looking at the sidebar, you might see a lot of documentation and feel like there is a steep learning curve. Don't worry!

For 99% of use cases, you don't need to read the whole manual or learn every function. You only need to use one function and tell it your language:

import { fixRTL } from 'rtl-text-tools';

// That's it! It automatically fixes digits, punctuation, ellipsis, and brackets.
fixRTL('مرحبا, رقم 123...', { lang: 'arabic' }); 
// Output: "...مرحبا، رقم ١٢٣"

Just pass your text to fixRTL(), define your target language ('arabic', 'persian', or 'hebrew'), and let the library handle the rest. It is smart enough to leave English/LTR text completely untouched.

🗺️ Where to go next?

If you want to know more about how the library works, or if you need to solve a specific problem, choose your path below:

👋 "I want to learn the basics"

Start here to learn how to install the package, understand the basic options, and see a few quick examples. 👉 Getting Started

🔬 "I want to know deeply"

If you want to use individual utility functions (like just converting digits, or just wrapping text for emails), or you need to know the exact parameters and return types for every function. 👉 API Reference

⚛️ "I'm using a specific framework"

Find idiomatic integration guides, custom hooks, directives, and pipes for your tech stack. 👉 Framework Guides (React, Vue, Angular, Vanilla JS)

💡 "I'm building a specific type of app"

Learn how to handle RTL text in tricky environments like HTML Emails, Chat Applications, Text Editors, and E-commerce platforms. 👉 Use Cases

🌍 "I need language-specific details"

Deep dive into the Unicode ranges, specific numeral systems, and quirks of Arabic, Persian, Hebrew, Urdu, and other RTL scripts. 👉 Language-Specific Guides

❓ "I'm stuck or facing a bug"

Check out common rendering issues, framework-specific tips, and our legacy browser compatibility matrix. 👉 FAQ & Troubleshooting | Browser Compatibility

🤝 Community & Support

• 🐛 Found a bug? Open an issue on GitHub.
• 💡 Have an idea? We welcome contributions! Check out the Contributing Guide.
• 📦 View on NPM: rtl-text-tools

Happy coding! 🎉
Homayoun Mohammadi (@homayounmmdy)