Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RegistrationTableInstance<D>

Type parameters

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

Hierarchy

  • {}
  • UseRegistrationTableInstanceProps<D>
  • UseFiltersInstanceProps<D>
  • UseGlobalFiltersInstanceProps<D>
  • UsePaginationInstanceProps<D>
  • UseSortByInstanceProps<D>
    • RegistrationTableInstance

Index

Properties

Properties

allColumns

allColumns: Array<RegistrationColumnInstance<D>>

allColumnsHidden

allColumnsHidden: boolean

canNextPage

canNextPage: boolean

canPreviousPage

canPreviousPage: boolean

columns

columns: Array<RegistrationColumnInstance<D>>

dispatch

dispatch: TableDispatch

filteredFlatRows

filteredFlatRows: Array<Row<D>>

filteredRows

filteredRows: Array<Row<D>>

filteredRowsById

filteredRowsById: Record<string, Row<D>>

flatHeaders

flatHeaders: Array<RegistrationColumnInstance<D>>

flatRows

flatRows: Array<Row<D>>

footerGroups

footerGroups: Array<RegistrationHeaderGroup<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

globalFilteredFlatRows

globalFilteredFlatRows: Array<Row<D>>

globalFilteredRows

globalFilteredRows: Array<Row<D>>

globalFilteredRowsById

globalFilteredRowsById: Record<string, Row<D>>

gotoPage

gotoPage: (updater: ((pageIndex: number) => number) | number) => void

Type declaration

    • (updater: ((pageIndex: number) => number) | number): void

    • Parameters

      • updater: ((pageIndex: number) => number) | number

      Returns void

headerGroups

headerGroups: Array<RegistrationHeaderGroup<D>>

headers

headers: Array<RegistrationColumnInstance<D>>

nextPage

nextPage: () => void

Type declaration

    • (): void

    • Returns void

page

page: Array<Row<D>>

pageCount

pageCount: number

pageOptions

pageOptions: number[]

plugins

plugins: Array<PluginHook<D>>

preFilteredFlatRows

preFilteredFlatRows: Array<Row<D>>

preFilteredRows

preFilteredRows: Array<Row<D>>

preFilteredRowsById

preFilteredRowsById: Record<string, Row<D>>

preGlobalFilteredFlatRows

preGlobalFilteredFlatRows: Array<Row<D>>

preGlobalFilteredRows

preGlobalFilteredRows: Array<Row<D>>

preGlobalFilteredRowsById

preGlobalFilteredRowsById: Record<string, Row<D>>

preSortedRows

preSortedRows: Array<Row<D>>

prepareRow

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

Type declaration

    • (row: Row<D>): void

    • Parameters

      • row: Row<D>

      Returns void

previousPage

previousPage: () => void

Type declaration

    • (): void

    • Returns void

rows

rows: Array<Row<D>>

rowsById

rowsById: Record<string, Row<D>>

setAllFilters

setAllFilters: (updater: Filters<D> | ((filters: Filters<D>) => Filters<D>)) => void

Type declaration

    • (updater: Filters<D> | ((filters: Filters<D>) => Filters<D>)): void

    • Parameters

      • updater: Filters<D> | ((filters: Filters<D>) => Filters<D>)

      Returns void

setFilter

setFilter: (columnId: IdType<D>, updater: ((filterValue: FilterValue) => FilterValue) | FilterValue) => void

Type declaration

    • (columnId: IdType<D>, updater: ((filterValue: FilterValue) => FilterValue) | FilterValue): void

    • Parameters

      • columnId: IdType<D>
      • updater: ((filterValue: FilterValue) => FilterValue) | FilterValue

      Returns void

setGlobalFilter

setGlobalFilter: (filterValue: FilterValue) => void

Type declaration

    • (filterValue: FilterValue): void

    • Parameters

      • filterValue: FilterValue

      Returns void

setHiddenColumns

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

Type declaration

setPageSize

setPageSize: (pageSize: number) => void

Type declaration

    • (pageSize: number): void

    • Parameters

      • pageSize: number

      Returns void

setSortBy

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

Type declaration

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

    • Parameters

      • sortBy: Array<SortingRule<D>>

      Returns void

state

state: RegistrationTableState<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<RegistrationColumnInstance<D>>

Generated using TypeDoc