Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataTableComponent<E, S, SS, S>

Type parameters

  • E: object

  • S

  • SS

  • S

Hierarchy

Index

Constructors

constructor

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

customFilterForms

customFilterForms: Map<string, FormInstance> = new Map<string, FormInstance>()

defaultSort

defaultSort: string | undefined

disposers

disposers: IReactionDisposer[] = []

firstLoad

firstLoad: boolean = true

operatorsByProperty

operatorsByProperty: Map<string, ComparisonType> = new Map()

props

props: Readonly<DataTableProps<E>> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

selectedRowKeys

selectedRowKeys: string[] = []

state

state: Readonly<S>

tableFilters

tableFilters: Record<string, any>

valuesByProperty

valuesByProperty: Map<string, CustomFilterInputValue> = new Map()

Static NO_COLUMN_DEF_ERROR

NO_COLUMN_DEF_ERROR: "You need to provide either columnDefinitions or fields prop" = "You need to provide either columnDefinitions or fields prop"

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Accessors

clearFiltersButton

  • get clearFiltersButton(): ReactNode

errorContext

  • get errorContext(): string

fields

  • get fields(): string[]

generateColumnProps

  • get generateColumnProps(): Array<ColumnProps<E>>

isClearFiltersShown

  • get isClearFiltersShown(): boolean

isRowSelectionEnabled

  • get isRowSelectionEnabled(): boolean

paginationConfig

  • get paginationConfig(): TablePaginationConfig

rowSelectionType

  • get rowSelectionType(): RowSelectionType

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

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

clearFilters

  • clearFilters(): 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

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<DataTableProps<E>>, 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<DataTableProps<E>>
    • prevState: Readonly<S>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<DataTableProps<E>>, nextState: Readonly<S>, nextContext: any): void

constructRowKey

  • constructRowKey(record: E & WithId): string

forceUpdate

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

    • Optional callback: undefined | function

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<DataTableProps<E>>, 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

    Returns SS | null

handleFilterOperatorChange

  • handleFilterOperatorChange(operator: ComparisonType, propertyName: string): void

handleFilterValueChange

isFilterForColumnEnabled

  • isFilterForColumnEnabled(propertyName: string): boolean

onChange

  • onChange(pagination: TablePaginationConfig, filters: Record<string, Key[] | null>, sorter: SorterResult<E> | Array<SorterResult<E>>): void

onRow

  • onRow(record: E): HTMLAttributes<HTMLElement>

onRowClicked

  • onRowClicked(record: E): void

onRowSelectionChange

  • onRowSelectionChange(): void

onRowSelectionColumnClicked

  • onRowSelectionColumnClicked(selectedRowKeys: ReactText[]): void

render

  • render(): Element

setState

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

    • K: keyof S

    Parameters

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

    Returns void

Optional shouldComponentUpdate

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

    Returns boolean

Object literals

Static defaultProps

defaultProps: object

canSelectRowByClick

canSelectRowByClick: boolean = true

hideClearFilters

hideClearFilters: boolean = false

hideSelectionColumn

hideSelectionColumn: boolean = false

rowSelectionMode

rowSelectionMode: "none" | "single" | "multi" = 'single' as 'single' | 'multi' | 'none'

Generated using TypeDoc