Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UseLineUpLiteOptions<D>

Type Parameters

Hierarchy

Index

Properties

Methods

Properties

Optional aggregations

aggregations?: Record<string, AggregatorFn<D>>

Optional autoResetExpanded

autoResetExpanded?: boolean

Optional autoResetFilters

autoResetFilters?: boolean

Optional autoResetGroupBy

autoResetGroupBy?: boolean

Optional autoResetHiddenColumns

autoResetHiddenColumns?: boolean

Optional autoResetSelectedRows

autoResetSelectedRows?: boolean

Optional autoResetSortBy

autoResetSortBy?: boolean

columns

columns: LineUpLiteColumn<D>[]

data

data: readonly D[]

Optional defaultCanFilter

defaultCanFilter?: boolean

Optional defaultCanGroupBy

defaultCanGroupBy?: boolean

Optional defaultCanSort

defaultCanSort?: boolean

Optional defaultColumn

defaultColumn?: Partial<LineUpLiteColumn<D>>

Optional disableFilters

disableFilters?: boolean

Optional disableGroupBy

disableGroupBy?: boolean

Optional disableMultiSort

disableMultiSort?: boolean

Optional disableSortBy

disableSortBy?: boolean

Optional disableSortRemove

disableSortRemove?: boolean

Optional disabledMultiRemove

disabledMultiRemove?: boolean

Optional expandColumnWidth

expandColumnWidth?: number

width of the expand column

default

20

Optional expandSubRows

expandSubRows?: boolean

features

features: readonly (PluginHook<D> | PluginHook<D>[])[]

Optional filterTypes

filterTypes?: FilterTypes<D>

Optional i18n

i18n?: Partial<{ collapseAllGroups: string; collapseGroup: string; expandAllGroups: string; expandGroup: string }> & Partial<{ selectAll: string; selectGroup: string; selectRow: string; unselectAll: string; unselectGroup: string; unselectRow: string }>

i18n customizations

Optional icons

icons?: { expandGroup?: ComponentType<{}> }

icon to use for the expand icon

default

'▸'

Type declaration

  • Optional expandGroup?: ComponentType<{}>

Optional initialState

initialState?: Partial<TableState<D>>

Optional manualExpandedKey

manualExpandedKey?: IdType<D>

Optional manualFilters

manualFilters?: boolean

Optional manualGroupBy

manualGroupBy?: boolean

Optional manualRowSelectedKey

manualRowSelectedKey?: IdType<D>

Optional manualSortBy

manualSortBy?: boolean

Optional maxMultiSortColCount

maxMultiSortColCount?: number

Optional paginateExpandedRows

paginateExpandedRows?: boolean

Optional rankColumnWidth

rankColumnWidth?: number

width of the rank column

default

40

Optional selectCheckboxComponent

selectCheckboxComponent?: ComponentType<TableToggleAllRowsSelectedProps>

Optional selectColumnWidth

selectColumnWidth?: number

width of the select column

default

20

Optional selectSubRows

selectSubRows?: boolean

Optional sortTypes

sortTypes?: Record<string, SortByFn<D>>

Methods

Optional getRowId

  • getRowId(originalRow: D, relativeIndex: number, parent?: Row<D>): string

  • Parameters

    • originalRow: D
    • relativeIndex: number
    • Optional parent: Row<D>

    Returns string

Optional getSubRows

  • getSubRows(originalRow: D, relativeIndex: number): D[]

  • Parameters

    • originalRow: D
    • relativeIndex: number

    Returns D[]

Optional groupByFn

  • groupByFn(rows: Row<D>[], columnId: IdType<D>): Record<string, Row<D>[]>

  • Parameters

    • rows: Row<D>[]
    • columnId: IdType<D>

    Returns Record<string, Row<D>[]>

Optional isMultiSortEvent

  • isMultiSortEvent(e: MouseEvent<Element, MouseEvent>): boolean

  • Parameters

    • e: MouseEvent<Element, MouseEvent>

    Returns boolean

Optional onStateChange

Optional orderByFn

  • orderByFn(rows: Row<D>[], sortFns: OrderByFn<D>[], directions: boolean[]): Row<D>[]

  • Parameters

    • rows: Row<D>[]
    • sortFns: OrderByFn<D>[]
    • directions: boolean[]

    Returns Row<D>[]

Optional stateReducer

  • stateReducer(newState: TableState<D>, action: ActionType, previousState: TableState<D>, instance?: TableInstance<D>): TableState<D>

  • Parameters

    • newState: TableState<D>
    • action: ActionType
    • previousState: TableState<D>
    • Optional instance: TableInstance<D>

    Returns TableState<D>

Optional useControlledState

  • useControlledState(state: TableState<D>, meta: MetaBase<D>): TableState<D>

  • Parameters

    • state: TableState<D>
    • meta: MetaBase<D>

    Returns TableState<D>

Generated using TypeDoc