Class Text

Component for rendering texts from dictionary.

Hierarchy

Constructors

constructor

Methods

addDictionary addFunction format formatJSX get getJSX setDictionary

Constructors

constructor

  • new Text(props): Text

  • Parameters

    Returns Text

  • new Text(props, context): Text

  • Parameters

    Returns Text

    Deprecated

    See

    React Docs

Methods

StaticaddDictionary

  • addDictionary(dictionary): Text

  • Adds the dictionary to the default dictionary.

    Parameters

    • dictionary: {
          [key: string]: string;
      }

      Dictionary data.

      • [key: string]: string

    Returns Text

  • addDictionary(key, dictionary): Text

  • Adds the dictionary to the specific key.

    Parameters

    • key: string

      Key of the dictionary.

    • dictionary: {
          [key: string]: string;
      }

      Dictionary data.

      • [key: string]: string

    Returns Text

StaticaddFunction

  • addFunction(name, fn): Text

  • Registers function to the text.

    Parameters

    • name: string

      Name of the function.

    • fn: ((...args: any[]) => string)

      Called function.

        • (...args): string

        • Parameters

          • Rest...args: any[]

          Returns string

    Returns Text

Staticformat

  • format(text, ...args): string

  • Formats the text.

    Parameters

    • text: string

      Text to format.

    • Rest...args: any[]

      Arguments for text format.

    Returns string

StaticformatJSX

  • formatJSX(text, ...args): Element

  • Formats the text with HTML converted to JSX.

    Parameters

    • text: string

      Text to format.

    • Rest...args: any[]

      Arguments for text format.

    Returns Element

Staticget

  • get<T>(key, ...args): string

  • Gets the text from the dictionary.

    Type Parameters

    • T = any

    Parameters

    • key: keyof T

      Key of the text in the dictionary.

    • Rest...args: any[]

      Arguments for text format.

    Returns string

    Typeparam

    T - Type of the dictionary object -> typeof { key: 'value' }.

StaticgetJSX

  • getJSX<T>(key, ...args): Element

  • Gets the text from the dictionary as JSX object. All HTML in the text is converted to JSX.

    Type Parameters

    • T = any

    Parameters

    • key: keyof T

      Key of the text in the dictionary.

    • Rest...args: any[]

      Arguments for text format.

    Returns Element

    Typeparam

    T - Type of the dictionary object -> typeof { key: 'value' }.

StaticsetDictionary

Settings

Member Visibility

On This Page

Constructors
Methods