Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HeaderCellProps

Hierarchy

  • TableCellProps
    • HeaderCellProps

Index

Properties

Properties

Optional align

align: "inherit" | "left" | "center" | "right" | "justify"

Set the text-align on the table cell content.

Monetary or generally number fields should be right aligned as that allows you to add them up quickly in your head without having to worry about decimals.

Optional children

children: React.ReactNode

The table cell contents.

Optional classes

classes: Partial<ClassNameMap<TableCellBaseProps>>

Override or extend the styles applied to the component.

Optional component

component: React.ElementType<TableCellBaseProps>

The component used for the root node. Either a string to use a HTML element or a component.

Optional customclasses

customclasses: string | string[]

Custom CSS classes to pass to the button

Optional data-qa

data-qa: undefined | string

Data-qa tag to apply to the search bar and input element

header

header: HeaderProps

The header data

Optional innerRef

innerRef: React.Ref<any>

Optional isActionButtonCell

isActionButtonCell: undefined | false | true

Whether this header is for a cell that contains an action button

onRequestSort

onRequestSort: <T>(property: T) => void

The function triggered when a sort request is made

Type declaration

    • <T>(property: T): void

    • Type parameters

      • T: string

      Parameters

      • property: T

      Returns void

order

order: "desc" | "asc"

The order direction for the header

orderby

orderby: string

The property to order by

Optional padding

padding: Padding

Sets the padding applied to the cell. By default, the Table parent component set the value (normal). default is deprecated, use normal instead.

Optional scope

scope: TableCellBaseProps["scope"]

Set scope attribute.

Optional size

size: Size

Specify the size of the cell. By default, the Table parent component set the value (medium).

Optional sortDirection

sortDirection: SortDirection

Set aria-sort direction.

tooltiplabel

tooltiplabel: ReactNode

The label for the tooltip

tooltipplacement

tooltipplacement: TooltipProps["placement"]

The placement of the tooltip

Optional variant

variant: "head" | "body" | "footer"

Specify the cell type. By default, the TableHead, TableBody or TableFooter parent component set the value.

Generated using TypeDoc