Quick Start

Get UrduMagic up and running in your project in less than a minute.

Installation

via npm

Install the package using your preferred package manager:

npm install urdumagic

via CDN

For plain HTML projects, you can include the script directly:

<script src="https://unpkg.com/urdumagic/dist/urdumagic.js"></script>

Basic Usage

Initialize UrduMagic with your desired configuration.

import { UrduMagic } from 'urdumagic';

const app = UrduMagic.init({
  defaultLang: 'en',
  modes: ['en', 'ur', 'roman'],
});

// Transliterate Roman Urdu to Urdu Script
const urdu = app.toUrdu('salam');
console.log(urdu); // → سلام

// Transliterate back to Roman Urdu
const roman = app.toRoman('سلام');
console.log(roman); // → salam

If you need full translation (English ↔ Urdu), you can use the built-in 10,000+ entry offline dictionary:

const result = app.fromEnglish('democracy');
console.log(result.urdu); // → جمہوریت

For full site translation (English ↔ Urdu), you can use the translate method which leverages the 10,000+ entry offline dictionary:

const translation = await app.translate('democracy', 'ur');
console.log(translation); // → جمہوریت

Next: Explore the full API Reference → · Add Custom Words & Missing Word Detection →

Developing with AI Assistant?

If you're using Cursor, GitHub Copilot, ChatGPT, or Claude, copy our AI Integration Prompt → to have your AI assistant implement and test UrduMagic in seconds.