@longline/aqua-ui 1.0.302 → 1.0.303

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.
Files changed (101) hide show
  1. package/controls/Chip/Chip.d.ts +41 -13
  2. package/controls/Chip/Chip.js +76 -22
  3. package/controls/Chip/index.d.ts +2 -1
  4. package/controls/Chip/index.js +1 -1
  5. package/controls/CircularProgress/CircularProgress.d.ts +38 -6
  6. package/controls/CircularProgress/CircularProgress.js +67 -17
  7. package/controls/CircularProgress/index.d.ts +1 -0
  8. package/controls/Dropzone/Dropzone.d.ts +42 -10
  9. package/controls/Dropzone/Dropzone.js +76 -16
  10. package/controls/Dropzone/index.d.ts +1 -0
  11. package/controls/Fab/Fab.d.ts +40 -15
  12. package/controls/Fab/Fab.js +76 -28
  13. package/controls/Fab/index.d.ts +2 -1
  14. package/controls/Fab/index.js +1 -1
  15. package/controls/Ghost/Ghost.d.ts +36 -0
  16. package/controls/Ghost/Ghost.js +72 -1
  17. package/controls/Ghost/index.d.ts +2 -1
  18. package/controls/Ghost/index.js +1 -1
  19. package/controls/Gradient/Gradient.d.ts +51 -5
  20. package/controls/Gradient/Gradient.js +98 -8
  21. package/controls/Gradient/index.d.ts +1 -0
  22. package/controls/Histogram/Histogram.d.ts +47 -6
  23. package/controls/Histogram/Histogram.js +84 -21
  24. package/controls/Histogram/HistogramAppearance.d.ts +2 -1
  25. package/controls/Histogram/IHistogramBin.d.ts +1 -1
  26. package/controls/Histogram/index.d.ts +5 -3
  27. package/controls/Histogram/index.js +2 -3
  28. package/controls/Icon/Icon.d.ts +50 -22
  29. package/controls/Icon/Icon.js +47 -18
  30. package/controls/Icon/index.d.ts +2 -1
  31. package/controls/Icon/index.js +1 -1
  32. package/controls/Key/Key.d.ts +39 -5
  33. package/controls/Key/Key.js +74 -8
  34. package/controls/Key/index.d.ts +2 -1
  35. package/controls/Key/index.js +1 -1
  36. package/controls/LinearChart/LinearChart.d.ts +36 -5
  37. package/controls/LinearChart/LinearChart.js +64 -6
  38. package/controls/LinearChart/index.d.ts +2 -1
  39. package/controls/LinearChart/index.js +1 -1
  40. package/controls/ListView/Column.d.ts +42 -5
  41. package/controls/ListView/Column.js +39 -3
  42. package/controls/ListView/IListViewProps.d.ts +2 -2
  43. package/controls/ListView/ListView.d.ts +58 -2
  44. package/controls/ListView/ListView.js +57 -2
  45. package/controls/ListView/index.d.ts +1 -0
  46. package/controls/Mouse/Mouse.d.ts +32 -7
  47. package/controls/Mouse/Mouse.js +60 -12
  48. package/controls/Mouse/index.d.ts +2 -1
  49. package/controls/Mouse/index.js +1 -1
  50. package/controls/PrimaryButton/PrimaryButton.d.ts +37 -9
  51. package/controls/PrimaryButton/PrimaryButton.js +70 -16
  52. package/controls/PrimaryButton/index.d.ts +2 -1
  53. package/controls/PrimaryButton/index.js +1 -1
  54. package/controls/Progress/Progress.d.ts +32 -10
  55. package/controls/Progress/Progress.js +60 -18
  56. package/controls/Progress/index.d.ts +2 -1
  57. package/controls/Progress/index.js +1 -1
  58. package/controls/SecondaryButton/SecondaryButton.d.ts +34 -8
  59. package/controls/SecondaryButton/SecondaryButton.js +64 -14
  60. package/controls/SecondaryButton/index.d.ts +1 -0
  61. package/controls/SpeechRecognizer/SpeechRecognizer.d.ts +31 -1
  62. package/controls/SpeechRecognizer/SpeechRecognizer.js +29 -1
  63. package/controls/SpeechRecognizer/index.d.ts +1 -1
  64. package/controls/SpeechRecognizer/index.js +1 -1
  65. package/controls/TabBar/Tab.d.ts +31 -1
  66. package/controls/TabBar/Tab.js +58 -1
  67. package/controls/TabBar/TabBar.d.ts +43 -5
  68. package/controls/TabBar/TabBar.js +82 -8
  69. package/controls/TabBar/index.d.ts +3 -1
  70. package/controls/TabBar/index.js +1 -1
  71. package/controls/TertiaryButton/TertiaryButton.d.ts +32 -7
  72. package/controls/TertiaryButton/TertiaryButton.js +60 -12
  73. package/controls/TertiaryButton/index.d.ts +2 -1
  74. package/controls/TertiaryButton/index.js +1 -1
  75. package/controls/ToggleButton/ToggleButton.d.ts +36 -3
  76. package/controls/ToggleButton/ToggleButton.js +69 -5
  77. package/controls/ToggleButton/index.d.ts +2 -1
  78. package/controls/ToggleButton/index.js +1 -1
  79. package/controls/View/View.d.ts +22 -8
  80. package/controls/View/View.js +40 -14
  81. package/controls/View/index.d.ts +2 -1
  82. package/controls/View/index.js +1 -1
  83. package/inputs/Dropdown/Dropdown.d.ts +2 -1
  84. package/inputs/Dropdown/index.d.ts +2 -1
  85. package/map/controls/CompassButton/CompassButton.d.ts +1 -1
  86. package/map/controls/FullscreenButton/FullscreenButton.d.ts +1 -1
  87. package/map/controls/ZoomInButton/ZoomInButton.d.ts +3 -2
  88. package/map/controls/ZoomOutButton/ZoomOutButton.d.ts +3 -2
  89. package/map/controls/base/MapButton/MapButton.d.ts +2 -1
  90. package/map/controls/base/MapButton/index.d.ts +2 -1
  91. package/package.json +1 -1
  92. package/services/Toast/IToastMessage.d.ts +3 -3
  93. package/services/Toast/IToastProps.d.ts +1 -1
  94. package/services/Toast/Toast.d.ts +43 -5
  95. package/services/Toast/Toast.js +35 -4
  96. package/services/Toast/ToastContainer.d.ts +37 -4
  97. package/services/Toast/ToastContainer.js +75 -9
  98. package/services/Toast/ToastContext.d.ts +5 -4
  99. package/services/Toast/ToastProvider.js +16 -11
  100. package/services/Toast/useToast.d.ts +37 -1
  101. package/services/Toast/useToast.js +42 -2
