Interface UseTableInstanceProps<D>

Type Parameters

  • D extends object

Hierarchy

Properties

allColumns allColumnsHidden columns dispatch flatHeaders flatRows footerGroups getHooks getTableBodyProps getTableProps getToggleHideAllColumnsProps headerGroups headers plugins prepareRow rows rowsById setHiddenColumns state toggleHideAllColumns toggleHideColumn totalColumnsWidth visibleColumns

Properties

allColumns

allColumns: ColumnInstance<D>[]

allColumnsHidden

allColumnsHidden: boolean

columns

columns: ColumnInstance<D>[]

dispatch

dispatch: TableDispatch<any>

flatHeaders

flatHeaders: ColumnInstance<D>[]

flatRows

flatRows: Row<D>[]

footerGroups

footerGroups: HeaderGroup<D>[]

getHooks

getHooks: (() => Hooks<D>)

Type declaration

getTableBodyProps

getTableBodyProps: ((propGetter?: TableBodyPropGetter<D>) => TableBodyProps)

Type declaration

    • (propGetter?: TableBodyPropGetter<D>): TableBodyProps

    • Parameters

      • Optional propGetter: TableBodyPropGetter<D>

      Returns TableBodyProps

getTableProps

getTableProps: ((propGetter?: TablePropGetter<D>) => TableProps)

Type declaration

getToggleHideAllColumnsProps

getToggleHideAllColumnsProps: ((props?: Partial<TableToggleHideAllColumnProps>) => TableToggleHideAllColumnProps)

Type declaration

headerGroups

headerGroups: HeaderGroup<D>[]

headers

headers: ColumnInstance<D>[]

plugins

plugins: PluginHook<D>[]

prepareRow

prepareRow: ((row: Row<D>) => void)

Type declaration

    • (row: Row<D>): void

    • Parameters

      Returns void

rows

rows: Row<D>[]

rowsById

rowsById: Record<string, Row<D>>

setHiddenColumns

setHiddenColumns: ((param: IdType<D>[] | UpdateHiddenColumns<D>) => void)

Type declaration

    • (param: IdType<D>[] | UpdateHiddenColumns<D>): void

    • Parameters

      • param: IdType<D>[] | UpdateHiddenColumns<D>

      Returns void

state

state: TableState<D>

toggleHideAllColumns

toggleHideAllColumns: ((value?: boolean) => void)

Type declaration

    • (value?: boolean): void

    • Parameters

      • Optional value: boolean

      Returns void

toggleHideColumn

toggleHideColumn: ((columnId: IdType<D>, value?: boolean) => void)

Type declaration

    • (columnId: IdType<D>, value?: boolean): void

    • Parameters

      • columnId: IdType<D>
      • Optional value: boolean

      Returns void

totalColumnsWidth

totalColumnsWidth: number

visibleColumns

visibleColumns: ColumnInstance<D>[]

Settings

Member Visibility

Theme

Generated using TypeDoc