Mixins / foldkit-mixins-ui

TableSelection

interface · packages/mixins-ui/src/table.ts:90

interface TableSelection<Row, Message> {
  readonly id: string
  readonly isSelected: (row: Row) => boolean
  readonly onToggle: (row: Row, selected: boolean) => Message
  readonly onToggleAll: (selected: boolean) => Message
  readonly rowLabel?: ((row: Row) => string) | undefined
  readonly allLabel?: string | undefined
  readonly checkbox?: NamedStyle<typeof Checkbox.CheckboxSlots> | undefined
}

A checkbox on every row, the rows chosen being the application's.

Members

TableSelection.id

property · packages/mixins-ui/src/table.ts:92

readonly id: string

Prefixes the checkboxes' ids, unique on the page.

TableSelection.isSelected

property · packages/mixins-ui/src/table.ts:93

readonly isSelected: (row: Row) => boolean

TableSelection.onToggle

property · packages/mixins-ui/src/table.ts:94

readonly onToggle: (row: Row, selected: boolean) => Message

TableSelection.onToggleAll

property · packages/mixins-ui/src/table.ts:96

readonly onToggleAll: (selected: boolean) => Message

Sent by the heading's box: true to choose every row, false for none.

TableSelection.rowLabel

property · packages/mixins-ui/src/table.ts:98

readonly rowLabel?: ((row: Row) => string) | undefined

A row's checkbox's name; default "Select row".

TableSelection.allLabel

property · packages/mixins-ui/src/table.ts:100

readonly allLabel?: string | undefined

The heading's checkbox's name; default "Select all rows".

TableSelection.checkbox

property · packages/mixins-ui/src/table.ts:102

readonly checkbox?: NamedStyle<typeof Checkbox.CheckboxSlots> | undefined

A style of CheckboxSlots, for the boxes' look.