Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Props

Hierarchy

Index

Properties

Properties

allColumns

allColumns: Array<SocSettingColumnInstance<Record<string, unknown>>>

allColumnsHidden

allColumnsHidden: boolean

cell

cell: SocSettingCell<D, V>

column

column: SocSettingColumnInstance<D>

columns

columns: Array<SocSettingColumnInstance<Record<string, unknown>>>

dispatch

dispatch: TableDispatch

flatHeaders

flatHeaders: Array<SocSettingColumnInstance<Record<string, unknown>>>

flatRows

flatRows: Array<SocSettingRow<Record<string, unknown>>>

footerGroups

footerGroups: Array<SocSettingHeaderGroup<Record<string, unknown>>>

getHooks

getHooks: () => Hooks<Record<string, unknown>>

Type declaration

    • (): Hooks<Record<string, unknown>>

    • Returns Hooks<Record<string, unknown>>

getTableBodyProps

getTableBodyProps: (propGetter?: TableBodyPropGetter<Record<string, unknown>>) => TableBodyProps

Type declaration

    • (propGetter?: TableBodyPropGetter<Record<string, unknown>>): TableBodyProps

    • Parameters

      • Optional propGetter: TableBodyPropGetter<Record<string, unknown>>

      Returns TableBodyProps

getTableProps

getTableProps: (propGetter?: TablePropGetter<Record<string, unknown>>) => TableProps

Type declaration

    • (propGetter?: TablePropGetter<Record<string, unknown>>): TableProps

    • Parameters

      • Optional propGetter: TablePropGetter<Record<string, unknown>>

      Returns TableProps

getToggleHideAllColumnsProps

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

Type declaration

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

    • Parameters

      • Optional props: Partial<TableToggleHideAllColumnProps>

      Returns TableToggleHideAllColumnProps

headerGroups

headerGroups: Array<SocSettingHeaderGroup<Record<string, unknown>>>

headers

headers: Array<SocSettingColumnInstance<Record<string, unknown>>>

Optional isExpanded

isExpanded: undefined | false | true

plugins

plugins: Array<PluginHook<Record<string, unknown>>>

prepareRow

prepareRow: (row: SocSettingRow<Record<string, unknown>>) => void

Type declaration

row

row: SocSettingRow<D>

rows

rows: Array<SocSettingRow<Record<string, unknown>>>

rowsById

rowsById: Record<string, SocSettingRow<Record<string, unknown>>>

setCellState

setCellState: (rowPath: string[], columnId: IdType<Record<string, unknown>>, updater: UseRowUpdater) => void

Type declaration

    • (rowPath: string[], columnId: IdType<Record<string, unknown>>, updater: UseRowUpdater): void

    • Parameters

      • rowPath: string[]
      • columnId: IdType<Record<string, unknown>>
      • updater: UseRowUpdater

      Returns void

setHiddenColumns

setHiddenColumns: (param: Array<IdType<Record<string, unknown>>> | UpdateHiddenColumns<Record<string, unknown>>) => void

Type declaration

    • (param: Array<IdType<Record<string, unknown>>> | UpdateHiddenColumns<Record<string, unknown>>): void

    • Parameters

      Returns void

setRowState

setRowState: (rowPath: string[], updater: UseRowUpdater) => void

Type declaration

    • (rowPath: string[], updater: UseRowUpdater): void

    • Parameters

      • rowPath: string[]
      • updater: UseRowUpdater

      Returns void

state

state: SocSettingTableState<Record<string, unknown>>

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<Record<string, unknown>>, value?: undefined | false | true) => void

Type declaration

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

    • Parameters

      • columnId: IdType<Record<string, unknown>>
      • Optional value: undefined | false | true

      Returns void

totalColumnsWidth

totalColumnsWidth: number

value

value: CellValue<V>

visibleColumns

visibleColumns: Array<SocSettingColumnInstance<Record<string, unknown>>>

windowWidth

windowWidth: number

Generated using TypeDoc