Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LineUpLitePaginatedProps<D>

Type Parameters

Hierarchy

Index

Properties

actionFilter?: CustomFilterByAction<D>

custom handler for filter action click

actionGroupBy?: CustomGroupByAction<D>

custom handler for group by action click

actionSortBy?: CustomSortByAction<D>

custom handler for sort by action click

aggregations?: Record<string, AggregatorFn<D>>
autoResetExpanded?: boolean
autoResetFilters?: boolean
autoResetGroupBy?: boolean
autoResetHiddenColumns?: boolean
autoResetPage?: boolean
autoResetSelectedRows?: boolean
autoResetSortBy?: boolean
children?: ReactNode
className?: string
classNames?: Partial<Record<MultiCustomizeKeys, string>>

hook for adding extra CSS classnames

columns: LineUpLiteColumn<D>[]
components?: Partial<Record<"table" | MultiCustomizeKeys, LineUpLiteComponentLike>>
dark?: boolean
data: readonly D[]
defaultCanFilter?: boolean
defaultCanGroupBy?: boolean
defaultCanSort?: boolean
defaultColumn?: Partial<LineUpLiteColumn<D>>
disableFilters?: boolean
disableGroupBy?: boolean
disableMultiSort?: boolean
disableSortBy?: boolean
disableSortRemove?: boolean
disabledMultiRemove?: boolean
expandColumnWidth?: number

width of the expand column

default

20

expandSubRows?: boolean
features: readonly (PluginHook<D> | PluginHook<D>[])[]
filterTypes?: FilterTypes<D>
i18n?: Partial<{ collapseAllGroups: string; collapseGroup: string; expandAllGroups: string; expandGroup: string }> & Partial<{ selectAll: string; selectGroup: string; selectRow: string; unselectAll: string; unselectGroup: string; unselectRow: string }> & Partial<{ filterColumn: string; groupByAnotherColumn: string; groupByColumn: string; groupByRemoveColumn: string; hideColumn: string; sortByAnotherColumn: string; sortByAnotherColumnDesc: string; sortByColumn: string; sortByColumnDesc: string; sortByRemoveColumn: string }>

i18n customizations

icon to use for the expand icon

initialState?: Partial<TableState<D>>
manualExpandedKey?: IdType<D>
manualFilters?: boolean
manualGroupBy?: boolean
manualPagination?: boolean
manualRowSelectedKey?: IdType<D>
manualSortBy?: boolean
maxMultiSortColCount?: number
pageCount?: number
paginateExpandedRows?: boolean
rankColumnWidth?: number

width of the rank column

default

40

selectCheckboxComponent?: ComponentType<TableToggleAllRowsSelectedProps>
selectColumnWidth?: number

width of the select column

default

20

selectSubRows?: boolean
sortTypes?: Record<string, SortByFn<D>>
style?: CSSProperties
styles?: Partial<Record<MultiCustomizeKeys, CSSProperties>>

hoop for adding extra styles

Methods

  • callback for generating extra toolbar actions for a column

    Parameters

    Returns ReactNode

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

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

    Returns string

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

    • originalRow: D
    • relativeIndex: number

    Returns D[]

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

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

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

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

    • e: MouseEvent<Element, MouseEvent>

    Returns boolean

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

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

    Returns Row<D>[]

  • 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>

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

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

    Returns TableState<D>

Generated using TypeDoc