Language Emoji 🌍

language-emoji is a lightweight and easy-to-use package that helps you transform language codes (e.g., en_US or en) into country emoji flags 🌎, language names, and native language names.

Features ✨

• 🌍 Supports multiple languages with language codes.
• 🇺🇸 Converts language codes to emoji flags.
• 📝 Provides English and native names for languages.
• ⚡ Lightweight and fast — ideal for web and server-side projects, no dependencies.
• 🤖 Useful for Telegram bots: parse users language_code easily.

---

Installation 📦

Using npm

1npm install language-emoji

Using yarn

1yarn add language-emoji

---

Usage 🚀

Import the package

1import { langFlag, fallbackLangFlag, langName, langNativeName } from 'language-emoji';

Example 1: Get Emoji Flag

1import { langFlag, fallbackLangFlag } from 'language-emoji';
2
3console.log(langFlag('en_US'));   // Output: 🇺🇸
4console.log(langFlag('ru'));      // Output: 🇷🇺
5
6console.log(langFlag('lalala'));           // Output: undefined
7console.log(fallbackLangFlag('lalala'));   // Output: 🌎

Example 2: Get Language Name

1import { langName } from 'language-emoji';
2
3console.log(langName('es'));   // Output: Spanish
4console.log(langName('de'));   // Output: German

Example 3: Get Native Language Name

1import { langNativeName } from 'language-emoji';
2
3console.log(langNativeName('zh'));   // Output: 中文
4console.log(langNativeName('ja'));   // Output: 日本語

---

API Reference 📚

langData(lang: string): LanguageData | undefined

Returns the language data for a given language code.

• lang: Language code in formats like en_US or fr.
• Returns: An object containing:
  • flag: Emoji flag string (e.g., 🇺🇸).
  • name: English name string (e.g., English).
  • native_name: Native name string (e.g., Français).

---

langFlag(lang: string): string | undefined

Returns the emoji flag for a given language code.

• lang: Language code in formats like en_US or fr.
• Returns: Emoji flag string (e.g., 🇺🇸) or undefined if not found.

---

fallbackLangFlag(lang: string): string

Returns the emoji flag for a given language code, falling back to 🌍 if not found.

• lang: Language code.
• Returns: Emoji flag string (e.g., "🇺🇸") or "🌍" if not found.

---

langName(lang: string): string

Returns the English name of the language for a given code.

• lang: Language code.
• Returns: English name string (e.g., "Spanish") or lang code itself if not found.

---

langNativeName(lang: string): string

Returns the native name of the language for a given code.

• lang: Language code.
• Returns: Native name string (e.g., "Français") or lang code itself if not found.

---

Supported Languages 🌐

The package supports a wide range of languages. Some examples include:

• en - English 🇺🇸
• fr - French 🇫🇷
• es - Spanish 🇪🇸
• de - German 🇩🇪
• zh - Chinese 🇨🇳
• And more...

For the full list of supported languages, check the data object in the source code.

This package supports the following language code formats:

• IETF BCP 47 - e.g., en-US, fr-CA
• ISO 639-1 - e.g., en, fr
• Underscore Format - e.g., en_US, fr_CA (commonly used in localization systems)

You can input any of these formats, and the package will normalize them for consistent handling.

---

Contributing 🤝

Contributions are welcome! Feel free to open an issue or submit a pull request on GitHub.

---

License 📄

This project is licensed under the MIT License.

---

Contact 📬

For questions or support, reach out via:

• GitHub Issues: Create an Issue

---

Enjoy using language-emoji! 🌍✨