Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "src/createI18nProvider"

Index

Functions

Functions

createI18nInstance

  • createI18nInstance(__namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; config: config; context: Config; hardfork: boolean; locale: string }, i18nParentInstance: I18nConfigInstance): Config

  • Parameters

    • __namedParameters: { children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal; config: config; context: Config; hardfork: boolean; locale: string }
      • children: string | number | false | true | {} | ReactElement<any, string | ((props: P) => ReactElement | null) | {}> | ReactNodeArray | ReactPortal
      • config: config
      • context: Config
      • hardfork: boolean
      • locale: string
    • i18nParentInstance: I18nConfigInstance

    Returns Config

createI18nProvider

  • createI18nProvider<TMethods>(methods: TMethods, config?: I18nProviderConfig): { I18nContext: Context<TMethods & { config: I18nConfigInstance }>; I18nProvider: NamedExoticComponent<I18nProviderProps> & { type: T }; useI18n: useI18n }

  • Create i18n provider with given methods.

    Type parameters

    Parameters

    • methods: TMethods

      I18n methods.

    • Default value config: I18nProviderConfig = {}

      Default config.

    Returns { I18nContext: Context<TMethods & { config: I18nConfigInstance }>; I18nProvider: NamedExoticComponent<I18nProviderProps> & { type: T }; useI18n: useI18n }

    Provider, context, and hook.

    • I18nContext: Context<TMethods & { config: I18nConfigInstance }>

      Context with config and methods.

    • I18nProvider: NamedExoticComponent<I18nProviderProps> & { type: T }

      Config and methods provider.

    • useI18n: useI18n

      Hook to recieve config and methods.

createPayload

  • createPayload<TMethods>(config: I18nConfigInstance, methodsEntries: [string, () => any][]): TMethods & { config: I18nConfigInstance }

  • Type parameters

    Parameters

    • config: I18nConfigInstance
    • methodsEntries: [string, () => any][]

    Returns TMethods & { config: I18nConfigInstance }

destroyI18nInstance

  • destroyI18nInstance(i18n: I18nConfigInstance): void

useI18nInstance

  • useI18nInstance(props: Partial<I18nProviderProps>, i18nParentInstance: I18nConfigInstance): Config

Generated using TypeDoc