Loosen empty table row header key

carbon-design-system · May 4, 2024 · 6ca28ef · 6ca28ef
1 parent 788f517
commit 6ca28ef
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md
@@ -932,7 +932,7 @@ export type DataTableKey<Row = DataTableRow> =
 export type DataTableValue = any;
 
 export interface DataTableEmptyHeader<Row = DataTableRow> {
-  key: DataTableKey<Row>;
+  key: DataTableKey<Row> | string;
   empty: boolean;
   display?: (item: Value, row: Row) => DataTableValue;
   sort?: false | ((a: DataTableValue, b: DataTableValue) => number);

diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json
@@ -2722,9 +2722,9 @@
           "ts": "type DataTableValue = any"
         },
         {
-          "type": "{\n   key: DataTableKey<Row>;\n   empty: boolean;\n   display?: (item: Value, row: Row) => DataTableValue;\n   sort?: false | ((a: DataTableValue, b: DataTableValue) => number);\n   columnMenu?: boolean;\n   width?: string;\n   minWidth?: string;\n}",
+          "type": "{\n   key: DataTableKey<Row> | string;\n   empty: boolean;\n   display?: (item: Value, row: Row) => DataTableValue;\n   sort?: false | ((a: DataTableValue, b: DataTableValue) => number);\n   columnMenu?: boolean;\n   width?: string;\n   minWidth?: string;\n}",
           "name": "DataTableEmptyHeader<Row=DataTableRow>",
-          "ts": "interface DataTableEmptyHeader<Row=DataTableRow> {\n   key: DataTableKey<Row>;\n   empty: boolean;\n   display?: (item: Value, row: Row) => DataTableValue;\n   sort?: false | ((a: DataTableValue, b: DataTableValue) => number);\n   columnMenu?: boolean;\n   width?: string;\n   minWidth?: string;\n}"
+          "ts": "interface DataTableEmptyHeader<Row=DataTableRow> {\n   key: DataTableKey<Row> | string;\n   empty: boolean;\n   display?: (item: Value, row: Row) => DataTableValue;\n   sort?: false | ((a: DataTableValue, b: DataTableValue) => number);\n   columnMenu?: boolean;\n   width?: string;\n   minWidth?: string;\n}"
         },
         {
           "type": "{\n   key: DataTableKey<Row>;\n   value: DataTableValue;\n   display?: (item: Value, row: Row) => DataTableValue;\n   sort?: false | ((a: DataTableValue, b: DataTableValue) => number);\n   columnMenu?: boolean;\n   width?: string;\n   minWidth?: string;\n}",

diff --git a/src/DataTable/DataTable.svelte b/src/DataTable/DataTable.svelte
@@ -5,7 +5,7 @@
    * @typedef {import('./DataTableTypes.d.ts').PropertyPath<Row>} DataTableKey<Row=DataTableRow>
    * @typedef {any} DataTableValue
    * @typedef {{
-   *    key: DataTableKey<Row>;
+   *    key: DataTableKey<Row> | string;
    *    empty: boolean;
    *    display?: (item: Value, row: Row) => DataTableValue;
    *    sort?: false | ((a: DataTableValue, b: DataTableValue) => number);

diff --git a/types/DataTable/DataTable.svelte.d.ts b/types/DataTable/DataTable.svelte.d.ts
@@ -7,7 +7,7 @@ export type DataTableKey<Row = DataTableRow> =
 export type DataTableValue = any;
 
 export interface DataTableEmptyHeader<Row = DataTableRow> {
-  key: DataTableKey<Row>;
+  key: DataTableKey<Row> | string;
   empty: boolean;
   display?: (item: Value, row: Row) => DataTableValue;
   sort?: false | ((a: DataTableValue, b: DataTableValue) => number);