From 94472817a8b4821317d6d64aad335aad28106769 Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Sun, 5 Jun 2022 12:27:52 -0700 Subject: [PATCH] Run "yarn build:docs" --- COMPONENT_INDEX.md | 14 +++++++------ docs/src/COMPONENT_API.json | 28 +++++++++++++++++++++++-- types/DataTable/TableHeader.svelte.d.ts | 16 ++++++++++++-- 3 files changed, 48 insertions(+), 10 deletions(-) diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index 3600d371..75781dcc 100644 --- a/COMPONENT_INDEX.md +++ b/COMPONENT_INDEX.md @@ -3864,12 +3864,14 @@ None. ### Props -| Prop name | Required | Kind | Reactive | Type | Default value | Description | -| :-------------- | :------- | :--------------- | :------- | ------------------------- | ------------------------------------------------ | ------------------------------------------------------ | -| disableSorting | No | let | No | boolean | false | Set to `true` to disable sorting on this specific cell | -| scope | No | let | No | string | "col" | Specify the `scope` attribute | -| translateWithId | No | let | No | () => string | () => "" | Override the default id translations | -| id | No | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element | +| Prop name | Required | Kind | Reactive | Type | Default value | Description | +| :-------------- | :------- | :--------------- | :------- | ---------------------------------------------------------- | ------------------------------------------------ | -------------------------------------- | +| sortable | No | let | No | boolean | false | Set to `true` for the sortable variant | +| sortDirection | No | let | No | "none" | "ascending" | "descending" | "none" | Specify the sort direction | +| active | No | let | No | boolean | false | Set to `true` if the column sorting | +| scope | No | let | No | string | "col" | Specify the `scope` attribute | +| translateWithId | No | let | No | () => string | () => "" | Override the default id translations | +| id | No | let | No | string | "ccs-" + Math.random().toString(36) | Set an id for the top-level element | ### Slots diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index 562853ce..0e659208 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -11843,9 +11843,33 @@ "filePath": "src/DataTable/TableHeader.svelte", "props": [ { - "name": "disableSorting", + "name": "sortable", "kind": "let", - "description": "Set to `true` to disable sorting on this specific cell", + "description": "Set to `true` for the sortable variant", + "type": "boolean", + "value": "false", + "isFunction": false, + "isFunctionDeclaration": false, + "isRequired": false, + "constant": false, + "reactive": false + }, + { + "name": "sortDirection", + "kind": "let", + "description": "Specify the sort direction", + "type": "\"none\" | \"ascending\" | \"descending\"", + "value": "\"none\"", + "isFunction": false, + "isFunctionDeclaration": false, + "isRequired": false, + "constant": false, + "reactive": false + }, + { + "name": "active", + "kind": "let", + "description": "Set to `true` if the column sorting", "type": "boolean", "value": "false", "isFunction": false, diff --git a/types/DataTable/TableHeader.svelte.d.ts b/types/DataTable/TableHeader.svelte.d.ts index 170a1f03..6252c1b6 100644 --- a/types/DataTable/TableHeader.svelte.d.ts +++ b/types/DataTable/TableHeader.svelte.d.ts @@ -4,10 +4,22 @@ import type { SvelteComponentTyped } from "svelte"; export interface TableHeaderProps extends svelte.JSX.HTMLAttributes { /** - * Set to `true` to disable sorting on this specific cell + * Set to `true` for the sortable variant * @default false */ - disableSorting?: boolean; + sortable?: boolean; + + /** + * Specify the sort direction + * @default "none" + */ + sortDirection?: "none" | "ascending" | "descending"; + + /** + * Set to `true` if the column sorting + * @default false + */ + active?: boolean; /** * Specify the `scope` attribute