Options
All
  • Public
  • Public/Protected
  • All
Menu

Class I18nSystem<SS>

. . .

example

I18nSystem provides context that allows I18String to fetch the traductions, it Must be placed wrapping all components that use I18String, since useing I18String outside an I18nSystem will result in errors.

Example is assuming you use redux to store locales, however, this is not mandatory, you can manage your state in any way you want as long as it


const myLocaleData = store.getState().localeData;

const yourApp = ()=>{
     return(
         <I18nSystem value={myLocaleData}>
            <AppRouter/>
         </I18nSystem>
     )
}

Multiple I18n:

You might want to keep a separate set of traductions for a part of the app, if that is the case, you can instantiate a I18nSystem wrapping the section of the app you want with another I18nSystem as follows:


const myLocaleData = store.getState().localeData;

const myPluginLocale = store.getState().pluginLocales;

const yourApp = ()=>{
     return(
         <I18nSystem value={myLocaleData}>
             <AppRoutes/>
             <I18nSystem value={myPluginLocale}>
                 <PluginRoutes/>
             </I18nSystem
         </I18nSystem>
     )
}

. . .

Type parameters

  • SS

Hierarchy

Index

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<I18nSystemProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<I18nSystemProps>, nextState: Readonly<any>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<I18nSystemProps>, prevState: Readonly<any>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<I18nSystemProps>
    • prevState: Readonly<any>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<I18nSystemProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<I18nSystemProps>, nextState: Readonly<any>, nextContext: any): void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<I18nSystemProps>, prevState: Readonly<any>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

render

  • render(): Element

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<I18nSystemProps>, nextState: Readonly<any>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<I18nSystemProps>
    • nextState: Readonly<any>
    • nextContext: any

    Returns boolean

Generated using TypeDoc