Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AdminColumnInstance<D, V>

Type parameters

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

  • V = unknown

Hierarchy

Index

Properties

Properties

Optional Cell

Cell: Renderer<CellProps<D, V>>

canSort

canSort: boolean

clearSortBy

clearSortBy: () => void

Type declaration

    • (): void

    • Returns void

columns

columns: Array<AdminColumnInstance<D>>

depth

depth: number

getFooterProps

getFooterProps: (propGetter?: AdminFooterPropGetter<D>) => TableFooterProps

Type declaration

getHeaderProps

getHeaderProps: (propGetter?: AdminHeaderPropGetter<D>) => TableHeaderProps

Type declaration

getSortByToggleProps

getSortByToggleProps: (props?: Partial<TableSortByToggleProps>) => TableSortByToggleProps

Type declaration

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

    • Parameters

      • Optional props: Partial<TableSortByToggleProps>

      Returns TableSortByToggleProps

getToggleHiddenProps

getToggleHiddenProps: (userProps?: unknown) => unknown

Type declaration

    • (userProps?: unknown): unknown

    • Parameters

      • Optional userProps: unknown

      Returns unknown

id

id: IdType<D>

index

index: number

isSorted

isSorted: boolean

isSortedDesc

isSortedDesc: boolean | undefined

isVisible

isVisible: boolean

parent

parent: AdminColumnInstance<D>

Optional placeholderOf

placeholderOf: AdminColumnInstance

render

render: (type: "Header" | "Footer" | string, props?: Record<string, unknown>) => ReactNode

Type declaration

    • (type: "Header" | "Footer" | string, props?: Record<string, unknown>): ReactNode

    • Parameters

      • type: "Header" | "Footer" | string
      • Optional props: Record<string, unknown>

      Returns ReactNode

sortedIndex

sortedIndex: number

toggleHidden

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

Type declaration

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

    • Parameters

      • Optional value: undefined | false | true

      Returns void

toggleSortBy

toggleSortBy: (descending: boolean, multi: boolean) => void

Type declaration

    • (descending: boolean, multi: boolean): void

    • Parameters

      • descending: boolean
      • multi: boolean

      Returns void

totalLeft

totalLeft: number

totalWidth

totalWidth: number

Generated using TypeDoc