Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Layout<P, S, SS>

Type parameters

Hierarchy

  • Layout<P>
    • Layout

Index

Properties

Protected _theme

_theme: Theme = createTheme({ ...this.props?.theme, ...this._getTheme() })

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

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

Protected _createPath

  • _createPath(path: string, version: string): string
  • Creates path with version parameter.

    Parameters

    • path: string

      Path of the loaded link.

    • version: string

      Version of the app.

    Returns string

Protected _getTheme

  • _getTheme(): ThemeOptions

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<P>, prevState: Readonly<S>, 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<P>
    • prevState: Readonly<S>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<P>, prevState: Readonly<S>): 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

    • prevProps: Readonly<P>
    • prevState: Readonly<S>

    Returns SS | null

getText

  • getText(key: string): string
  • getText(key: string, ...args: Array<any>): string
  • Gets the text from the dictionary.

    Parameters

    • key: string

      Key of the text in the dictionary.

    Returns string

  • Gets the text from the dictionary.

    Parameters

    • key: string

      Key of the text in the dictionary.

    • Rest ...args: Array<any>

      Arguments for text format.

    Returns string

renderBody

  • renderBody(): Element
  • Renders <body> tag with with container and bundle data.

    Returns Element

renderBundleData

  • renderBundleData(): Element
  • Renders initial data and bundle <script> tag.

    Returns Element

renderContainer

  • renderContainer(): Element

renderHead

  • renderHead(): Element
  • Renders <head> tag with charset, metas, title, scripts and styles.

    Returns Element

renderLoader

  • renderLoader(): Element

renderMeta

  • renderMeta(): Element
  • Renders the meta tags. If it's used in inherited Layout super.renderMeta() should be called.

    Returns Element

renderThemeContainer

  • renderThemeContainer(): Element

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<P>, nextState: Readonly<S>, 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<P>
    • nextState: Readonly<S>
    • nextContext: any

    Returns boolean

Generated using TypeDoc