Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LegacyIntlProvider

Use for class components that still rely on the old API

This is only necessary when you have a component that rely on multiple contexts and that you cannot move to a stateless component. If you can use a stateless component instead, prefer using useIntlcontext hook If you are stuck with a stateful component, use static contextType = IntlProviderContext If you have multiple context, then you'll need this legacy provider until you can move to hooks

Hierarchy

Index

Constructors

constructor

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

Readonly props

props: Readonly<IntlProviderProps> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<{}>

Static childContextTypes

childContextTypes: { intl: Requireable<InferProps<{ defaultFormats: Requireable<object>; defaultLocale: Requireable<string>; formatDate: Validator<(...args: any[]) => any>; formatHTMLMessage: Validator<(...args: any[]) => any>; formatMessage: Validator<(...args: any[]) => any>; formatNumber: Validator<(...args: any[]) => any>; formatPlural: Validator<(...args: any[]) => any>; formatRelative: Validator<(...args: any[]) => any>; formatTime: Validator<(...args: any[]) => any>; formats: Requireable<object>; formatters: Requireable<object>; locale: Requireable<string>; messages: Requireable<object>; now: Validator<(...args: any[]) => any>; textComponent: Requireable<any> }>> } = ...

Type declaration

  • intl: Requireable<InferProps<{ defaultFormats: Requireable<object>; defaultLocale: Requireable<string>; formatDate: Validator<(...args: any[]) => any>; formatHTMLMessage: Validator<(...args: any[]) => any>; formatMessage: Validator<(...args: any[]) => any>; formatNumber: Validator<(...args: any[]) => any>; formatPlural: Validator<(...args: any[]) => any>; formatRelative: Validator<(...args: any[]) => any>; formatTime: Validator<(...args: any[]) => any>; formats: Requireable<object>; formatters: Requireable<object>; locale: Requireable<string>; messages: Requireable<object>; now: Validator<(...args: any[]) => any>; textComponent: Requireable<any> }>>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IntlProviderProps>, nextState: Readonly<{}>, 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<IntlProviderProps>, prevState: Readonly<{}>, snapshot?: any): 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<IntlProviderProps>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IntlProviderProps>, 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<IntlProviderProps>, nextState: Readonly<{}>, nextContext: any): void

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

formatMessage

  • formatMessage(__namedParameters: Object, values?: null): string
  • Parameters

    • __namedParameters: Object
    • values: null = null

    Returns string

formatStuff

  • formatStuff(something: any): any
  • Parameters

    • something: any

    Returns any

getChildContext

  • getChildContext(): { intl: { formatDate: (something: any) => any; formatHTMLMessage: (something: any) => any; formatMessage: (__namedParameters: Object, values?: null) => string; formatNumber: (something: any) => any; formatPlural: (something: any) => any; formatRelative: (something: any) => any; formatTime: (something: any) => any; locale: string; now: (something: any) => any } }
  • Returns { intl: { formatDate: (something: any) => any; formatHTMLMessage: (something: any) => any; formatMessage: (__namedParameters: Object, values?: null) => string; formatNumber: (something: any) => any; formatPlural: (something: any) => any; formatRelative: (something: any) => any; formatTime: (something: any) => any; locale: string; now: (something: any) => any } }

    • intl: { formatDate: (something: any) => any; formatHTMLMessage: (something: any) => any; formatMessage: (__namedParameters: Object, values?: null) => string; formatNumber: (something: any) => any; formatPlural: (something: any) => any; formatRelative: (something: any) => any; formatTime: (something: any) => any; locale: string; now: (something: any) => any }
      • formatDate: (something: any) => any
          • (something: any): any
          • Parameters

            • something: any

            Returns any

      • formatHTMLMessage: (something: any) => any
          • (something: any): any
          • Parameters

            • something: any

            Returns any

      • formatMessage: (__namedParameters: Object, values?: null) => string
          • (__namedParameters: Object, values?: null): string
          • Parameters

            • __namedParameters: Object
            • values: null = null

            Returns string

      • formatNumber: (something: any) => any
          • (something: any): any
          • Parameters

            • something: any

            Returns any

      • formatPlural: (something: any) => any
          • (something: any): any
          • Parameters

            • something: any

            Returns any

      • formatRelative: (something: any) => any
          • (something: any): any
          • Parameters

            • something: any

            Returns any

      • formatTime: (something: any) => any
          • (something: any): any
          • Parameters

            • something: any

            Returns any

      • locale: string
      • now: (something: any) => any
          • (something: any): any
          • Parameters

            • something: any

            Returns any

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IntlProviderProps>, prevState: Readonly<{}>): any
  • 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 any

render

  • render(): ReactNode
  • Returns ReactNode

setState

  • setState<K>(state: null | {} | ((prevState: Readonly<{}>, props: Readonly<IntlProviderProps>) => null | {} | Pick<{}, K>) | Pick<{}, K>, callback?: () => void): void
  • Type parameters

    • K: never

    Parameters

    • state: null | {} | ((prevState: Readonly<{}>, props: Readonly<IntlProviderProps>) => null | {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IntlProviderProps>, nextState: Readonly<{}>, 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

    Returns boolean

Generated using TypeDoc