Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Config<SS>

This component allows the user to set configuration options for the server. The configuration can either be uploaded as a JSON file or typed in manually.

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns Config

Properties

context

context: any

props

props: Readonly<object> & Readonly<__type>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<ConfigState>

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<__type>, nextState: Readonly<ConfigState>, 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

componentDidMount

  • componentDidMount(): void
  • Called when the component is first mounted and fetches the current configuration.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<__type>, prevState: Readonly<ConfigState>, 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<__type>
    • prevState: Readonly<ConfigState>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

fetchConfigData

  • fetchConfigData(): Promise<void>
  • Retrieves the current confoguration from the API and updates state.

    Returns Promise<void>

forceUpdate

  • forceUpdate(callBack?: undefined | function): void
  • Parameters

    • Optional callBack: undefined | function

    Returns void

Optional getSnapshotBeforeUpdate

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

    Returns SS | null

render

  • render(): Element
  • Renders the component

    Returns Element

setState

  • setState<K>(state: function | null | S | object, callback?: undefined | function): void
  • Type parameters

    • K: keyof ConfigState

    Parameters

    • state: function | null | S | object
    • Optional callback: undefined | function

    Returns void

Optional shouldComponentUpdate

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

    Returns boolean

Generated using TypeDoc