@nimbus-ds/components 5.57.0 → 5.57.2-rc.1

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 (92) hide show
  1. package/package.json +2 -2
  2. package/dist/Accordion/index.d.ts +0 -160
  3. package/dist/Accordion/index.js +0 -2
  4. package/dist/Alert/index.d.ts +0 -60
  5. package/dist/Alert/index.js +0 -2
  6. package/dist/Badge/index.d.ts +0 -55
  7. package/dist/Badge/index.js +0 -2
  8. package/dist/Box/index.d.ts +0 -788
  9. package/dist/Box/index.js +0 -2
  10. package/dist/Button/index.d.ts +0 -88
  11. package/dist/Button/index.js +0 -2
  12. package/dist/CHANGELOG.md +0 -919
  13. package/dist/Card/index.d.ts +0 -153
  14. package/dist/Card/index.js +0 -2
  15. package/dist/Checkbox/index.d.ts +0 -68
  16. package/dist/Checkbox/index.js +0 -2
  17. package/dist/Chip/index.d.ts +0 -59
  18. package/dist/Chip/index.js +0 -2
  19. package/dist/Collapsible/index.d.ts +0 -45
  20. package/dist/Collapsible/index.js +0 -2
  21. package/dist/Divider/index.d.ts +0 -43
  22. package/dist/Divider/index.js +0 -2
  23. package/dist/FileUploader/index.d.ts +0 -209
  24. package/dist/FileUploader/index.js +0 -2
  25. package/dist/Icon/index.d.ts +0 -122
  26. package/dist/Icon/index.js +0 -2
  27. package/dist/IconButton/index.d.ts +0 -173
  28. package/dist/IconButton/index.js +0 -2
  29. package/dist/Input/index.d.ts +0 -76
  30. package/dist/Input/index.js +0 -2
  31. package/dist/Label/index.d.ts +0 -55
  32. package/dist/Label/index.js +0 -2
  33. package/dist/Link/index.d.ts +0 -115
  34. package/dist/Link/index.js +0 -2
  35. package/dist/List/index.d.ts +0 -105
  36. package/dist/List/index.js +0 -2
  37. package/dist/Modal/index.d.ts +0 -239
  38. package/dist/Modal/index.js +0 -2
  39. package/dist/MultiSelect/index.d.ts +0 -107
  40. package/dist/MultiSelect/index.js +0 -2
  41. package/dist/Pagination/index.d.ts +0 -41
  42. package/dist/Pagination/index.js +0 -2
  43. package/dist/Popover/index.d.ts +0 -166
  44. package/dist/Popover/index.js +0 -2
  45. package/dist/ProgressBar/index.d.ts +0 -72
  46. package/dist/ProgressBar/index.js +0 -2
  47. package/dist/README.md +0 -235
  48. package/dist/Radio/index.d.ts +0 -62
  49. package/dist/Radio/index.js +0 -2
  50. package/dist/ScrollPane/index.d.ts +0 -921
  51. package/dist/ScrollPane/index.js +0 -2
  52. package/dist/SegmentedControl/index.d.ts +0 -890
  53. package/dist/SegmentedControl/index.js +0 -2
  54. package/dist/Select/index.d.ts +0 -87
  55. package/dist/Select/index.js +0 -2
  56. package/dist/Sidebar/index.d.ts +0 -390
  57. package/dist/Sidebar/index.js +0 -2
  58. package/dist/Skeleton/index.d.ts +0 -31
  59. package/dist/Skeleton/index.js +0 -2
  60. package/dist/Slider/index.d.ts +0 -158
  61. package/dist/Slider/index.js +0 -2
  62. package/dist/Spinner/index.d.ts +0 -53
  63. package/dist/Spinner/index.js +0 -2
  64. package/dist/SplitButton/index.d.ts +0 -1018
  65. package/dist/SplitButton/index.js +0 -2
  66. package/dist/Stepper/index.d.ts +0 -883
  67. package/dist/Stepper/index.js +0 -2
  68. package/dist/Table/index.d.ts +0 -193
  69. package/dist/Table/index.js +0 -2
  70. package/dist/Tabs/index.d.ts +0 -92
  71. package/dist/Tabs/index.js +0 -2
  72. package/dist/Tag/index.d.ts +0 -51
  73. package/dist/Tag/index.js +0 -2
  74. package/dist/Text/index.d.ts +0 -608
  75. package/dist/Text/index.js +0 -2
  76. package/dist/Textarea/index.d.ts +0 -76
  77. package/dist/Textarea/index.js +0 -2
  78. package/dist/Thumbnail/index.d.ts +0 -73
  79. package/dist/Thumbnail/index.js +0 -2
  80. package/dist/TimePicker/index.d.ts +0 -343
  81. package/dist/TimePicker/index.js +0 -2
  82. package/dist/Title/index.d.ts +0 -165
  83. package/dist/Title/index.js +0 -2
  84. package/dist/Toast/index.d.ts +0 -71
  85. package/dist/Toast/index.js +0 -2
  86. package/dist/Toggle/index.d.ts +0 -48
  87. package/dist/Toggle/index.js +0 -2
  88. package/dist/Tooltip/index.d.ts +0 -47
  89. package/dist/Tooltip/index.js +0 -2
  90. package/dist/components-props.json +0 -1
  91. package/dist/index.d.ts +0 -4813
  92. package/dist/index.js +0 -2
