Class Component<P, S, SS>

Base RS Components. All components in the application should be inherited from this class or its subclasses.

Type Parameters

  • P = {}
  • S = {}
  • SS = any

Hierarchy (view full)

Constructors

constructor

Properties

_mounted

Methods

componentDidMount componentWillUnmount getContext getJSXText getStateKey getText loadState onPopState saveState

Constructors

constructor

  • new Component<P, S, SS>(props): Component<P, S, SS>

  • Type Parameters

    • P = {}
    • S = {}
    • SS = any

    Parameters

    • props: P

    Returns Component<P, S, SS>

  • new Component<P, S, SS>(props, context): Component<P, S, SS>

  • Type Parameters

    • P = {}
    • S = {}
    • SS = any

    Parameters

    • props: P
    • context: any

    Returns Component<P, S, SS>

    Deprecated

    See

    React Docs

Properties

Protected_mounted

_mounted: boolean

Indicates if the component is mounted.

Methods

componentDidMount

  • componentDidMount(): void

  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

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

getContext

getJSXText

  • getJSXText<T>(key): 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.

    Returns Element

    Typeparam

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

  • getJSXText<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' }.

ProtectedgetStateKey

  • getStateKey(): string

  • Gets the state key of the component instance. By default the method returns null. If it's overriden to return a string value the saveState and loadState are handled automatically in the component's lifecycle.

    Returns string

getText

  • getText<T>(key): string

  • Gets the text from the dictionary.

    Type Parameters

    • T = any

    Parameters

    • key: keyof T

      Key of the text in the dictionary.

    Returns string

    Typeparam

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

  • getText<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' }.

ProtectedloadState

  • loadState(key): Promise<void>

  • Loads the state from the memory storage.

    Parameters

    • key: string

      State key of the component instance.

    Returns Promise<void>

ProtectedonPopState

  • onPopState(event): void

  • Method called after window.onpopstate event is triggered.

    Parameters

    • event: any

    Returns void

ProtectedsaveState

  • saveState(key): void

  • Saves the current state to the memory storage.

    Parameters

    • key: string

      State key of the component instance.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods