Skip to main content

Installation

Use airport with vanillaJS​

1. Installation​

Using npm:

npm install airport-js

Using yarn:

yarn add airport-js

2. Instantiate airport​

import { Airport, createLSFactory } from 'airport-js';

const airport = new Airport({ 
  supportedLocales:['ko', 'en'],
  locale:"ko",
  fallbackLocale:"ko",
  currency :{
    ko: 'KRW',
    en: 'USD',
  },
  currencyFormat:{
    KRW: '{price}원',
    USD: '${price}',
  },
  currencyFormatValueKey:'price',
  exchangeRate:{
    USD: 1,
    KRW: 1000,
  },
})

const createLS = createLSFactory<typeof supportedLocales>()

const LLS = createLS({
  hello: {
    ko: '안녕하세요',
    en: 'Hello'
  }
})

console.log(airport.t(LLS.hello))

Use airport with ReactJS​

1. Installation​

Using npm:

npm install airport-react

Using yarn:

yarn add airport-react

2. Add Provider to Root Container​

import { AirportProvider } from 'airport-react'
import App from './App'

// Declare supportedLocales as const for Typescript typing
const supportedLocales = ['ko', 'en'] as const

function Root() {
  return <AirportProvider
    supportedLocales={supportedLocales}
    locale="ko"
    fallbackLocale="ko"
  >
    <App />
  </AirportProvider>
}

3. use Airport through useAirport​

import * as React from 'react'
import { useAirport } from 'airport-react'

function App() {
  const { setLocale, t, fc } = useAirport()
  // ...
}