# kol-table-stateful

<!-- Auto Generated Below -->


## Properties

| Property                 | Attribute              | Description                                                                                                        | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Default     |
| ------------------------ | ---------------------- | ------------------------------------------------------------------------------------------------------------------ |   | ----------- |
| `_allowMultiSort`        | `_allow-multi-sort`    | Defines whether to allow multi sort.                                                                               | `boolean \| 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` |
| `_hasSettingsMenu`       | `_has-settings-menu`   | Enables the settings menu if true (default: false).                                                                | `boolean \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | `undefined` |
| `_headers` _(required)_  | `_headers`             | Defines the horizontal and vertical table headers.                                                                 | `string \| { horizontal?: KoliBriTableHeaderCellWithLogic[][] \| undefined; vertical?: KoliBriTableHeaderCellWithLogic[][] \| 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` |
| `_minWidth` _(required)_ | `_min-width`           | Defines the table min-width (CSS width values).                                                                    | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | `undefined` |
| `_on`                    | --                     | Defines the callback functions for table events.                                                                   | `undefined \| { onSelectionChange?: EventValueOrEventCallback<Event, StatefulSelectionChangeEventPayload> \| undefined; }`                                                                                                                                                                                                                                                                                                                                                                                                          | `undefined` |
| `_pagination`            | `_pagination`          | Defines whether to show the data distributed over multiple pages.                                                  | `boolean \| string \| undefined \| { _page: number; } & { _on?: KoliBriPaginationButtonCallbacks \| undefined; _page?: number \| undefined; _max?: number \| undefined; _boundaryCount?: number \| undefined; _hasButtons?: boolean \| Stringified<PaginationHasButton> \| undefined; _pageSize?: number \| undefined; _pageSizeOptions?: Stringified<number[]> \| undefined; _siblingCount?: number \| undefined; _customClass?: string \| undefined; _label?: string \| undefined; _tooltipAlign?: AlignPropType \| undefined; }` | `undefined` |
| `_paginationPosition`    | `_pagination-position` | Controls the position of the pagination.                                                                           | `"both" \| "bottom" \| "top" \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | `'bottom'`  |
| `_selection`             | `_selection`           | Defines how rows can be selected and the current selection.                                                        | `string \| undefined \| ({ label: (row: KoliBriTableDataType) => string; keyPropertyName?: string \| undefined; multiple?: boolean \| undefined; selectedKeys?: KoliBriTableSelectionKeys \| undefined; disabledKeys?: KoliBriTableSelectionKeys \| undefined; })`                                                                                                                                                                                                                                                                  | `undefined` |
| `_tableSettings`         | --                     | Defines the table settings including column visibility, order and width.                                           | `TableSettings \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | `undefined` |


## Methods

### `getSelection() => Promise<KoliBriTableDataType[] | KoliBriTableDataType | null>`

Returns the selected rows.

#### Returns

Type: `Promise<KoliBriTableDataType | KoliBriTableDataType[] | null>`




----------------------------------------------


