UNPKG

@public-ui/components

Version:

Contains all web components that belong to KoliBri - The accessible HTML-Standard.

25 lines (16 loc) 8.32 kB
# kol-table-stateless <!-- Auto Generated Below --> ## Properties | Property | Attribute | Description | Type | Default | | --------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | `_ariaLabelledby` | `_aria-labelledby` | References an external element by ID that serves as the accessible label for this table. Uses ElementInternals.ariaLabelledByElements to cross the Shadow DOM boundary. Supported by desktop screen readers (NVDA, JAWS with Chrome/Firefox). Not yet supported by mobile screen readers (TalkBack, VoiceOver iOS) — use `_label` instead. | `string \| undefined` | `undefined` | | `_data` _(required)_ | `_data` | Defines the primary table data. | `KoliBriTableDataType[] \| string` | `undefined` | | `_dataFoot` | `_data-foot` | Defines the data for the table footer. | `KoliBriTableDataType[] \| string \| undefined` | `undefined` | | `_fixedCols` | -- | Defines the fixed number of columns from start and end of the table | `[number, number] \| undefined` | `undefined` | | `_hasSettingsMenu` | `_has-settings-menu` | Enables the settings menu if true (default: false). | `boolean \| undefined` | `undefined` | | `_headerCells` _(required)_ | `_header-cells` | Defines the horizontal and vertical table headers. | `string \| { horizontal?: KoliBriTableHeaderCell[][] \| undefined; vertical?: KoliBriTableHeaderCell[][] \| undefined; }` | `undefined` | | `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` | `undefined` | | `_on` | -- | Defines the callback functions for table events. | `undefined \| { onSort?: EventValueOrEventCallback<MouseEvent, SortEventPayload> \| undefined; onSelectionChange?: EventValueOrEventCallback<Event, KoliBriTableSelectionKeys> \| undefined; onChangeHeaderCells?: EventValueOrEventCallback<Event, TableHeaderCells> \| undefined; }` | `undefined` | | `_selection` | `_selection` | Defines how rows can be selected and the current selection. | `string \| undefined \| ({ disabledKeys?: KoliBriTableSelectionKeys \| undefined; keyPropertyName?: string \| undefined; label: (row: KoliBriTableDataType) => string; multiple?: boolean \| undefined; selectedKeys?: KoliBriTableSelectionKeys \| undefined; })` | `undefined` | | `_variant` | `_variant` | Defines which variant should be used for presentation. | `string \| undefined` | `undefined` | ----------------------------------------------