Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LineUp<SS>

Type parameters

  • SS

Hierarchy

Index

Properties

Private adapter

adapter: Adapter = new builderAdapter.Adapter({props: () => this.props,createInstance: (data: LocalDataProvider, options: Partial<ILineUpOptions>) => this.createInstance(this.node!, data, options),columnDescs: (data: any[]) => filterChildrenProps<LineUpColumnDesc, any>(this.props.children, LineUpColumnDesc).map((d) => d.type.build(d.props, data)),rankingBuilders: () => filterChildrenProps<LineUpRanking>(this.props.children, LineUpRanking).map((d) => LineUpRanking.merge(d.props))})

Private node

node: HTMLElement | null = null

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

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

componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<ILineUpProps>): void
  • Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<Readonly<ILineUpProps>>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void
  • Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<Readonly<ILineUpProps>>, nextState: Readonly<__type>, nextContext: any): void

Protected createInstance

  • createInstance(node: HTMLElement, data: LocalDataProvider, options: Partial<ITaggleOptions>): LineUpImpl | Taggle
  • Parameters

    • node: HTMLElement
    • data: LocalDataProvider
    • options: Partial<ITaggleOptions>

    Returns LineUpImpl | Taggle

Optional getSnapshotBeforeUpdate

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

    Returns SS | null

render

  • render(): Element

Optional shouldComponentUpdate

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

    Returns boolean

Generated using TypeDoc