1.0.1 • Published 2 months ago

auto-intl-helpers v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 months ago

easy-intl

Simplify internationalization in your application, with support for multiple languages using i18next.

Installation

To install easy-intl, run the following command in your project directory:

npm install easy-intl

Usage

First, import the library in your React project:

import { changeLanguage, t } from 'easy-intl';

To change the language dynamically:

changeLanguage('en'); // Switches the current language to English

To translate a text:

const greeting = t('hello'); // Retrieves the translation for the key 'hello'

API

changeLanguage(lng)

Changes the current language of the application.

  • lng: string - The language code to switch to.

t(key, options)

Translates a key into the current language.

  • key: string - The key to translate.
  • options: Object (optional) - Options for interpolation.

loadNamespaces(ns, callback)

Load additional namespaces or languages on demand.

  • ns: Array|string - Namespaces to load.
  • callback: Function (optional) - Optional callback to run after loading.

addResources(lng, ns, resources)

Extend or override existing translations.

  • lng: string - The language code.
  • ns: string - The namespace.
  • resources: Object - The new or updated translations.

Contributing

We welcome contributions to easy-intl! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Commit your changes with meaningful messages.
  4. Push your branch and open a pull request.

Please make sure your code adheres to the project's coding standards and include tests if applicable.

License

This project is licensed under the MIT License - see the LICENSE file for details.