Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

browser-i18n

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

browser-i18n

Simple i18n module for the browser, compatible with the i18n server module data files.

  • 0.1.6
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

browser-i18n

A simple in-browser i18n module, compatible with the i18n-node server module data files. Meant to be use with a module bundler (like parcel).

Installation

By using npm:

npm i browser-i18n --save

Usage

import I18n from 'browser-i18n';

const i18n = new I18n({
    language: 'fr',
    path: '/locales',
    extension: '.json'
});

console.log( i18n.__('Hello') );
// Output: 'Bonjour'

console.log( i18n.__('Oh, hi %s!', 'Mark') );
// Output: 'Oh, salut Mark!'


// Or using the global selector ...

console.log( __('Hello') );
// Output: 'Bonjour'

Files structures

One file for each language. They may have the following structure:

// /locales/en.json

{
  "Hello": "Hello",
  "Oh, hi %s!": "Oh, hi %s!",
  "Bye!": "Bye!"
}
// /locales/fr.json

{
  "Hello": "Bonjour",
  "Oh, hi %s!": "Oh, salut %s!",
  "Bye!": "Au revoir!"
}

Put your locales folder accessible publicly. You can do it by putting it in your public root:

.
└── public
    └── locales
        ├── en.json
        └── fr.json

Or, using express:

app.use('/locales', express.static(path.join(__dirname, 'locales')));

API

Configuration:

const i18n = new I18n({
    language: 'fr',     // The langage wanted - Default 'en'
    path: '/locales',   // The path to access the locales files - Default '/locales'
    extension: '.json', // Local file extension - Default '.json'
    setGobal: true,     // Set the function '__' on a global scope - Default true
    onReady: callback,  // Set a callback triggered when the dataFile is loaded
    verbose: true       // Set the verbosity of the object - Default to true
});

Keywords

FAQs

Package last updated on 13 Aug 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc