npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@jota-one/i36n

v2.4.1

Published

Translation manager twice simpler and twice better

Downloads

9

Readme

i36n

Translation manager twice simpler and twice better

Installation

As npm dependency in your node project

Simply install it as a dependency of the project you want to internationalize.

npm install @jota-one/i36n

Usage

This a Vue 3 example, but it will also work with the composition-api module in Vue 2. @jota-one/i36n is compatible with Vue 2 and Vue 3 :tada:.

To use it in Vue2, simply use:

import { provideI36n, useI36n } from '@jota-one/i36n/src/index.vue2.js'

This module follow the provide/inject pattern, available in Vue. This means that you will first have to provide the translator on a top level part of your application.

Then you can inject it wherever you need it.

Provide

Somewhere before you need your first label, you have to provide the library to your app. In your <script> tag first import the library:

import { provideI36n } from '@jota-one/i36n'

In your setup() function, call the provideI36n() function. You need to pass it 2 parameters:

  1. the language identifier (en, de, fr), in a reactive variable (in the example below, it's a prop)
  2. An object containing the load function. The load function is used to... load the labels for the chosen language. In the example below, we are simply asynchronously fetching the labels in a local file, but you can also load them with an XHR request or in any other way.
<script>
import { provideI36n } from '@jota-one/i36n'
// ... imports, etc..

const load = async lang => (await import(`@/i18n/${lang}.json`)).default

setup(props) {
  provideI36n(props.language, { load })
}
</script>

If you pass a 3rd argument (a Vue app instance) to the provideI36n, it will provide the feature on the app directly.

const app = createApp(App, { ... })
provideI36n(props.language, { load }, app)

Internally, it will call app.provide, instead of the standalone provide function.

Inject

Once the providing is done, you can inject the library features anywhere in your app by using the useI36n() function.

In your <script> tag, near the top, import the library

import { useI36n } from '@jota-one/i36n'

In your setup() function, call the useI36n() function. It will give you the $label() translation function.

:warning: In Vue 3, you should rename it with a name not starting with à dollar sign, or you will have warnings.

setup() {
  const { $label: label } = useI36n()
  
  // other cool stuffs
  // ...
  const meal = ref('kebab')
  
  return { label, meal }
}

In your template (or inside your setup function, further), use it.

<h1>{{ label('food_title') }}</h1>
<p>{{ label('food_favorite', { meal }) }}</p>

Assuming that your current language translation file looks like this:

{
  "food_title": "Some great meals",
  "food_favorite": "My favourite meal is {meal}. Yummy!"
}

The above template will resolve in:

<h1>Some great meals</h1>
<p>My favourite meal is kebab. Yummy!</p>

And the killer feature

You can pass a showKey property in the provideI36n() second parameter, along with the load method. This showKey must be a reactive variable (a ref) containing a Boolean.

As long as its value is false, you won't notice anything. But if you change the value to true, the $label() function will display the label keys and the needed placeholders instead of resolving the label.

This is incredibly useful while you develop, trust us.

See a "demo" in the animated gif on this page