Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AdminTableInstance<D>

Type parameters

  • D: Record<string, unknown> = Record<string, unknown>

Hierarchy

Index

Properties

Properties

allColumns

allColumns: Array<AdminColumnInstance<D>>

allColumnsHidden

allColumnsHidden: boolean

columns

columns: Array<AdminColumnInstance<D>>

dispatch

dispatch: TableDispatch

flatHeaders

flatHeaders: Array<AdminColumnInstance<D>>

flatRows

flatRows: Array<Row<D>>

footerGroups

footerGroups: Array<AdminHeaderGroup<D>>

getHooks

getHooks: () => Hooks<D>

Type declaration

    • (): Hooks<D>

    • Returns Hooks<D>

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

    • (propGetter?: TablePropGetter<D>): TableProps

    • Parameters

      • Optional propGetter: TablePropGetter<D>

      Returns TableProps

getToggleHideAllColumnsProps

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

Type declaration

    • (props?: Partial<TableToggleHideAllColumnProps>): TableToggleHideAllColumnProps

    • Parameters

      • Optional props: Partial<TableToggleHideAllColumnProps>

      Returns TableToggleHideAllColumnProps

headerGroups

headerGroups: Array<AdminHeaderGroup<D>>

headers

headers: Array<AdminColumnInstance<D>>

plugins

plugins: Array<PluginHook<D>>

preSortedRows

preSortedRows: Array<Row<D>>

prepareRow

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

Type declaration

    • (row: Row<D>): void

    • Parameters

      • row: Row<D>

      Returns void

rows

rows: Array<Row<D>>

rowsById

rowsById: Record<string, Row<D>>

setHiddenColumns

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

Type declaration

setSortBy

setSortBy: (sortBy: Array<SortingRule<D>>) => void

Type declaration

    • (sortBy: Array<SortingRule<D>>): void

    • Parameters

      • sortBy: Array<SortingRule<D>>

      Returns void

state

state: AdminTableState<D>

toggleHideAllColumns

toggleHideAllColumns: (value?: undefined | false | true) => void

Type declaration

    • (value?: undefined | false | true): void

    • Parameters

      • Optional value: undefined | false | true

      Returns void

toggleHideColumn

toggleHideColumn: (columnId: IdType<D>, value?: undefined | false | true) => void

Type declaration

    • (columnId: IdType<D>, value?: undefined | false | true): void

    • Parameters

      • columnId: IdType<D>
      • Optional value: undefined | false | true

      Returns void

toggleSortBy

toggleSortBy: (columnId: IdType<D>, descending: boolean, isMulti: boolean) => void

Type declaration

    • (columnId: IdType<D>, descending: boolean, isMulti: boolean): void

    • Parameters

      • columnId: IdType<D>
      • descending: boolean
      • isMulti: boolean

      Returns void

totalColumnsWidth

totalColumnsWidth: number

visibleColumns

visibleColumns: Array<AdminColumnInstance<D>>

Generated using TypeDoc