package/dist/index.d.ts DELETED
@@ -1,4813 +0,0 @@
1
- // Generated by dts-bundle-generator v7.2.0
2
-
3
- import React from 'react';
4
- import { ButtonHTMLAttributes, ComponentPropsWithRef, DragEvent, HTMLAttributes, ImgHTMLAttributes, InputHTMLAttributes, OptgroupHTMLAttributes, OptionHTMLAttributes, PropsWithChildren, ReactElement, ReactNode, RefObject, SVGAttributes } from 'react';
5
-
6
- export interface SkeletonProperties {
7
- /**
8
- * Width of the skeleton. Useful when the skeleton is inside an inline element with no width of its own.
9
- */
10
- width: string;
11
- /**
12
- * Height of the skeleton. Useful when you don't want to adapt the skeleton to a text element but for instance a card.
13
- */
14
- height: string;
15
- /**
16
- * The border radius of the skeleton.
17
- */
18
- borderRadius?: string;
19
- /**
20
- * This is an attribute used to identify a DOM node for testing purposes.
21
- */
22
- "data-testid"?: string;
23
- }
24
- export type SkeletonProps = SkeletonProperties & HTMLAttributes<HTMLDivElement>;
25
- export declare const Skeleton: React.FC<SkeletonProps>;
26
- export type BadgeSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "height" | "className">> & {
27
- /**
28
- * This is an attribute used to identify a DOM node for testing purposes.
29
- */
30
- "data-testid"?: string;
31
- };
32
- export type BadgeSkeletonProps = BadgeSkeletonProperties;
33
- declare const BadgeSkeleton: React.FC<BadgeSkeletonProps>;
34
- export interface BadgeComponents {
35
- Skeleton: typeof BadgeSkeleton;
36
- }
37
- export interface BadgeProperties {
38
- /**
39
- * Change the visual style of the badge.
40
- * @default neutral
41
- */
42
- appearance?: "primary" | "success" | "warning" | "danger" | "neutral";
43
- /**
44
- * Total items to be displayed without badge
45
- */
46
- count: number | string;
47
- /**
48
- * Change the color scheme of the badge.
49
- * @default surface
50
- */
51
- theme?: "surface" | "light";
52
- }
53
- export type BadgeProps = BadgeProperties & HTMLAttributes<HTMLElement>;
54
- export declare const Badge: React.FC<BadgeProps> & BadgeComponents;
55
- export type Merge<P1 = {}, P2 = {}> = Omit<P1, keyof P2> & P2;
56
- export type ForwardRefExoticComponent<E, OwnProps> = React.ForwardRefExoticComponent<Merge<E extends React.ElementType ? React.ComponentPropsWithRef<E> : never, OwnProps & {
57
- as?: E;
58
- }>>;
59
- export interface PolymorphicForwardRefComponent<IntrinsicElementString, OwnProps = {}
60
- /**
61
- * Extends original type to ensure built in React types play nice
62
- * with polymorphic components still e.g. `React.ElementRef` etc.
63
- */
64
- > extends ForwardRefExoticComponent<IntrinsicElementString, OwnProps> {
65
- /**
66
- * When `as` prop is passed, use this overload.
67
- * Merges original own props (without DOM props) and the inferred props
68
- * from `as` element with the own props taking precendence.
69
- *
70
- * We explicitly avoid `React.ElementType` and manually narrow the prop types
71
- * so that events are typed when using JSX.IntrinsicElements.
72
- */
73
- <As = IntrinsicElementString>(props: As extends "" ? {
74
- as: keyof React.JSX.IntrinsicElements;
75
- } : As extends React.ComponentType<infer P> ? Merge<P, OwnProps & {
76
- as: As;
77
- }> : As extends keyof React.JSX.IntrinsicElements ? Merge<React.JSX.IntrinsicElements[As], OwnProps & {
78
- as: As;
79
- }> : never): React.ReactElement | null;
80
- }
81
- export interface Conditions<T> {
82
- xs?: T;
83
- md?: T;
84
- lg?: T;
85
- xl?: T;
86
- xxl?: T;
87
- }
88
- export type AspectRatio = "1/1" | "16/9" | "9/16" | "4/3" | "3/4" | "2/1" | "1/2";
89
- export type BorderStyle = "solid" | "none" | "hidden" | "dashed" | "dotted";
90
- export type BoxSizing = "border-box" | "content-box";
91
- export type Cursor = "auto" | "pointer" | "not-allowed" | "grab" | "inherit";
92
- export type Display = "block" | "flex" | "inline-flex" | "grid" | "inline-grid" | "none";
93
- export type FlexWrap = "nowrap" | "wrap" | "wrap-reverse";
94
- export type FlexDirection = "row" | "row-reverse" | "column" | "column-reverse";
95
- export type JustifyContent = "flex-start" | "flex-end" | "center" | "space-between" | "space-around" | "space-evenly";
96
- export type AlignItems = "stretch" | "flex-start" | "flex-end" | "center" | "baseline";
97
- export type AlignSelf = "auto" | "flex-start" | "flex-end" | "center" | "baseline" | "stretch";
98
- export type TextAlign = "left" | "right" | "center" | "justify";
99
- export type TextDecoration = "none" | "underline" | "line-through";
100
- export type Position = "absolute" | "fixed" | "relative" | "static" | "sticky";
101
- export type Overflow = "visible" | "hidden" | "scroll" | "auto";
102
- export type PointerEvents = "auto" | "none" | "visiblePainted" | "visibleFill" | "visibleStroke" | "visible" | "painted" | "fill" | "stroke" | "all" | "inherit";
103
- export type TransitionTiming = "ease" | "ease-in" | "ease-out" | "ease-in-out" | "linear" | "step-start" | "step-end";
104
- export type WordBreak = "normal" | "break-all" | "keep-all" | "break-word";
105
- export type TextOverflow = "clip" | "ellipsis";
106
- export type WhiteSpace = "normal" | "nowrap" | "pre" | "pre-wrap" | "pre-line" | "break-spaces";
107
- export type ScrollbarWidth = "auto" | "none" | "thin";
108
- declare const propertiesBox: {
109
- gap: {
110
- none: string;
111
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
112
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
113
- "1-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
114
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
115
- "2-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
116
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
117
- "3-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
118
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
119
- "4-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
120
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
121
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
122
- "7": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
123
- "8": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
124
- "9": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
125
- "10": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
126
- "11": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
127
- "12": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
128
- "14": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
129
- "16": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
130
- "18": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
131
- "20": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
132
- };
133
- gridGap: {
134
- none: string;
135
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
136
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
137
- "1-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
138
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
139
- "2-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
140
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
141
- "3-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
142
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
143
- "4-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
144
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
145
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
146
- "7": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
147
- "8": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
148
- "9": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
149
- "10": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
150
- "11": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
151
- "12": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
152
- "14": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
153
- "16": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
154
- "18": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
155
- "20": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
156
- };
157
- display: Display[];
158
- flexDirection: FlexDirection[];
159
- flexWrap: FlexWrap[];
160
- justifyContent: JustifyContent[];
161
- alignItems: AlignItems[];
162
- alignSelf: AlignSelf[];
163
- pointerEvents: PointerEvents[];
164
- backgroundColor: {
165
- "primary-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
166
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
167
- "primary-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
168
- "primary-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
169
- "success-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
170
- "success-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
171
- "success-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
172
- "success-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
173
- "warning-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
174
- "warning-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
175
- "warning-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
176
- "warning-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
177
- "danger-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
178
- "danger-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
179
- "danger-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
180
- "danger-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
181
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
182
- "neutral-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
183
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
184
- "neutral-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
185
- "neutral-surfaceDisabled": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
186
- "neutral-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
187
- "neutral-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
188
- "ai-generative-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
189
- "ai-generative-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
190
- transparent: string;
191
- };
192
- background: {
193
- "ai-generative-interactive-border": string;
194
- "ai-generative-interactive": string;
195
- transparent: string;
196
- };
197
- color: {
198
- currentColor: string;
199
- "primary-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
200
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
201
- "primary-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
202
- "primary-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
203
- "success-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
204
- "success-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
205
- "success-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
206
- "success-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
207
- "warning-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
208
- "warning-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
209
- "warning-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
210
- "warning-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
211
- "danger-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
212
- "danger-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
213
- "danger-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
214
- "danger-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
215
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
216
- "neutral-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
217
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
218
- "neutral-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
219
- "neutral-surfaceDisabled": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
220
- "neutral-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
221
- "neutral-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
222
- "ai-generative-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
223
- "ai-generative-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
224
- transparent: string;
225
- };
226
- borderColor: {
227
- "primary-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
228
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
229
- "primary-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
230
- "success-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
231
- "success-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
232
- "success-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
233
- "warning-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
234
- "warning-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
235
- "warning-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`; /**
236
- * The gridTemplateAreas property specifies named grid areas, establishing the cells in the grid and assigning them names.
237
- */
238
- "danger-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
239
- "danger-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
240
- "danger-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
241
- "neutral-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
242
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
243
- "neutral-surfaceDisabled": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
244
- "neutral-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
245
- "ai-generative-interactiveHover": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
246
- transparent: string;
247
- };
248
- borderRadius: {
249
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
250
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
251
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
252
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
253
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
254
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
255
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
256
- full: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
257
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
258
- half: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
259
- none: string;
260
- };
261
- borderWidth: {
262
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
263
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
264
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
265
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
266
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
267
- none: string;
268
- };
269
- borderStyle: BorderStyle[];
270
- boxSizing: BoxSizing[];
271
- cursor: Cursor[]; /**
272
- * The padding properties are used to generate space around an box's content area.
273
- */
274
- spacing: {
275
- none: string;
276
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
277
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
278
- "1-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
279
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
280
- "2-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
281
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
282
- "3-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
283
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
284
- "4-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
285
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
286
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
287
- "7": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
288
- "8": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
289
- "9": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
290
- "10": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
291
- "11": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
292
- "12": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
293
- "14": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
294
- "16": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
295
- "18": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
296
- "20": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
297
- };
298
- margin: {
299
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
300
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
301
- "1-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
302
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
303
- "2-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
304
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
305
- "3-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
306
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
307
- "4-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
308
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
309
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
310
- "7": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
311
- "8": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
312
- "9": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
313
- "10": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
314
- "11": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
315
- "12": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
316
- "14": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
317
- "16": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
318
- "18": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
319
- "20": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
320
- auto: string;
321
- none: string;
322
- };
323
- position: Position[];
324
- overflow: Overflow[];
325
- overflowX: Overflow[];
326
- overflowY: Overflow[];
327
- boxShadow: {
328
- "0": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
329
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
330
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
331
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
332
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
333
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
334
- focusRing: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
335
- aiFocus: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
336
- };
337
- transitionDuration: {
338
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
339
- fast: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
340
- slow: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
341
- slower: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
342
- };
343
- transitionTimingFunction: TransitionTiming[];
344
- textDecoration: TextDecoration[];
345
- zIndex: {
346
- "100": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
347
- "200": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
348
- "300": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
349
- "400": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
350
- "500": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
351
- "600": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
352
- "700": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
353
- "800": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
354
- "900": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
355
- };
356
- textAlign: TextAlign[];
357
- fontWeight: {
358
- regular: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
359
- medium: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
360
- bold: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
361
- };
362
- fontSize: {
363
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
364
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
365
- "1-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
366
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
367
- "2-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
368
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
369
- "3-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
370
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
371
- "4-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
372
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
373
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
374
- "7": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
375
- "8": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
376
- "9": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
377
- "10": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
378
- "11": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
379
- "12": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
380
- "14": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
381
- "16": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
382
- "18": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
383
- "20": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
384
- h1: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
385
- h2: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
386
- h3: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
387
- h4: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
388
- h5: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
389
- h6: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
390
- };
391
- lineHeight: {
392
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
393
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
394
- "1-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
395
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
396
- "2-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
397
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
398
- "3-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
399
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
400
- "4-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
401
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
402
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
403
- "7": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
404
- "8": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
405
- "9": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
406
- "10": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
407
- "11": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
408
- "12": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
409
- "14": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
410
- "16": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
411
- "18": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
412
- "20": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
413
- h1: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
414
- h2: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
415
- h3: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
416
- h4: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
417
- h5: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
418
- h6: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
419
- };
420
- scrollbarWidth: ScrollbarWidth[];
421
- };
422
- export type BoxBorderColorProperties = keyof typeof propertiesBox.borderColor;
423
- export type BoxBorderRadiusProperties = keyof typeof propertiesBox.borderRadius;
424
- export type BoxBorderWidthProperties = keyof typeof propertiesBox.borderWidth;
425
- export type BoxBackgroundColorProperties = keyof typeof propertiesBox.backgroundColor;
426
- export type BoxColorProperties = keyof typeof propertiesBox.color;
427
- export type BoxShadowProperties = keyof typeof propertiesBox.boxShadow;
428
- export type BoxSpacingProperties = keyof typeof propertiesBox.spacing;
429
- export type BoxMarginProperties = keyof typeof propertiesBox.margin;
430
- export type BoxGapProperties = keyof typeof propertiesBox.gap;
431
- export type BoxGridGapProperties = keyof typeof propertiesBox.gridGap;
432
- export type BoxZIndexProperties = keyof typeof propertiesBox.zIndex;
433
- export type BoxTransitionDurationProperties = keyof typeof propertiesBox.transitionDuration;
434
- export type BoxFontSizeProperties = keyof typeof propertiesBox.fontSize;
435
- export type BoxFontWeightProperties = keyof typeof propertiesBox.fontWeight;
436
- export type BoxLineHeightProperties = keyof typeof propertiesBox.lineHeight;
437
- export type BoxBackgroundProperties = keyof typeof propertiesBox.background;
438
- export interface BoxConditions<T> extends Conditions<T> {
439
- focus?: T;
440
- focusVisible?: T;
441
- focusWithin?: T;
442
- active?: T;
443
- hover?: T;
444
- disabled?: T;
445
- }
446
- export interface BoxSprinkle {
447
- /**
448
- * The width property specifies the width of a box's content area.
449
- */
450
- width?: string | BoxConditions<string>;
451
- /**
452
- * The height property specifies the height of a box's content area.
453
- */
454
- height?: string | BoxConditions<string>;
455
- /**
456
- * The max width property specifies the width of a box's content area.
457
- */
458
- maxWidth?: string | BoxConditions<string>;
459
- /**
460
- * The max height property specifies the height of a box's content area.
461
- */
462
- maxHeight?: string | BoxConditions<string>;
463
- /**
464
- * The min width property specifies the width of a box's content area.
465
- */
466
- minWidth?: string | BoxConditions<string>;
467
- /**
468
- * The min height property specifies the height of a box's content area.
469
- */
470
- minHeight?: string | BoxConditions<string>;
471
- /**
472
- * The bottom property participates in setting the vertical position of a positioned box.
473
- */
474
- bottom?: string | BoxConditions<string>;
475
- /**
476
- * The left property participates in specifying the horizontal position of a positioned box.
477
- */
478
- left?: string | BoxConditions<string>;
479
- /**
480
- * The right property participates in specifying the horizontal position of a positioned box.
481
- */
482
- right?: string | BoxConditions<string>;
483
- /**
484
- * The top property participates in setting the vertical position of a positioned box.
485
- */
486
- top?: string | BoxConditions<string>;
487
- /**
488
- * This is the shorthand for flexGrow, flexShrink and flexBasis combined.
489
- */
490
- flex?: string | BoxConditions<string>;
491
- /**
492
- * This defines the ability for a flex item to shrink if necessary.
493
- */
494
- flexShrink?: string | BoxConditions<string>;
495
- /**
496
- * This defines the ability for a flex item to grow if necessary.
497
- */
498
- flexGrow?: string | BoxConditions<string>;
499
- /**
500
- * The flexWrap property sets whether flex items are forced onto one line or can wrap onto multiple lines.
501
- */
502
- flexWrap?: FlexWrap | BoxConditions<FlexWrap>;
503
- /**
504
- * The order property controls the order in which they appear in a flex container.
505
- */
506
- order?: string | BoxConditions<string>;
507
- /**
508
- * The gridTemplateColumns property defines the line names and track sizing functions of the grid columns.
509
- */
510
- gridTemplateColumns?: string | BoxConditions<string>;
511
- /**
512
- * The gridTemplateAreas property specifies named grid areas, establishing the cells in the grid and assigning them names.
513
- */
514
- gridTemplateAreas?: string | BoxConditions<string>;
515
- /**
516
- * The gridTemplateRows property defines the line names and track sizing functions of the grid rows.
517
- */
518
- gridTemplateRows?: string | BoxConditions<string>;
519
- /**
520
- * The gridArea shorthand property specifies a grid item's size and location within a grid by contributing a line,
521
- * a span, or nothing (automatic) to its grid placement, thereby specifying the edges of its grid area.
522
- */
523
- gridArea?: string | BoxConditions<string>;
524
- /**
525
- * The display property sets whether an box is treated as a block or inline element and the layout used for its children,
526
- * such as grid or flex.
527
- */
528
- display?: Display | BoxConditions<Display>;
529
- /**
530
- * The justifyContent property defines how the browser distributes space between and around content items along
531
- * the main-axis of a flex container, and the inline axis of a grid container.
532
- */
533
- justifyContent?: JustifyContent | BoxConditions<JustifyContent>;
534
- /**
535
- * The flexDirection property sets how flex items are placed in the flex container defining the main axis and the direction.
536
- */
537
- flexDirection?: FlexDirection | BoxConditions<FlexDirection>;
538
- /**
539
- * The alignItems property sets the align-self value on all direct children as a group. In Flexbox, it controls the alignment of items on the Cross Axis.
540
- * In Grid Layout, it controls the alignment of items on the Block Axis within their grid area.
541
- */
542
- alignItems?: AlignItems | BoxConditions<AlignItems>;
543
- /**
544
- * The alignSelf property overrides a grid or flex item's align-items value. In Grid, it aligns the item inside the grid area.
545
- * In Flexbox, it aligns the item on the cross axis.
546
- */
547
- alignSelf?: AlignSelf | BoxConditions<AlignSelf>;
548
- /**
549
- * The gap property sets the gaps between rows and columns. It is a shorthand for rowGap and columnGap.
550
- */
551
- gap?: BoxGapProperties | BoxConditions<BoxGapProperties>;
552
- /**
553
- * The gridGap property sets the gaps between rows and columns. It is a shorthand for rowGap and columnGap.
554
- */
555
- gridGap?: BoxGridGapProperties | BoxConditions<BoxGridGapProperties>;
556
- /**
557
- * The pointerEvents property sets under what circumstances (if any) a particular graphic element can become the target of pointer events.
558
- */
559
- pointerEvents?: PointerEvents | BoxConditions<PointerEvents>;
560
- /**
561
- * The position property sets how an box is positioned in a document.
562
- */
563
- position?: Position | BoxConditions<Position>;
564
- /**
565
- * The overflow shorthand property sets the desired behavior for an box's overflow.
566
- */
567
- overflow?: Overflow | BoxConditions<Overflow>;
568
- /**
569
- * The overflow-x property sets what shows when content overflows a block-level box's left and right edges.
570
- */
571
- overflowX?: Overflow | BoxConditions<Overflow>;
572
- /**
573
- * The overflow-y property sets what shows when content overflows a block-level box's top and bottom edges.
574
- */
575
- overflowY?: Overflow | BoxConditions<Overflow>;
576
- /**
577
- * The cursor property sets the mouse cursor, if any, to show when the mouse pointer is over an box.
578
- */
579
- cursor?: Cursor | BoxConditions<Cursor>;
580
- /**
581
- * The backgroundColor property sets the background color of the box.
582
- * @default neutral-background
583
- * @examples ["neutral-interactive", { xs: "neutral-surface", md: "neutral-interactive" }]
584
- */
585
- backgroundColor?: BoxBackgroundColorProperties | BoxConditions<BoxBackgroundColorProperties>;
586
- /**
587
- * The color property is used to set the color of the box.
588
- */
589
- color?: BoxColorProperties | BoxConditions<BoxColorProperties>;
590
- /**
591
- * The borderRadius property rounds the corners of an box's outer border edge.
592
- */
593
- borderRadius?: BoxBorderRadiusProperties | BoxConditions<BoxBorderRadiusProperties>;
594
- /**
595
- * The borderWidth property sets the width of an box's border.
596
- */
597
- borderWidth?: BoxBorderWidthProperties | BoxConditions<BoxBorderWidthProperties>;
598
- /**
599
- * The borderTopWidth property defines the width of the border at the top of a box.
600
- */
601
- borderTopWidth?: BoxBorderWidthProperties | BoxConditions<BoxBorderWidthProperties>;
602
- /**
603
- * The borderBottomWidth property defines the width of the border at the bottom of a box.
604
- */
605
- borderBottomWidth?: BoxBorderWidthProperties | BoxConditions<BoxBorderWidthProperties>;
606
- /**
607
- * The borderLeftWidth property defines the width of the border at the left of a box.
608
- */
609
- borderLeftWidth?: BoxBorderWidthProperties | BoxConditions<BoxBorderWidthProperties>;
610
- /**
611
- * The borderRightWidth property defines the width of the border at the right of a box.
612
- */
613
- borderRightWidth?: BoxBorderWidthProperties | BoxConditions<BoxBorderWidthProperties>;
614
- /**
615
- * The borderWidthX shorthand property defines the width of the element's border on the left and right.
616
- */
617
- borderWidthX?: BoxBorderWidthProperties | BoxConditions<BoxBorderWidthProperties>;
618
- /**
619
- * The borderWidthY shorthand property defines the width of the element's border on the top and bottom.
620
- */
621
- borderWidthY?: BoxBorderWidthProperties | BoxConditions<BoxBorderWidthProperties>;
622
- /**
623
- * The borderColor property sets the color of the box's four borders.
624
- */
625
- borderColor?: BoxBorderColorProperties | BoxConditions<BoxBorderColorProperties>;
626
- /**
627
- * borderStyle property sets the line style for all four sides of an box's border.
628
- */
629
- borderStyle?: BorderStyle | BoxConditions<BorderStyle>;
630
- /**
631
- * The boxSizing property sets how the total width and height of an box is calculated.
632
- * @default border-box
633
- */
634
- boxSizing?: BoxSizing | BoxConditions<BoxSizing>;
635
- /**
636
- * The boxShadow property adds shadow effects around an box's frame.
637
- */
638
- boxShadow?: BoxShadowProperties | BoxConditions<BoxShadowProperties>;
639
- /**
640
- * The padding properties are used to generate space around an box's content area.
641
- */
642
- padding?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
643
- /**
644
- * The paddingTop property sets the height of the padding area on the top of an box.
645
- */
646
- paddingTop?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
647
- /**
648
- * The paddingBottom property sets the height of the padding area on the bottom of an box.
649
- */
650
- paddingBottom?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
651
- /**
652
- * The paddingLeft property sets the width of the padding area to the left of an box.
653
- */
654
- paddingLeft?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
655
- /**
656
- * The paddingLeft property sets the width of the padding area to the right of an box.
657
- */
658
- paddingRight?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
659
- /**
660
- * The margin shorthand property sets the margin area on all four sides of an box.
661
- */
662
- margin?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
663
- /**
664
- * The marginTop property sets the margin area on the top of an box.
665
- */
666
- marginTop?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
667
- /**
668
- * The marginBottom property sets the margin area on the bottom of an box.
669
- */
670
- marginBottom?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
671
- /**
672
- * The marginLeft property sets the margin area on the left side of an box.
673
- */
674
- marginLeft?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
675
- /**
676
- * The marginRight property sets the margin area on the right side of an box.
677
- */
678
- marginRight?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
679
- /**
680
- * The transitionTimingFunction property sets how intermediate values are calculated for CSS properties being affected by a transition effect.
681
- */
682
- transitionTimingFunction?: TransitionTiming | BoxConditions<TransitionTiming>;
683
- /**
684
- * The transitionProperty property sets the CSS properties to which a transition effect should be applied.
685
- */
686
- transitionProperty?: string | BoxConditions<string>;
687
- /**
688
- * The transitionDelay property specifies the duration to wait before starting a property's transition effect when its value changes.
689
- */
690
- transitionDelay?: string | BoxConditions<string>;
691
- /**
692
- * The transitionDuration property sets the length of time a transition animation should take to complete. By default, the value is 0s, meaning that no animation will occur.
693
- */
694
- transitionDuration?: BoxTransitionDurationProperties | BoxConditions<BoxTransitionDurationProperties>;
695
- /**
696
- * The zIndex property specifies the stack order of the box.
697
- */
698
- zIndex?: BoxZIndexProperties | BoxConditions<BoxZIndexProperties>;
699
- /**
700
- * The background property sets the background of the box.
701
- */
702
- background?: BoxBackgroundProperties | BoxConditions<BoxBackgroundProperties>;
703
- /**
704
- * The backgroundImage property sets one or more background images on an element.
705
- */
706
- backgroundImage?: string | BoxConditions<string>;
707
- /**
708
- * The backgroundPosition property sets the initial position for each background image.
709
- * The position is relative to the position layer set by background-origin.
710
- */
711
- backgroundPosition?: string | BoxConditions<string>;
712
- /**
713
- * The backgroundBlendMode property sets how an element's background images should blend with each
714
- * other and with the element's background color.
715
- */
716
- backgroundBlendMode?: string | BoxConditions<string>;
717
- /**
718
- * The backgroundRepeat property sets how background images are repeated. A background image can be repeated along the horizontal and vertical axes, or not repeated at all.
719
- */
720
- backgroundRepeat?: string | BoxConditions<string>;
721
- /**
722
- * The textDecoration shorthand property sets the appearance of decorative lines on text.
723
- */
724
- textDecoration?: TextDecoration | BoxConditions<TextDecoration>;
725
- /**
726
- * The backgroundSize property sets the size of the element's background image. The image can be left to its natural size, stretched, or constrained to fit the available space.
727
- */
728
- backgroundSize?: string | BoxConditions<string>;
729
- /**
730
- * The p shorthand property sets the margin area on all four sides of an box.
731
- */
732
- p?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
733
- /**
734
- * The pl shorthand property sets the width of the padding area to the left of an box.
735
- */
736
- pl?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
737
- /**
738
- * The pl shorthand property sets the width of the padding area to the right of an box.
739
- */
740
- pr?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
741
- /**
742
- * The pt shorthand property sets the height of the padding area on the top of an box.
743
- */
744
- pt?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
745
- /**
746
- * The pb shorthand property sets the height of the padding area on the botton of an box.
747
- */
748
- pb?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
749
- /**
750
- * The px shorthand property defines the width of the left and right padding area of a box.
751
- */
752
- px?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
753
- /**
754
- * The py pt shorthand property sets the height of the padding area at the top and bottom of a box.
755
- */
756
- py?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
757
- /**
758
- * The paddingX shorthand property defines the width of the left and right padding area of a box.
759
- */
760
- paddingX?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
761
- /**
762
- * The paddingY pt shorthand property sets the height of the padding area at the top and bottom of a box.
763
- */
764
- paddingY?: BoxSpacingProperties | BoxConditions<BoxSpacingProperties>;
765
- /**
766
- * The m shorthand property sets the margin area on all four sides of an box.
767
- */
768
- m?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
769
- /**
770
- * The mr property sets the margin area on the right side of an box.
771
- */
772
- mr?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
773
- /**
774
- * The ml property sets the margin area on the left side of an box.
775
- */
776
- ml?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
777
- /**
778
- * The mt property sets the margin area on the top of an box.
779
- */
780
- mt?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
781
- /**
782
- * The marginBottom property sets the margin area on the bottom of an box.
783
- */
784
- mb?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
785
- /**
786
- * The mx property defines the margin area on the left and right side of a box.
787
- */
788
- mx?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
789
- /**
790
- * The my property defines the margin area on the top and bottom of a box
791
- */
792
- my?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
793
- /**
794
- * The marginX property defines the margin area on the left and right side of a box.
795
- */
796
- marginX?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
797
- /**
798
- * The marginY property defines the margin area on the top and bottom of a box
799
- */
800
- marginY?: BoxMarginProperties | BoxConditions<BoxMarginProperties>;
801
- /**
802
- * The fontSize property sets the size of the box.
803
- * @default base
804
- */
805
- fontSize?: BoxFontSizeProperties | BoxConditions<BoxFontSizeProperties>;
806
- /**
807
- * The fontWeight property sets how thick or thin characters in box should be displayed.
808
- * @default regular
809
- */
810
- fontWeight?: BoxFontWeightProperties | BoxConditions<BoxFontWeightProperties>;
811
- /**
812
- * The lineHeight property specifies the line height of the box.
813
- * @default base
814
- */
815
- lineHeight?: BoxLineHeightProperties | BoxConditions<BoxLineHeightProperties>;
816
- /**
817
- * The textAlign property specifies the horizontal alignment of box.
818
- * @default left
819
- */
820
- textAlign?: TextAlign | BoxConditions<TextAlign>;
821
- /**
822
- * The scrollbarWidth property specifies the width of the scrollbar.
823
- */
824
- scrollbarWidth?: ScrollbarWidth | BoxConditions<ScrollbarWidth>;
825
- }
826
- declare const fileUploader: {
827
- sprinkle: ((props: {
828
- aspectRatio?: "none" | AspectRatio | undefined;
829
- flexDirection?: "row" | "column" | undefined;
830
- cursor?: Cursor | undefined;
831
- backgroundColor?: "transparent" | "primary-surface" | "neutral-background" | undefined;
832
- borderColor?: "transparent" | "primary-interactive" | "ai-generativeInteractiveHover" | undefined;
833
- }) => string) & {
834
- properties: Set<"aspectRatio" | "backgroundColor" | "cursor" | "flexDirection" | "borderColor">;
835
- };
836
- properties: {
837
- aspectRatio: readonly [
838
- "none",
839
- ...AspectRatio[]
840
- ];
841
- flexDirection: readonly [
842
- "row",
843
- "column"
844
- ];
845
- cursor: Cursor[];
846
- backgroundColor: {
847
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
848
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
849
- transparent: string;
850
- };
851
- borderColor: {
852
- "primary-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
853
- "ai-generativeInteractiveHover": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
854
- transparent: string;
855
- };
856
- borderRadius: {
857
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
858
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
859
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
860
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
861
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
862
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
863
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
864
- full: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
865
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
866
- half: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
867
- };
868
- };
869
- classnames: {
870
- container: string;
871
- container__input: string;
872
- disabled: string;
873
- dragging: string;
874
- skeleton: string;
875
- asOverlay: string;
876
- overlay: string;
877
- overlay__content: string;
878
- overlay__content__text: string;
879
- overlay__image: string;
880
- };
881
- };
882
- declare const icon: {
883
- sprinkle: ((props: {
884
- color?: "currentColor" | "primary-interactive" | "primary-surface" | "primary-textLow" | "success-textLow" | "success-surface" | "warning-interactive" | "warning-surface" | "warning-textLow" | "danger-interactive" | "danger-surface" | "danger-textLow" | "neutral-background" | "neutral-interactive" | "neutral-surface" | "neutral-textLow" | "neutral-textHigh" | "success-interactive" | "ai-generative" | "primary-textHigh" | "success-interactivePressed" | "success-textHigh" | "warning-textHigh" | "danger-textHigh" | "neutral-textDisabled" | "ai-gradientPurpleHigh" | undefined;
885
- cursor?: Cursor | undefined;
886
- }) => string) & {
887
- properties: Set<"color" | "cursor">;
888
- };
889
- properties: {
890
- color: {
891
- currentColor: string;
892
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
893
- "primary-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
894
- "primary-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
895
- "primary-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
896
- "success-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
897
- "success-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
898
- "success-interactivePressed": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
899
- "success-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
900
- "success-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
901
- "warning-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
902
- "warning-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
903
- "warning-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
904
- "warning-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
905
- "danger-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
906
- "danger-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
907
- "danger-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
908
- "danger-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
909
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
910
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
911
- "neutral-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
912
- "neutral-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
913
- "neutral-textDisabled": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
914
- "neutral-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
915
- "ai-gradientPurpleHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
916
- "ai-generative": string;
917
- };
918
- cursor: Cursor[];
919
- };
920
- classnames: {
921
- base: string;
922
- };
923
- };
924
- declare const propertiesIconButton: {
925
- backgroundColor: {
926
- transparent: string;
927
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
928
- "neutral-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
929
- "neutral-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
930
- "ai-generativeSurface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
931
- };
932
- borderColor: {
933
- "neutral-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
934
- "neutral-interactiveHover": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
935
- "neutral-interactivePressed": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
936
- "primary-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
937
- transparent: string;
938
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
939
- "neutral-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
940
- "ai-generativeSurface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
941
- };
942
- };
943
- export type IconButtonBackgroundColorProperties = keyof typeof propertiesIconButton.backgroundColor;
944
- export type IconButtonBorderColorProperties = keyof typeof propertiesIconButton.borderColor;
945
- export interface IconButtonConditions<T> extends Conditions<T> {
946
- focus?: T;
947
- active?: T;
948
- hover?: T;
949
- }
950
- export interface IconButtonSprinkle {
951
- /**
952
- * The size of the component.
953
- * @default 2.75rem
954
- */
955
- size?: string | IconButtonConditions<string>;
956
- /**
957
- * The borderColor property sets the color of the icon button's four borders.
958
- * @default { xs: "neutral-interactive", active: "neutral-interactivePressed", hover: "neutral-interactiveHover", focus: "primary-interactive" }
959
- */
960
- borderColor?: IconButtonBorderColorProperties | IconButtonConditions<IconButtonBorderColorProperties>;
961
- /**
962
- * The backgroundColor property sets the background color of the icon button.
963
- * @default { xs: "neutral-surface", active: "neutral-interactive", hover: "neutral-surfaceHighlight" }
964
- */
965
- backgroundColor?: IconButtonBackgroundColorProperties | IconButtonConditions<IconButtonBackgroundColorProperties>;
966
- }
967
- declare const propertiesText: {
968
- color: {
969
- "ai-generative": "transparent";
970
- currentColor: string;
971
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
972
- "primary-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
973
- "primary-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
974
- "primary-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
975
- "success-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
976
- "success-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
977
- "success-interactivePressed": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
978
- "success-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
979
- "success-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
980
- "warning-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
981
- "warning-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
982
- "warning-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
983
- "warning-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
984
- "danger-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
985
- "danger-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
986
- "danger-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
987
- "danger-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`; /**
988
- * The whiteSpace property sets how white space inside an element is handled.
989
- */
990
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
991
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
992
- "neutral-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
993
- "neutral-textDisabled": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
994
- "neutral-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
995
- "neutral-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
996
- };
997
- textAlign: TextAlign[];
998
- lineHeight: {
999
- readonly caption: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1000
- readonly base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1001
- readonly highlight: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1002
- };
1003
- fontWeight: {
1004
- regular: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1005
- medium: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1006
- bold: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1007
- };
1008
- fontSize: {
1009
- caption: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1010
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`; /**
1011
- * The overflow property specifies what happens if content overflows an element's box.
1012
- */
1013
- highlight: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1014
- };
1015
- wordBreak: WordBreak[];
1016
- textDecoration: TextDecoration[];
1017
- textOverflow: TextOverflow[];
1018
- whiteSpace: WhiteSpace[];
1019
- overflow: Overflow[];
1020
- };
1021
- export type TextColorProperties = keyof typeof propertiesText.color;
1022
- export type TextFontSizeProperties = keyof typeof propertiesText.fontSize;
1023
- export type TextFontWeightProperties = keyof typeof propertiesText.fontWeight;
1024
- export type TextLineHeightProperties = keyof typeof propertiesText.lineHeight;
1025
- export type TextConditions<T> = Conditions<T>;
1026
- export interface TextSprinkle {
1027
- /**
1028
- * The fontSize property sets the size of the text.
1029
- * @default base
1030
- */
1031
- fontSize?: TextFontSizeProperties | TextConditions<TextFontSizeProperties>;
1032
- /**
1033
- * The fontWeight property sets how thick or thin characters in text should be displayed.
1034
- * @default regular
1035
- */
1036
- fontWeight?: TextFontWeightProperties | TextConditions<TextFontWeightProperties>;
1037
- /**
1038
- * The lineHeight property specifies the line height of the text.
1039
- * @default base
1040
- */
1041
- lineHeight?: TextLineHeightProperties | TextConditions<TextLineHeightProperties>;
1042
- /**
1043
- * The textAlign property specifies the horizontal alignment of text.
1044
- * @default left
1045
- */
1046
- textAlign?: TextAlign | TextConditions<TextAlign>;
1047
- /**
1048
- * The color property is used to set the color of the text.
1049
- * Note: Gradients like 'ai-generative' changes other properties like 'width' and 'display', which could make the component behave differently. Ensure to visually test the component when dynamically changing the color.
1050
- * @default neutral-textLow
1051
- */
1052
- color?: TextColorProperties | TextConditions<TextColorProperties>;
1053
- /**
1054
- * The amount of lines at which the text will be trimmed, showing an ellipsis when overflowed.
1055
- */
1056
- lineClamp?: number | TextConditions<number>;
1057
- /**
1058
- * The amount of lines at which the text will be trimmed, showing an ellipsis when overflowed.
1059
- */
1060
- WebkitLineClamp?: number | TextConditions<number>;
1061
- /**
1062
- * The wordBreak property sets whether line breaks appear wherever the text would otherwise overflow its content box.
1063
- */
1064
- wordBreak?: WordBreak | TextConditions<WordBreak>;
1065
- /**
1066
- * The textDecoration shorthand property sets the appearance of decorative lines on text.
1067
- */
1068
- textDecoration?: TextDecoration | TextConditions<TextDecoration>;
1069
- /**
1070
- * The textOverflow property specifies how overflowed content that is not displayed should be signaled to the user (e.g., 'ellipsis' for '...', 'clip' for hard cutoff).
1071
- * Note: This property only works when overflow is set to 'hidden'.
1072
- */
1073
- textOverflow?: TextOverflow | TextConditions<TextOverflow>;
1074
- /**
1075
- * The whiteSpace property sets how white space inside an element is handled.
1076
- */
1077
- whiteSpace?: WhiteSpace | TextConditions<WhiteSpace>;
1078
- /**
1079
- * The overflow property specifies what happens if content overflows an element's box.
1080
- */
1081
- overflow?: Overflow | TextConditions<Overflow>;
1082
- }
1083
- declare const text: {
1084
- sprinkle: import("rainbow-sprinkles/dist/declarations/src/createRuntimeFn").SprinklesFn<[
1085
- {
1086
- config: {
1087
- color: {
1088
- values: {
1089
- currentColor: {
1090
- default: string;
1091
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1092
- };
1093
- "primary-interactive": {
1094
- default: string;
1095
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1096
- };
1097
- "primary-surface": {
1098
- default: string;
1099
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1100
- };
1101
- "primary-textLow": {
1102
- default: string;
1103
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1104
- };
1105
- "success-textLow": {
1106
- default: string;
1107
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1108
- };
1109
- "success-surface": {
1110
- default: string;
1111
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1112
- };
1113
- "warning-interactive": {
1114
- default: string;
1115
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1116
- };
1117
- "warning-surface": {
1118
- default: string;
1119
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1120
- };
1121
- "warning-textLow": {
1122
- default: string;
1123
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1124
- };
1125
- "danger-interactive": {
1126
- default: string;
1127
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1128
- };
1129
- "danger-surface": {
1130
- default: string;
1131
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1132
- };
1133
- "danger-textLow": {
1134
- default: string;
1135
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1136
- };
1137
- "neutral-background": {
1138
- default: string;
1139
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1140
- };
1141
- "neutral-interactive": {
1142
- default: string;
1143
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1144
- };
1145
- "neutral-surface": {
1146
- default: string;
1147
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1148
- };
1149
- "neutral-textLow": {
1150
- default: string;
1151
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1152
- };
1153
- "neutral-textHigh": {
1154
- default: string;
1155
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1156
- };
1157
- "success-interactive": {
1158
- default: string;
1159
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1160
- };
1161
- "ai-generative": {
1162
- default: string;
1163
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1164
- };
1165
- "primary-textHigh": {
1166
- default: string;
1167
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1168
- };
1169
- "success-interactivePressed": {
1170
- default: string;
1171
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1172
- };
1173
- "success-textHigh": {
1174
- default: string;
1175
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1176
- };
1177
- "warning-textHigh": {
1178
- default: string;
1179
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1180
- };
1181
- "danger-textHigh": {
1182
- default: string;
1183
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1184
- };
1185
- "neutral-textDisabled": {
1186
- default: string;
1187
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1188
- };
1189
- };
1190
- staticScale: {
1191
- "ai-generative": "transparent";
1192
- currentColor: string;
1193
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1194
- "primary-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1195
- "primary-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1196
- "primary-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1197
- "success-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1198
- "success-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1199
- "success-interactivePressed": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1200
- "success-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1201
- "success-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1202
- "warning-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1203
- "warning-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1204
- "warning-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1205
- "warning-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1206
- "danger-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1207
- "danger-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1208
- "danger-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1209
- "danger-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1210
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1211
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1212
- "neutral-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1213
- "neutral-textDisabled": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1214
- "neutral-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1215
- "neutral-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1216
- };
1217
- name: "color";
1218
- };
1219
- textAlign: {
1220
- values: {
1221
- center: {
1222
- default: string;
1223
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1224
- };
1225
- left: {
1226
- default: string;
1227
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1228
- };
1229
- right: {
1230
- default: string;
1231
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1232
- };
1233
- justify: {
1234
- default: string;
1235
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1236
- };
1237
- };
1238
- staticScale: TextAlign[];
1239
- name: "textAlign";
1240
- };
1241
- lineHeight: {
1242
- values: {
1243
- caption: {
1244
- default: string;
1245
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1246
- };
1247
- base: {
1248
- default: string;
1249
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1250
- };
1251
- highlight: {
1252
- default: string;
1253
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1254
- };
1255
- };
1256
- staticScale: {
1257
- readonly caption: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1258
- readonly base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1259
- readonly highlight: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1260
- };
1261
- name: "lineHeight";
1262
- };
1263
- fontWeight: {
1264
- values: {
1265
- regular: {
1266
- default: string;
1267
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1268
- };
1269
- medium: {
1270
- default: string;
1271
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1272
- };
1273
- bold: {
1274
- default: string;
1275
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1276
- };
1277
- };
1278
- staticScale: {
1279
- regular: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1280
- medium: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1281
- bold: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1282
- };
1283
- name: "fontWeight";
1284
- };
1285
- fontSize: {
1286
- values: {
1287
- caption: {
1288
- default: string;
1289
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1290
- };
1291
- base: {
1292
- default: string;
1293
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1294
- };
1295
- highlight: {
1296
- default: string;
1297
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1298
- };
1299
- };
1300
- staticScale: {
1301
- caption: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1302
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1303
- highlight: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1304
- };
1305
- name: "fontSize";
1306
- };
1307
- wordBreak: {
1308
- values: {
1309
- normal: {
1310
- default: string;
1311
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1312
- };
1313
- "break-word": {
1314
- default: string;
1315
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1316
- };
1317
- "break-all": {
1318
- default: string;
1319
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1320
- };
1321
- "keep-all": {
1322
- default: string;
1323
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1324
- };
1325
- };
1326
- staticScale: WordBreak[];
1327
- name: "wordBreak";
1328
- };
1329
- textDecoration: {
1330
- values: {
1331
- none: {
1332
- default: string;
1333
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1334
- };
1335
- "line-through": {
1336
- default: string;
1337
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1338
- };
1339
- underline: {
1340
- default: string;
1341
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1342
- };
1343
- };
1344
- staticScale: TextDecoration[];
1345
- name: "textDecoration";
1346
- };
1347
- textOverflow: {
1348
- values: {
1349
- clip: {
1350
- default: string;
1351
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1352
- };
1353
- ellipsis: {
1354
- default: string;
1355
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1356
- };
1357
- };
1358
- staticScale: TextOverflow[];
1359
- name: "textOverflow";
1360
- };
1361
- whiteSpace: {
1362
- values: {
1363
- pre: {
1364
- default: string;
1365
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1366
- };
1367
- normal: {
1368
- default: string;
1369
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1370
- };
1371
- nowrap: {
1372
- default: string;
1373
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1374
- };
1375
- "break-spaces": {
1376
- default: string;
1377
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1378
- };
1379
- "pre-line": {
1380
- default: string;
1381
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1382
- };
1383
- "pre-wrap": {
1384
- default: string;
1385
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1386
- };
1387
- };
1388
- staticScale: WhiteSpace[];
1389
- name: "whiteSpace";
1390
- };
1391
- overflow: {
1392
- values: {
1393
- hidden: {
1394
- default: string;
1395
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1396
- };
1397
- auto: {
1398
- default: string;
1399
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1400
- };
1401
- visible: {
1402
- default: string;
1403
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1404
- };
1405
- scroll: {
1406
- default: string;
1407
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1408
- };
1409
- };
1410
- staticScale: Overflow[];
1411
- name: "overflow";
1412
- };
1413
- };
1414
- } & {
1415
- config: {
1416
- lineClamp: {
1417
- dynamic: {
1418
- default: string;
1419
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1420
- };
1421
- dynamicScale: true;
1422
- name: "lineClamp";
1423
- vars: {
1424
- default: string;
1425
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1426
- };
1427
- };
1428
- WebkitLineClamp: {
1429
- dynamic: {
1430
- default: string;
1431
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1432
- };
1433
- dynamicScale: boolean;
1434
- name: "WebkitLineClamp";
1435
- vars: {
1436
- default: string;
1437
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
1438
- };
1439
- };
1440
- };
1441
- } & {
1442
- config: {
1443
- [x: string]: {
1444
- mappings: ("fontSize" | "fontWeight" | "color" | "lineHeight" | "textAlign" | "textOverflow" | "whiteSpace" | "wordBreak" | "lineClamp" | "overflow" | "textDecoration" | "WebkitLineClamp")[];
1445
- };
1446
- };
1447
- }
1448
- ]>;
1449
- properties: {
1450
- color: {
1451
- "ai-generative": "transparent";
1452
- currentColor: string;
1453
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1454
- "primary-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1455
- "primary-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1456
- "primary-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1457
- "success-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1458
- "success-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1459
- "success-interactivePressed": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1460
- "success-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1461
- "success-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1462
- "warning-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1463
- "warning-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1464
- "warning-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1465
- "warning-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1466
- "danger-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1467
- "danger-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1468
- "danger-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1469
- "danger-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1470
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1471
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1472
- "neutral-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1473
- "neutral-textDisabled": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1474
- "neutral-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1475
- "neutral-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1476
- };
1477
- textAlign: TextAlign[];
1478
- lineHeight: {
1479
- readonly caption: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1480
- readonly base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1481
- readonly highlight: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1482
- };
1483
- fontWeight: {
1484
- regular: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1485
- medium: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1486
- bold: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1487
- };
1488
- fontSize: {
1489
- caption: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1490
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1491
- highlight: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1492
- };
1493
- wordBreak: WordBreak[];
1494
- textDecoration: TextDecoration[];
1495
- textOverflow: TextOverflow[];
1496
- whiteSpace: WhiteSpace[];
1497
- overflow: Overflow[];
1498
- };
1499
- aiColors: {
1500
- readonly "ai-generative": "transparent";
1501
- };
1502
- aiStyles: {
1503
- readonly "ai-generative": string;
1504
- };
1505
- classnames: {
1506
- base: string;
1507
- trim: string;
1508
- aiGenerative: string;
1509
- aiStyles: {
1510
- readonly "ai-generative": string;
1511
- };
1512
- };
1513
- };
1514
- declare const propertiesTitle: {
1515
- color: {
1516
- "primary-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1517
- "primary-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1518
- "success-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1519
- "success-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1520
- "warning-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1521
- "warning-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1522
- "danger-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1523
- "danger-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1524
- "neutral-textHigh": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1525
- "neutral-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1526
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1527
- };
1528
- textAlign: TextAlign[];
1529
- fontSize: {
1530
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1531
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1532
- "1-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1533
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1534
- "2-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1535
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1536
- "3-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1537
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1538
- "4-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1539
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1540
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1541
- "7": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1542
- "8": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1543
- "9": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1544
- "10": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1545
- "11": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1546
- "12": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1547
- "14": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1548
- "16": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1549
- "18": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1550
- "20": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1551
- h1: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1552
- h2: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1553
- h3: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1554
- h4: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1555
- h5: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1556
- h6: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1557
- };
1558
- fontWeight: {
1559
- regular: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1560
- medium: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1561
- bold: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1562
- };
1563
- lineHeight: {
1564
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1565
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1566
- "1-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1567
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1568
- "2-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1569
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1570
- "3-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1571
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1572
- "4-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1573
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1574
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1575
- "7": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1576
- "8": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1577
- "9": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1578
- "10": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1579
- "11": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1580
- "12": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1581
- "14": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1582
- "16": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1583
- "18": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1584
- "20": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1585
- h1: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1586
- h2: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1587
- h3: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1588
- h4: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1589
- h5: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1590
- h6: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1591
- };
1592
- };
1593
- export type TitleColorProperties = keyof typeof propertiesTitle.color;
1594
- export type TitleFontSizeProperties = keyof typeof propertiesTitle.fontSize;
1595
- export type TitleFontWeightProperties = keyof typeof propertiesTitle.fontWeight;
1596
- export type TitleLineHeightProperties = keyof typeof propertiesTitle.lineHeight;
1597
- export type TitleConditions<T> = Conditions<T>;
1598
- export interface TitleSprinkle {
1599
- /**
1600
- * The fontSize property sets the size of the title.
1601
- * @default base
1602
- */
1603
- fontSize?: TitleFontSizeProperties | TitleConditions<TitleFontSizeProperties>;
1604
- /**
1605
- * The fontWeight property sets how thick or thin characters in title should be displayed.
1606
- * @default regular
1607
- */
1608
- fontWeight?: TitleFontWeightProperties | TitleConditions<TitleFontWeightProperties>;
1609
- /**
1610
- * The lineHeight property specifies the line height of the title.
1611
- * @default base
1612
- */
1613
- lineHeight?: TitleLineHeightProperties | TitleConditions<TitleLineHeightProperties>;
1614
- /**
1615
- * The textAlign property specifies the horizontal alignment of title.
1616
- * @default left
1617
- */
1618
- textAlign?: TextAlign | TitleConditions<TextAlign>;
1619
- /**
1620
- * The color property is used to set the color of the title.
1621
- * @default neutral-textLow
1622
- */
1623
- color?: TitleColorProperties | TitleConditions<TitleColorProperties>;
1624
- }
1625
- declare const list: {
1626
- classnames: {
1627
- container: string;
1628
- container__item: string;
1629
- skeleton: string;
1630
- };
1631
- sprinkle: ((props: {
1632
- padding?: "1" | "2" | "3" | "4" | "5" | "0-5" | "6" | "7" | "8" | undefined;
1633
- }) => string) & {
1634
- properties: Set<"padding">;
1635
- };
1636
- properties: {
1637
- padding: {
1638
- "0-5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1639
- "1": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1640
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1641
- "3": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1642
- "4": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1643
- "5": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1644
- "6": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1645
- "7": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1646
- "8": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1647
- };
1648
- };
1649
- };
1650
- declare const multiSelect: {
1651
- sprinkle: ((props: {
1652
- zIndex?: "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | {
1653
- xs?: "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | undefined;
1654
- md?: "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | undefined;
1655
- lg?: "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | undefined;
1656
- xl?: "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | undefined;
1657
- } | undefined;
1658
- }) => string) & {
1659
- properties: Set<"zIndex">;
1660
- };
1661
- properties: {
1662
- zIndex: {
1663
- "100": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1664
- "200": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1665
- "300": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1666
- "400": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1667
- "500": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1668
- "600": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1669
- "700": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1670
- "800": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1671
- "900": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1672
- };
1673
- };
1674
- classnames: {
1675
- appearance: Record<"success" | "warning" | "danger" | "neutral", string>;
1676
- container: string;
1677
- container__icon: string;
1678
- container__button: string;
1679
- };
1680
- };
1681
- declare const propertiesPopover: {
1682
- backgroundColor: {
1683
- "primary-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1684
- "primary-interactiveHover": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1685
- "success-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1686
- "danger-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1687
- "neutral-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1688
- "warning-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1689
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1690
- };
1691
- color: {
1692
- "primary-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1693
- "primary-interactiveHover": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1694
- "success-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1695
- "danger-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1696
- "neutral-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1697
- "warning-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1698
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1699
- };
1700
- padding: {
1701
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1702
- small: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1703
- none: string;
1704
- };
1705
- zIndex: {
1706
- "100": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1707
- "200": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1708
- "300": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1709
- "400": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1710
- "500": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1711
- "600": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1712
- "700": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1713
- "800": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1714
- "900": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1715
- };
1716
- overflow: Overflow[];
1717
- };
1718
- export type PopoverColorProperties = keyof typeof propertiesPopover.color;
1719
- export type PopoverBackgroundColorProperties = keyof typeof propertiesPopover.backgroundColor;
1720
- export type PopoverPaddingProperties = keyof typeof propertiesPopover.padding;
1721
- export type PopoverZIndexProperties = keyof typeof propertiesPopover.zIndex;
1722
- export interface PopoverSprinkle {
1723
- /**
1724
- * The width property specifies the width of a popover's content area.
1725
- * @default fit-content
1726
- */
1727
- width?: string | Conditions<string>;
1728
- /**
1729
- * The maxWidth property specifies the maximum width of a popover's content area.
1730
- */
1731
- maxWidth?: string | Conditions<string>;
1732
- /**
1733
- * The height property specifies the height of a popover's content area.
1734
- */
1735
- height?: string | Conditions<string>;
1736
- /**
1737
- * The zIndex property specifies the stack order of the popover.
1738
- */
1739
- zIndex?: PopoverZIndexProperties | Conditions<PopoverZIndexProperties>;
1740
- /**
1741
- * The backgroundColor property sets the background color of the popover.
1742
- * @default neutral-background
1743
- * @examples ["neutral-interactive", { xs: "neutral-surface", md: "neutral-interactive" }]
1744
- */
1745
- backgroundColor?: PopoverBackgroundColorProperties | Conditions<PopoverBackgroundColorProperties>;
1746
- /**
1747
- * The color property is used to set the color of the popover.
1748
- * @default neutral-background
1749
- */
1750
- color?: PopoverColorProperties | Conditions<PopoverColorProperties>;
1751
- /**
1752
- * The padding properties are used to generate space around an popover's content area.
1753
- * @default base
1754
- */
1755
- padding?: PopoverPaddingProperties | Conditions<PopoverPaddingProperties>;
1756
- /**
1757
- * The overflow shorthand property sets the desired behavior for an popover's content overflow.
1758
- */
1759
- overflow?: Overflow | Conditions<Overflow>;
1760
- }
1761
- declare const spinner: {
1762
- sprinkle: ((props: {
1763
- color?: "currentColor" | "primary-interactive" | "primary-surface" | "primary-textLow" | "success-textLow" | "success-surface" | "danger-interactive" | "danger-surface" | "danger-textLow" | "neutral-background" | "neutral-interactive" | "neutral-surface" | "neutral-textLow" | "success-interactive" | undefined;
1764
- }) => string) & {
1765
- properties: Set<"color">;
1766
- };
1767
- properties: {
1768
- color: {
1769
- currentColor: string;
1770
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1771
- "primary-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1772
- "primary-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1773
- "success-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1774
- "success-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1775
- "success-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1776
- "danger-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1777
- "danger-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1778
- "danger-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1779
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1780
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1781
- "neutral-interactive": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1782
- "neutral-textLow": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1783
- };
1784
- };
1785
- classnames: {
1786
- base: string;
1787
- };
1788
- };
1789
- declare const link: {
1790
- sprinkle: ((props: {
1791
- textDecoration?: TextDecoration | undefined;
1792
- fontSize?: "caption" | "base" | "highlight" | undefined;
1793
- lineHeight?: "caption" | "base" | "highlight" | undefined;
1794
- }) => string) & {
1795
- properties: Set<"fontSize" | "lineHeight" | "textDecoration">;
1796
- };
1797
- properties: {
1798
- textDecoration: TextDecoration[];
1799
- fontSize: {
1800
- caption: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1801
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1802
- highlight: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1803
- };
1804
- lineHeight: {
1805
- readonly caption: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1806
- readonly base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1807
- readonly highlight: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1808
- };
1809
- };
1810
- classnames: {
1811
- base: string;
1812
- appearance: Record<"primary" | "danger" | "neutral" | "neutral-background", string>;
1813
- };
1814
- };
1815
- export interface TooltipSprinkle {
1816
- /**
1817
- * The maxWidth property specifies the maximum width of a popover's content area.
1818
- */
1819
- maxWidth?: string | Conditions<string>;
1820
- }
1821
- declare const thumbnail: {
1822
- sprinkle: ((props: {
1823
- aspectRatio?: AspectRatio | undefined;
1824
- }) => string) & {
1825
- properties: Set<"aspectRatio">;
1826
- };
1827
- properties: {
1828
- aspectRatio: AspectRatio[];
1829
- };
1830
- classnames: {
1831
- container: string;
1832
- container__image: string;
1833
- container__placeholder: string;
1834
- skeleton: string;
1835
- width: string;
1836
- };
1837
- };
1838
- declare const accordion: {
1839
- sprinkle: ((props: {
1840
- borderTop?: "base" | "none" | undefined;
1841
- borderBottom?: "base" | "none" | undefined;
1842
- padding?: "base" | "none" | undefined;
1843
- }) => string) & {
1844
- properties: Set<"borderBottom" | "borderTop" | "padding">;
1845
- };
1846
- properties: {
1847
- borderTop: {
1848
- none: string;
1849
- base: string;
1850
- };
1851
- borderBottom: {
1852
- none: string;
1853
- base: string;
1854
- };
1855
- padding: {
1856
- none: string;
1857
- base: string;
1858
- };
1859
- };
1860
- classnames: {
1861
- header: string;
1862
- header_static: string;
1863
- header__content: string;
1864
- header__description: string;
1865
- header__title: string;
1866
- header_active: string;
1867
- body: string;
1868
- };
1869
- };
1870
- declare const card: {
1871
- classnames: {
1872
- container: string;
1873
- container__footer: string;
1874
- };
1875
- subComponents: {
1876
- header: {
1877
- sprinkle: ((props: {
1878
- padding?: "base" | "small" | "none" | undefined;
1879
- }) => string) & {
1880
- properties: Set<"padding">;
1881
- };
1882
- properties: {
1883
- padding: {
1884
- base: string;
1885
- small: string;
1886
- none: string;
1887
- };
1888
- };
1889
- };
1890
- body: {
1891
- sprinkle: ((props: {
1892
- padding?: "base" | "small" | "none" | undefined;
1893
- }) => string) & {
1894
- properties: Set<"padding">;
1895
- };
1896
- properties: {
1897
- padding: {
1898
- base: string;
1899
- small: string;
1900
- none: string;
1901
- };
1902
- };
1903
- };
1904
- footer: {
1905
- sprinkle: ((props: {
1906
- padding?: "base" | "small" | "none" | undefined;
1907
- }) => string) & {
1908
- properties: Set<"padding">;
1909
- };
1910
- properties: {
1911
- padding: {
1912
- base: string;
1913
- small: string;
1914
- none: string;
1915
- };
1916
- };
1917
- };
1918
- };
1919
- sprinkle: ((props: {
1920
- backgroundColor?: "primary-surface" | "primary-surfaceHighlight" | "success-surface" | "success-surfaceHighlight" | "warning-surface" | "warning-surfaceHighlight" | "danger-surface" | "danger-surfaceHighlight" | "neutral-background" | "neutral-surface" | "neutral-surfaceHighlight" | undefined;
1921
- padding?: "base" | "small" | "none" | undefined;
1922
- }) => string) & {
1923
- properties: Set<"backgroundColor" | "padding">;
1924
- };
1925
- properties: {
1926
- backgroundColor: {
1927
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1928
- "primary-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1929
- "success-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1930
- "success-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1931
- "danger-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1932
- "danger-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1933
- "warning-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1934
- "warning-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1935
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1936
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1937
- "neutral-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1938
- };
1939
- padding: {
1940
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1941
- small: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1942
- none: string;
1943
- };
1944
- };
1945
- };
1946
- declare const propertiesModal: {
1947
- padding: {
1948
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1949
- small: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
1950
- none: string;
1951
- };
1952
- };
1953
- export type PaddingProperties = keyof typeof propertiesModal.padding;
1954
- export interface ModalSprinkle {
1955
- /**
1956
- * The maxWidth property specifies the maxWidth of a modal's content area. The width of the modal will be defined by the width of the content in this prop.
1957
- * @default { xs: "100%", md: "500px" }
1958
- */
1959
- maxWidth?: string | Conditions<string>;
1960
- /**
1961
- * The padding properties are used to generate space around an modal's content area.
1962
- * @default base
1963
- */
1964
- padding?: PaddingProperties | Conditions<PaddingProperties>;
1965
- }
1966
- declare const modal: {
1967
- classnames: {
1968
- overlay: string;
1969
- overlayScoped: string;
1970
- container: string;
1971
- container__close: string;
1972
- container__footer: string;
1973
- };
1974
- subComponents: {
1975
- header: {
1976
- sprinkle: ((props: {
1977
- padding?: "base" | "small" | "none" | undefined;
1978
- }) => string) & {
1979
- properties: Set<"padding">;
1980
- };
1981
- properties: {
1982
- padding: {
1983
- base: string;
1984
- small: string;
1985
- none: string;
1986
- };
1987
- };
1988
- content: string;
1989
- };
1990
- body: {
1991
- sprinkle: ((props: {
1992
- padding?: "base" | "small" | "none" | undefined;
1993
- }) => string) & {
1994
- properties: Set<"padding">;
1995
- };
1996
- properties: {
1997
- padding: {
1998
- base: string;
1999
- small: string;
2000
- none: string;
2001
- };
2002
- };
2003
- };
2004
- footer: {
2005
- sprinkle: ((props: {
2006
- padding?: "base" | "small" | "none" | undefined;
2007
- }) => string) & {
2008
- properties: Set<"padding">;
2009
- };
2010
- properties: {
2011
- padding: {
2012
- base: string;
2013
- small: string;
2014
- none: string;
2015
- };
2016
- };
2017
- };
2018
- };
2019
- sprinkle: import("rainbow-sprinkles/dist/declarations/src/createRuntimeFn").SprinklesFn<[
2020
- {
2021
- config: {
2022
- maxWidth: {
2023
- dynamic: {
2024
- default: string;
2025
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2026
- };
2027
- dynamicScale: true;
2028
- name: "maxWidth";
2029
- vars: {
2030
- default: string;
2031
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2032
- };
2033
- };
2034
- padding: {
2035
- dynamic: {
2036
- default: string;
2037
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2038
- };
2039
- dynamicScale: {
2040
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2041
- small: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2042
- none: string;
2043
- };
2044
- name: "padding";
2045
- vars: {
2046
- default: string;
2047
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2048
- };
2049
- };
2050
- };
2051
- } & {
2052
- config: {
2053
- [x: string]: {
2054
- mappings: ("maxWidth" | "padding")[];
2055
- };
2056
- };
2057
- }
2058
- ]>;
2059
- properties: {
2060
- padding: {
2061
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2062
- small: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2063
- none: string;
2064
- };
2065
- };
2066
- };
2067
- declare const sidebarSprinkle: {
2068
- sprinkle: import("rainbow-sprinkles/dist/declarations/src/createRuntimeFn").SprinklesFn<[
2069
- {
2070
- config: {
2071
- zIndex: {
2072
- values: {
2073
- 100: {
2074
- default: string;
2075
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2076
- };
2077
- 200: {
2078
- default: string;
2079
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2080
- };
2081
- 300: {
2082
- default: string;
2083
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2084
- };
2085
- 400: {
2086
- default: string;
2087
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2088
- };
2089
- 500: {
2090
- default: string;
2091
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2092
- };
2093
- 600: {
2094
- default: string;
2095
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2096
- };
2097
- 700: {
2098
- default: string;
2099
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2100
- };
2101
- 800: {
2102
- default: string;
2103
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2104
- };
2105
- 900: {
2106
- default: string;
2107
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2108
- };
2109
- };
2110
- staticScale: {
2111
- "100": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2112
- "200": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2113
- "300": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2114
- "400": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2115
- "500": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2116
- "600": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2117
- "700": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2118
- "800": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2119
- "900": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2120
- };
2121
- name: "zIndex";
2122
- };
2123
- padding: {
2124
- values: {
2125
- base: {
2126
- default: string;
2127
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2128
- };
2129
- small: {
2130
- default: string;
2131
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2132
- };
2133
- none: {
2134
- default: string;
2135
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2136
- };
2137
- };
2138
- staticScale: {
2139
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2140
- small: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2141
- none: string;
2142
- };
2143
- name: "padding";
2144
- };
2145
- };
2146
- } & {
2147
- config: {
2148
- maxWidth: {
2149
- dynamic: {
2150
- default: string;
2151
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2152
- };
2153
- dynamicScale: true;
2154
- name: "maxWidth";
2155
- vars: {
2156
- default: string;
2157
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2158
- };
2159
- };
2160
- };
2161
- } & {
2162
- config: {
2163
- [x: string]: {
2164
- mappings: ("zIndex" | "maxWidth" | "padding")[];
2165
- };
2166
- };
2167
- }
2168
- ]>;
2169
- properties: {
2170
- zIndex: {
2171
- "100": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2172
- "200": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2173
- "300": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2174
- "400": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2175
- "500": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2176
- "600": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2177
- "700": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2178
- "800": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2179
- "900": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2180
- };
2181
- padding: {
2182
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2183
- small: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2184
- none: string;
2185
- };
2186
- };
2187
- };
2188
- export type SidebarPaddingProperties = keyof typeof sidebarSprinkle.properties.padding;
2189
- export type SidebarZIndexProperties = keyof typeof sidebarSprinkle.properties.zIndex;
2190
- export interface SidebarSprinkle {
2191
- /**
2192
- * The maxWidth property specifies the maxWidth of a sidebar's content area.
2193
- * @default 375px
2194
- */
2195
- maxWidth?: string | Conditions<string>;
2196
- /**
2197
- * The zIndex property specifies the stack order of the sidebar.
2198
- */
2199
- zIndex?: SidebarZIndexProperties | Conditions<SidebarZIndexProperties>;
2200
- /**
2201
- * The padding properties are used to generate space around an sidebar's content area.
2202
- * @default base
2203
- */
2204
- padding?: SidebarPaddingProperties | Conditions<SidebarPaddingProperties>;
2205
- }
2206
- declare const sidebar: {
2207
- sprinkle: import("rainbow-sprinkles/dist/declarations/src/createRuntimeFn").SprinklesFn<[
2208
- {
2209
- config: {
2210
- zIndex: {
2211
- values: {
2212
- 100: {
2213
- default: string;
2214
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2215
- };
2216
- 200: {
2217
- default: string;
2218
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2219
- };
2220
- 300: {
2221
- default: string;
2222
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2223
- };
2224
- 400: {
2225
- default: string;
2226
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2227
- };
2228
- 500: {
2229
- default: string;
2230
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2231
- };
2232
- 600: {
2233
- default: string;
2234
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2235
- };
2236
- 700: {
2237
- default: string;
2238
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2239
- };
2240
- 800: {
2241
- default: string;
2242
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2243
- };
2244
- 900: {
2245
- default: string;
2246
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2247
- };
2248
- };
2249
- staticScale: {
2250
- "100": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2251
- "200": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2252
- "300": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2253
- "400": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2254
- "500": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2255
- "600": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2256
- "700": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2257
- "800": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2258
- "900": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2259
- };
2260
- name: "zIndex";
2261
- };
2262
- padding: {
2263
- values: {
2264
- base: {
2265
- default: string;
2266
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2267
- };
2268
- small: {
2269
- default: string;
2270
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2271
- };
2272
- none: {
2273
- default: string;
2274
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2275
- };
2276
- };
2277
- staticScale: {
2278
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2279
- small: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2280
- none: string;
2281
- };
2282
- name: "padding";
2283
- };
2284
- };
2285
- } & {
2286
- config: {
2287
- maxWidth: {
2288
- dynamic: {
2289
- default: string;
2290
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2291
- };
2292
- dynamicScale: true;
2293
- name: "maxWidth";
2294
- vars: {
2295
- default: string;
2296
- conditions: Record<"xs" | "md" | "lg" | "xl", string>;
2297
- };
2298
- };
2299
- };
2300
- } & {
2301
- config: {
2302
- [x: string]: {
2303
- mappings: ("zIndex" | "maxWidth" | "padding")[];
2304
- };
2305
- };
2306
- }
2307
- ]>;
2308
- properties: {
2309
- zIndex: {
2310
- "100": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2311
- "200": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2312
- "300": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2313
- "400": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2314
- "500": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2315
- "600": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2316
- "700": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2317
- "800": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2318
- "900": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2319
- };
2320
- padding: {
2321
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2322
- small: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2323
- none: string;
2324
- };
2325
- };
2326
- classnames: {
2327
- overlay: string;
2328
- overlayScoped: string;
2329
- container: string;
2330
- containerScoped: string;
2331
- container__header: string;
2332
- container__body: string;
2333
- container__footer: string;
2334
- position: Record<"left" | "right", string>;
2335
- isVisible: string;
2336
- };
2337
- };
2338
- declare const propertiesTable: {
2339
- backgroundColor: {
2340
- transparent: string;
2341
- "neutral-background": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2342
- "neutral-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2343
- "neutral-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2344
- "primary-surface": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2345
- "primary-surfaceHighlight": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2346
- };
2347
- padding: {
2348
- base: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2349
- small: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2350
- none: string;
2351
- };
2352
- };
2353
- declare const propertiesWrapper: {
2354
- borderRadius: {
2355
- none: string;
2356
- "2": `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
2357
- };
2358
- };
2359
- export type TablePaddingProperties = keyof typeof propertiesTable.padding;
2360
- export type TableRowBackgroundColorProperties = keyof typeof propertiesTable.backgroundColor;
2361
- export type TableBorderRadiusProperties = keyof typeof propertiesWrapper.borderRadius;
2362
- export interface TableConditions<T> extends Conditions<T> {
2363
- rest?: T;
2364
- focus?: T;
2365
- active?: T;
2366
- hover?: T;
2367
- }
2368
- export interface TableSprinkle {
2369
- /**
2370
- * The width property specifies the width of a table's content area.
2371
- */
2372
- width?: string | TableConditions<string>;
2373
- /**
2374
- * The maxWidth property specifies the maxWidth of a table's content area.
2375
- */
2376
- maxWidth?: string | TableConditions<string>;
2377
- /**
2378
- * The minWidth property specifies the minWidth of a table's content area.
2379
- */
2380
- minWidth?: string | TableConditions<string>;
2381
- /**
2382
- * The backgroundColor property sets the background color of the table.
2383
- */
2384
- backgroundColor?: TableRowBackgroundColorProperties | TableConditions<TableRowBackgroundColorProperties>;
2385
- /**
2386
- * The padding properties are used to generate space around an table's content area.
2387
- */
2388
- padding?: TablePaddingProperties | TableConditions<TablePaddingProperties>;
2389
- }
2390
- export interface TableWrapperSprinkle {
2391
- /**
2392
- * Controls the border radius of the table wrapper.
2393
- * Use "none" for no border radius or "2" for the default token value.
2394
- * @default "2"
2395
- */
2396
- borderRadius?: TableBorderRadiusProperties;
2397
- }
2398
- export interface BoxProperties extends BoxSprinkle {
2399
- /**
2400
- * Element to be rendered inside the Box component.
2401
- * @TJS-type React.ReactNode
2402
- */
2403
- children?: ReactNode;
2404
- }
2405
- export type BoxBaseProps = BoxProperties & Omit<HTMLAttributes<HTMLElement>, "color">;
2406
- export declare const Box: PolymorphicForwardRefComponent<"div", BoxBaseProps>;
2407
- export type BoxProps = ComponentPropsWithRef<typeof Box>;
2408
- export type ButtonSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "className" | "data-testid">>;
2409
- export type ButtonSkeletonProps = ButtonSkeletonProperties;
2410
- declare const ButtonSkeleton: React.FC<ButtonSkeletonProps>;
2411
- export interface ButtonComponents {
2412
- Skeleton: typeof ButtonSkeleton;
2413
- }
2414
- export interface ButtonProperties {
2415
- /**
2416
- * The content of the button.
2417
- * @TJS-type React.ReactNode
2418
- */
2419
- children: ReactNode;
2420
- /**
2421
- * Change the visual style of the button.
2422
- * @default neutral
2423
- */
2424
- appearance?: "primary" | "danger" | "neutral" | "transparent" | "ai-primary" | "ai-secondary";
2425
- /**
2426
- * Disables the button, disallowing user interaction.
2427
- * @default false
2428
- */
2429
- disabled?: boolean;
2430
- /**
2431
- * Determines if the button should grow to fill the full width of its container.
2432
- * @default false
2433
- */
2434
- fullWidth?: boolean;
2435
- /**
2436
- * Change the size of the button.
2437
- * @default medium
2438
- */
2439
- size?: "large" | "medium" | "small";
2440
- }
2441
- export type ButtonBaseProps = ButtonProperties & ButtonHTMLAttributes<HTMLButtonElement>;
2442
- export declare const Button: PolymorphicForwardRefComponent<"button" | "a", ButtonBaseProps> & ButtonComponents;
2443
- export type ButtonProps = ComponentPropsWithRef<typeof Button>;
2444
- export type CheckboxSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "className" | "data-testid">>;
2445
- export type CheckboxSkeletonProps = CheckboxSkeletonProperties;
2446
- declare const CheckboxSkeleton: React.FC<CheckboxSkeletonProps>;
2447
- export interface CheckboxComponents {
2448
- Skeleton: typeof CheckboxSkeleton;
2449
- }
2450
- export interface CheckboxProperties {
2451
- /**
2452
- * The name of the input element.
2453
- */
2454
- name: string;
2455
- /**
2456
- * Change the visual style of the checkbox.
2457
- * @default neutral
2458
- */
2459
- appearance?: "primary" | "danger";
2460
- /**
2461
- * Modifies true/false value of the native checkbox.
2462
- */
2463
- checked?: boolean;
2464
- /**
2465
- * Modifies the native disabled state of the native checkbox.
2466
- */
2467
- disabled?: boolean;
2468
- /**
2469
- * If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.
2470
- * @default false
2471
- */
2472
- indeterminate?: boolean;
2473
- /**
2474
- * Text to be rendered inside the component.
2475
- */
2476
- label?: string;
2477
- /**
2478
- * Highlights the checkbox to indicate its value was generated by AI.
2479
- * Applies AI gradient border that persists regardless of checked state.
2480
- * @default false
2481
- */
2482
- aiGenerated?: boolean;
2483
- }
2484
- export type CheckboxProps = CheckboxProperties & InputHTMLAttributes<HTMLInputElement>;
2485
- export declare const Checkbox: React.FC<CheckboxProps> & CheckboxComponents;
2486
- export type ChipSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "height" | "className">> & {
2487
- /**
2488
- * This is an attribute used to identify a DOM node for testing purposes.
2489
- */
2490
- "data-testid"?: string;
2491
- };
2492
- export type ChipSkeletonProps = ChipSkeletonProperties;
2493
- declare const ChipSkeleton: React.FC<ChipSkeletonProps>;
2494
- export interface ChipComponents {
2495
- Skeleton: typeof ChipSkeleton;
2496
- }
2497
- export interface ChipProperties {
2498
- /**
2499
- Text to be displayed on chip.
2500
- */
2501
- text: string;
2502
- /**
2503
- * SVG icon to be displayed on chip.
2504
- * @TJS-type React.ReactNode
2505
- */
2506
- icon?: ReactNode;
2507
- /**
2508
- * Informs whether the close icon should be displayed.
2509
- */
2510
- removable?: boolean;
2511
- /**
2512
- * Highlights the chip to indicate its value was generated by AI.
2513
- * Applies AI gradient border and an AI outline.
2514
- */
2515
- aiGenerated?: boolean;
2516
- }
2517
- export type ChipProps = ChipProperties & ButtonHTMLAttributes<HTMLButtonElement | HTMLDivElement>;
2518
- export declare const Chip: React.FC<ChipProps> & ChipComponents;
2519
- export type FileUploaderSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "height" | "className">> & Partial<Pick<FileUploaderProps, "aspectRatio">> & {
2520
- /**
2521
- * This is an attribute used to identify a DOM node for testing purposes.
2522
- */
2523
- "data-testid"?: string;
2524
- };
2525
- export type FileUploaderSkeletonProps = FileUploaderSkeletonProperties;
2526
- declare const FileUploaderSkeleton: React.FC<FileUploaderSkeletonProps>;
2527
- export interface FileUploaderOverlayProperties {
2528
- /**
2529
- * Title text displayed in the overlay
2530
- */
2531
- title?: string;
2532
- /**
2533
- * Subtitle text displayed below the title
2534
- */
2535
- subtitle?: string;
2536
- /**
2537
- * Source URL for the image displayed in the overlay
2538
- */
2539
- imageSrc?: string;
2540
- /**
2541
- * Alt text for the image
2542
- */
2543
- imageAlt?: string;
2544
- /**
2545
- * Border color of the overlay
2546
- * @default primary-interactive
2547
- */
2548
- borderColor?: keyof typeof fileUploader.properties.borderColor;
2549
- /**
2550
- * Background color of the overlay
2551
- * @default primary-surface
2552
- */
2553
- backgroundColor?: keyof typeof fileUploader.properties.backgroundColor;
2554
- /**
2555
- * Border radius of the overlay
2556
- * @default 2
2557
- */
2558
- borderRadius?: keyof typeof fileUploader.properties.borderRadius;
2559
- /**
2560
- * Content to render inside the overlay
2561
- */
2562
- children?: ReactNode;
2563
- }
2564
- export type FileUploaderOverlayProps = FileUploaderOverlayProperties & Omit<HTMLAttributes<HTMLDivElement>, "title">;
2565
- declare const FileUploaderOverlay: React.FC<FileUploaderOverlayProps>;
2566
- export interface FileUploaderComponents {
2567
- Skeleton: typeof FileUploaderSkeleton;
2568
- Overlay: typeof FileUploaderOverlay;
2569
- }
2570
- export interface FileUploaderProperties {
2571
- /**
2572
- * Provide additional context to the action.
2573
- */
2574
- placeholder?: string;
2575
- /**
2576
- * Accept file types
2577
- * @default image/jpeg,image/gif,image/png
2578
- */
2579
- accept?: string;
2580
- /**
2581
- * Height value of the file uploader. Defaults to 100%.
2582
- * @default 100%
2583
- */
2584
- height?: string;
2585
- /**
2586
- * Width value of the file uploader. Defaults to 100%.
2587
- * @default 100%
2588
- */
2589
- width?: string;
2590
- /**
2591
- * Permitted aspect ratios for the size of the file uploader.
2592
- * @default 1/1
2593
- */
2594
- aspectRatio?: (typeof fileUploader.properties.aspectRatio)[number];
2595
- /**
2596
- * Defines the position of the placeholder in relation to the icon.
2597
- * @default column
2598
- */
2599
- flexDirection?: (typeof fileUploader.properties.flexDirection)[number];
2600
- /**
2601
- * Callback fired when files are dropped (before validation)
2602
- */
2603
- onDrop?: (event: DragEvent<HTMLLabelElement | HTMLDivElement>) => void;
2604
- /**
2605
- * Callback fired when all dropped files are rejected due to file type validation
2606
- */
2607
- onDropReject?: (event: DragEvent<HTMLLabelElement | HTMLDivElement>) => void;
2608
- /**
2609
- * Callback fired when files are successfully accepted and processed
2610
- */
2611
- onDropSuccess?: (event: DragEvent<HTMLLabelElement | HTMLDivElement>) => void;
2612
- /**
2613
- * Callback fired when an error occurs during file drop processing
2614
- */
2615
- onError?: (error: Error) => void;
2616
- /**
2617
- * Content to render inside the file uploader container
2618
- */
2619
- children?: ReactNode;
2620
- /**
2621
- * Custom overlay element to render when dragging files over the uploader.
2622
- * When defined, this overlay will be displayed instead of children during drag operations.
2623
- */
2624
- dragOverlay?: ReactNode;
2625
- /**
2626
- * When true, the file uploader will not be clickable and files can only be uploaded by dragging and dropping. Useful for invisible upload areas used along FileUploader.Overlay.
2627
- * @default false
2628
- */
2629
- disableClickUpload?: boolean;
2630
- /**
2631
- * When true, the file uploader will be rendered as an overlay. Useful for invisible upload areas used along FileUploader.Overlay.
2632
- * @default false
2633
- */
2634
- asOverlay?: boolean;
2635
- }
2636
- export type FileUploaderProps = FileUploaderProperties & {
2637
- dragOverlay?: ReactElement<FileUploaderOverlayProps>;
2638
- } & InputHTMLAttributes<HTMLInputElement>;
2639
- export declare const FileUploader: React.FC<FileUploaderProps> & FileUploaderComponents;
2640
- export type IconSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "height" | "className">> & {
2641
- /**
2642
- * This is an attribute used to identify a DOM node for testing purposes.
2643
- */
2644
- "data-testid"?: string;
2645
- };
2646
- export type IconSkeletonProps = IconSkeletonProperties;
2647
- declare const IconSkeleton: React.FC<IconSkeletonProps>;
2648
- export interface IconComponents {
2649
- Skeleton: typeof IconSkeleton;
2650
- }
2651
- export interface IconProperties {
2652
- /**
2653
- * The SVG contents to display in the Icon.
2654
- * @TJS-type React.ReactNode
2655
- */
2656
- source: ReactNode;
2657
- /**
2658
- * Set the color for the SVG fill.
2659
- * Use "ai-generative" to apply the Nimbus AI generative gradient.
2660
- * @default neutral-textLow
2661
- */
2662
- color?: keyof typeof icon.properties.color | "ai-generative";
2663
- /**
2664
- * The cursor property specifies the mouse cursor to be displayed when pointing over an element.
2665
- * @default inherit
2666
- */
2667
- cursor?: (typeof icon.properties.cursor)[number];
2668
- }
2669
- export type IconProps = IconProperties & HTMLAttributes<HTMLDivElement>;
2670
- export declare const Icon: React.FC<IconProps> & IconComponents;
2671
- /**
2672
- * Checks if a color value is valid (exists and is not "none" or "transparent")
2673
- * @param color - The color value to check
2674
- * @returns True if color is valid, false otherwise
2675
- */
2676
- export declare const isValidColorValue: (color: string | undefined) => boolean;
2677
- /**
2678
- * Checks if a color value can use gradient (valid and not already a URL reference)
2679
- * @param color - The color value to check
2680
- * @returns True if color can use gradient, false otherwise
2681
- */
2682
- export declare const canUseGradient: (color: string) => boolean;
2683
- /**
2684
- * Checks if a color value is a gradient
2685
- * @param color - The color value to check
2686
- * @returns True if color is a known gradient value, false otherwise
2687
- */
2688
- export declare const isGradient: (color: string) => boolean;
2689
- /**
2690
- * Collection of known gradient color values
2691
- */
2692
- export declare const GRADIENT_COLORS: Set<string>;
2693
- export type IconButtonSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "height" | "className">> & {
2694
- /**
2695
- * This is an attribute used to identify a DOM node for testing purposes.
2696
- */
2697
- "data-testid"?: string;
2698
- };
2699
- export type IconButtonSkeletonProps = IconButtonSkeletonProperties;
2700
- declare const IconButtonSkeleton: React.FC<IconButtonSkeletonProps>;
2701
- export interface IconButtonComponents {
2702
- Skeleton: typeof IconButtonSkeleton;
2703
- }
2704
- export interface IconButtonProperties extends IconButtonSprinkle {
2705
- /**
2706
- * Type of html tag to create for the Icon Button component.
2707
- * @default button
2708
- */
2709
- as?: "button" | "div";
2710
- /**
2711
- * The SVG contents to display in the Icon button.
2712
- * @TJS-type React.ReactNode
2713
- */
2714
- source: ReactNode;
2715
- /**
2716
- * Set the color for the inner Icon fill.
2717
- * @default neutral-textHigh
2718
- */
2719
- color?: IconProps["color"];
2720
- /**
2721
- * AI gradient background appearance for the button container.
2722
- * When provided, container color/border sprinkles are ignored in favor of gradient styles.
2723
- */
2724
- appearance?: "ai-generative";
2725
- }
2726
- export type IconButtonProps = IconButtonProperties & ButtonHTMLAttributes<HTMLButtonElement | HTMLDivElement>;
2727
- export declare const IconButton: React.FC<IconButtonProps> & IconButtonComponents;
2728
- export type InputPasswordProperties = Pick<InputBaseProps, "appearance" | "disabled" | "aiGenerated">;
2729
- declare const InputPassword: React.ForwardRefExoticComponent<InputPasswordProperties & React.InputHTMLAttributes<HTMLInputElement> & React.RefAttributes<HTMLInputElement>>;
2730
- export type InputSearchProperties = Pick<InputBaseProps, "appearance" | "disabled" | "aiGenerated">;
2731
- declare const InputSearch: React.ForwardRefExoticComponent<InputSearchProperties & React.InputHTMLAttributes<HTMLInputElement> & React.RefAttributes<HTMLInputElement>>;
2732
- export type InputSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "className" | "data-testid">>;
2733
- export type InputSkeletonProps = InputSkeletonProperties;
2734
- declare const InputSkeleton: React.FC<InputSkeletonProps>;
2735
- export interface InputComponents {
2736
- Password: typeof InputPassword;
2737
- Search: typeof InputSearch;
2738
- Skeleton: typeof InputSkeleton;
2739
- }
2740
- export interface InputProperties {
2741
- /**
2742
- * Change the visual style of the input.
2743
- * @default neutral
2744
- */
2745
- appearance?: "neutral" | "success" | "warning" | "danger" | "ai-generative";
2746
- /**
2747
- * Highlights the field to indicate its value was generated by AI.
2748
- * Applies AI gradient border, white background and an AI focus ring.
2749
- */
2750
- aiGenerated?: boolean;
2751
- /**
2752
- * Disables the input, disallowing user interaction.
2753
- */
2754
- disabled?: boolean;
2755
- /**
2756
- * Sent icon display position
2757
- * @default start
2758
- */
2759
- appendPosition?: "end" | "start";
2760
- /**
2761
- * SVG icon to be displayed on input.
2762
- * @TJS-type React.ReactNode
2763
- */
2764
- append?: ReactNode;
2765
- /**
2766
- * This is an attribute used to identify a DOM node for testing purposes.
2767
- */
2768
- "data-testid"?: string;
2769
- }
2770
- export type InputBaseProps = InputProperties & InputHTMLAttributes<HTMLInputElement>;
2771
- export declare const Input: React.ForwardRefExoticComponent<InputProperties & React.InputHTMLAttributes<HTMLInputElement> & React.RefAttributes<HTMLInputElement>> & InputComponents;
2772
- export type InputProps = ComponentPropsWithRef<typeof Input>;
2773
- export type LabelSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "height" | "className">> & {
2774
- /**
2775
- * This is an attribute used to identify a DOM node for testing purposes.
2776
- */
2777
- "data-testid"?: string;
2778
- };
2779
- export type LabelSkeletonProps = LabelSkeletonProperties;
2780
- declare const LabelSkeleton: React.FC<LabelSkeletonProps>;
2781
- export interface LabelComponents {
2782
- Skeleton: typeof LabelSkeleton;
2783
- }
2784
- export interface LabelProperties {
2785
- /**
2786
- * The content of the label.
2787
- * @TJS-type React.ReactNode
2788
- */
2789
- children: ReactNode;
2790
- /**
2791
- * The for attribute specifies which form element a label is bound to.
2792
- */
2793
- htmlFor?: string;
2794
- /**
2795
- * If true the label will be visually hidden but maintain accessibility purpose
2796
- * @default false
2797
- */
2798
- hidden?: boolean;
2799
- }
2800
- export type LabelProps = LabelProperties & HTMLAttributes<HTMLElement>;
2801
- export declare const Label: React.FC<LabelProps> & LabelComponents;
2802
- export type LinkSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "className" | "data-testid">>;
2803
- export type LinkSkeletonProps = LinkSkeletonProperties;
2804
- declare const LinkSkeleton: React.FC<LinkSkeletonProps>;
2805
- export interface LinkComponents {
2806
- Skeleton: typeof LinkSkeleton;
2807
- }
2808
- export interface LinkProperties {
2809
- /**
2810
- * The content of the link.
2811
- * @TJS-type React.ReactNode
2812
- */
2813
- children: ReactNode;
2814
- /**
2815
- * Change the visual style of the link.
2816
- * @default neutral
2817
- */
2818
- appearance?: "primary" | "danger" | "neutral" | "neutral-background";
2819
- /**
2820
- * The textDecoration property specifies the decoration added to link.
2821
- * @default neutral
2822
- */
2823
- textDecoration?: (typeof link.properties.textDecoration)[number];
2824
- /**
2825
- * The fontSize property sets the size of the link.
2826
- * @default base
2827
- */
2828
- fontSize?: keyof typeof link.properties.fontSize;
2829
- /**
2830
- * The lineHeight property specifies the line height of the link
2831
- * @default base
2832
- */
2833
- lineHeight?: keyof typeof link.properties.lineHeight;
2834
- }
2835
- export type LinkBaseProps = LinkProperties & HTMLAttributes<HTMLElement>;
2836
- export declare const Link: PolymorphicForwardRefComponent<"button" | "a", LinkBaseProps> & LinkComponents;
2837
- export type LinkProps = ComponentPropsWithRef<typeof Link>;
2838
- export type ListSkeletonItemProperties = Partial<Pick<SkeletonProps, "width">> & Partial<Pick<SkeletonProps, "height">> & {
2839
- /**
2840
- * This is an attribute used to identify a DOM node for testing purposes.
2841
- */
2842
- "data-testid"?: string;
2843
- };
2844
- export type ListSkeletonItemProps = ListSkeletonItemProperties;
2845
- declare const ListSkeletonItem: React.FC<ListSkeletonItemProps>;
2846
- export interface ListSkeletonProperties {
2847
- /**
2848
- * The content of the list skeleton.
2849
- * @TJS-type React.ReactNode
2850
- */
2851
- children: ReactNode;
2852
- /**
2853
- * This is an attribute used to identify a DOM node for testing purposes.
2854
- */
2855
- "data-testid"?: string;
2856
- }
2857
- export type ListSkeletonProps = ListSkeletonProperties & HTMLAttributes<HTMLDivElement>;
2858
- declare const ListSkeleton: React.FC<ListSkeletonProps>;
2859
- export interface ListItemProperties {
2860
- /**
2861
- * The content of the list item.
2862
- * @TJS-type React.ReactNode
2863
- */
2864
- children: ReactNode;
2865
- }
2866
- export type ListItemProps = ListItemProperties & HTMLAttributes<HTMLLIElement>;
2867
- declare const ListItem: React.FC<ListItemProps>;
2868
- export interface ListComponents {
2869
- Skeleton: typeof ListSkeleton;
2870
- SkeletonItem: typeof ListSkeletonItem;
2871
- Item: typeof ListItem;
2872
- }
2873
- export interface ListProperties {
2874
- /**
2875
- * The content of the list.
2876
- * @TJS-type React.ReactNode
2877
- */
2878
- children: ReactNode;
2879
- /**
2880
- * Determines the type of html list that will be rendered
2881
- * @default ul
2882
- */
2883
- as?: "ul" | "ol";
2884
- /**
2885
- * The padding of the list.
2886
- * @default 6
2887
- */
2888
- padding?: keyof typeof list.properties.padding;
2889
- }
2890
- export type ListProps = ListProperties & HTMLAttributes<HTMLUListElement | HTMLOListElement>;
2891
- export declare const List: React.FC<ListProps> & ListComponents;
2892
- export type MultiSelectSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "className" | "data-testid">>;
2893
- export type MultiSelectSkeletonProps = MultiSelectSkeletonProperties & HTMLAttributes<HTMLDivElement>;
2894
- declare const MultiSelectSkeleton: React.FC<MultiSelectSkeletonProps>;
2895
- export interface MultiSelectComponents {
2896
- Skeleton: typeof MultiSelectSkeleton;
2897
- }
2898
- export interface MultiSelectOption {
2899
- /**
2900
- * Label for the option.
2901
- */
2902
- label: string;
2903
- /**
2904
- * Value of the option
2905
- */
2906
- value: string;
2907
- }
2908
- export interface MultiSelectProperties {
2909
- /**
2910
- * The name of the wrapper element or the select element when native.
2911
- */
2912
- name: string;
2913
- /**
2914
- * The id of the wrapper element or the select element when native.
2915
- */
2916
- id: string;
2917
- /**
2918
- * Change the visual style of the select.
2919
- * @default neutral
2920
- */
2921
- appearance?: "success" | "warning" | "danger" | "neutral";
2922
- /**
2923
- * Options of the MultiSelect
2924
- */
2925
- options: MultiSelectOption[];
2926
- /**
2927
- * Options of the MultiSelect
2928
- */
2929
- onChange?: (values: MultiSelectOption[]) => void;
2930
- /**
2931
- * Deafult of the MultiSelect
2932
- */
2933
- value?: MultiSelectOption[];
2934
- /**
2935
- * ZIndex of the MultiSelect
2936
- */
2937
- zIndex?: keyof typeof multiSelect.properties.zIndex;
2938
- }
2939
- export type MultiSelectBaseProps = MultiSelectProperties & Omit<InputHTMLAttributes<HTMLInputElement>, "children" | "value">;
2940
- export declare const MultiSelect: React.FC<MultiSelectBaseProps> & MultiSelectComponents;
2941
- export type MultiSelectProps = ComponentPropsWithRef<typeof MultiSelect>;
2942
- export type PopoverPlacement = "top" | "right" | "bottom" | "left" | "bottom-start" | "bottom-end" | "left-start" | "left-end" | "right-start" | "right-end" | "top-start" | "top-end";
2943
- export interface PopoverProperties extends PopoverSprinkle {
2944
- /**
2945
- * An HTML element, or a function that returns one. It's used to set the position of the popover.
2946
- * @TJS-type React.ReactNode | ((data: { open: boolean, setVisibility: (visibility: boolean) => void }) => React.ReactNode);
2947
- */
2948
- children: ReactNode | ((data: {
2949
- open: boolean;
2950
- setVisibility: (visibility: boolean) => void;
2951
- }) => ReactNode);
2952
- /**
2953
- * The content of the popover.
2954
- * @TJS-type React.ReactNode
2955
- */
2956
- content: ReactNode;
2957
- /**
2958
- * If true, the component is shown.
2959
- */
2960
- visible?: boolean;
2961
- /**
2962
- * Function to control popover opening and closing.
2963
- * @TJS-type (visible: boolean) => void;
2964
- */
2965
- onVisibility?: (visible: boolean) => void;
2966
- /**
2967
- * Conditional for displaying the popover arrow.
2968
- * @default true
2969
- */
2970
- arrow?: boolean;
2971
- /**
2972
- * A common feature of select dropdowns is that the dropdown matches the width of the reference regardless of its contents.
2973
- * @default false
2974
- */
2975
- matchReferenceWidth?: boolean;
2976
- /**
2977
- * Position of the popover.
2978
- * @default bottom
2979
- */
2980
- position?: PopoverPlacement;
2981
- /**
2982
- * Adds hover event listeners that change the open state, like CSS :hover.
2983
- * @default false
2984
- */
2985
- enabledHover?: boolean;
2986
- /**
2987
- * Adds click event listeners that change the open state.
2988
- * @default true
2989
- */
2990
- enabledClick?: boolean;
2991
- /**
2992
- * Adds listeners that dismiss (close) the floating element.
2993
- * @default true
2994
- */
2995
- enabledDismiss?: boolean;
2996
- /**
2997
- * Offest displaces the floating element from its core placement along the specified axes.
2998
- * @default 10
2999
- */
3000
- offset?: number;
3001
- /**
3002
- * When enabled, renders an invisible overlay that prevents accidental clicks on elements behind the popover.
3003
- * @default false
3004
- */
3005
- renderOverlay?: boolean;
3006
- }
3007
- export type PopoverProps = PopoverProperties & Omit<HTMLAttributes<HTMLDivElement>, "children" | "content">;
3008
- export declare const Popover: React.FC<PopoverProps>;
3009
- export type RadioSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "className">> & Partial<Pick<RadioProps, "as">> & {
3010
- /**
3011
- * This is an attribute used to identify a DOM node for testing purposes.
3012
- */
3013
- "data-testid"?: string;
3014
- };
3015
- export type RadioSkeletonProps = RadioSkeletonProperties;
3016
- declare const RadioSkeleton: React.FC<RadioSkeletonProps>;
3017
- export interface RadioComponents {
3018
- Skeleton: typeof RadioSkeleton;
3019
- }
3020
- export interface RadioProperties {
3021
- /**
3022
- * Name attribute of the input element.
3023
- */
3024
- name: string;
3025
- /**
3026
- * Change the visual style of the radio.
3027
- * @default radio
3028
- */
3029
- as?: "radio" | "button";
3030
- /**
3031
- * Modifies true/false value of the native radio.
3032
- */
3033
- checked?: boolean;
3034
- /**
3035
- * Modifies the native disabled state of the native radio.
3036
- */
3037
- disabled?: boolean;
3038
- /**
3039
- * Text to be rendered inside the component.
3040
- */
3041
- label?: string;
3042
- }
3043
- export type RadioProps = RadioProperties & InputHTMLAttributes<HTMLInputElement>;
3044
- export declare const Radio: React.FC<RadioProps> & RadioComponents;
3045
- export interface SelectGroupProperties {
3046
- /**
3047
- * Label for the option group.
3048
- */
3049
- label: string;
3050
- /**
3051
- * The content of the option group.
3052
- * @TJS-type React.ReactNode
3053
- */
3054
- children: ReactNode;
3055
- }
3056
- export type SelectGroupProps = SelectGroupProperties & OptgroupHTMLAttributes<HTMLOptGroupElement>;
3057
- declare const SelectGroup: React.FC<SelectGroupProps>;
3058
- export interface SelectOptionProperties {
3059
- /**
3060
- * Label for the option.
3061
- */
3062
- label: string;
3063
- /**
3064
- * Value of the option
3065
- */
3066
- value: string;
3067
- }
3068
- export type SelectOptionProps = SelectOptionProperties & OptionHTMLAttributes<HTMLOptionElement>;
3069
- declare const SelectOption: React.FC<SelectOptionProps>;
3070
- export type SelectSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "className" | "data-testid">>;
3071
- export type SelectSkeletonProps = SelectSkeletonProperties;
3072
- declare const SelectSkeleton: React.FC<SelectSkeletonProps>;
3073
- export interface SelectComponents {
3074
- Group: typeof SelectGroup;
3075
- Option: typeof SelectOption;
3076
- Skeleton: typeof SelectSkeleton;
3077
- }
3078
- export interface SelectProperties {
3079
- /**
3080
- * The name of the wrapper element or the select element when native.
3081
- */
3082
- name: string;
3083
- /**
3084
- * The id of the wrapper element or the select element when native.
3085
- */
3086
- id: string;
3087
- /**
3088
- * The content of the select.
3089
- * @TJS-type React.ReactNode
3090
- */
3091
- children: ReactNode;
3092
- /**
3093
- * Change the visual style of the select.
3094
- * @default neutral
3095
- */
3096
- appearance?: "success" | "warning" | "danger" | "neutral" | "ai-generative";
3097
- /**
3098
- * Shows ai-generative appearance with active ai focus shadow.
3099
- * When true, this styling takes precedence over `appearance`.
3100
- * @default false
3101
- */
3102
- aiGenerated?: boolean;
3103
- }
3104
- export declare const Select: React.ForwardRefExoticComponent<SelectProperties & React.SelectHTMLAttributes<HTMLSelectElement> & React.InputHTMLAttributes<HTMLSelectElement> & React.RefAttributes<HTMLSelectElement>> & SelectComponents;
3105
- export type SelectProps = ComponentPropsWithRef<typeof Select>;
3106
- export interface SpinnerProperties {
3107
- /**
3108
- * Sets the width and height of the spinner.
3109
- * @default large
3110
- */
3111
- size?: "small" | "medium" | "large" | number;
3112
- /**
3113
- * Set the color for the spinner SVG fill.
3114
- * @default primary-interactive
3115
- */
3116
- color?: keyof typeof spinner.properties.color;
3117
- }
3118
- export type SpinnerProps = SpinnerProperties & SVGAttributes<SVGElement>;
3119
- export declare const Spinner: React.FC<SpinnerProps>;
3120
- /**
3121
- * Available appearance variants for the slider fill.
3122
- * Controls the color scheme of the active range portion of the slider.
3123
- */
3124
- export type SliderAppearance = "primary" | "success" | "warning" | "danger" | "neutral";
3125
- /**
3126
- * Common properties shared between single and range slider modes.
3127
- */
3128
- export interface SliderCommonProperties {
3129
- /**
3130
- * The minimum value of the slider range.
3131
- * @default 0
3132
- */
3133
- min?: number;
3134
- /**
3135
- * The maximum value of the slider range.
3136
- * @default 100
3137
- */
3138
- max?: number;
3139
- /**
3140
- * The step increment between values.
3141
- * @default 1
3142
- */
3143
- step?: number;
3144
- /**
3145
- * Visual appearance of the slider fill.
3146
- * @default "primary"
3147
- */
3148
- appearance?: SliderAppearance;
3149
- /**
3150
- * Whether the slider is disabled.
3151
- * @default false
3152
- */
3153
- disabled?: boolean;
3154
- /**
3155
- * This is an attribute used to identify a DOM node for testing purposes.
3156
- */
3157
- "data-testid"?: string;
3158
- }
3159
- /**
3160
- * Properties specific to single value slider mode.
3161
- * Used for documentation generation.
3162
- */
3163
- export interface SliderProperties extends SliderCommonProperties {
3164
- /**
3165
- * The current value of the slider (single mode).
3166
- */
3167
- value: number;
3168
- /**
3169
- * Callback fired when the value changes.
3170
- */
3171
- onChange?: (value: number) => void;
3172
- /**
3173
- * Callback fired when the user finishes interacting with the slider.
3174
- */
3175
- onChangeEnd?: (value: number) => void;
3176
- /**
3177
- * Accessible label for the slider thumb.
3178
- * @default "Value"
3179
- */
3180
- ariaLabel?: string;
3181
- }
3182
- /**
3183
- * Properties specific to range slider mode (two thumbs).
3184
- */
3185
- export interface SliderRangeProperties extends SliderCommonProperties {
3186
- /**
3187
- * The current minimum value selected on the slider.
3188
- */
3189
- minValue: number;
3190
- /**
3191
- * The current maximum value selected on the slider.
3192
- */
3193
- maxValue: number;
3194
- /**
3195
- * Callback fired when the min or max value changes.
3196
- */
3197
- onChange?: (minValue: number, maxValue: number) => void;
3198
- /**
3199
- * Callback fired when the min value changes.
3200
- */
3201
- onMinChange?: (value: number) => void;
3202
- /**
3203
- * Callback fired when the max value changes.
3204
- */
3205
- onMaxChange?: (value: number) => void;
3206
- /**
3207
- * Callback fired when the user finishes interacting with the slider.
3208
- */
3209
- onChangeEnd?: (minValue: number, maxValue: number) => void;
3210
- /**
3211
- * Accessible label for the minimum value thumb.
3212
- * @default "Minimum value"
3213
- */
3214
- minAriaLabel?: string;
3215
- /**
3216
- * Accessible label for the maximum value thumb.
3217
- * @default "Maximum value"
3218
- */
3219
- maxAriaLabel?: string;
3220
- }
3221
- /**
3222
- * Props for single value slider mode.
3223
- */
3224
- export type SliderBaseProps = SliderProperties & Omit<HTMLAttributes<HTMLDivElement>, "onChange" | "style">;
3225
- /**
3226
- * Props for range slider mode.
3227
- */
3228
- export type SliderRangeBaseProps = SliderRangeProperties & Omit<HTMLAttributes<HTMLDivElement>, "onChange" | "className" | "style">;
3229
- declare const SliderRange: React.ForwardRefExoticComponent<SliderRangeProperties & Omit<React.HTMLAttributes<HTMLDivElement>, "className" | "style" | "onChange"> & React.RefAttributes<HTMLDivElement>>;
3230
- export type SliderRangeProps = ComponentPropsWithRef<typeof SliderRange>;
3231
- declare const SliderBase: React.ForwardRefExoticComponent<SliderProperties & Omit<React.HTMLAttributes<HTMLDivElement>, "style" | "onChange"> & React.RefAttributes<HTMLDivElement>>;
3232
- /**
3233
- * Slider component with Range subcomponent.
3234
- *
3235
- * @example
3236
- * // Single value slider
3237
- * <Slider value={50} onChange={(value) => console.log(value)} />
3238
- *
3239
- * @example
3240
- * // Range slider
3241
- * <Slider.Range minValue={25} maxValue={75} onChange={(min, max) => console.log(min, max)} />
3242
- */
3243
- export declare const Slider: React.ForwardRefExoticComponent<SliderProperties & Omit<React.HTMLAttributes<HTMLDivElement>, "style" | "onChange"> & React.RefAttributes<HTMLDivElement>> & {
3244
- Range: React.ForwardRefExoticComponent<SliderRangeProperties & Omit<React.HTMLAttributes<HTMLDivElement>, "className" | "style" | "onChange"> & React.RefAttributes<HTMLDivElement>>;
3245
- };
3246
- export type SliderProps = ComponentPropsWithRef<typeof SliderBase>;
3247
- export type TagSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "height" | "className">> & {
3248
- /**
3249
- * This is an attribute used to identify a DOM node for testing purposes.
3250
- */
3251
- "data-testid"?: string;
3252
- };
3253
- export type TagSkeletonProps = TagSkeletonProperties;
3254
- declare const TagSkeleton: React.FC<TagSkeletonProps>;
3255
- export interface TagComponents {
3256
- Skeleton: typeof TagSkeleton;
3257
- }
3258
- export interface TagProperties {
3259
- /**
3260
- * The content of the tag.
3261
- * @TJS-type React.ReactNode
3262
- */
3263
- children: ReactNode;
3264
- /**
3265
- * Change the visual style of the tag.
3266
- * @default neutral
3267
- */
3268
- appearance?: "primary" | "success" | "warning" | "danger" | "neutral" | "ai-generative";
3269
- }
3270
- export type TagProps = TagProperties & HTMLAttributes<HTMLDivElement>;
3271
- export declare const Tag: React.FC<TagProps> & TagComponents;
3272
- export type TextSkeletonProperties = {
3273
- fontSize?: keyof typeof text.properties.fontSize;
3274
- } & Partial<Pick<SkeletonProps, "width" | "height" | "className" | "data-testid">>;
3275
- export type TextSkeletonProps = TextSkeletonProperties;
3276
- declare const TextSkeleton: React.FC<TextSkeletonProps>;
3277
- export interface TextComponents {
3278
- Skeleton: typeof TextSkeleton;
3279
- }
3280
- export interface TextProperties extends Omit<TextSprinkle, "WebkitLineClamp"> {
3281
- /**
3282
- * The content of the link.
3283
- * @TJS-type React.ReactNode
3284
- */
3285
- children: ReactNode;
3286
- /**
3287
- * Type of html tag to create for the Text component.
3288
- * @default p
3289
- */
3290
- as?: "p" | "span";
3291
- }
3292
- export type TextProps = TextProperties & Omit<TextSprinkle, "WebkitLineClamp"> & HTMLAttributes<HTMLParagraphElement>;
3293
- export declare const Text: React.FC<TextProps> & TextComponents;
3294
- export type TextareaSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "className" | "data-testid">>;
3295
- export type TextareaSkeletonProps = TextareaSkeletonProperties;
3296
- declare const TextareaSkeleton: React.FC<TextareaSkeletonProps>;
3297
- export interface TextareaComponents {
3298
- Skeleton: typeof TextareaSkeleton;
3299
- }
3300
- export interface TextareaProperties {
3301
- /**
3302
- * Change the visual style of the textarea.
3303
- * @default neutral
3304
- */
3305
- appearance?: "neutral" | "success" | "warning" | "danger" | "ai-generative" | "transparent";
3306
- /**
3307
- * Highlights the field to indicate its value was generated by AI.
3308
- * Applies AI gradient border, white background and an AI focus ring.
3309
- */
3310
- aiGenerated?: boolean;
3311
- /**
3312
- * Number of lines to be rendered for the user to input text
3313
- * @default 2
3314
- */
3315
- lines?: number;
3316
- /**
3317
- * Controls intrinsic sizing behavior of the field. When true, the textarea will grow with content up to the maxLines limit (if provided) and then scroll.
3318
- * @default false
3319
- */
3320
- autoGrow?: boolean;
3321
- /**
3322
- * Caps the textarea visual height to the given number of lines.
3323
- * When used together with autoGrow=true, the textarea will grow
3324
- * with content up to this limit and then scroll.
3325
- */
3326
- maxLines?: number;
3327
- /**
3328
- * Sets the minimum height of the textarea to the given number of lines.
3329
- * The textarea will never shrink below this height, even when empty.
3330
- */
3331
- minLines?: number;
3332
- /**
3333
- * ID of the textarea
3334
- * */
3335
- id: string;
3336
- /**
3337
- * Enable/disable textarea resize functionality
3338
- * @default true
3339
- */
3340
- resize?: boolean;
3341
- }
3342
- export declare const Textarea: React.ForwardRefExoticComponent<TextareaProperties & React.TextareaHTMLAttributes<HTMLTextAreaElement> & React.InputHTMLAttributes<HTMLTextAreaElement> & React.RefAttributes<HTMLTextAreaElement>> & TextareaComponents;
3343
- export type TextareaProps = ComponentPropsWithRef<typeof Textarea>;
3344
- export type ThumbnailSkeletonProperties = Partial<Pick<ThumbnailProps, "aspectRatio">> & Partial<Pick<SkeletonProps, "width" | "className" | "data-testid">>;
3345
- export type ThumbnailSkeletonProps = ThumbnailSkeletonProperties;
3346
- declare const ThumbnailSkeleton: React.FC<ThumbnailSkeletonProps>;
3347
- export interface ThumbnailComponents {
3348
- Skeleton: typeof ThumbnailSkeleton;
3349
- }
3350
- export interface ThumbnailProperties {
3351
- /**
3352
- * The required alt attribute specifies an alternate text for an image, if the image cannot be displayed.
3353
- */
3354
- alt: string;
3355
- /**
3356
- * The content of the thumbnail.
3357
- * @TJS-type React.ReactNode
3358
- */
3359
- children?: ReactNode;
3360
- /**
3361
- * Permitted aspect ratios for the size of the thumbnail image.
3362
- * @default 1/1
3363
- */
3364
- aspectRatio?: (typeof thumbnail.properties.aspectRatio)[number];
3365
- /**
3366
- * Width value of the thumbnail image. Defaults to 100%.
3367
- * @default 100%
3368
- */
3369
- width?: string;
3370
- }
3371
- export type ThumbnailProps = ThumbnailProperties & ImgHTMLAttributes<HTMLImageElement>;
3372
- export declare const Thumbnail: React.FC<ThumbnailProps> & ThumbnailComponents;
3373
- export type TitleSkeletonProperties = Pick<TitleProps, "as"> & Partial<Pick<SkeletonProps, "width" | "height" | "className" | "data-testid">>;
3374
- export type TitleSkeletonProps = TitleSkeletonProperties;
3375
- declare const TitleSkeleton: React.FC<TitleSkeletonProps>;
3376
- export interface TitleComponents {
3377
- Skeleton: typeof TitleSkeleton;
3378
- }
3379
- export interface TitleProperties extends TitleSprinkle {
3380
- /**
3381
- * The content of the title.
3382
- * @TJS-type React.ReactNode
3383
- */
3384
- children: ReactNode;
3385
- /**
3386
- * Type of html tag to create for the title.
3387
- * @default h1
3388
- */
3389
- as?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
3390
- }
3391
- export type TitleProps = TitleProperties & HTMLAttributes<HTMLHeadingElement>;
3392
- export declare const Title: React.FC<TitleProps> & TitleComponents;
3393
- export type ToastOffset = "default" | "high";
3394
- export type ToastBehavior = "stacked" | "single";
3395
- export interface ToastProviderProperties {
3396
- /**
3397
- * @TJS-type React.ReactNode
3398
- */
3399
- children: ReactNode;
3400
- /**
3401
- * Controls the vertical offset of the toast container from the bottom.
3402
- * Use "high" for mobile apps with bottom navigation bars.
3403
- * @default "default"
3404
- */
3405
- offset?: ToastOffset;
3406
- /**
3407
- * Controls how multiple toasts are handled.
3408
- * "stacked" - new toasts are piled up alongside already rendered ones.
3409
- * "single" - only one toast is shown at a time; each new toast immediately replaces the previous one.
3410
- * @default "stacked"
3411
- */
3412
- behavior?: ToastBehavior;
3413
- }
3414
- export type ToastProviderProps = ToastProviderProperties;
3415
- export declare const ToastProvider: React.FC<ToastProviderProps>;
3416
- export interface ToastComponents {
3417
- Provider: typeof ToastProvider;
3418
- }
3419
- export type Types = "primary" | "success" | "danger" | "progress";
3420
- export interface ToastProperties {
3421
- /**
3422
- * Unique toast ID used when hiding or removing a toast.
3423
- */
3424
- id: string;
3425
- /**
3426
- * The text that should appear in the toast message.
3427
- */
3428
- text: string;
3429
- /**
3430
- * Change the visual style of the toast.
3431
- * @default primary
3432
- */
3433
- type?: Types;
3434
- /**
3435
- * The time in milliseconds that the toast message should persist.
3436
- * @default 4000
3437
- */
3438
- duration?: 4000 | 8000 | 16000;
3439
- /**
3440
- * Tells you whether or not Toast should close automatically.
3441
- * @default true
3442
- */
3443
- autoClose?: boolean;
3444
- /**
3445
- * Tells the toast position when we are using multiple toasts.
3446
- * @default 0
3447
- */
3448
- position?: number;
3449
- }
3450
- export type ToastProps = ToastProperties & HTMLAttributes<HTMLDivElement>;
3451
- export declare const Toast: React.FC<ToastProps> & ToastComponents;
3452
- export interface ToastContextProps {
3453
- closeToast: (id: string) => void;
3454
- addToast: (toast: Omit<ToastProps, "autoClose">) => void;
3455
- }
3456
- export declare const useToast: () => ToastContextProps;
3457
- export type ToggleSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "className" | "data-testid">>;
3458
- export type ToggleSkeletonProps = ToggleSkeletonProperties;
3459
- declare const ToggleSkeleton: React.FC<ToggleSkeletonProps>;
3460
- export interface ToggleComponents {
3461
- Skeleton: typeof ToggleSkeleton;
3462
- }
3463
- export interface ToggleProperties {
3464
- /**
3465
- * The name of the input element.
3466
- */
3467
- name: string;
3468
- /**
3469
- * Sets toggle state to activated or deactivated.
3470
- */
3471
- active?: boolean;
3472
- /**
3473
- * Text to be rendered inside the component
3474
- */
3475
- label?: string;
3476
- }
3477
- export type ToggleProps = ToggleProperties & InputHTMLAttributes<HTMLInputElement>;
3478
- export declare const Toggle: React.FC<ToggleProps> & ToggleComponents;
3479
- export interface TooltipProperties extends TooltipSprinkle {
3480
- /**
3481
- * An HTML element, or a function that returns one. It's used to set the position of the tooltip.
3482
- * @TJS-type React.ReactNode
3483
- */
3484
- children: ReactNode;
3485
- /**
3486
- * The text that should appear in the tooltip message.
3487
- */
3488
- content: string;
3489
- /**
3490
- * Conditional for displaying the popover arrow.
3491
- * @default false
3492
- */
3493
- arrow?: boolean;
3494
- /**
3495
- * Position of the popover.
3496
- * @default bottom
3497
- */
3498
- position?: "top" | "bottom" | "left" | "right";
3499
- }
3500
- export type TooltipProps = TooltipProperties & HTMLAttributes<HTMLDivElement>;
3501
- export declare const Tooltip: React.FC<TooltipProps>;
3502
- export type ProgressBarSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "height" | "className" | "data-testid">>;
3503
- declare const ProgressBarSkeleton: React.FC<ProgressBarSkeletonProperties>;
3504
- export interface ProgressBarComponents {
3505
- Skeleton: typeof ProgressBarSkeleton;
3506
- }
3507
- export interface ProgressBarProperties {
3508
- /**
3509
- * Progress value from 0 to 100
3510
- * @note Always renders with a minimum 8px width for visual consistency
3511
- */
3512
- value: number;
3513
- /**
3514
- * Change the visual style of the progress bar.
3515
- * @default neutral
3516
- */
3517
- appearance?: "primary" | "success" | "warning" | "danger" | "neutral" | "ai-generative";
3518
- /**
3519
- * Applies a box shadow to the progress bar fill using the appearance color.
3520
- * @default 0
3521
- */
3522
- boxShadow?: 0 | 1 | 2;
3523
- /**
3524
- * Custom height for the progress bar. Any valid CSS height value.
3525
- * @default "0.5rem"
3526
- */
3527
- height?: string;
3528
- /**
3529
- * Change the background color of the progress bar track.
3530
- * @default neutral-surfaceDisabled
3531
- */
3532
- backgroundColor?: "neutral-surfaceDisabled" | "neutral-background";
3533
- }
3534
- /**
3535
- * ProgressBar component displays the progress of an operation or task in a visual format.
3536
- * It provides a horizontal bar that fills based on the completion percentage.
3537
- *
3538
- * @component
3539
- * @example
3540
- * <ProgressBar value={50} appearance="primary" />
3541
- *
3542
- * @example
3543
- * // With skeleton loading state
3544
- * <ProgressBar.Skeleton width="200px" />
3545
- */
3546
- export declare const ProgressBar: React.ForwardRefExoticComponent<ProgressBarProperties & Omit<React.HTMLAttributes<HTMLDivElement>, keyof ProgressBarProperties> & React.RefAttributes<HTMLDivElement>> & ProgressBarComponents;
3547
- export type ProgressBarProps = ComponentPropsWithRef<typeof ProgressBar>;
3548
- export interface DividerProperties {
3549
- /**
3550
- * Defines the orientation of the divider.
3551
- * @default horizontal
3552
- */
3553
- orientation?: "horizontal" | "vertical";
3554
- /**
3555
- * Visual appearance color.
3556
- * @default neutral
3557
- */
3558
- appearance?: "neutral" | "primary";
3559
- /**
3560
- * Thickness level based on shape.border.width tokens.
3561
- * @default 1
3562
- */
3563
- thickness?: 1 | 2 | 3;
3564
- /**
3565
- * CSS width of the divider. Applies to horizontal orientation only.
3566
- * @default "100%"
3567
- */
3568
- width?: string;
3569
- /**
3570
- * CSS margin-left applied to the divider.
3571
- */
3572
- marginLeft?: string;
3573
- /**
3574
- * CSS margin-right applied to the divider.
3575
- */
3576
- marginRight?: string;
3577
- }
3578
- export type DividerProps = DividerProperties & HTMLAttributes<HTMLHRElement>;
3579
- export declare const Divider: React.FC<DividerProps>;
3580
- export interface AccordionBodyProperties {
3581
- /**
3582
- * The content of the accordion body.
3583
- * @TJS-type React.ReactNode
3584
- */
3585
- children: ReactNode;
3586
- /**
3587
- * The borderBottom property defines a lower border of the accordion body.
3588
- * @default none
3589
- */
3590
- borderBottom?: keyof typeof accordion.properties.borderBottom;
3591
- /**
3592
- * The borderTop property defines a top border of the accordion body.
3593
- * @default none
3594
- */
3595
- borderTop?: keyof typeof accordion.properties.borderTop;
3596
- /**
3597
- * Padding properties are used to generate space around the content area of an Accordion.Body..
3598
- * @default base
3599
- */
3600
- padding?: keyof typeof accordion.properties.padding;
3601
- }
3602
- export type AccordionBodyProps = AccordionBodyProperties & HTMLAttributes<HTMLElement>;
3603
- declare const AccordionBody: React.FC<AccordionBodyProps>;
3604
- export interface AccordionItemProperties {
3605
- /**
3606
- * The content of the accordion body.
3607
- * @TJS-type React.ReactNode
3608
- */
3609
- children: ReactNode;
3610
- /**
3611
- * Unique indicator to identify accordion items
3612
- */
3613
- index: string;
3614
- /**
3615
- * Determines if the accordion item is interactive (clickable) or static.
3616
- * When false, the header renders as a div without click handlers, hover effects, or toggle icon.
3617
- * @default true
3618
- */
3619
- interactive?: boolean;
3620
- /**
3621
- * This is an attribute used to identify a DOM node for testing purposes.
3622
- */
3623
- testId?: string;
3624
- }
3625
- export type AccordionItemProps = AccordionItemProperties;
3626
- declare const AccordionItem: React.FC<AccordionItemProps>;
3627
- export interface AccordionHeaderProperties {
3628
- /**
3629
- * The content of the accordion header.
3630
- * @TJS-type React.ReactNode | ((data: { selected: string; index: string }) => React.ReactNode);
3631
- */
3632
- children?: ReactNode | ((data: {
3633
- selected: string;
3634
- index: string;
3635
- }) => ReactNode);
3636
- /**
3637
- * The title to display in the accordion header.
3638
- */
3639
- title?: string;
3640
- /**
3641
- * The subtitle to display in the accordion header.
3642
- */
3643
- subtitle?: string;
3644
- /**
3645
- * The SVG contents to display in the accordion header.
3646
- * @TJS-type React.ReactNode
3647
- */
3648
- icon?: ReactNode;
3649
- /**
3650
- * Removes the arrow icon that shows if the accordion item is open or not which makes it possible to create a custom indicator.
3651
- * @default false
3652
- */
3653
- noIconToggle?: boolean;
3654
- /**
3655
- * The borderTop property defines a lower border of the accordion header.
3656
- * @default base
3657
- */
3658
- borderTop?: keyof typeof accordion.properties.borderTop;
3659
- /**
3660
- * The borderBottom property defines a lower border of the accordion header.
3661
- */
3662
- borderBottom?: keyof typeof accordion.properties.borderBottom;
3663
- }
3664
- export type AccordionHeaderProps = AccordionHeaderProperties & Omit<HTMLAttributes<HTMLElement>, "children">;
3665
- declare const AccordionHeader: React.FC<AccordionHeaderProps>;
3666
- export interface AccordionComponents {
3667
- Body: typeof AccordionBody;
3668
- Item: typeof AccordionItem;
3669
- Header: typeof AccordionHeader;
3670
- }
3671
- export interface AccordionBaseProperties {
3672
- /**
3673
- * The content of the accordion.
3674
- * @TJS-type React.ReactNode
3675
- */
3676
- children?: ReactNode;
3677
- }
3678
- export interface UncontrolledAccordionProperties extends AccordionBaseProperties {
3679
- /**
3680
- * Informs which accordion item is open by default, this value must be the same as informed in the index of each item
3681
- */
3682
- selectedDefault?: string;
3683
- }
3684
- export interface ControlledAccordionProperties extends AccordionBaseProperties {
3685
- /**
3686
- * The currently selected accordion item ID.
3687
- */
3688
- selectedItem: string;
3689
- /**
3690
- * Callback fired when the selected accordion item changes.
3691
- * @param selectedId The ID of the selected accordion item
3692
- */
3693
- onItemSelect?: (selectedId: string) => void;
3694
- }
3695
- /**
3696
- * Props for the Accordion component, supporting both controlled and uncontrolled modes
3697
- */
3698
- export type AccordionProps = (UncontrolledAccordionProperties | ControlledAccordionProperties) & Omit<HTMLAttributes<HTMLElement>, "onItemSelect" | "selectedItem">;
3699
- export type AccordionProperties = AccordionBaseProperties & UncontrolledAccordionProperties & ControlledAccordionProperties;
3700
- export declare const Accordion: React.FC<AccordionProps> & AccordionComponents;
3701
- export type AlertSkeletonProperties = Partial<Pick<SkeletonProps, "width" | "height" | "className" | "data-testid">>;
3702
- export type AlertSkeletonProps = AlertSkeletonProperties;
3703
- declare const AlertSkeleton: React.FC<AlertSkeletonProps>;
3704
- export interface AlertComponents {
3705
- Skeleton: typeof AlertSkeleton;
3706
- }
3707
- export interface AlertProperties {
3708
- /**
3709
- * The content for the title of the alert.
3710
- */
3711
- title?: string;
3712
- /**
3713
- * Change the visual style of the alert.
3714
- * @default neutral
3715
- */
3716
- appearance?: "primary" | "success" | "warning" | "danger" | "neutral";
3717
- /**
3718
- * The content of the alert.
3719
- * @TJS-type React.ReactNode
3720
- */
3721
- children: ReactNode;
3722
- /**
3723
- * Function to be passed on actioning the dismiss button.
3724
- * @TJS-type () => void;
3725
- */
3726
- onRemove?: () => void;
3727
- /**
3728
- * Determines if the alert is shown or not.
3729
- * @default true
3730
- */
3731
- show?: boolean;
3732
- }
3733
- export type AlertProps = AlertProperties & HTMLAttributes<HTMLElement>;
3734
- export declare const Alert: React.FC<AlertProps> & AlertComponents;
3735
- export interface CardBodyProperties {
3736
- /**
3737
- * The content of the card body.
3738
- * @TJS-type React.ReactNode
3739
- */
3740
- children: ReactNode;
3741
- /**
3742
- * The padding properties are used to generate space around an card's body content area.
3743
- * @default none
3744
- */
3745
- padding?: keyof typeof card.subComponents.body.properties.padding;
3746
- }
3747
- export type CardBodyProps = CardBodyProperties & HTMLAttributes<HTMLElement>;
3748
- declare const CardBody: React.FC<CardBodyProps>;
3749
- export interface CardFooterProperties {
3750
- /**
3751
- * The content of the card footer.
3752
- * @TJS-type React.ReactNode
3753
- */
3754
- children: ReactNode;
3755
- /**
3756
- * The padding properties are used to generate space around an card's footer content area.
3757
- * @default none
3758
- */
3759
- padding?: keyof typeof card.subComponents.footer.properties.padding;
3760
- }
3761
- export type CardFooterProps = CardFooterProperties & HTMLAttributes<HTMLElement>;
3762
- declare const CardFooter: React.FC<CardFooterProps>;
3763
- export interface CardHeaderProperties {
3764
- /**
3765
- * The content of the card header.
3766
- * @TJS-type React.ReactNode
3767
- */
3768
- children?: ReactNode;
3769
- /**
3770
- * The title to display in the card header.
3771
- */
3772
- title?: string;
3773
- /**
3774
- * The padding properties are used to generate space around an card's header content area.
3775
- * @default none
3776
- */
3777
- padding?: keyof typeof card.subComponents.header.properties.padding;
3778
- }
3779
- export type CardHeaderProps = CardHeaderProperties & HTMLAttributes<HTMLElement>;
3780
- declare const CardHeader: React.FC<CardHeaderProps>;
3781
- export interface CardComponents {
3782
- Body: typeof CardBody;
3783
- Footer: typeof CardFooter;
3784
- Header: typeof CardHeader;
3785
- }
3786
- export interface CardProperties {
3787
- /**
3788
- * The content of the card.
3789
- * @TJS-type React.ReactNode
3790
- */
3791
- children: ReactNode;
3792
- /**
3793
- * The padding properties are used to generate space around an card's content area.
3794
- * @default base
3795
- */
3796
- padding?: keyof typeof card.properties.padding;
3797
- /**
3798
- * The backgroundColor property sets the background color of the card.
3799
- * @default neutral-background
3800
- */
3801
- backgroundColor?: keyof typeof card.properties.backgroundColor;
3802
- }
3803
- export type CardProps = CardProperties & HTMLAttributes<HTMLElement>;
3804
- export declare const Card: React.FC<CardProps> & CardComponents;
3805
- export interface CollapsibleBodyProperties {
3806
- /**
3807
- * The content of the collapsible body.
3808
- * @TJS-type React.ReactNode
3809
- */
3810
- children: ReactNode;
3811
- /**
3812
- * Show Collapsible.Body when state is open or closed.
3813
- * @default open
3814
- */
3815
- visibleWhen?: "open" | "closed";
3816
- /**
3817
- * Set the direction that Collapsible.Body going to open
3818
- * @default none
3819
- */
3820
- direction?: "top" | "bottom" | "none";
3821
- }
3822
- export type CollapsibleBodyProps = CollapsibleBodyProperties & HTMLAttributes<HTMLElement>;
3823
- declare const CollapsibleBody: React.FC<CollapsibleBodyProps>;
3824
- export interface CollapsibleItemProperties {
3825
- /**
3826
- * The content of the collapsible body.
3827
- * @TJS-type React.ReactNode
3828
- */
3829
- children: ReactNode;
3830
- }
3831
- export type CollapsibleItemProps = CollapsibleItemProperties;
3832
- declare const CollapsibleItem: React.FC<CollapsibleItemProps>;
3833
- export interface CollapsibleComponents {
3834
- Body: typeof CollapsibleBody;
3835
- Item: typeof CollapsibleItem;
3836
- }
3837
- export interface CollapsibleProperties {
3838
- children?: ReactNode;
3839
- open?: boolean;
3840
- }
3841
- export type CollapsibleBaseProps = CollapsibleProperties & Omit<HTMLAttributes<HTMLElement>, "onChange">;
3842
- export declare const Collapsible: React.FC<CollapsibleProperties> & CollapsibleComponents;
3843
- export type CloseOnOutsidePress = (event: PointerEvent | MouseEvent) => boolean;
3844
- export interface ModalBodyProperties {
3845
- /**
3846
- * The content of the modal body.
3847
- * @TJS-type React.ReactNode
3848
- */
3849
- children: ReactNode;
3850
- /**
3851
- * The padding properties are used to generate space around an modal's body content area.
3852
- * @default none
3853
- */
3854
- padding?: keyof typeof modal.subComponents.body.properties.padding;
3855
- }
3856
- export type ModalBodyProps = ModalBodyProperties & HTMLAttributes<HTMLElement>;
3857
- declare const ModalBody: React.FC<ModalBodyProps>;
3858
- export interface ModalFooterProperties {
3859
- /**
3860
- * The content of the modal footer.
3861
- * @TJS-type React.ReactNode
3862
- */
3863
- children: ReactNode;
3864
- /**
3865
- * The padding properties are used to generate space around an modal's footer content area.
3866
- * @default none
3867
- */
3868
- padding?: keyof typeof modal.subComponents.footer.properties.padding;
3869
- }
3870
- export type ModalFooterProps = ModalFooterProperties & HTMLAttributes<HTMLElement>;
3871
- declare const ModalFooter: React.FC<ModalFooterProps>;
3872
- export interface ModalHeaderProperties {
3873
- /**
3874
- * The content of the modal header.
3875
- * @TJS-type React.ReactNode
3876
- */
3877
- children?: ReactNode;
3878
- /**
3879
- * The title to display in the modal header.
3880
- */
3881
- title?: string;
3882
- /**
3883
- * The tag to display next to the title.
3884
- * @TJS-type React.ReactNode
3885
- */
3886
- tag?: ReactNode;
3887
- /**
3888
- * The padding properties are used to generate space around an modal's header content area.
3889
- * @default none
3890
- */
3891
- padding?: keyof typeof modal.subComponents.header.properties.padding;
3892
- }
3893
- export type ModalHeaderProps = ModalHeaderProperties & HTMLAttributes<HTMLElement>;
3894
- declare const ModalHeader: React.FC<ModalHeaderProps>;
3895
- export interface ModalComponents {
3896
- Body: typeof ModalBody;
3897
- Footer: typeof ModalFooter;
3898
- Header: typeof ModalHeader;
3899
- }
3900
- export interface ModalProperties extends ModalSprinkle {
3901
- /**
3902
- * The content of the modal.
3903
- * @TJS-type React.ReactNode
3904
- */
3905
- children: ReactNode;
3906
- /**
3907
- * Whether the modal is open or not.
3908
- */
3909
- open: boolean;
3910
- /**
3911
- * Callback fired when the component requests to be closed.
3912
- * @TJS-type (open: boolean) => void;
3913
- */
3914
- onDismiss?: (open: boolean) => void;
3915
- /**
3916
- * Id to be embedded in the portal element
3917
- */
3918
- portalId?: string;
3919
- /**
3920
- * Controls whether clicking/pressing outside should close the modal.
3921
- * - boolean: enable/disable dismissal on outside press
3922
- * - function: receive the DOM event and return true to allow closing, false to ignore
3923
- *
3924
- * Defaults to true.
3925
- */
3926
- closeOnOutsidePress?: boolean | CloseOnOutsidePress;
3927
- /**
3928
- * The attribute name to ignore when checking for outside clicks. Useful to
3929
- * mark regions (e.g., a chat) that should not close the modal when clicked.
3930
- * @default "data-nimbus-outside-press-ignore"
3931
- */
3932
- ignoreAttributeName?: string;
3933
- /**
3934
- * The padding properties are used to generate space around an modal's content area.
3935
- * @default base
3936
- */
3937
- padding?: keyof typeof modal.properties.padding;
3938
- }
3939
- export type ModalProps = ModalProperties & {
3940
- /**
3941
- * Root element where the portal should be mounted. When provided and not null,
3942
- * the portal renders inside this element; when null/undefined, the default root is used.
3943
- */
3944
- root?: HTMLElement | null;
3945
- } & HTMLAttributes<HTMLDivElement>;
3946
- export declare const Modal: React.FC<ModalProps> & ModalComponents;
3947
- export interface PaginationItemData {
3948
- pageNumber: number | string;
3949
- isCurrent: boolean;
3950
- }
3951
- export interface PaginationProperties {
3952
- /**
3953
- * The currently selected page.
3954
- */
3955
- activePage: number;
3956
- /**
3957
- * The total number of pages.
3958
- */
3959
- pageCount: number;
3960
- /**
3961
- * Called with event and page number when a page is clicked.
3962
- * @TJS-type (page: number) => void;
3963
- */
3964
- onPageChange: (page: number) => void;
3965
- /**
3966
- * Determines whether page numbers should be shown.
3967
- * @default true
3968
- */
3969
- showNumbers?: boolean;
3970
- /**
3971
- * Custom render function for pagination items.
3972
- */
3973
- renderItem?: (item: PaginationItemData) => React.ReactNode;
3974
- }
3975
- export type PaginationProps = PaginationProperties & HTMLAttributes<HTMLElement>;
3976
- export declare const Pagination: React.FC<PaginationProps>;
3977
- export interface ScrollPaneItemProperties {
3978
- /**
3979
- * The content to be rendered inside the scroll pane item
3980
- */
3981
- children: ReactNode;
3982
- /**
3983
- * Custom class name for styling
3984
- */
3985
- className?: string;
3986
- /**
3987
- * Callback fired when the item is clicked
3988
- */
3989
- onClick?: (event: React.MouseEvent<HTMLDivElement>) => void;
3990
- }
3991
- export type ScrollPaneItemProps = ScrollPaneItemProperties & {
3992
- style?: React.CSSProperties;
3993
- } & Omit<React.HTMLAttributes<HTMLDivElement>, "children">;
3994
- export type ScrollPaneArrowProperties = {
3995
- children: ReactNode;
3996
- };
3997
- export type ScrollPaneArrowVerticalEndProperties = ScrollPaneArrowProperties;
3998
- export type ScrollPaneArrowVerticalStartProperties = ScrollPaneArrowProperties;
3999
- export type ScrollPaneArrowHorizontalEndProperties = ScrollPaneArrowProperties;
4000
- export type ScrollPaneArrowHorizontalStartProperties = ScrollPaneArrowProperties;
4001
- export type ScrollPaneScrollBehavior = "hidden-items" | "always";
4002
- export interface ScrollPaneProperties {
4003
- /**
4004
- * The content to be rendered inside the scroll pane
4005
- */
4006
- children: ReactNode;
4007
- /**
4008
- * Whether to show gradient overlays when content overflows
4009
- * @default true
4010
- */
4011
- showGradients?: boolean;
4012
- /**
4013
- * Whether to show navigation arrows for scrolling
4014
- * @default false
4015
- */
4016
- showArrows?: boolean;
4017
- /**
4018
- * Whether to show the scrollbar
4019
- * @default true
4020
- */
4021
- showScrollbar?: boolean;
4022
- /**
4023
- * The direction of the scroll (horizontal or vertical)
4024
- * @default "horizontal"
4025
- */
4026
- direction?: "horizontal" | "vertical";
4027
- /**
4028
- * Whether items should scroll into view when clicked
4029
- * @default true
4030
- */
4031
- scrollToItemOnClick?: boolean;
4032
- /**
4033
- * Defines the scroll behavior when clicking on items
4034
- * - 'hidden-items': Only scrolls to items that are not fully visible (default)
4035
- * - 'always': Always scrolls to items, centering them in the viewport
4036
- * @default "hidden-items"
4037
- */
4038
- scrollBehavior?: ScrollPaneScrollBehavior;
4039
- /**
4040
- * Enable grab-to-scroll functionality (click and drag to scroll)
4041
- * When enabled, prevents item dragging inside the ScrollPane
4042
- * @default false
4043
- */
4044
- enableGrabScroll?: boolean;
4045
- /**
4046
- * Custom arrow component to render at the start of the scroll area
4047
- */
4048
- scrollPaneArrowStart?: React.ReactNode;
4049
- /**
4050
- * Custom arrow component to render at the end of the scroll area
4051
- */
4052
- scrollPaneArrowEnd?: React.ReactNode;
4053
- /**
4054
- * Props to be passed to the content container
4055
- */
4056
- contentContainerProps?: object;
4057
- }
4058
- export type ScrollPaneProps = ScrollPaneProperties & Omit<BoxProps, "children"> & {
4059
- contentContainerProps?: BoxProps;
4060
- /**
4061
- * Ref to the scroll container
4062
- */
4063
- scrollContainerRef?: RefObject<HTMLDivElement | null>;
4064
- };
4065
- /**
4066
- * ScrollPane component handles responsive scrolls in lists that are overflowing inside a container.
4067
- * It provides gradient overlays, optional navigation arrows, and scroll-to-item functionality.
4068
- *
4069
- * @example
4070
- * <ScrollPane showArrows showGradients showScrollbar>
4071
- * <ScrollPane.Item>Item 1</ScrollPane.Item>
4072
- * <ScrollPane.Item>Item 2</ScrollPane.Item>
4073
- * </ScrollPane>
4074
- */
4075
- export declare const ScrollPane: {
4076
- ({ children, showGradients, showArrows, showScrollbar, scrollContainerRef: externalScrollContainerRef, direction, scrollToItemOnClick, scrollBehavior, enableGrabScroll, scrollPaneArrowStart, scrollPaneArrowEnd, contentContainerProps, ...rest }: ScrollPaneProps): React.JSX.Element;
4077
- displayName: string;
4078
- Item: React.FC<ScrollPaneItemProps>;
4079
- ArrowHorizontalStart: React.FC<ScrollPaneArrowProperties>;
4080
- ArrowHorizontalEnd: React.FC<ScrollPaneArrowProperties>;
4081
- ArrowVerticalStart: React.FC<ScrollPaneArrowProperties>;
4082
- ArrowVerticalEnd: React.FC<ScrollPaneArrowProperties>;
4083
- };
4084
- export interface SidebarBodyProperties {
4085
- /**
4086
- * The content of the sidebar body.
4087
- * @TJS-type React.ReactNode
4088
- */
4089
- children: ReactNode;
4090
- /**
4091
- * The padding properties are used to generate space around an sidebar's body content area.
4092
- * @default base
4093
- */
4094
- padding?: keyof typeof sidebar.properties.padding;
4095
- }
4096
- export type SidebarBodyProps = SidebarBodyProperties & HTMLAttributes<HTMLElement>;
4097
- declare const SidebarBody: React.FC<SidebarBodyProps>;
4098
- export interface SidebarFooterProperties {
4099
- /**
4100
- * The content of the sidebar footer.
4101
- * @TJS-type React.ReactNode
4102
- */
4103
- children: ReactNode;
4104
- /**
4105
- * The padding properties are used to generate space around an sidebar's footer content area.
4106
- * @default base
4107
- */
4108
- padding?: keyof typeof sidebar.properties.padding;
4109
- }
4110
- export type SidebarFooterProps = SidebarFooterProperties & HTMLAttributes<HTMLElement>;
4111
- declare const SidebarFooter: React.FC<SidebarFooterProps>;
4112
- export interface SidebarHeaderProperties {
4113
- /**
4114
- * The content of the sidebar header.
4115
- * @TJS-type React.ReactNode
4116
- */
4117
- children?: ReactNode;
4118
- /**
4119
- * The title to display in the sidebar header.
4120
- */
4121
- title?: string;
4122
- /**
4123
- * The padding properties are used to generate space around an sidebar's header content area.
4124
- * @default base
4125
- */
4126
- padding?: keyof typeof sidebar.properties.padding;
4127
- }
4128
- export type SidebarHeaderProps = SidebarHeaderProperties & HTMLAttributes<HTMLElement>;
4129
- declare const SidebarHeader: React.FC<SidebarHeaderProps>;
4130
- export interface SidebarComponents {
4131
- Body: typeof SidebarBody;
4132
- Footer: typeof SidebarFooter;
4133
- Header: typeof SidebarHeader;
4134
- }
4135
- export interface SidebarProperties extends SidebarSprinkle {
4136
- /**
4137
- * Side from which the sidebar will appear.
4138
- * @default right
4139
- */
4140
- position?: "right" | "left";
4141
- /**
4142
- * The padding properties are used to generate space around an sidebar's content area.
4143
- * @default base
4144
- */
4145
- padding?: keyof typeof sidebar.properties.padding;
4146
- /**
4147
- * The content of the sidebar.
4148
- * @TJS-type React.ReactNode
4149
- */
4150
- children: ReactNode;
4151
- /**
4152
- * Callback fired when the component requests to be closed.
4153
- * () => void;
4154
- */
4155
- onRemove?: () => void;
4156
- /**
4157
- * Determines if the sidebar is shown or not.
4158
- * @default true
4159
- */
4160
- open?: boolean;
4161
- /**
4162
- * Determines if RemoveScroll wraps sidebar's children component.
4163
- * @default true
4164
- */
4165
- needRemoveScroll?: boolean;
4166
- /**
4167
- * Controls whether clicking/pressing outside should close the sidebar.
4168
- * - boolean: enable/disable dismissal on outside press
4169
- * - function: receive the DOM event and return true to allow closing, false to ignore
4170
- *
4171
- * Defaults to true for backward compatibility.
4172
- */
4173
- closeOnOutsidePress?: boolean | CloseOnOutsidePress;
4174
- /**
4175
- * The attribute name to ignore when checking for outside clicks.
4176
- * @default "data-nimbus-outside-press-ignore"
4177
- */
4178
- ignoreAttributeName?: string;
4179
- }
4180
- export type SidebarProps = SidebarProperties & {
4181
- /**
4182
- * Root element where the portal should be mounted. When provided and not null,
4183
- * the portal renders inside this element; when null/undefined, the default root is used.
4184
- */
4185
- root?: HTMLElement | null;
4186
- } & HTMLAttributes<HTMLDivElement>;
4187
- export declare const Sidebar: React.FC<SidebarProps> & SidebarComponents;
4188
- /**
4189
- * Represents the visual state of a step
4190
- */
4191
- export type StepState = "completed" | "started" | "pending";
4192
- export interface StepperItemProperties {
4193
- /**
4194
- * The step number (0-based index) for this item.
4195
- * This is automatically assigned by the parent Stepper component.
4196
- */
4197
- step: number;
4198
- /**
4199
- * The label text to display for this step
4200
- */
4201
- label?: string;
4202
- }
4203
- export type StepperItemProps = StepperItemProperties & HTMLAttributes<HTMLDivElement>;
4204
- export interface StepperCardProperties {
4205
- className?: string;
4206
- /**
4207
- * The content to be rendered inside the card container
4208
- * @TJS-type React.ReactNode
4209
- */
4210
- children: ReactNode;
4211
- }
4212
- export type StepperCardProps = StepperCardProperties;
4213
- export interface StepperComponents {
4214
- Item: React.FC<Omit<StepperItemProps, "step">>;
4215
- Card: React.FC<StepperCardProps>;
4216
- }
4217
- export interface BaseStepperProperties {
4218
- /**
4219
- * The currently active step (0-based index).
4220
- * Steps before this will be marked as completed.
4221
- */
4222
- activeStep: number;
4223
- /**
4224
- * The content of the stepper (StepperItem components).
4225
- * Total steps will be calculated automatically based on the number of children.
4226
- * @TJS-type React.ReactNode
4227
- */
4228
- children: ReactNode;
4229
- }
4230
- export interface ControlledStepperProperties extends BaseStepperProperties {
4231
- /**
4232
- * The currently selected step (0-based index).
4233
- * This step will be visually highlighted to show user selection.
4234
- */
4235
- selectedStep: number;
4236
- /**
4237
- * Callback called when a step is selected.
4238
- * Receives the step number (0-based index) as parameter.
4239
- */
4240
- onSelectStep: (step: number) => void;
4241
- }
4242
- /**
4243
- * Props for the Stepper component, supporting both controlled and uncontrolled modes
4244
- */
4245
- export type StepperProps = (BaseStepperProperties | ControlledStepperProperties) & Omit<BoxProps, "display" | "flexWrap" | "gap">;
4246
- export type StepperProperties = BaseStepperProperties & ControlledStepperProperties;
4247
- export declare const Stepper: React.FC<StepperProps> & StepperComponents;
4248
- /**
4249
- * Context value provided by StepperContext to share state between stepper components
4250
- */
4251
- export interface StepperContextValue {
4252
- /**
4253
- * The total number of steps in the stepper
4254
- */
4255
- totalSteps: number;
4256
- /**
4257
- * The currently active step (0-based index)
4258
- */
4259
- activeStep: number;
4260
- /**
4261
- * The currently selected step (0-based index)
4262
- */
4263
- selectedStep?: number;
4264
- /**
4265
- * Callback to handle step selection
4266
- */
4267
- onSelect?: (step: number) => void;
4268
- }
4269
- /**
4270
- * Checks if the stepper is in controlled mode.
4271
- * @param props - The props of the stepper
4272
- * @returns True if the stepper is controlled, false otherwise
4273
- */
4274
- export declare const isControlled: (props: any) => props is ControlledStepperProperties;
4275
- export interface TabsButtonProperties {
4276
- /**
4277
- * Label of the tab button.
4278
- */
4279
- label: string;
4280
- /**
4281
- * Content of the tab button.
4282
- */
4283
- labelContent?: ReactNode;
4284
- /**
4285
- * Determines if tab is active.
4286
- * @default false
4287
- */
4288
- active?: boolean;
4289
- /**
4290
- * Position of the tab inside the tab list.
4291
- */
4292
- index: number;
4293
- /**
4294
- * Function executed when clicking the tab.
4295
- * @TJS-type (index: number) => void;
4296
- */
4297
- setActiveTab: (index: number) => void;
4298
- /**
4299
- * Determines if tab spans all available width.
4300
- * @default false
4301
- */
4302
- fullWidth?: boolean;
4303
- }
4304
- export type TabsButtonProps = TabsButtonProperties & HTMLAttributes<HTMLLIElement>;
4305
- declare const TabsButton: React.FC<TabsButtonProps>;
4306
- export interface TabsItemProperties {
4307
- /**
4308
- * Label of the tabpanel. Used to pair with it's corresponding tab control.
4309
- */
4310
- label: string;
4311
- /**
4312
- * Optional content of the tabpanel.
4313
- * @TJS-type ReactNode;
4314
- */
4315
- labelContent?: ReactNode;
4316
- /**
4317
- * The content of the tabs item.
4318
- * @TJS-type ReactNode | ReactNode[];
4319
- */
4320
- children: ReactNode | ReactNode[];
4321
- }
4322
- export type TabsItemProps = TabsItemProperties & HTMLAttributes<HTMLElement>;
4323
- declare const TabsItem: React.FC<TabsItemProps>;
4324
- export interface TabsComponents {
4325
- Button: typeof TabsButton;
4326
- Item: typeof TabsItem;
4327
- }
4328
- export interface BaseTabsProperties {
4329
- /**
4330
- * The content of the tabs.
4331
- * @TJS-type ReactElement<TabsButtonProps>[];
4332
- */
4333
- children: ReactElement<TabsButtonProps>[];
4334
- /**
4335
- * Sets the indicated tab as active by default. If unset, defaults to first tab.
4336
- */
4337
- preSelectedTab?: number;
4338
- /**
4339
- * Determines if tabs should span available width.
4340
- * @default false
4341
- */
4342
- fullWidth?: boolean;
4343
- }
4344
- export interface ControlledTabsProperties extends BaseTabsProperties {
4345
- /**
4346
- * The currently selected tab index.
4347
- */
4348
- selected: number;
4349
- /**
4350
- * Callback fired when the selected tab changes.
4351
- */
4352
- onTabSelect: (index: number) => void;
4353
- /**
4354
- * preSelectedTab is not used in controlled mode
4355
- */
4356
- preSelectedTab?: never;
4357
- }
4358
- export type TabsProps = (BaseTabsProperties | ControlledTabsProperties) & Omit<HTMLAttributes<HTMLDivElement>, "children" | "onSelect">;
4359
- export declare const Tabs: React.FC<TabsProps> & TabsComponents;
4360
- export interface TableBodyProperties {
4361
- /**
4362
- * The content of the table body.
4363
- * @TJS-type React.ReactNode
4364
- */
4365
- children: ReactNode;
4366
- }
4367
- export type TableBodyProps = TableBodyProperties & HTMLAttributes<HTMLTableSectionElement>;
4368
- declare const TableBody: React.FC<TableBodyProps>;
4369
- export interface TableCellProperties extends TableSprinkle {
4370
- /**
4371
- * The content of the table cell.
4372
- * @TJS-type React.ReactNode
4373
- */
4374
- children: ReactNode;
4375
- /**
4376
- * Type of html tag to create for the table cell.
4377
- * @default td
4378
- */
4379
- as?: "td" | "th";
4380
- /**
4381
- * Column index (0-based) to apply minWidth constraint from the Table's columnLayout.
4382
- * When provided, the cell will inherit minWidth from the corresponding column definition.
4383
- */
4384
- column?: number;
4385
- }
4386
- export type TableCellProps = TableCellProperties & HTMLAttributes<HTMLTableCellElement>;
4387
- declare const TableCell: React.FC<TableCellProps>;
4388
- export interface TableHeadProperties {
4389
- /**
4390
- * The content of the table head.
4391
- * @TJS-type React.ReactNode
4392
- */
4393
- children: ReactNode;
4394
- }
4395
- export type TableHeadProps = TableHeadProperties & HTMLAttributes<HTMLTableSectionElement>;
4396
- declare const TableHead: React.FC<TableHeadProps>;
4397
- export interface TableRowProperties extends TableSprinkle {
4398
- /**
4399
- * The content of the table row.
4400
- * @TJS-type React.ReactNode
4401
- */
4402
- children: ReactNode;
4403
- /**
4404
- * The ID of the table row.
4405
- */
4406
- id?: string;
4407
- /**
4408
- * Function to be passed when clicking on the table row.
4409
- * @TJS-type () => void;
4410
- */
4411
- onClick?: () => void;
4412
- }
4413
- export type TableRowProps = TableRowProperties & HTMLAttributes<HTMLTableRowElement>;
4414
- declare const TableRow: React.FC<TableRowProps>;
4415
- export interface TableComponents {
4416
- Body: typeof TableBody;
4417
- Cell: typeof TableCell;
4418
- Head: typeof TableHead;
4419
- Row: typeof TableRow;
4420
- }
4421
- export interface TableColumnLayout {
4422
- /**
4423
- * Unique identifier for the column.
4424
- */
4425
- id: string;
4426
- /**
4427
- * Fixed width applied to the column. Accepts any valid CSS width value in pixels.
4428
- */
4429
- width?: string;
4430
- /**
4431
- * Growth factor that distributes remaining space among columns without a fixed width.
4432
- * Must be a positive number greater than 0.
4433
- */
4434
- grow?: number;
4435
- /**
4436
- * Minimum width constraint for the column. The column will not shrink below this value.
4437
- * Only applies when using `grow`. Accepts any valid CSS width value in pixels.
4438
- */
4439
- minWidth?: string;
4440
- /**
4441
- * Determines which side the column will be fixed (sticky) to during horizontal scrolling.
4442
- * Fixed columns use CSS `position: sticky` and stay visible on the specified side.
4443
- * Only contiguous columns can be fixed (i.e. no 'normal' columns between fixed columns on the same side).
4444
- * Requires a defined `width` to calculate proper offsets.
4445
- * - 'left': Column sticks to the left side of the table
4446
- * - 'right': Column sticks to the right side of the table
4447
- */
4448
- fixed?: "left" | "right";
4449
- }
4450
- export interface TableProperties extends TableWrapperSprinkle {
4451
- /**
4452
- * The content of the table.
4453
- * @TJS-type React.ReactNode
4454
- */
4455
- children: ReactNode;
4456
- /**
4457
- * Column sizing definitions applied from left to right. Use `width` for fixed columns and `grow` to distribute the remaining space proportionally.
4458
- */
4459
- columnLayout?: TableColumnLayout[];
4460
- /**
4461
- * Minimum width of the table. When the container is smaller, horizontal scrolling is enabled.
4462
- * Accepts any valid CSS width value (e.g., "600px", "50rem").
4463
- */
4464
- minWidth?: string;
4465
- /**
4466
- * Maximum width of the table. The table will not exceed this width.
4467
- * Accepts any valid CSS width value (e.g., "1200px", "80rem").
4468
- */
4469
- maxWidth?: string;
4470
- /**
4471
- * Shows a sticky scrollbar at the bottom of the viewport when the table overflows horizontally.
4472
- * The scrollbar stays visible while scrolling vertically, making it easier to navigate wide tables.
4473
- * @default false
4474
- */
4475
- stickyScrollbar?: boolean;
4476
- }
4477
- export type TableProps = TableProperties & HTMLAttributes<HTMLTableElement>;
4478
- export declare const Table: React.FC<TableProps> & TableComponents;
4479
- export interface SegmentedControlButtonSkeletonProps {
4480
- /** Width of the skeleton button */
4481
- width?: string;
4482
- /** Height of the skeleton button */
4483
- height?: string;
4484
- /** Additional CSS class name */
4485
- className?: string;
4486
- }
4487
- export type SegmentedControlButtonProperties = PropsWithChildren<{
4488
- /**
4489
- * Unique identifier for the segment button.
4490
- * Required for proper state management and accessibility.
4491
- */
4492
- id: string;
4493
- /**
4494
- * Label of the segment used for accessibility.
4495
- */
4496
- label?: string;
4497
- /**
4498
- * Determines if segment spans all available width.
4499
- * @default false
4500
- */
4501
- fullWidth?: boolean;
4502
- }>;
4503
- export type SegmentedControlButtonProps = SegmentedControlButtonProperties & ButtonHTMLAttributes<HTMLButtonElement>;
4504
- export interface SegmentedControlButtonComponents {
4505
- Skeleton: React.FC<SegmentedControlButtonSkeletonProps>;
4506
- }
4507
- declare const SegmentedControlButton: PolymorphicForwardRefComponent<"button" | "a", SegmentedControlButtonProps> & SegmentedControlButtonComponents;
4508
- declare const SegmentedControlButtonSkeleton: React.FC<SegmentedControlButtonSkeletonProps>;
4509
- export interface SegmentedControlBaseProps {
4510
- /**
4511
- * The content of the segmented control.
4512
- * Should contain SegmentedControlButton components with unique id props.
4513
- */
4514
- children: ReactNode;
4515
- /**
4516
- * Determines if segments span all available width.
4517
- * @default false
4518
- */
4519
- fullWidth?: boolean;
4520
- }
4521
- /**
4522
- * Component composition structure for the SegmentedControl
4523
- */
4524
- export interface SegmentedControlComponents {
4525
- Button: typeof SegmentedControlButton;
4526
- ButtonSkeleton: typeof SegmentedControlButtonSkeleton;
4527
- }
4528
- export interface ControlledSegmentedControlProperties extends SegmentedControlBaseProps {
4529
- /**
4530
- * The currently selected segment IDs.
4531
- * Allows for single or multiple selection.
4532
- */
4533
- selectedSegments: string[];
4534
- /**
4535
- * Callback fired when the selected segments change.
4536
- * @param selectedIds Array of selected segment IDs
4537
- */
4538
- onSegmentsSelect?: (selectedIds: string[]) => void;
4539
- }
4540
- /**
4541
- * Props for the SegmentedControl component, supporting both controlled and uncontrolled modes
4542
- */
4543
- export type SegmentedControlProps = (SegmentedControlBaseProps | ControlledSegmentedControlProperties) & Omit<BoxProps, "display" | "backgroundColor" | "gap" | "borderRadius" | "children">;
4544
- /**
4545
- * SegmentedControl component for grouped selection controls
4546
- */
4547
- export declare const SegmentedControl: React.FC<SegmentedControlProps> & SegmentedControlComponents;
4548
- export interface SegmentedControlContextValue {
4549
- /**
4550
- * Register a button with its unique identifier
4551
- * @param id The unique identifier for the button
4552
- */
4553
- registerButton: (id: string) => void;
4554
- /**
4555
- * Unregister a button by its identifier
4556
- * @param id The identifier of the button to unregister
4557
- */
4558
- unregisterButton: (id: string) => void;
4559
- /**
4560
- * Toggle a segment's state by ID
4561
- * @param id The unique identifier of the segment to toggle
4562
- */
4563
- toggleSegment: (id: string) => void;
4564
- /**
4565
- * Check if a segment is currently selected by ID
4566
- * @param id The unique identifier of the segment to check
4567
- */
4568
- isSelected: (id: string) => boolean;
4569
- /**
4570
- * Whether buttons should span full width
4571
- */
4572
- fullWidth: boolean;
4573
- }
4574
- /**
4575
- * Hook to use SegmentedControl context with error if not found
4576
- * @throws Error if not within a SegmentedControl
4577
- */
4578
- export declare const useSegmentedControlContext: () => SegmentedControlContextValue;
4579
- export interface SplitButtonActionProperties {
4580
- /**
4581
- * The content of the action item.
4582
- * @TJS-type React.ReactNode
4583
- */
4584
- children: ReactNode;
4585
- /**
4586
- * Optional icon to display before the action text.
4587
- * @TJS-type React.ReactNode
4588
- */
4589
- icon?: ReactNode;
4590
- /**
4591
- * Callback function when the action is clicked.
4592
- * @TJS-type () => void;
4593
- */
4594
- onClick?: () => void;
4595
- /**
4596
- * Disables the action item.
4597
- * @default false
4598
- */
4599
- disabled?: boolean;
4600
- }
4601
- export type SplitButtonActionProps = SplitButtonActionProperties & Pick<BoxProps, "className" | "backgroundColor" | "borderWidth" | "display" | "alignItems" | "gap" | "p" | "borderRadius">;
4602
- declare const SplitButtonAction: React.FC<SplitButtonActionProps>;
4603
- export interface SplitButtonPrimaryProperties {
4604
- /**
4605
- * The content of the primary button.
4606
- * @TJS-type React.ReactNode
4607
- */
4608
- children: ReactNode;
4609
- /**
4610
- * Callback function when the primary button is clicked.
4611
- * @TJS-type () => void;
4612
- */
4613
- onClick?: () => void;
4614
- }
4615
- export type SplitButtonPrimaryProps = SplitButtonPrimaryProperties & Omit<ButtonHTMLAttributes<HTMLButtonElement>, "onClick" | "children">;
4616
- declare const SplitButtonPrimary: React.FC<SplitButtonPrimaryProps>;
4617
- export interface SplitButtonSecondaryProperties {
4618
- /**
4619
- * The content of the secondary dropdown menu.
4620
- * @TJS-type React.ReactNode
4621
- */
4622
- children: ReactNode;
4623
- /**
4624
- * Accessible label for the dropdown button.
4625
- * @default "Show more actions"
4626
- */
4627
- ariaLabel?: string;
4628
- }
4629
- export type SplitButtonSecondaryProps = SplitButtonSecondaryProperties & Omit<ButtonHTMLAttributes<HTMLButtonElement>, "children">;
4630
- declare const SplitButtonSecondary: React.FC<SplitButtonSecondaryProps>;
4631
- export interface SplitButtonComponents {
4632
- Action: typeof SplitButtonAction;
4633
- Primary: typeof SplitButtonPrimary;
4634
- Secondary: typeof SplitButtonSecondary;
4635
- }
4636
- export interface SplitButtonProperties {
4637
- /**
4638
- * The subcomponents (Primary and Secondary).
4639
- * @TJS-type React.ReactNode
4640
- */
4641
- children: ReactNode;
4642
- /**
4643
- * Disables the entire split button.
4644
- * @default false
4645
- */
4646
- disabled?: boolean;
4647
- /**
4648
- * Controls the visibility of the popover.
4649
- */
4650
- open?: boolean;
4651
- /**
4652
- * Callback function to control popover opening and closing.
4653
- * @TJS-type (open: boolean) => void;
4654
- */
4655
- onOpenChange?: (open: boolean) => void;
4656
- /**
4657
- * Position of the popover relative to the button.
4658
- * @default bottom-end
4659
- */
4660
- popoverPosition?: PopoverProps["position"];
4661
- }
4662
- export type SplitButtonProps = SplitButtonProperties & Omit<BoxProps, "children" | "display" | "gap" | "position">;
4663
- /**
4664
- * SplitButton component allows users to perform actions by clicking a primary button and displaying a dropdown menu with additional actions.
4665
- */
4666
- export declare const SplitButton: React.FC<SplitButtonProps> & SplitButtonComponents;
4667
- export type TimeFormat = "12h" | "24h";
4668
- export type AmPm = "AM" | "PM";
4669
- export type TimePickerMode = "scroll" | "dropdown";
4670
- /**
4671
- * Translatable labels for the TimePicker component.
4672
- * All texts can be customized for localization.
4673
- */
4674
- export interface TimePickerLabels {
4675
- /**
4676
- * Label for the hours column in 24h format.
4677
- * @default "Hours"
4678
- */
4679
- hoursLabel?: string;
4680
- /**
4681
- * Label for the hour column in 12h format.
4682
- * @default "Hour"
4683
- */
4684
- hourLabel?: string;
4685
- /**
4686
- * Label for the minutes column.
4687
- * @default "Minutes"
4688
- */
4689
- minutesLabel?: string;
4690
- /**
4691
- * Accessible label for the AM/PM selector group.
4692
- * @default "AM/PM selector"
4693
- */
4694
- amPmSelectorLabel?: string;
4695
- /**
4696
- * Display text for the AM option.
4697
- * @default "AM"
4698
- */
4699
- amLabel?: string;
4700
- /**
4701
- * Display text for the PM option.
4702
- * @default "PM"
4703
- */
4704
- pmLabel?: string;
4705
- }
4706
- export interface TimeValue {
4707
- hours: number;
4708
- minutes: number;
4709
- ampm?: AmPm;
4710
- }
4711
- export interface TimePickerProperties {
4712
- /**
4713
- * Display mode for the time picker panel.
4714
- * - "scroll": Shows a scroll-based wheel picker with separate hour/minute columns.
4715
- * - "dropdown": Shows a single scrollable list of time options.
4716
- * @default "scroll"
4717
- */
4718
- mode?: TimePickerMode;
4719
- /**
4720
- * Current time value (HH:mm string format or Date object).
4721
- * For 12h format, use "HH:mm AM/PM" or just "HH:mm" (will default to AM).
4722
- */
4723
- value?: string | Date | null;
4724
- /**
4725
- * Callback fired when the time changes.
4726
- * @param value - The formatted time string (HH:mm for 24h, hh:mm AM/PM for 12h).
4727
- * @param date - A Date object representing the selected time (today's date with selected time).
4728
- */
4729
- onChange?: (value: string | null, date: Date | null) => void;
4730
- /**
4731
- * Time format: 12-hour with AM/PM or 24-hour.
4732
- * @default "24h"
4733
- */
4734
- format?: TimeFormat;
4735
- /**
4736
- * Step interval in minutes for the time picker.
4737
- * For scroll mode: controls minute increments in the minutes column.
4738
- * For dropdown mode: controls the time options shown in the list.
4739
- * Common values: 1, 15, 30, 60.
4740
- * @default 1 for scroll picker, 30 for dropdown
4741
- */
4742
- step?: number;
4743
- /**
4744
- * Whether the picker is disabled.
4745
- * @default false
4746
- */
4747
- disabled?: boolean;
4748
- /**
4749
- * Placeholder text for the input field.
4750
- * @default "Select time"
4751
- */
4752
- placeholder?: string;
4753
- /**
4754
- * Controls the open state of the picker panel (controlled mode).
4755
- */
4756
- open?: boolean;
4757
- /**
4758
- * Callback fired when the panel open state changes.
4759
- */
4760
- onOpenChange?: (open: boolean) => void;
4761
- /**
4762
- * Accessible label for the time picker input.
4763
- */
4764
- "aria-label"?: string;
4765
- /**
4766
- * ID of an element that labels the time picker.
4767
- */
4768
- "aria-labelledby"?: string;
4769
- /**
4770
- * ID of an element that describes the time picker.
4771
- */
4772
- "aria-describedby"?: string;
4773
- /**
4774
- * Name attribute for the hidden input (for form submission).
4775
- */
4776
- name?: string;
4777
- /**
4778
- * Whether the input is required.
4779
- * @default false
4780
- */
4781
- required?: boolean;
4782
- /**
4783
- * ID attribute for the input element.
4784
- */
4785
- id?: string;
4786
- /**
4787
- * Translatable labels for localization.
4788
- * Allows customization of all text content rendered by the component.
4789
- */
4790
- labels?: TimePickerLabels;
4791
- }
4792
- export type OmittedHTMLAttributes = "value" | "onChange" | "placeholder" | "disabled";
4793
- export interface TimePickerProps extends TimePickerProperties, Omit<HTMLAttributes<HTMLDivElement>, OmittedHTMLAttributes> {
4794
- }
4795
- /**
4796
- * TimePicker allows users to select a time value using either a scroll-based
4797
- * wheel picker (default) or a dropdown list of time options.
4798
- *
4799
- * @example
4800
- * // Basic 24h scroll picker with 15-minute intervals
4801
- * <TimePicker value="14:30" onChange={(value) => console.log(value)} step={15} />
4802
- *
4803
- * @example
4804
- * // 12h format scroll picker
4805
- * <TimePicker format="12h" step={30} />
4806
- *
4807
- * @example
4808
- * // Dropdown mode
4809
- * <TimePicker mode="dropdown" value="14:30" onChange={(value) => console.log(value)} step={30} />
4810
- */
4811
- export declare const TimePicker: React.ForwardRefExoticComponent<TimePickerProps & React.RefAttributes<HTMLDivElement>>;
4812
-
4813
- export {};