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

intl-lightly

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

intl-lightly

A lightweight localization library.

  • 1.1.0
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

intl-lightly

A lightweight localization library.

Getting Started

  1. Install

    #npm
    pnpm i intl-lightly
    
    #npm
    npm i intl-lightly
    
    #yarn
    yarn add intl-lighly
    
  2. Initialize

    // eg: boot.js
    import intl from 'inty-lightly'
    import enLocale from './languages/en-US'
    import zhLocale from './languages/zh-US'
    
    // locales already build in
    intl.init({
      locales:{
        'en-US':enLocale
        'zh-CN':zhLocale
      },
      currentLocales:'en-US'
    })
    
    // or if locale is dynamic load
    const zhCN = await import('./languages/zh-US') 
    intl.add('zh-CN',zhCN)
    
    

Features

  • Not only key=>string but key=>object
        const enUS= {
            hi:'Hi',
            buttons:{
                submit:'Submit',
                cancel:'Cancel'
            }
        }
    
    
  • Multiple way to get value
    
    intl.get('hi')
    
    intl.get('buttons.submit')
    
    intl.select( s =>{
        return {
            user:s.user,
            submitBtn:s.buttons.submit
        }
    })
    
    
  • Template support
    // assume you had locale data like this
    const enUS = {
        greet:'Hi,{userName}!'
        formTip:{
             input:'Please input {label}',
             min:"Can't smaller than {min}"
        }
    }
    
    //useCase.js
    intl.getReplaced('greet',{userName:'Neo'})// 'Hi,Neo!'
    
    const formTip = intl.get('formTip')
    intl.replace(formTip.input,{label:'First Name'}) // 'Please input First Name'
    

Typesafe Usege

  1. declare language

    //en-US.ts
    const enLocale = {
        hi: 'Hi',
        table:{
            createdAt: 'Created At'
        }
        user:{
          name: 'Name'
        }
    }
    export type EnLocal = typeof enLocale
    export default enLocale
    
  2. declare typesafe select function

    //pickLocale.ts
    import intl from 'intl-lightly'
    import { EnLocal } from '../locales/en-gb'
    
    /**
    * Pick some locale with intellisense
    */
    export function pickLocale<T extends (local: EnLocal) => any>(pick: T) {
        return intl.select<EnLocal, ReturnType<T>>(pick)
    }
    
  3. Use pickLocale in component

    export function Profile(){
        const locale = pickLocale(s=>s.user)
        return (<div>
            <div>{locale.name}</div>
        </div>)
    }
    

Keywords

FAQs

Package last updated on 17 Sep 2023

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