@justeat/f-globalisation

1.5.0 • Public • Published

f-globalisation

Fozzie Bear

A utility which wires up vue-i18n within your Smart Component


npm version CircleCI Coverage Status Known Vulnerabilities

Usage

  1. Install the module using NPM or Yarn:

    yarn add @justeat/f-globalisation
  2. Import the Mixin

    F-Globalisation contains a mixin which should be imported into your "Smart Component", for example in F-Checkout import it into the Checkout.vue component as that is the root.

    import { VueGlobalisationMixin } from '@justeat/f-globalisation';
    
    export default {
        mixins: [VueGlobalisationMixin]
    }
    
  3. Add tenantConfigs to your component data

    The mixin will access your localisation by accessing this data property. See F-Checkout for an example if needed. It should expose an import for the localisation files in your component.

    import tenantConfigs from '../tenants';
    
    export default {
        mixins: [VueGlobalisationMixin],
    
        data () {
            return {
                tenantConfigs
            }
        }
    }
    
  4. Now apply vue-i18n within your components

    Once installed; you should be able to access $t, <i18n> and this.$i18n. The correct locale messages should be loaded automatically and en-GB should also be loaded as a fallback.

    vue-i18n is not needed as a dependency, because it is registered by the host application, such as CoreWeb or Storybook and thus exists in context.

    The mixin also exposes a prop; so that you can pass a locale in from a website host where required.

Readme

Keywords

Package Sidebar

Install

npm i @justeat/f-globalisation

Weekly Downloads

8

Version

1.5.0

License

Apache-2.0

Unpacked Size

365 kB

Total Files

11

Last publish

Collaborators

  • ilia.chikmarev
  • fidel.montesino
  • anastasiia.horban
  • raouf.sawehli
  • mmakwe-onyeka
  • gregory.palaci
  • arielfdr
  • dawidchar
  • roberto.santana
  • lizzie.turney
  • davidpn.11
  • dandel10n
  • mwh1989
  • kevinrodrigues
  • fozzie-bot
  • ashleynolan
  • simonsje
  • xander-marjoram
  • sergii.semenkiv
  • thomaswilliammcclean
  • benrwhite
  • robertellison
  • zlatin.ivanov
  • joshuang2332
  • oliversweb
  • andymayje
  • jamieomaguire
  • adammorr
  • lsphillips