Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(data-table): allow custom inputName for radio/checkbox #2087

Merged
merged 1 commit into from
Mar 9, 2025
+85 −30
Merged

feat(data-table): allow custom inputName for radio/checkbox #2087

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 25 additions & 24 deletions COMPONENT_INDEX.md
View file
Original file line number Diff line number Diff line change
@@ -971,30 +971,31 @@ export interface DataTableCell<Row = DataTableRow> {

### Props

| Prop name | Required | Kind | Reactive | Type | Default value | Description |
| :------------------ | :------- | :--------------- | :------- | ------------------------------------------------------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------- |
| selectedRowIds | No | <code>let</code> | Yes | <code>ReadonlyArray<DataTableRowId></code> | <code>[]</code> | Specify the row ids to be selected |
| selectable | No | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` for the selectable variant<br />Automatically set to `true` if `radio` or `batchSelection` are `true` |
| expandedRowIds | No | <code>let</code> | Yes | <code>ReadonlyArray<DataTableRowId></code> | <code>[]</code> | Specify the row ids to be expanded |
| expandable | No | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` for the expandable variant<br />Automatically set to `true` if `batchExpansion` is `true` |
| sortDirection | No | <code>let</code> | Yes | <code>"none" &#124; "ascending" &#124; "descending"</code> | <code>"none"</code> | Specify the sort direction |
| sortKey | No | <code>let</code> | Yes | <code>DataTableKey<Row></code> | <code>null</code> | Specify the header key to sort by |
| headers | No | <code>let</code> | No | <code>ReadonlyArray<DataTableHeader<Row>></code> | <code>[]</code> | Specify the data table headers |
| rows | No | <code>let</code> | No | <code>ReadonlyArray<Row></code> | <code>[]</code> | Specify the rows the data table should render<br />keys defined in `headers` are used for the row ids |
| size | No | <code>let</code> | No | <code>"compact" &#124; "short" &#124; "medium" &#124; "tall"</code> | <code>undefined</code> | Set the size of the data table |
| title | No | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the title of the data table |
| description | No | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the description of the data table |
| zebra | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use zebra styles |
| sortable | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` for the sortable variant |
| batchExpansion | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable batch expansion |
| nonExpandableRowIds | No | <code>let</code> | No | <code>ReadonlyArray<DataTableRowId></code> | <code>[]</code> | Specify the ids for rows that should not be expandable |
| radio | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` for the radio selection variant |
| batchSelection | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable batch selection |
| nonSelectableRowIds | No | <code>let</code> | No | <code>ReadonlyArray<DataTableRowId></code> | <code>[]</code> | Specify the ids of rows that should not be selectable |
| stickyHeader | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable a sticky header |
| useStaticWidth | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use static width |
| pageSize | No | <code>let</code> | No | <code>number</code> | <code>0</code> | Specify the number of items to display in a page |
| page | No | <code>let</code> | No | <code>number</code> | <code>0</code> | Set to `number` to set current page |
| Prop name | Required | Kind | Reactive | Type | Default value | Description |
| :------------------ | :------- | :--------------- | :------- | ------------------------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| selectedRowIds | No | <code>let</code> | Yes | <code>ReadonlyArray<DataTableRowId></code> | <code>[]</code> | Specify the row ids to be selected |
| selectable | No | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` for the selectable variant<br />Automatically set to `true` if `radio` or `batchSelection` are `true` |
| expandedRowIds | No | <code>let</code> | Yes | <code>ReadonlyArray<DataTableRowId></code> | <code>[]</code> | Specify the row ids to be expanded |
| expandable | No | <code>let</code> | Yes | <code>boolean</code> | <code>false</code> | Set to `true` for the expandable variant<br />Automatically set to `true` if `batchExpansion` is `true` |
| sortDirection | No | <code>let</code> | Yes | <code>"none" &#124; "ascending" &#124; "descending"</code> | <code>"none"</code> | Specify the sort direction |
| sortKey | No | <code>let</code> | Yes | <code>DataTableKey<Row></code> | <code>null</code> | Specify the header key to sort by |
| headers | No | <code>let</code> | No | <code>ReadonlyArray<DataTableHeader<Row>></code> | <code>[]</code> | Specify the data table headers |
| rows | No | <code>let</code> | No | <code>ReadonlyArray<Row></code> | <code>[]</code> | Specify the rows the data table should render<br />keys defined in `headers` are used for the row ids |
| size | No | <code>let</code> | No | <code>"compact" &#124; "short" &#124; "medium" &#124; "tall"</code> | <code>undefined</code> | Set the size of the data table |
| title | No | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the title of the data table |
| description | No | <code>let</code> | No | <code>string</code> | <code>""</code> | Specify the description of the data table |
| inputName | No | <code>let</code> | No | <code>string</code> | <code>"ccs-" + Math.random().toString(36)</code> | Specify a name attribute for the input elements<br />in a selectable data table (radio or checkbox).<br />When the table is inside a form, this name will<br />be included in the form data on submit. |
| zebra | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use zebra styles |
| sortable | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` for the sortable variant |
| batchExpansion | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable batch expansion |
| nonExpandableRowIds | No | <code>let</code> | No | <code>ReadonlyArray<DataTableRowId></code> | <code>[]</code> | Specify the ids for rows that should not be expandable |
| radio | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` for the radio selection variant |
| batchSelection | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable batch selection |
| nonSelectableRowIds | No | <code>let</code> | No | <code>ReadonlyArray<DataTableRowId></code> | <code>[]</code> | Specify the ids of rows that should not be selectable |
| stickyHeader | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to enable a sticky header |
| useStaticWidth | No | <code>let</code> | No | <code>boolean</code> | <code>false</code> | Set to `true` to use static width |
| pageSize | No | <code>let</code> | No | <code>number</code> | <code>0</code> | Specify the number of items to display in a page |
| page | No | <code>let</code> | No | <code>number</code> | <code>0</code> | Set to `number` to set current page |

### Slots

12 changes: 12 additions & 0 deletions docs/src/COMPONENT_API.json
View file
Original file line number Diff line number Diff line change
@@ -2899,6 +2899,18 @@
"constant": false,
"reactive": false
},
{
"name": "inputName",
"kind": "let",
"description": "Specify a name attribute for the input elements\nin a selectable data table (radio or checkbox).\nWhen the table is inside a form, this name will\nbe included in the form data on submit.",
"type": "string",
"value": "\"ccs-\" + Math.random().toString(36)",
"isFunction": false,
"isFunctionDeclaration": false,
"isRequired": false,
"constant": false,
"reactive": false
},
{
"name": "zebra",
"kind": "let",
14 changes: 13 additions & 1 deletion docs/src/pages/components/DataTable.svx
View file
Original file line number Diff line number Diff line change
@@ -1029,10 +1029,18 @@ In the following example, each row in the sortable data table has an overflow me

Set `selectable` to `true` for rows to be multi-selectable.

Bind to `selectedRowIds` to get the ids of the selected rows.

To customize the `input` name for the checkbox, use the `inputName` prop.

<FileSource src="/framed/DataTable/SelectableDataTable" />

## Batch selection

To enable batch selection, set `batchSelection` to `true`.

This checkbox is used to select all rows. It enters an indeterminate state when some rows are selected.

<FileSource src="/framed/DataTable/DataTableBatchSelection" />

## Batch selection with initial selected rows
@@ -1051,14 +1059,18 @@ By default, `ToolbarBatchActions` is activated if one or more rows is selected.

Use the `active` prop to control the toolbar. Note that it will still activate if one or more rows are selected.

You can also prevent the default "Cancel" behavior in the dispatched `on:cancel` event.
You can prevent the default "Cancel" behavior in the dispatched `on:cancel` event.

<FileSource src="/framed/DataTable/DataTableBatchSelectionToolbarControlled" />

## Selectable rows (radio)

Set `radio` to `true` for only one row to be selected at a time.

Bind to `selectedRowIds` to get the ids of the selected rows. Because it's radio selection, `selectedRowIds` will only contain one id.

To customize the `input` name for the radio button, use the `inputName` prop.

<FileSource src="/framed/DataTable/RadioSelectableDataTable" />

## Non-selectable rows
11 changes: 10 additions & 1 deletion src/DataTable/DataTable.svelte
View file
Original file line number Diff line number Diff line change
@@ -71,6 +71,14 @@
/** Specify the description of the data table */
export let description = "";

/**
* Specify a name attribute for the input elements
* in a selectable data table (radio or checkbox).
* When the table is inside a form, this name will
* be included in the form data on submit.
*/
export let inputName = "ccs-" + Math.random().toString(36);

/** Set to `true` to use zebra styles */
export let zebra = false;

@@ -515,12 +523,12 @@
>
{#if !nonSelectableRowIds.includes(row.id)}
{@const inputId = `${id}-${row.id}`}
{@const inputName = `${id}-name`}
{#if radio}
<RadioButton
id={inputId}
name={inputName}
checked={selectedRowIds.includes(row.id)}
value={row.id}
on:change={() => {
selectedRowIds = [row.id];
dispatch("click:row--select", { row, selected: true });
@@ -531,6 +539,7 @@
id={inputId}
name={inputName}
checked={selectedRowIds.includes(row.id)}
value={row.id}
on:change={() => {
if (selectedRowIds.includes(row.id)) {
selectedRowIds = selectedRowIds.filter(
20 changes: 16 additions & 4 deletions tests/DataTable/DuplicateDataTables.test.svelte
View file
Original file line number Diff line number Diff line change
@@ -12,8 +12,20 @@
];
</script>

<DataTable radio {headers} {rows} />
<DataTable radio {headers} {rows} />
<DataTable inputName="radio-select" radio {headers} {rows} />
<DataTable inputName="radio-select" radio {headers} {rows} />

<DataTable batchSelection selectable {headers} {rows} />
<DataTable batchSelection selectable {headers} {rows} />
<DataTable
inputName="checkbox-select"
batchSelection
selectable
{headers}
{rows}
/>
<DataTable
inputName="checkbox-select"
batchSelection
selectable
{headers}
{rows}
/>
9 changes: 9 additions & 0 deletions types/DataTable/DataTable.svelte.d.ts
View file
Original file line number Diff line number Diff line change
@@ -77,6 +77,15 @@ type $Props<Row> = {
*/
description?: string;

/**
* Specify a name attribute for the input elements
* in a selectable data table (radio or checkbox).
* When the table is inside a form, this name will
* be included in the form data on submit.
* @default "ccs-" + Math.random().toString(36)
*/
inputName?: string;

/**
* Set to `true` to use zebra styles
* @default false