@@ -1 +1 @@
1
- export * from './LinearChart';
1
+ export { LinearChart } from './LinearChart';
@@ -36,7 +36,7 @@ interface IColumnProps {
36
36
  reverse?: boolean;
37
37
  /**
38
38
  * Cell content alignment. Defaults to `left`.
39
- * @default let
39
+ * @default left
40
40
  */
41
41
  align?: 'left' | 'right';
42
42
  /**
@@ -65,12 +65,49 @@ interface IColumnProps {
65
65
  paddingRight?: number;
66
66
  }
67
67
  /**
68
- * TableColumn species a column name, and how to render content for that
69
- * column.
70
- * TableColumn itself doesn't render anything.
68
+ * Column definition for `ListView`. Specifies header, sorting, and cell rendering.
69
+ *
70
+ * This component doesn't render anything itself—it defines column configuration
71
+ * that `ListView` reads from its children.
72
+ *
73
+ * ## Usage
74
+ *
75
+ * ```tsx
76
+ * <ListView data={users}>
77
+ * {/* Basic column *}
78
+ * <ListView.Column name="Name" sort="name">
79
+ * {(item) => item.name}
80
+ * </ListView.Column>
81
+ *
82
+ * {/* Fixed-width, right-aligned *}
83
+ * <ListView.Column name="Amount" width="100px" align="right" sort="amount">
84
+ * {(item) => `$${item.amount.toFixed(2)}`}
85
+ * </ListView.Column>
86
+ *
87
+ * {/* Custom sort value *}
88
+ * <ListView.Column name="Date" sort="date" sortValue={(item) => new Date(item.date)}>
89
+ * {(item) => formatDate(item.date)}
90
+ * </ListView.Column>
91
+ * </ListView>
92
+ * ```
93
+ *
94
+ * ## Props
95
+ *
96
+ * | Prop | Description |
97
+ * |------|-------------|
98
+ * | `name` | Column header text |
99
+ * | `label` | Optional custom header (overrides `name`) |
100
+ * | `width` | Flex weight (number) or fixed width (string) |
101
+ * | `sort` | Sort key—omit to disable sorting |
102
+ * | `sortValue` | Function to extract sortable value from item |
103
+ * | `defaultSort` | Set this column as the initial sort |
104
+ * | `reverse` | Default to descending sort |
105
+ * | `align` | Cell alignment: "left" or "right" |
106
+ * | `fixed` | Prevent column from being hidden |
71
107
  */
72
108
  declare const Column: {
73
109
  (_: IColumnProps): null;
74
110
  displayName: string;
75
111
  };
76
- export { Column, IColumnProps };
112
+ export { Column };
113
+ export type { IColumnProps };
@@ -1,7 +1,43 @@
1
1
  /**
2
- * TableColumn species a column name, and how to render content for that
3
- * column.
4
- * TableColumn itself doesn't render anything.
2
+ * Column definition for `ListView`. Specifies header, sorting, and cell rendering.
3
+ *
4
+ * This component doesn't render anything itself—it defines column configuration
5
+ * that `ListView` reads from its children.
6
+ *
7
+ * ## Usage
8
+ *
9
+ * ```tsx
10
+ * <ListView data={users}>
11
+ * {/* Basic column *}
12
+ * <ListView.Column name="Name" sort="name">
13
+ * {(item) => item.name}
14
+ * </ListView.Column>
15
+ *
16
+ * {/* Fixed-width, right-aligned *}
17
+ * <ListView.Column name="Amount" width="100px" align="right" sort="amount">
18
+ * {(item) => `$${item.amount.toFixed(2)}`}
19
+ * </ListView.Column>
20
+ *
21
+ * {/* Custom sort value *}
22
+ * <ListView.Column name="Date" sort="date" sortValue={(item) => new Date(item.date)}>
23
+ * {(item) => formatDate(item.date)}
24
+ * </ListView.Column>
25
+ * </ListView>
26
+ * ```
27
+ *
28
+ * ## Props
29
+ *
30
+ * | Prop | Description |
31
+ * |------|-------------|
32
+ * | `name` | Column header text |
33
+ * | `label` | Optional custom header (overrides `name`) |
34
+ * | `width` | Flex weight (number) or fixed width (string) |
35
+ * | `sort` | Sort key—omit to disable sorting |
36
+ * | `sortValue` | Function to extract sortable value from item |
37
+ * | `defaultSort` | Set this column as the initial sort |
38
+ * | `reverse` | Default to descending sort |
39
+ * | `align` | Cell alignment: "left" or "right" |
40
+ * | `fixed` | Prevent column from being hidden |
5
41
  */
6
42
  var Column = function (_) { return null; };
7
43
  Column.displayName = "ListView.Column";
@@ -109,7 +109,7 @@ interface IListViewProps {
109
109
  expansion?: React.ReactNode;
110
110
  /**
111
111
  * If set, when an item is activated it scrolls into view.
112
- * @fefault false
112
+ * @default false
113
113
  */
114
114
  focusActive?: boolean;
115
115
  /**
@@ -145,4 +145,4 @@ interface IListViewProps {
145
145
  */
146
146
  onCheck?: (data: any[], item: any | boolean) => void;
147
147
  }
148
- export { IListViewProps };
148
+ export type { IListViewProps };
@@ -11,7 +11,62 @@ interface IProps extends IListViewProps {
11
11
  children?: React.ReactElement<IColumnProps> | React.ReactElement<IColumnProps>[];
12
12
  }
13
13
  /**
14
- * Customizable `ListView` component.
14
+ * A data table with sorting, column management, virtualization, and row selection.
15
+ *
16
+ * Displays tabular data with customizable columns defined as children. Supports
17
+ * sorting, hover effects, striped rows, row expansion, and optional virtualization
18
+ * for large datasets.
19
+ *
20
+ * ## Usage
21
+ *
22
+ * ```tsx
23
+ * // Basic table
24
+ * <ListView data={users}>
25
+ * <ListView.Column name="Name" sort="name">
26
+ * {(item) => item.name}
27
+ * </ListView.Column>
28
+ * <ListView.Column name="Email" sort="email">
29
+ * {(item) => item.email}
30
+ * </ListView.Column>
31
+ * </ListView>
32
+ *
33
+ * // With selection and hover
34
+ * <ListView data={items} hover active={selectedItem} onClick={setSelectedItem}>
35
+ * <ListView.Column name="Title" sort="title" defaultSort>
36
+ * {(item) => item.title}
37
+ * </ListView.Column>
38
+ * </ListView>
39
+ *
40
+ * // Virtualized for large datasets
41
+ * <ListView data={bigData} virtual overscan={20}>
42
+ * <ListView.Column name="ID">{(item) => item.id}</ListView.Column>
43
+ * </ListView>
44
+ * ```
45
+ *
46
+ * ## Features
47
+ *
48
+ * | Prop | Description |
49
+ * |------|-------------|
50
+ * | `hover` | Highlight rows on mouse hover |
51
+ * | `striped` | Alternate row background colors |
52
+ * | `grid` | Show cell borders |
53
+ * | `dark` | Dark theme variant |
54
+ * | `virtual` | Virtualize rendering for large lists |
55
+ * | `columnsEditable` | Allow users to show/hide columns |
56
+ * | `expanded` | Show expansion content below active row |
57
+ *
58
+ * ## Column Definition
59
+ *
60
+ * Columns are defined using `ListView.Column` children:
61
+ *
62
+ * | Prop | Description |
63
+ * |------|-------------|
64
+ * | `name` | Column header text |
65
+ * | `sort` | Key for sorting (omit to disable sorting) |
66
+ * | `defaultSort` | Make this the initial sort column |
67
+ * | `width` | Number (flex weight) or string (e.g., "100px") |
68
+ * | `align` | Cell alignment: "left" (default) or "right" |
69
+ * | `children` | Render function: `(item) => ReactNode` |
15
70
  */
16
71
  declare const ListView: {
17
72
  ({ data, dark, noheader, hover, striped, grid, total, singular, plural, shadow, ghost, rowHeight, columnsEditable, expanded, focusActive, virtual, overscan, ...props }: IProps): React.JSX.Element;
@@ -21,4 +76,5 @@ declare const ListView: {
21
76
  displayName: string;
22
77
  };
23
78
  };
24
- export { ListView, IListViewProps };
79
+ export { ListView };
80
+ export type { IListViewProps };
@@ -75,7 +75,7 @@ var ListViewBase = function (props) {
75
75
  if (!Array.isArray(props.data))
76
76
  return;
77
77
  // Find column corresponding to sort key. Abort if column now found.
78
- var sortColumn = columns.find(function (c) { return c.sort == sort; });
78
+ var sortColumn = columns.find(function (c) { return c.sort === sort; });
79
79
  if (!sortColumn)
80
80
  return;
81
81
  setData(sortItems(props.data, sort, reverse, sortColumn.sortValue));
@@ -123,7 +123,62 @@ var ListViewBase = function (props) {
123
123
  return (React.createElement(Table, __assign({}, otherProps, { data: data, columns: columns, sort: sort, reverse: reverse, onSortClick: handleSort, columnsMode: columnsMode, onOpenColumns: handleColumns, onCheck: props.onCheck ? handleCheck : null, onChangeColumns: handleChangeColumns, onCloseColumns: function () { return setColumnsMode(false); }, onResetColumns: handleResetColumns })));
124
124
  };
125
125
  /**
126
- * Customizable `ListView` component.
126
+ * A data table with sorting, column management, virtualization, and row selection.
127
+ *
128
+ * Displays tabular data with customizable columns defined as children. Supports
129
+ * sorting, hover effects, striped rows, row expansion, and optional virtualization
130
+ * for large datasets.
131
+ *
132
+ * ## Usage
133
+ *
134
+ * ```tsx
135
+ * // Basic table
136
+ * <ListView data={users}>
137
+ * <ListView.Column name="Name" sort="name">
138
+ * {(item) => item.name}
139
+ * </ListView.Column>
140
+ * <ListView.Column name="Email" sort="email">
141
+ * {(item) => item.email}
142
+ * </ListView.Column>
143
+ * </ListView>
144
+ *
145
+ * // With selection and hover
146
+ * <ListView data={items} hover active={selectedItem} onClick={setSelectedItem}>
147
+ * <ListView.Column name="Title" sort="title" defaultSort>
148
+ * {(item) => item.title}
149
+ * </ListView.Column>
150
+ * </ListView>
151
+ *
152
+ * // Virtualized for large datasets
153
+ * <ListView data={bigData} virtual overscan={20}>
154
+ * <ListView.Column name="ID">{(item) => item.id}</ListView.Column>
155
+ * </ListView>
156
+ * ```
157
+ *
158
+ * ## Features
159
+ *
160
+ * | Prop | Description |
161
+ * |------|-------------|
162
+ * | `hover` | Highlight rows on mouse hover |
163
+ * | `striped` | Alternate row background colors |
164
+ * | `grid` | Show cell borders |
165
+ * | `dark` | Dark theme variant |
166
+ * | `virtual` | Virtualize rendering for large lists |
167
+ * | `columnsEditable` | Allow users to show/hide columns |
168
+ * | `expanded` | Show expansion content below active row |
169
+ *
170
+ * ## Column Definition
171
+ *
172
+ * Columns are defined using `ListView.Column` children:
173
+ *
174
+ * | Prop | Description |
175
+ * |------|-------------|
176
+ * | `name` | Column header text |
177
+ * | `sort` | Key for sorting (omit to disable sorting) |
178
+ * | `defaultSort` | Make this the initial sort column |
179
+ * | `width` | Number (flex weight) or string (e.g., "100px") |
180
+ * | `align` | Cell alignment: "left" (default) or "right" |
181
+ * | `children` | Render function: `(item) => ReactNode` |
127
182
  */
128
183
  var ListView = function (_a) {
129
184
  var _b = _a.data, data = _b === void 0 ? null : _b, _c = _a.dark, dark = _c === void 0 ? false : _c, _d = _a.noheader, noheader = _d === void 0 ? false : _d, _e = _a.hover, hover = _e === void 0 ? false : _e, _f = _a.striped, striped = _f === void 0 ? false : _f, _g = _a.grid, grid = _g === void 0 ? false : _g, _h = _a.total, total = _h === void 0 ? false : _h, _j = _a.singular, singular = _j === void 0 ? "record" : _j, _k = _a.plural, plural = _k === void 0 ? "records" : _k, _l = _a.shadow, shadow = _l === void 0 ? false : _l, _m = _a.ghost, ghost = _m === void 0 ? false : _m, _o = _a.rowHeight, rowHeight = _o === void 0 ? 48 : _o, _p = _a.columnsEditable, columnsEditable = _p === void 0 ? false : _p, _q = _a.expanded, expanded = _q === void 0 ? false : _q, _r = _a.focusActive, focusActive = _r === void 0 ? false : _r, _s = _a.virtual, virtual = _s === void 0 ? false : _s, _t = _a.overscan, overscan = _t === void 0 ? 10 : _t, props = __rest(_a, ["data", "dark", "noheader", "hover", "striped", "grid", "total", "singular", "plural", "shadow", "ghost", "rowHeight", "columnsEditable", "expanded", "focusActive", "virtual", "overscan"]);
@@ -1 +1,2 @@
1
1
  export { ListView } from './ListView';
2
+ export type { IListViewProps } from './IListViewProps';
@@ -31,16 +31,41 @@ interface IMouseProps {
31
31
  size?: number;
32
32
  }
33
33
  /**
34
- * `Mouse` Renders an SVG mouse shape with optional highlighting of the
35
- * left, right, and wheel buttons.
34
+ * An SVG mouse icon with interactive button highlighting.
36
35
  *
37
- * - `left`, `right`, `wheel`: Whether each button appears "pressed"
38
- * - `color`: Main mouse fill color (defaults to theme neutral color)
39
- * - `accent`: Fill color of the wheel (defaults to primary theme color)
40
- * - `size`: Scales the mouse height in pixels
36
+ * Renders a mouse shape that can visually indicate which buttons are pressed.
37
+ * Useful for tutorials, documentation, or UI hints showing mouse interactions.
38
+ *
39
+ * ## Usage
40
+ *
41
+ * ```tsx
42
+ * // Default mouse
43
+ * <Mouse />
44
+ *
45
+ * // Left click indicator
46
+ * <Mouse left />
47
+ *
48
+ * // Right click with scroll
49
+ * <Mouse right wheel />
50
+ *
51
+ * // Custom colors and size
52
+ * <Mouse left color="white" accent="orange" size={48} />
53
+ * ```
54
+ *
55
+ * ## Props
56
+ *
57
+ * | Prop | Description |
58
+ * |------|-------------|
59
+ * | `left` | Highlight left button as pressed |
60
+ * | `right` | Highlight right button as pressed |
61
+ * | `wheel` | Highlight scroll wheel |
62
+ * | `color` | Mouse body fill color (default: theme neutral) |
63
+ * | `accent` | Wheel highlight color (default: theme primary) |
64
+ * | `size` | Height in pixels (max 100px) |
41
65
  */
42
66
  declare const Mouse: {
43
67
  ({ left, right, wheel, ...props }: IMouseProps): React.JSX.Element;
44
68
  displayName: string;
45
69
  };
46
- export { Mouse, IMouseProps };
70
+ export { Mouse };
71
+ export type { IMouseProps };
@@ -36,23 +36,71 @@ var MouseBase = function (props) {
36
36
  };
37
37
  var MouseStyled = styled(MouseBase)(templateObject_2 || (templateObject_2 = __makeTemplateObject(["\n ", "\n max-height: 100px;\n fill: ", ";\n .left { fill: ", "; }\n .right { fill: ", "; }\n .wheel { fill: ", "; }\n"], ["\n ", "\n max-height: 100px;\n fill: ", ";\n .left { fill: ", "; }\n .right { fill: ", "; }\n .wheel { fill: ", "; }\n"
38
38
  /**
39
- * `Mouse` Renders an SVG mouse shape with optional highlighting of the
40
- * left, right, and wheel buttons.
39
+ * An SVG mouse icon with interactive button highlighting.
41
40
  *
42
- * - `left`, `right`, `wheel`: Whether each button appears "pressed"
43
- * - `color`: Main mouse fill color (defaults to theme neutral color)
44
- * - `accent`: Fill color of the wheel (defaults to primary theme color)
45
- * - `size`: Scales the mouse height in pixels
41
+ * Renders a mouse shape that can visually indicate which buttons are pressed.
42
+ * Useful for tutorials, documentation, or UI hints showing mouse interactions.
43
+ *
44
+ * ## Usage
45
+ *
46
+ * ```tsx
47
+ * // Default mouse
48
+ * <Mouse />
49
+ *
50
+ * // Left click indicator
51
+ * <Mouse left />
52
+ *
53
+ * // Right click with scroll
54
+ * <Mouse right wheel />
55
+ *
56
+ * // Custom colors and size
57
+ * <Mouse left color="white" accent="orange" size={48} />
58
+ * ```
59
+ *
60
+ * ## Props
61
+ *
62
+ * | Prop | Description |
63
+ * |------|-------------|
64
+ * | `left` | Highlight left button as pressed |
65
+ * | `right` | Highlight right button as pressed |
66
+ * | `wheel` | Highlight scroll wheel |
67
+ * | `color` | Mouse body fill color (default: theme neutral) |
68
+ * | `accent` | Wheel highlight color (default: theme primary) |
69
+ * | `size` | Height in pixels (max 100px) |
46
70
  */
47
71
  ])), function (p) { return p.size && css(templateObject_1 || (templateObject_1 = __makeTemplateObject(["\n height: ", "px;\n "], ["\n height: ", "px;\n "])), p.size); }, function (p) { var _a; return (_a = p.color) !== null && _a !== void 0 ? _a : p.theme.colors.neutral[100]; }, function (p) { var _a; return (_a = p.color) !== null && _a !== void 0 ? _a : p.theme.colors.neutral[100]; }, function (p) { var _a; return (_a = p.color) !== null && _a !== void 0 ? _a : p.theme.colors.neutral[100]; }, function (p) { var _a; return (_a = p.accent) !== null && _a !== void 0 ? _a : p.theme.colors.primary[1]; });
48
72
  /**
49
- * `Mouse` Renders an SVG mouse shape with optional highlighting of the
50
- * left, right, and wheel buttons.
73
+ * An SVG mouse icon with interactive button highlighting.
74
+ *
75
+ * Renders a mouse shape that can visually indicate which buttons are pressed.
76
+ * Useful for tutorials, documentation, or UI hints showing mouse interactions.
77
+ *
78
+ * ## Usage
79
+ *
80
+ * ```tsx
81
+ * // Default mouse
82
+ * <Mouse />
83
+ *
84
+ * // Left click indicator
85
+ * <Mouse left />
86
+ *
87
+ * // Right click with scroll
88
+ * <Mouse right wheel />
89
+ *
90
+ * // Custom colors and size
91
+ * <Mouse left color="white" accent="orange" size={48} />
92
+ * ```
93
+ *
94
+ * ## Props
51
95
  *
52
- * - `left`, `right`, `wheel`: Whether each button appears "pressed"
53
- * - `color`: Main mouse fill color (defaults to theme neutral color)
54
- * - `accent`: Fill color of the wheel (defaults to primary theme color)
55
- * - `size`: Scales the mouse height in pixels
96
+ * | Prop | Description |
97
+ * |------|-------------|
98
+ * | `left` | Highlight left button as pressed |
99
+ * | `right` | Highlight right button as pressed |
100
+ * | `wheel` | Highlight scroll wheel |
101
+ * | `color` | Mouse body fill color (default: theme neutral) |
102
+ * | `accent` | Wheel highlight color (default: theme primary) |
103
+ * | `size` | Height in pixels (max 100px) |
56
104
  */
57
105
  var Mouse = function (_a) {
58
106
  var _b = _a.left, left = _b === void 0 ? false : _b, _c = _a.right, right = _c === void 0 ? false : _c, _d = _a.wheel, wheel = _d === void 0 ? false : _d, props = __rest(_a, ["left", "right", "wheel"]);
@@ -1 +1,2 @@
1
- export * from './Mouse';
1
+ export { Mouse } from './Mouse';
2
+ export type { IMouseProps } from './Mouse';
@@ -1 +1 @@
1
- export * from './Mouse';
1
+ export { Mouse } from './Mouse';
@@ -45,19 +45,47 @@ interface IPrimaryButtonProps {
45
45
  onClick: (e?: React.MouseEvent) => void;
46
46
  }
47
47
  /**
48
- * Primary buttons denote the primary action. They may have icons or not and
49
- * have three colors: `positive`, `negative`, and themed (the default).
50
- * It renders as a `<button>` element.
48
+ * A prominent call-to-action button for primary actions.
51
49
  *
52
- * The `icon` name is passed in as a property. However, the other children of
53
- * the button can be any React component.
50
+ * Renders a styled `<button>` with support for semantic colors, icons, and
51
+ * disabled state. Use for the main action in a form or dialog.
54
52
  *
55
- * The color of the button defaults to a primary theme color, unless overridden
56
- * with `positive`, `negative` or `color`. The button can be in a `disabled`
57
- * state where it cannot be clicked.
53
+ * ## Usage
54
+ *
55
+ * ```tsx
56
+ * // Basic button
57
+ * <PrimaryButton onClick={handleSave}>Save</PrimaryButton>
58
+ *
59
+ * // Positive action (green)
60
+ * <PrimaryButton positive onClick={handleConfirm}>Confirm</PrimaryButton>
61
+ *
62
+ * // Negative action (red)
63
+ * <PrimaryButton negative onClick={handleDelete}>Delete</PrimaryButton>
64
+ *
65
+ * // With icon
66
+ * <PrimaryButton icon={SVG.Icons.Check} onClick={handleSubmit}>Submit</PrimaryButton>
67
+ *
68
+ * // Custom color
69
+ * <PrimaryButton color="purple" onClick={handleAction}>Custom</PrimaryButton>
70
+ *
71
+ * // Disabled state
72
+ * <PrimaryButton disabled onClick={handleSave}>Save</PrimaryButton>
73
+ * ```
74
+ *
75
+ * ## Props
76
+ *
77
+ * | Prop | Description |
78
+ * |------|-------------|
79
+ * | `positive` | Green color for confirmations/success actions |
80
+ * | `negative` | Red color for deletions/destructive actions |
81
+ * | `color` | Custom background color (CSS value) |
82
+ * | `icon` | SVG path or `IIconProps` for leading icon |
83
+ * | `disabled` | Prevents interaction |
84
+ * | `title` | Browser tooltip on hover |
58
85
  */
59
86
  declare const PrimaryButton: {
60
87
  ({ disabled, positive, negative, ...props }: IPrimaryButtonProps): React.JSX.Element;
61
88
  displayName: string;
62
89
  };
63
- export { PrimaryButton, IPrimaryButtonProps };
90
+ export { PrimaryButton };
91
+ export type { IPrimaryButtonProps };
@@ -56,29 +56,83 @@ var PrimaryButtonStyled = styled(PrimaryButtonBase).attrs(function (p) {
56
56
  };
57
57
  })(templateObject_2 || (templateObject_2 = __makeTemplateObject([" \n // Size:\n height: 46px; // was 56\n padding-left: 12px; // was 16\n padding-right: 12px; // was 16\n min-width: 90px;\n \n // Font:\n font: ", ";\n color: ", ";\n\n // Presentation:\n background-color: ", ";\n transition: \n background-color ease-in-out ", "ms, \n box-shadow ease-in-out ", "ms;\n border-radius: ", "px;\n border: none;\n cursor: pointer;\n user-select: none;\n outline: none;\n\n // Content:\n display: flex;\n align-items: center;\n white-space: nowrap;\n flex-wrap: nowrap; \n justify-content: center; \n gap: 6px;\n\n box-shadow: ", ";\n &:hover {\n background-color: ", ";\n box-shadow: ", ";\n }\n &:active {\n background-color: ", ";\n box-shadow: none;\n }\n &:focus {\n outline: solid 2px ", ";\n }\n \n svg {\n width: 24px;\n height: 24px; \n }\n\n ", "\n"], [" \n // Size:\n height: 46px; // was 56\n padding-left: 12px; // was 16\n padding-right: 12px; // was 16\n min-width: 90px;\n \n // Font:\n font: ", ";\n color: ", ";\n\n // Presentation:\n background-color: ", ";\n transition: \n background-color ease-in-out ", "ms, \n box-shadow ease-in-out ", "ms;\n border-radius: ", "px;\n border: none;\n cursor: pointer;\n user-select: none;\n outline: none;\n\n // Content:\n display: flex;\n align-items: center;\n white-space: nowrap;\n flex-wrap: nowrap; \n justify-content: center; \n gap: 6px;\n\n box-shadow: ", ";\n &:hover {\n background-color: ", ";\n box-shadow: ", ";\n }\n &:active {\n background-color: ", ";\n box-shadow: none;\n }\n &:focus {\n outline: solid 2px ", ";\n }\n \n svg {\n width: 24px;\n height: 24px; \n }\n\n ", "\n"
58
58
  /**
59
- * Primary buttons denote the primary action. They may have icons or not and
60
- * have three colors: `positive`, `negative`, and themed (the default).
61
- * It renders as a `<button>` element.
59
+ * A prominent call-to-action button for primary actions.
62
60
  *
63
- * The `icon` name is passed in as a property. However, the other children of
64
- * the button can be any React component.
61
+ * Renders a styled `<button>` with support for semantic colors, icons, and
62
+ * disabled state. Use for the main action in a form or dialog.
65
63
  *
66
- * The color of the button defaults to a primary theme color, unless overridden
67
- * with `positive`, `negative` or `color`. The button can be in a `disabled`
68
- * state where it cannot be clicked.
64
+ * ## Usage
65
+ *
66
+ * ```tsx
67
+ * // Basic button
68
+ * <PrimaryButton onClick={handleSave}>Save</PrimaryButton>
69
+ *
70
+ * // Positive action (green)
71
+ * <PrimaryButton positive onClick={handleConfirm}>Confirm</PrimaryButton>
72
+ *
73
+ * // Negative action (red)
74
+ * <PrimaryButton negative onClick={handleDelete}>Delete</PrimaryButton>
75
+ *
76
+ * // With icon
77
+ * <PrimaryButton icon={SVG.Icons.Check} onClick={handleSubmit}>Submit</PrimaryButton>
78
+ *
79
+ * // Custom color
80
+ * <PrimaryButton color="purple" onClick={handleAction}>Custom</PrimaryButton>
81
+ *
82
+ * // Disabled state
83
+ * <PrimaryButton disabled onClick={handleSave}>Save</PrimaryButton>
84
+ * ```
85
+ *
86
+ * ## Props
87
+ *
88
+ * | Prop | Description |
89
+ * |------|-------------|
90
+ * | `positive` | Green color for confirmations/success actions |
91
+ * | `negative` | Red color for deletions/destructive actions |
92
+ * | `color` | Custom background color (CSS value) |
93
+ * | `icon` | SVG path or `IIconProps` for leading icon |
94
+ * | `disabled` | Prevents interaction |
95
+ * | `title` | Browser tooltip on hover |
69
96
  */
70
97
  ])), function (p) { return p.theme.font.labelLarge; }, function (p) { return p.theme.colors.neutral[100]; }, function (p) { return p.backgroundColor; }, function (p) { return p.theme.animation.duration; }, function (p) { return p.theme.animation.duration; }, function (p) { return p.theme.radius.strong; }, function (p) { return p.theme.shadows.medium; }, function (p) { return darken(0.025, p.backgroundColor); }, function (p) { return p.theme.shadows.large; }, function (p) { return p.backgroundColor; }, function (p) { return p.outlineColor; }, function (p) { return p.disabled && css(templateObject_1 || (templateObject_1 = __makeTemplateObject(["\n cursor: auto;\n pointer-events: none;\n color: ", ";\n box-shadow: none;\n svg {\n fill: ", ";\n }\n "], ["\n cursor: auto;\n pointer-events: none;\n color: ", ";\n box-shadow: none;\n svg {\n fill: ", ";\n }\n "])), p.theme.colors.primary[3], p.theme.colors.primary[3]); });
71
98
  /**
72
- * Primary buttons denote the primary action. They may have icons or not and
73
- * have three colors: `positive`, `negative`, and themed (the default).
74
- * It renders as a `<button>` element.
99
+ * A prominent call-to-action button for primary actions.
100
+ *
101
+ * Renders a styled `<button>` with support for semantic colors, icons, and
102
+ * disabled state. Use for the main action in a form or dialog.
103
+ *
104
+ * ## Usage
105
+ *
106
+ * ```tsx
107
+ * // Basic button
108
+ * <PrimaryButton onClick={handleSave}>Save</PrimaryButton>
109
+ *
110
+ * // Positive action (green)
111
+ * <PrimaryButton positive onClick={handleConfirm}>Confirm</PrimaryButton>
112
+ *
113
+ * // Negative action (red)
114
+ * <PrimaryButton negative onClick={handleDelete}>Delete</PrimaryButton>
115
+ *
116
+ * // With icon
117
+ * <PrimaryButton icon={SVG.Icons.Check} onClick={handleSubmit}>Submit</PrimaryButton>
118
+ *
119
+ * // Custom color
120
+ * <PrimaryButton color="purple" onClick={handleAction}>Custom</PrimaryButton>
121
+ *
122
+ * // Disabled state
123
+ * <PrimaryButton disabled onClick={handleSave}>Save</PrimaryButton>
124
+ * ```
75
125
  *
76
- * The `icon` name is passed in as a property. However, the other children of
77
- * the button can be any React component.
126
+ * ## Props
78
127
  *
79
- * The color of the button defaults to a primary theme color, unless overridden
80
- * with `positive`, `negative` or `color`. The button can be in a `disabled`
81
- * state where it cannot be clicked.
128
+ * | Prop | Description |
129
+ * |------|-------------|
130
+ * | `positive` | Green color for confirmations/success actions |
131
+ * | `negative` | Red color for deletions/destructive actions |
132
+ * | `color` | Custom background color (CSS value) |
133
+ * | `icon` | SVG path or `IIconProps` for leading icon |
134
+ * | `disabled` | Prevents interaction |
135
+ * | `title` | Browser tooltip on hover |
82
136
  */
83
137
  var PrimaryButton = function (_a) {
84
138
  var _b = _a.disabled, disabled = _b === void 0 ? false : _b, _c = _a.positive, positive = _c === void 0 ? false : _c, _d = _a.negative, negative = _d === void 0 ? false : _d, props = __rest(_a, ["disabled", "positive", "negative"]);
@@ -1 +1,2 @@
1
- export * from './PrimaryButton';
1
+ export { PrimaryButton } from './PrimaryButton';
2
+ export type { IPrimaryButtonProps } from './PrimaryButton';
@@ -1 +1 @@
1
- export * from './PrimaryButton';
1
+ export { PrimaryButton } from './PrimaryButton';
@@ -36,23 +36,45 @@ interface IProgressProps {
36
36
  width?: string;
37
37
  }
38
38
  /**
39
- * A visual progress bar component that shows completion of a task, range, or
40
- * metric.
39
+ * A horizontal progress bar showing completion percentage.
41
40
  *
42
- * - Automatically clamps `value` between `0` and `100`.
43
- * - Fully responsive and stretches to available width.
44
- * - Animated bar fill when `value` changes.
45
- * - Optionally displays percentage value text.
41
+ * Displays an animated fill representing a value from 0-100. Values outside
42
+ * this range are automatically clamped. Stretches to fill available width.
46
43
  *
47
- * The bar always stretches to fill all horizontal space available to it.
44
+ * ## Usage
48
45
  *
49
- * @example
50
46
  * ```tsx
51
- * <Progress value={45} numbered color="#00c2a8" thickness={8} />
47
+ * // Basic progress
48
+ * <Progress value={45} />
49
+ *
50
+ * // With percentage label
51
+ * <Progress value={75} numbered />
52
+ *
53
+ * // Custom color and thickness
54
+ * <Progress value={60} color="#00c2a8" thickness={8} />
55
+ *
56
+ * // Fixed width with padding
57
+ * <Progress value={30} width="200px" padded />
52
58
  * ```
59
+ *
60
+ * ## Props
61
+ *
62
+ * | Prop | Description |
63
+ * |------|-------------|
64
+ * | `value` | Percentage complete (0-100, clamped) |
65
+ * | `numbered` | Show percentage text centered on bar |
66
+ * | `thickness` | Bar height in pixels (default: 5) |
67
+ * | `color` | Custom fill color (default: theme primary) |
68
+ * | `width` | Fixed width (CSS value); otherwise fills container |
69
+ * | `padded` | Add 10px margin around bar |
70
+ *
71
+ * ## Accessibility
72
+ *
73
+ * Includes `role="progressbar"` with `aria-valuenow`, `aria-valuemin`, and `aria-valuemax`.
53
74
  */
54
75
  declare const Progress: {
55
76
  ({ thickness, numbered, padded, ...props }: IProgressProps): React.JSX.Element;
56
77
  displayName: string;
57
78
  };
58
- export { Progress, IProgressProps };
79
+ export { Progress };
80
+ export type { IProgressProps };