@vayjs/vay
v2.0.2
Published
[](https://www.npmjs.com/package/vay.js)[](https://npmjs.com/package/vay.js)[
Readme
Vay.js
A lightweight (3kb minified), strongly typed, modern & dependency free internationalization (i18n) provider that features a simple API that supports interpolation, pluralization and context.
Installing
To use Vay with node and/or a bundler such as webpack or rollup, install it via yarn or npm:
yarn add @vayjs/vay
# or use npm
npm install @vayjs/vayYou can also use it directly in the browser and include it via CDN or locally.
<head>
...
<!-- as a local file -->
<script src="./your/path/to/vay.browser.min.js"></script>
<!-- or via CDN -->
<script src="http://unpkg.com/@vayjs/vay"></script>
...
</head>Getting started
Setting up the initial Vay instance is quick and requires only a dictionary and a configuration object. Vay provides functions to create both, to utility editor autocompletion and type safety. For a more in depth guide on how to use Vay, take a look at the full documentation.
Start by importing or destructuring the required methods. You are free to use module or import syntax, Vay provides export for both standards. When included via CDN or locally, destructuring the globally accessible Vay property is the easiest way to access the API.
// node require syntax
const { Vay, defineConfig, defineDictionary } = require('vay.js');
// modern es6 style syntax
import { Vay, defineConfig, defineDictionary } from 'vay.js';
// if added to the global namespace
const { Vay, defineConfig, defineDictionary } = Vay;Creating a Vay provider
To use Vay, create a new provider providing a config as well as any amount of dictionaries.
Note: The examples below assumes you're using es6.
import { defineConfig, defineDictionary, createProvider } from 'vay.js';
// create the Vay instance
const i18n = createProvider(
defineConfig(), // create a default config
defineDictionary('en', { token: 'Phrase' }), // create a dictionary
);Note: The dictionary keys should follow the ISO 639-1 convention of two letter language codes.
Translating dynamic content using the translate() method
Vay also provides a function to translate strings dynamically. This can prove useful when Vay is used with a JavaScript framework, or when translating text that is dynamically created. When using TypeScript, the method is strongly typed and will only accepts tokens that exists in the dictionary as well as provide useful autocompletion suggestions deeding on the used IDE.
import { defineConfig, defineDictionary, createProvider } from '@vayjs/vay';
const i18n = createProvider(defineConfig(), defineDictionary('en', { title: 'Hello World' }));
i18n.translate('title'); // Return 'Hello World'You can read more about the capabilities of the
translatemethod on the official docs.
Translating static content using the createStaticProvider function
Use the render() method of a staticProvider to translate a subset of a provided HTML Element and it's descendants. The method should be called after the DOM has finished rendering and is best used for static websites.
<div vay="title"></div>
<script>
const { defineConfig, defineDictionary, createProvider, createStaticProvider } = Vay;
// setup the instance
const i18n = createStaticProvider(
createProvider(
defineConfig(), // create a default config
defineDictionary('en', { title: 'Hello World' }), // create a dictionary
),
);
// render the translations to the page
window.addEventListener('DOMContentLoaded', () => {
i18n.render(document.documentElement);
});
</script>The <div> with the token 'title' will have it's text-content replaced with the respective phrase in the dictionary,
'Hello World'. When ever the used changes the language, you can re-render the translations.
Contributing
If you would like to contribute, take a look at the contribution guide.
License
Vay is licensed under the MIT License