@trackunit/react-table-base-components 0.0.47 → 0.0.48

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.cjs.js CHANGED
@@ -163,7 +163,11 @@ const cvaResizeHandel = cssClassVarianceUtilities.cvaMerge(["absolute", "cursor-
163
163
  });
164
164
 
165
165
  /**
166
- * Component for a sorting indicator element.
166
+ * The SortIndicator is used in the table header to indicate the current sort order of the column.
167
+ * This is a visual only component and does not handle the sorting logic.
168
+ *
169
+ * In most cases, we recommend using the Table Component which already handles sorting indication.
170
+ * However, if you need to construct a custom table, the Table Base Components can be utilized.
167
171
  *
168
172
  * @param {object} props - Props for the sorting indicator.
169
173
  * @param {boolean} [props.sortingState=false] - Indicates the sorting state (ascending/descending).
package/index.esm.js CHANGED
@@ -159,7 +159,11 @@ const cvaResizeHandel = cvaMerge(["absolute", "cursor-col-resize", "right-0", "t
159
159
  });
160
160
 
161
161
  /**
162
- * Component for a sorting indicator element.
162
+ * The SortIndicator is used in the table header to indicate the current sort order of the column.
163
+ * This is a visual only component and does not handle the sorting logic.
164
+ *
165
+ * In most cases, we recommend using the Table Component which already handles sorting indication.
166
+ * However, if you need to construct a custom table, the Table Base Components can be utilized.
163
167
  *
164
168
  * @param {object} props - Props for the sorting indicator.
165
169
  * @param {boolean} [props.sortingState=false] - Indicates the sorting state (ascending/descending).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trackunit/react-table-base-components",
3
- "version": "0.0.47",
3
+ "version": "0.0.48",
4
4
  "repository": "https://github.com/Trackunit/manager",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "engines": {
@@ -10,8 +10,8 @@
10
10
  "@trackunit/css-class-variance-utilities": "0.0.14",
11
11
  "@trackunit/date-and-time-utils": "0.0.4",
12
12
  "@trackunit/iris-app-api": "0.0.125",
13
- "@trackunit/react-components": "0.1.175",
14
- "@trackunit/react-form-components": "0.0.171",
13
+ "@trackunit/react-components": "0.1.176",
14
+ "@trackunit/react-form-components": "0.0.172",
15
15
  "@trackunit/ui-design-tokens": "0.0.78",
16
16
  "react": "18.2.0"
17
17
  },
@@ -3,4 +3,5 @@ import { TableRoot } from "./components/TableRoot";
3
3
  type Story = StoryObj<typeof TableRoot>;
4
4
  declare const meta: Meta<typeof TableRoot>;
5
5
  export default meta;
6
+ export declare const packageName: () => JSX.Element;
6
7
  export declare const Default: Story;
@@ -4,5 +4,6 @@ import "./CheckboxCell.variants";
4
4
  type Story = StoryObj<typeof CheckboxCell>;
5
5
  declare const meta: Meta<typeof CheckboxCell>;
6
6
  export default meta;
7
+ export declare const packageName: () => JSX.Element;
7
8
  export declare const Default: Story;
8
9
  export declare const Variants: () => JSX.Element;
@@ -4,5 +4,6 @@ import "./DateTimeCell.variants";
4
4
  type Story = StoryObj<typeof DateTimeCell>;
5
5
  declare const meta: Meta<typeof DateTimeCell>;
6
6
  export default meta;
7
+ export declare const packageName: () => JSX.Element;
7
8
  export declare const Default: Story;
8
9
  export declare const Variants: () => JSX.Element;
@@ -2,4 +2,5 @@ import { Meta, StoryObj } from "@storybook/react";
2
2
  type Story = StoryObj<typeof Image>;
3
3
  declare const meta: Meta<typeof Image>;
4
4
  export default meta;
5
+ export declare const packageName: () => JSX.Element;
5
6
  export declare const Default: Story;
@@ -3,4 +3,5 @@ import { IndicatorCell } from "./IndicatorCell";
3
3
  type Story = StoryObj<typeof IndicatorCell>;
4
4
  declare const meta: Meta<typeof IndicatorCell>;
5
5
  export default meta;
6
+ export declare const packageName: () => JSX.Element;
6
7
  export declare const Default: Story;
@@ -3,5 +3,6 @@ import { LinkCell } from "./LinkCell";
3
3
  type Story = StoryObj<typeof LinkCell>;
4
4
  declare const meta: Meta<typeof LinkCell>;
5
5
  export default meta;
6
+ export declare const packageName: () => JSX.Element;
6
7
  export declare const Default: Story;
7
8
  export declare const Variants: () => JSX.Element;
@@ -4,4 +4,5 @@ import "./NumberCell.variants";
4
4
  type Story = StoryObj<typeof NumberCell>;
5
5
  declare const meta: Meta<typeof NumberCell>;
6
6
  export default meta;
7
+ export declare const packageName: () => JSX.Element;
7
8
  export declare const Default: Story;
@@ -15,7 +15,11 @@ export interface SortIndicatorProps extends CommonProps, React.HTMLAttributes<HT
15
15
  sortingState?: false | "asc" | "desc";
16
16
  }
17
17
  /**
18
- * Component for a sorting indicator element.
18
+ * The SortIndicator is used in the table header to indicate the current sort order of the column.
19
+ * This is a visual only component and does not handle the sorting logic.
20
+ *
21
+ * In most cases, we recommend using the Table Component which already handles sorting indication.
22
+ * However, if you need to construct a custom table, the Table Base Components can be utilized.
19
23
  *
20
24
  * @param {object} props - Props for the sorting indicator.
21
25
  * @param {boolean} [props.sortingState=false] - Indicates the sorting state (ascending/descending).
@@ -3,4 +3,5 @@ import { SortIndicator } from "./SortIndicator";
3
3
  type Story = StoryObj<typeof SortIndicator>;
4
4
  declare const meta: Meta<typeof SortIndicator>;
5
5
  export default meta;
6
+ export declare const packageName: () => JSX.Element;
6
7
  export declare const Default: Story;
@@ -3,4 +3,5 @@ import { TagsCell } from "./TagsCell";
3
3
  type Story = StoryObj<typeof TagsCell>;
4
4
  declare const meta: Meta<typeof TagsCell>;
5
5
  export default meta;
6
+ export declare const packageName: () => JSX.Element;
6
7
  export declare const Default: Story;
@@ -4,5 +4,6 @@ import "./TextCell.variants";
4
4
  type Story = StoryObj<typeof TextCell>;
5
5
  declare const meta: Meta<typeof TextCell>;
6
6
  export default meta;
7
+ export declare const packageName: () => JSX.Element;
7
8
  export declare const Default: Story;
8
9
  export declare const Example: Story;