@marigold/components 7.8.2 → 8.0.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.
package/dist/index.d.mts CHANGED
@@ -12,11 +12,18 @@ import RAC, { ValidationResult, Key, DateValue, TagListProps } from 'react-aria-
12
12
  export { Form, FormProps, RouterProvider } from 'react-aria-components';
13
13
  export { I18nProvider } from '@react-aria/i18n';
14
14
  import { AriaTableProps } from '@react-aria/table';
15
- import { TableStateProps, RowProps as RowProps$1, TableBody, Cell, TableHeader, ColumnProps as ColumnProps$1 } from '@react-stately/table';
15
+ import { TableStateProps, RowProps as RowProps$1, ColumnProps as ColumnProps$1, TableBody, Cell, TableHeader } from '@react-stately/table';
16
16
  export { VisuallyHidden } from '@react-aria/visually-hidden';
17
17
 
18
18
  interface AccordionProps extends Omit<AriaAccordionProps<object>, 'children' | 'expandedKeys' | 'disabledKeys' | 'onExpandedChange'> {
19
+ /**
20
+ * The children of the component
21
+ */
19
22
  children: ItemElement<object>[] | ItemElement<object>;
23
+ /**
24
+ * Sets the mode of items open at the same time.
25
+ * @default single
26
+ */
20
27
  selectionMode?: SelectionMode;
21
28
  }
22
29
  declare const Accordion: {
@@ -30,8 +37,17 @@ interface AccordionOwnItemProps<T> extends ItemProps<T> {
30
37
  }
31
38
 
32
39
  interface AccordionItemProps {
40
+ /**
41
+ * Represents a single node in the tree structure, including its key, value, and any child nodes.
42
+ */
33
43
  item: Node<object>;
44
+ /**
45
+ * Manages the state of the tree structure, including selection and expansion of nodes.
46
+ */
34
47
  state: TreeState<object>;
48
+ /**
49
+ * Sets title of the accordion item which will be displayed to the button.
50
+ */
35
51
  title: string | ReactNode;
36
52
  variant?: string;
37
53
  size?: string;
@@ -39,15 +55,36 @@ interface AccordionItemProps {
39
55
  declare const AccordionItem: ({ item, state, title, variant, size, ...props }: AccordionItemProps) => react_jsx_runtime.JSX.Element;
40
56
 
41
57
  interface AsideProps extends GapSpaceProp {
58
+ /**
59
+ * The children of the component.
60
+ */
42
61
  children: [ReactElement, ReactElement];
62
+ /**
63
+ * The side of the aside content.
64
+ * @default left
65
+ */
43
66
  side?: 'left' | 'right';
67
+ /**
68
+ * The side width of the aside content.
69
+ */
44
70
  sideWidth?: string;
71
+ /**
72
+ * At which percent the content should wrap.
73
+ * @default 50%
74
+ */
45
75
  wrap?: NonZeroPercentage;
46
76
  }
47
77
  declare const Aside: ({ children, sideWidth, space, side, wrap, }: AsideProps) => react_jsx_runtime.JSX.Element;
48
78
 
49
79
  interface AspectProps extends Omit<HtmlProps<'div'>, 'className'>, AspectProp {
80
+ /**
81
+ * The children of the component.
82
+ */
50
83
  children?: ReactNode;
84
+ /**
85
+ * The maximum width of the image.
86
+ * @default 100%
87
+ */
51
88
  maxWidth?: string;
52
89
  }
53
90
  declare const Aspect: ({ ratio, maxWidth, children, }: AspectProps) => react_jsx_runtime.JSX.Element;
@@ -55,7 +92,13 @@ declare const Aspect: ({ ratio, maxWidth, children, }: AspectProps) => react_jsx
55
92
  interface HelpTextProps {
56
93
  variant?: string;
57
94
  size?: string;
95
+ /**
96
+ * A helpful text.
97
+ */
58
98
  description?: ReactNode;
99
+ /**
100
+ * An error message.
101
+ */
59
102
  errorMessage?: ReactNode | ((v: ValidationResult) => ReactNode);
60
103
  }
61
104
 
@@ -65,6 +108,11 @@ interface FieldBaseProps<T extends ElementType> extends WidthProp, Pick<HelpText
65
108
  variant?: string;
66
109
  size?: string;
67
110
  children?: ReactNode;
111
+ /**
112
+ * Use RAC prop names here so we can directly pass the components via "as"
113
+ */
114
+ isInvalid?: boolean;
115
+ isRequired?: boolean;
68
116
  }
69
117
  declare const FieldBase: <T extends ElementType>(props: FieldBaseProps<T> & DistributiveOmit<ComponentPropsWithRef<T>, "as"> & react.RefAttributes<any>) => ReactNode;
70
118
 
@@ -74,6 +122,9 @@ interface FieldGroupContextProps {
74
122
  declare const FieldGroupContext: react.Context<FieldGroupContextProps>;
75
123
  declare const useFieldGroupContext: () => FieldGroupContextProps;
76
124
  interface FieldGroupProps {
125
+ /**
126
+ * Sets the width of all Fields labels used inside the `FieldGroup`
127
+ */
77
128
  labelWidth?: string;
78
129
  children: ReactNode;
79
130
  }
@@ -99,13 +150,45 @@ declare const _ListBox: ListBoxComponent;
99
150
 
100
151
  type RemovedProps$n = 'className' | 'style' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly' | 'inputValue' | 'onInputChange' | 'defaultValue' | 'validate' | 'validationState';
101
152
  interface AutocompleteProps extends Omit<RAC.ComboBoxProps<object>, RemovedProps$n>, Pick<FieldBaseProps<'label'>, 'width' | 'label' | 'description' | 'errorMessage'> {
153
+ /**
154
+ * The value of the input (uncontrolled).
155
+ */
102
156
  defaultValue?: RAC.ComboBoxProps<object>['defaultInputValue'];
157
+ /**
158
+ * The value of the input (controlled).
159
+ */
103
160
  value?: RAC.ComboBoxProps<object>['inputValue'];
161
+ /**
162
+ * Called when the input value changes.
163
+ */
104
164
  onChange?: RAC.ComboBoxProps<object>['onInputChange'];
165
+ /**
166
+ * Called when the clear button is pressed.
167
+ */
105
168
  onClear?: () => void;
169
+ /**
170
+ * If `true`, the input is disabled.
171
+ *
172
+ * @default false
173
+ */
106
174
  disabled?: RAC.ComboBoxProps<object>['isDisabled'];
175
+ /**
176
+ * If `true`, the input is required.
177
+ *
178
+ * @default false
179
+ */
107
180
  required?: RAC.ComboBoxProps<object>['isRequired'];
181
+ /**
182
+ * If `true`, the field is considered invalid and if set the `errorMessage` is shown instead of the `description`.
183
+ *
184
+ * @default false
185
+ */
108
186
  error?: RAC.ComboBoxProps<object>['isInvalid'];
187
+ /**
188
+ * If `true`, the input is readOnly.
189
+ *
190
+ * @default false
191
+ */
109
192
  readOnly?: RAC.ComboBoxProps<object>['isReadOnly'];
110
193
  variant?: string;
111
194
  size?: string;
@@ -130,14 +213,45 @@ type RemovedProps$m = 'className' | 'style' | 'children' | 'isDisabled' | 'isReq
130
213
  interface ComboBoxProps extends Omit<RAC.ComboBoxProps<any>, RemovedProps$m>, Pick<FieldBaseProps<'label'>, 'width' | 'label' | 'description' | 'errorMessage'> {
131
214
  variant?: string;
132
215
  size?: string;
216
+ /**
217
+ * If `true`, the input is disabled.
218
+ * @default false
219
+ */
133
220
  disabled?: RAC.ComboBoxProps<any>['isDisabled'];
221
+ /**
222
+ * If `true`, the input is required.
223
+ * @default false
224
+ */
134
225
  required?: RAC.ComboBoxProps<any>['isRequired'];
226
+ /**
227
+ * If `true`, the input is readOnly.
228
+ * @default false
229
+ */
135
230
  readOnly?: RAC.ComboBoxProps<any>['isReadOnly'];
231
+ /**
232
+ * If `true`, the field is considered invalid and if set the `errorMessage` is shown instead of the `description`.
233
+ * @default false
234
+ */
136
235
  error?: RAC.ComboBoxProps<any>['isInvalid'];
236
+ /**
237
+ * The value of the input (uncontrolled).
238
+ */
137
239
  defaultValue?: RAC.ComboBoxProps<any>['defaultInputValue'];
240
+ /**
241
+ * The value of the input (controlled).
242
+ */
138
243
  value?: RAC.ComboBoxProps<any>['inputValue'];
244
+ /**
245
+ * Called when the input value changes.
246
+ */
139
247
  onChange?: RAC.ComboBoxProps<any>['onInputChange'];
248
+ /**
249
+ * ReactNode or function to render the list of items.
250
+ */
140
251
  children?: ReactNode | ((item: any) => ReactNode);
252
+ /**
253
+ * Set the placeholder for the select.
254
+ */
141
255
  placeholder?: string;
142
256
  }
143
257
  interface ComboBoxComponent extends ForwardRefExoticComponent<ComboBoxProps & RefAttributes<HTMLInputElement>> {
@@ -146,6 +260,9 @@ interface ComboBoxComponent extends ForwardRefExoticComponent<ComboBoxProps & Re
146
260
  declare const _ComboBox: ComboBoxComponent;
147
261
 
148
262
  interface BadgeProps extends Omit<HtmlProps<'div'>, 'className'> {
263
+ /**
264
+ * Children of the component
265
+ */
149
266
  children?: React.ReactNode;
150
267
  variant?: string;
151
268
  size?: string;
@@ -154,13 +271,27 @@ declare const Badge: ({ variant, size, children, ...props }: BadgeProps) => reac
154
271
 
155
272
  interface BreakoutProps extends Omit<HtmlProps<'div'>, 'className'>, AlignmentProp {
156
273
  children?: ReactNode;
274
+ /**
275
+ * Set the height of the breakout element.
276
+ */
157
277
  height?: string;
278
+ /**
279
+ * Horizontal alignment of the items inside the breakout element.
280
+ * @default left
281
+ */
158
282
  alignX?: keyof typeof alignment.horizontal.alignmentX;
283
+ /**
284
+ * Vertical alignment of the items inside the breakout element.
285
+ * @default top
286
+ */
159
287
  alignY?: keyof typeof alignment.horizontal.alignmentY;
160
288
  }
161
- declare const Breakout: ({ height, children, orientation, alignX, alignY, ...props }: BreakoutProps) => react_jsx_runtime.JSX.Element;
289
+ declare const Breakout: ({ height, children, alignX, alignY, ...props }: BreakoutProps) => react_jsx_runtime.JSX.Element;
162
290
 
163
291
  interface BodyProps extends Omit<HtmlProps<'section'>, 'className'> {
292
+ /**
293
+ * Children of the component
294
+ */
164
295
  children?: ReactNode;
165
296
  variant?: string;
166
297
  size?: string;
@@ -171,9 +302,23 @@ type RemovedProps$l = 'isDisabled';
171
302
  interface ButtonProps extends Omit<RAC.ButtonProps, RemovedProps$l> {
172
303
  variant?: string;
173
304
  size?: string;
305
+ /**
306
+ * Stretches the button width with full available space.
307
+ * @default false
308
+ */
174
309
  fullWidth?: boolean;
310
+ /**
311
+ * Class of the component.
312
+ */
175
313
  className?: string;
314
+ /**
315
+ * Children of the component
316
+ */
176
317
  children?: ReactNode;
318
+ /**
319
+ * Disables the button.
320
+ * @default false
321
+ */
177
322
  disabled?: RAC.ButtonProps['isDisabled'];
178
323
  }
179
324
  declare const _Button: react.ForwardRefExoticComponent<ButtonProps & react.RefAttributes<HTMLButtonElement>>;
@@ -182,21 +327,42 @@ interface CardProps extends Omit<HtmlProps<'div'>, 'className'>, GapSpaceProp, P
182
327
  children?: ReactNode;
183
328
  variant?: string;
184
329
  size?: string;
330
+ /**
331
+ * Padding of the component.
332
+ */
185
333
  p?: PaddingSpaceProp['space'];
334
+ /**
335
+ * Padding horizontal (left and right) of the component.
336
+ */
186
337
  px?: PaddingSpacePropX['spaceX'];
338
+ /**
339
+ * Padding vertical (top and bottom) of the component.
340
+ */
187
341
  py?: PaddingSpacePropY['spaceY'];
188
342
  }
189
343
  declare const Card: ({ children, variant, size, space, p, px, py, pt, pb, pl, pr, ...props }: CardProps) => react_jsx_runtime.JSX.Element;
190
344
 
191
345
  interface CenterProps extends Omit<HtmlProps<'div'>, 'className'>, GapSpaceProp {
192
346
  children?: ReactNode;
347
+ /**
348
+ * The maximum width of the container.
349
+ * @default 100%
350
+ */
193
351
  maxWidth?: string;
194
352
  }
195
353
  declare const Center: ({ maxWidth, space, children, ...props }: CenterProps) => react_jsx_runtime.JSX.Element;
196
354
 
197
355
  type CustomCheckboxProps = 'value' | 'onChange' | 'onFocus' | 'onBlur' | 'onKeyDown' | 'onKeyUp';
198
356
  interface CheckboxProps extends Omit<HtmlProps<'input'>, 'size' | 'type' | 'defaultValue' | CustomCheckboxProps>, Pick<RAC.CheckboxProps, CustomCheckboxProps> {
357
+ /**
358
+ * Use when it represents both selected and not selected values.
359
+ * @default false
360
+ */
199
361
  indeterminate?: boolean;
362
+ /**
363
+ * If `true`, the checkbox is considered invalid and if set the `errorMessage` is shown instead of the `description`.
364
+ * @default false
365
+ */
200
366
  error?: boolean;
201
367
  variant?: string;
202
368
  size?: string;
@@ -205,31 +371,82 @@ declare const _Checkbox: react.ForwardRefExoticComponent<CheckboxProps & react.R
205
371
 
206
372
  type RemovedProps$k = 'className' | 'style' | 'children' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly';
207
373
  interface CheckboxGroupProps extends Omit<RAC.CheckboxGroupProps, RemovedProps$k>, Pick<FieldBaseProps<'label'>, 'label' | 'description' | 'errorMessage'> {
374
+ /**
375
+ * The children of the component
376
+ */
208
377
  children?: ReactNode;
209
378
  variant?: string;
210
379
  size?: string;
380
+ /**
381
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
382
+ * @default full
383
+ */
211
384
  width?: WidthProp['width'];
385
+ /**
386
+ * Sets all checkboxes to disabled
387
+ * @default false
388
+ */
212
389
  disabled?: RAC.CheckboxGroupProps['isDisabled'];
390
+ /**
391
+ * Sets the checkbox as required.
392
+ * @default false
393
+ */
213
394
  required?: RAC.CheckboxGroupProps['isRequired'];
395
+ /**
396
+ * If `true`, the checkbox is considered invalid and if set the `errorMessage` is shown instead of the `description`.
397
+ * @default false
398
+ */
214
399
  error?: RAC.CheckboxGroupProps['isInvalid'];
400
+ /**
401
+ * Sets the checkbox on read only.
402
+ * @default false
403
+ */
215
404
  readOnly?: RAC.CheckboxGroupProps['isReadOnly'];
405
+ /**
406
+ * Wheather the component is displayed vertically or horizontally.
407
+ * @default vertical
408
+ */
216
409
  orientation?: Orientation;
217
410
  }
218
411
  declare const _CheckboxGroup: ({ children, variant, size, required, disabled, readOnly, error, width, orientation, ...rest }: CheckboxGroupProps) => react_jsx_runtime.JSX.Element;
219
412
 
220
413
  interface ColumnsProps extends GapSpaceProp {
414
+ /**
415
+ * The children of the component.
416
+ */
221
417
  children?: ReactNode;
418
+ /**
419
+ * An array of numbers to set the size of the children. The columns array length and the count of children must be the same. Write "fit" for the column you want to have it fitting the contents width and height.
420
+ */
222
421
  columns: Array<number | 'fit'>;
422
+ /**
423
+ * Collapse children into a vertical layout at given width. Note that `collapseAt` is based on the total element width, and not the window width. With a default value of "0" columns will not collapse by default.
424
+ */
223
425
  collapseAt?: string;
426
+ /**
427
+ * Stretch to height of parent container.
428
+ * @default false
429
+ */
224
430
  stretch?: boolean;
225
431
  }
226
432
  declare const Columns: ({ space, columns, collapseAt, stretch, children, ...props }: ColumnsProps) => react_jsx_runtime.JSX.Element;
227
433
 
228
434
  interface ContainerProps extends Omit<HtmlProps<'div'>, 'className'>, PlaceItemsProp, GridColumn, GridColsAlignProp {
229
435
  children?: ReactNode;
436
+ /**
437
+ * The content type of the container.
438
+ * @default 'content'
439
+ */
230
440
  contentType?: 'content' | 'header';
231
441
  size?: keyof typeof content | keyof typeof header;
442
+ /**
443
+ * Set alignment the content inside the container.
444
+ * @default left
445
+ */
232
446
  align?: 'left' | 'right' | 'center';
447
+ /**
448
+ * Set alignment of the items inside the container.
449
+ */
233
450
  alignItems?: PlaceItemsProp['align'];
234
451
  }
235
452
  declare const content: {
@@ -245,17 +462,37 @@ declare const header: {
245
462
  declare const Container: ({ contentType, size, align, alignItems, children, ...props }: ContainerProps) => react_jsx_runtime.JSX.Element;
246
463
 
247
464
  interface DialogTriggerProps extends Omit<RAC.DialogTriggerProps, 'isOpen'> {
465
+ /**
466
+ * Wheather compnent is rendered.
467
+ * @default false
468
+ */
248
469
  open?: boolean;
470
+ /**
471
+ * Whether to close the overlay when the user interacts outside it.
472
+ * @default false
473
+ */
249
474
  dismissable?: boolean;
475
+ /**
476
+ * Whether pressing the escape key to close the overlay should be disabled.
477
+ */
250
478
  keyboardDismissable?: boolean;
479
+ /**
480
+ * If `true`, the dialog will be non-modal, meaning it will not block interaction with the background content.
481
+ */
251
482
  isNonModal?: boolean;
252
483
  }
253
484
 
254
485
  type RemovedProps$j = 'className' | 'level';
255
486
  interface HeadlineProps extends Omit<RAC.HeadingProps, RemovedProps$j>, TextAlignProp {
487
+ /**
488
+ * Set the color of the headline.
489
+ */
256
490
  color?: string;
257
491
  variant?: string;
258
492
  size?: string;
493
+ /**
494
+ * Set a different level from theme, values are from 1 - 6.
495
+ */
259
496
  level?: '1' | '2' | '3' | '4' | '5' | '6' | RAC.HeadingProps['level'];
260
497
  }
261
498
  declare const _Headline: ({ variant, size, children, align, color, level, ...props }: HeadlineProps) => react_jsx_runtime.JSX.Element;
@@ -265,7 +502,14 @@ interface DialogHeadlineProps extends Omit<HeadlineProps, 'slot'> {
265
502
  interface DialogProps extends Omit<RAC.DialogProps, 'className' | 'style'> {
266
503
  variant?: string;
267
504
  size?: string;
505
+ /**
506
+ * Show the close button.
507
+ */
268
508
  closeButton?: boolean;
509
+ /**
510
+ * If `true`, the dialog will be non-modal, meaning it will not block interaction with the background content.
511
+ * @default false
512
+ */
269
513
  isNonModal?: boolean;
270
514
  }
271
515
  declare const _Dialog: {
@@ -280,6 +524,9 @@ interface DividerProps extends RAC.SeparatorProps {
280
524
  declare const _Divider: ({ variant, ...props }: DividerProps) => react_jsx_runtime.JSX.Element;
281
525
 
282
526
  interface FooterProps extends Omit<HtmlProps<'footer'>, 'className'> {
527
+ /**
528
+ * The children of the component.
529
+ */
283
530
  children?: ReactNode;
284
531
  variant?: string;
285
532
  size?: string;
@@ -307,6 +554,9 @@ declare const Grid: {
307
554
  };
308
555
 
309
556
  interface HeaderProps extends Omit<RAC.HeadingProps, 'children'> {
557
+ /**
558
+ * The children of the component.
559
+ */
310
560
  children?: ReactNode;
311
561
  variant?: string;
312
562
  size?: string;
@@ -316,14 +566,28 @@ declare const _Header: ({ variant, size, ...props }: HeaderProps) => react_jsx_r
316
566
  interface ImageProps extends Omit<HtmlProps<'img'>, 'className'>, ObjectFitProp, ObjectPositionProp {
317
567
  variant?: string;
318
568
  size?: string;
569
+ /**
570
+ * The children of the component.
571
+ */
319
572
  children?: never;
573
+ /**
574
+ * specifies an alternate text for an image, if the image cannot be displayed.
575
+ */
320
576
  alt: string;
321
577
  }
322
578
  declare const Image: ({ variant, size, fit, position, ...props }: ImageProps) => react_jsx_runtime.JSX.Element;
323
579
 
324
580
  interface InlineProps extends AlignmentProp, GapSpaceProp {
325
581
  children?: ReactNode;
582
+ /**
583
+ * Horizontal alignment of the items inside the breakout element.
584
+ * @default 'left'
585
+ */
326
586
  alignX?: keyof typeof alignment.horizontal.alignmentX;
587
+ /**
588
+ * Vertical alignment of the items inside the breakout element.
589
+ * @default 'center'
590
+ */
327
591
  alignY?: keyof typeof alignment.horizontal.alignmentY;
328
592
  }
329
593
  declare const Inline: ({ space, orientation, alignX, alignY, children, ...props }: InlineProps) => react_jsx_runtime.JSX.Element;
@@ -343,17 +607,45 @@ interface DateFieldProps extends Omit<RAC.DateFieldProps<DateValue>, RemovedProp
343
607
  variant?: string;
344
608
  size?: string;
345
609
  action?: ReactElement;
610
+ /**
611
+ * If `true`, the date field is required.
612
+ * @default false
613
+ */
346
614
  required?: RAC.DateFieldProps<DateValue>['isRequired'];
615
+ /**
616
+ * If `true`, the date field is disabled.
617
+ * @default false
618
+ */
347
619
  disabled?: RAC.DateFieldProps<DateValue>['isDisabled'];
620
+ /**
621
+ * If `true`, the field is considered invalid and if set the errorMessage is shown instead of the `description`.
622
+ * @default false
623
+ */
348
624
  error?: RAC.DateFieldProps<DateValue>['isInvalid'];
625
+ /**
626
+ * If `true`, the date field is readOnly.
627
+ * @default false
628
+ */
349
629
  readOnly?: RAC.DateFieldProps<DateValue>['isReadOnly'];
630
+ /**
631
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
632
+ * @default 'full'
633
+ */
350
634
  width?: WidthProp['width'];
351
635
  }
352
636
  declare const _DateField: react.ForwardRefExoticComponent<DateFieldProps & react.RefAttributes<HTMLInputElement>>;
353
637
 
354
638
  type RemovedProps$g = 'isDisabled' | 'isReadOnly' | 'isInvalid' | 'errorMessage' | 'className' | 'style';
355
639
  interface CalendarProps extends Omit<RAC.CalendarProps<DateValue>, RemovedProps$g> {
640
+ /**
641
+ * Disables the Calendar.
642
+ * @default false
643
+ */
356
644
  disabled?: boolean;
645
+ /**
646
+ * Whether the calendar value is immutable.
647
+ * @default false
648
+ */
357
649
  readOnly?: boolean;
358
650
  variant?: string;
359
651
  size?: string;
@@ -363,24 +655,59 @@ declare const _Calendar: ({ disabled, readOnly, size, variant, ...rest }: Calend
363
655
 
364
656
  type RemovedProps$f = 'isDisabled' | 'isReadOnly' | 'isRequired' | 'isInvalid' | 'style' | 'className' | 'isOpen';
365
657
  interface DatePickerProps extends Omit<RAC.DatePickerProps<DateValue>, RemovedProps$f>, Pick<FieldBaseProps<'label'>, 'label' | 'description' | 'errorMessage'> {
658
+ /**
659
+ * If `true`, the date picker is disabled.
660
+ * @default false
661
+ */
366
662
  disabled?: RAC.DatePickerProps<DateValue>['isDisabled'];
663
+ /**
664
+ * If `true`, the date picker is required.
665
+ * @default false
666
+ */
367
667
  required?: RAC.DatePickerProps<DateValue>['isRequired'];
668
+ /**
669
+ * If `true`, the date picker is readOnly.
670
+ * @default false
671
+ */
368
672
  readOnly?: RAC.DatePickerProps<DateValue>['isReadOnly'];
673
+ /**
674
+ * If `true`, the field is considered invalid and if set the errorMessage is shown instead of the `description`.
675
+ * @default false
676
+ */
369
677
  error?: RAC.DatePickerProps<DateValue>['isInvalid'];
678
+ /**
679
+ * Whether the calendar is open by default (controlled).
680
+ * @default false
681
+ */
370
682
  open?: RAC.DatePickerProps<DateValue>['isOpen'];
371
683
  variant?: string;
372
684
  size?: string;
685
+ /**
686
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
687
+ */
373
688
  width?: WidthProp['width'];
374
689
  }
375
690
  declare const _DatePicker: ({ disabled, required, readOnly, error, variant, size, open, granularity, ...rest }: DatePickerProps) => react_jsx_runtime.JSX.Element;
376
691
 
377
692
  type InsetProps = {
693
+ /**
694
+ * The children of the component
695
+ */
378
696
  children: ReactNode;
379
697
  space?: never;
698
+ /**
699
+ * Horizontal alignment for the children
700
+ */
380
701
  spaceX?: PaddingSpacePropX['spaceX'];
702
+ /**
703
+ * Vertical alignment for the children
704
+ */
381
705
  spaceY?: PaddingSpacePropY['spaceY'];
382
706
  } | {
383
707
  children: ReactNode;
708
+ /**
709
+ * The space between the children
710
+ */
384
711
  space?: PaddingSpaceProp['space'];
385
712
  spaceX?: never;
386
713
  spaceY?: never;
@@ -398,6 +725,10 @@ type RemovedProps$d = 'className' | 'isDisabled';
398
725
  interface LinkProps extends Omit<RAC.LinkProps, RemovedProps$d> {
399
726
  variant?: string;
400
727
  size?: string;
728
+ /**
729
+ * The link can't be clicked
730
+ * @default false
731
+ */
401
732
  disabled?: RAC.LinkProps['isDisabled'];
402
733
  }
403
734
  declare const _Link: react.ForwardRefExoticComponent<LinkProps & react.RefAttributes<HTMLAnchorElement>>;
@@ -409,7 +740,14 @@ interface ListItemProps extends Omit<HtmlProps<'li'>, 'className'> {
409
740
  interface ListProps extends Omit<HtmlProps<'ul'>, 'className'> {
410
741
  variant?: string;
411
742
  size?: string;
743
+ /**
744
+ * Displaying a unordered or ordered list for showing Information.
745
+ * @default 'ul'
746
+ */
412
747
  as?: 'ul' | 'ol';
748
+ /**
749
+ * The children of the component.
750
+ */
413
751
  children?: ReactNode;
414
752
  }
415
753
  declare const List: {
@@ -436,13 +774,33 @@ declare const _Popover: react.ForwardRefExoticComponent<PopoverProps & react.Ref
436
774
 
437
775
  type RemovedProps$a = 'isOpen' | 'className' | 'style' | 'children';
438
776
  interface MenuProps extends Omit<RAC.MenuTriggerProps, RemovedProps$a>, Omit<RAC.MenuProps<object>, RemovedProps$a> {
777
+ /**
778
+ * Whether the menu is open.
779
+ * @default false
780
+ */
439
781
  open?: RAC.MenuTriggerProps['isOpen'];
782
+ /**
783
+ * Placement of the popover.
784
+ * @default 'bottom'
785
+ */
440
786
  placement?: PopoverProps['placement'];
787
+ /**
788
+ * The label for the menu trigger button.
789
+ */
441
790
  label?: ReactNode;
442
791
  variant?: string;
443
792
  size?: string;
793
+ /**
794
+ * Handler that is called when an action is performed on an item.
795
+ */
444
796
  onAction?: (key: Key$1) => void;
797
+ /**
798
+ * The contents of the menu.
799
+ */
445
800
  children?: ReactNode;
801
+ /**
802
+ * Whether the menu trigger is disabled.
803
+ */
446
804
  disabled?: boolean;
447
805
  }
448
806
  declare const _Menu: {
@@ -458,18 +816,29 @@ interface ActionMenuProps extends RAC.MenuProps<object> {
458
816
  }
459
817
  declare const ActionMenu: ({ variant, size, disabled, ...props }: ActionMenuProps) => react_jsx_runtime.JSX.Element;
460
818
 
819
+ interface SectionMessageContentProps {
820
+ children?: ReactNode;
821
+ }
822
+
823
+ interface SectionMessageTitleProps {
824
+ children?: ReactNode;
825
+ }
826
+
461
827
  declare const icons: {
462
828
  success: () => react_jsx_runtime.JSX.Element;
463
829
  info: () => react_jsx_runtime.JSX.Element;
464
830
  warning: () => react_jsx_runtime.JSX.Element;
465
831
  error: () => react_jsx_runtime.JSX.Element;
466
832
  };
467
- interface MessageProps extends Omit<HtmlProps<'div'>, 'className'> {
468
- messageTitle: ReactNode;
833
+ interface SectionMessageProps extends Omit<HtmlProps<'div'>, 'className'> {
469
834
  variant?: keyof typeof icons;
470
835
  size?: string;
471
836
  }
472
- declare const Message: react.ForwardRefExoticComponent<MessageProps & react.RefAttributes<HTMLDivElement>>;
837
+ declare const SectionMessage: {
838
+ ({ variant, size, children, ...props }: SectionMessageProps): react_jsx_runtime.JSX.Element;
839
+ Title: ({ children }: SectionMessageTitleProps) => react_jsx_runtime.JSX.Element;
840
+ Content: ({ children, }: SectionMessageContentProps) => react_jsx_runtime.JSX.Element;
841
+ };
473
842
 
474
843
  interface MultiSelectItemProps {
475
844
  id: Key;
@@ -489,12 +858,40 @@ type RemovedProps$9 = 'className' | 'style' | 'children' | 'isDisabled' | 'isReq
489
858
  interface NumberFieldProps extends Omit<RAC.NumberFieldProps, RemovedProps$9>, Pick<FieldBaseProps<'label'>, 'label' | 'description' | 'errorMessage'> {
490
859
  variant?: string;
491
860
  size?: string;
861
+ /**
862
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
863
+ * @default full
864
+ */
492
865
  width?: WidthProp['width'];
866
+ /**
867
+ * If `true`, the input is disabled.
868
+ * @default false
869
+ */
493
870
  disabled?: RAC.NumberFieldProps['isDisabled'];
871
+ /**
872
+ * If `true`, the input is required.
873
+ * @default false
874
+ */
494
875
  required?: RAC.NumberFieldProps['isRequired'];
876
+ /**
877
+ * If `true`, the field is considered invalid and if set the errorMessage is shown instead of the `description`.
878
+ * @default false
879
+ */
495
880
  error?: RAC.NumberFieldProps['isInvalid'];
881
+ /**
882
+ * If `true`, the input is readOnly.
883
+ * @default false
884
+ */
496
885
  readOnly?: RAC.NumberFieldProps['isReadOnly'];
886
+ /**
887
+ * Property for hiding the step buttons of the field.
888
+ * @default false
889
+ */
497
890
  hideStepper?: boolean;
891
+ /**
892
+ * Placeholder text for the input field.
893
+ * @default none
894
+ */
498
895
  placeholder?: string;
499
896
  }
500
897
  declare const _NumberField: react.ForwardRefExoticComponent<NumberFieldProps & react.RefAttributes<HTMLInputElement>>;
@@ -526,16 +923,59 @@ type RemovedProps$8 = 'className' | 'style' | 'isDisabled' | 'isInvalid' | 'isRe
526
923
  interface RadioGroupProps extends Omit<RAC.RadioGroupProps, RemovedProps$8> {
527
924
  variant?: string;
528
925
  size?: string;
926
+ /**
927
+ * Set the label of the radio group.
928
+ * @default none
929
+ */
529
930
  label?: string;
931
+ /**
932
+ * Set the radio group help text.
933
+ * @default none
934
+ */
530
935
  description?: string;
936
+ /**
937
+ * Set the radio group error message if an error occurs.
938
+ * @default none
939
+ */
531
940
  errorMessage?: string;
941
+ /**
942
+ * The children elements of the radio group.
943
+ */
532
944
  children: ReactNode[];
945
+ /**
946
+ * Control the width of the field.
947
+ * @default 100%
948
+ */
533
949
  width?: WidthProp['width'];
950
+ /**
951
+ * If `true`, the radio group is considered invalid and if set the `errorMessage` is shown.
952
+ * @default false
953
+ */
534
954
  error?: RAC.RadioGroupProps['isInvalid'];
955
+ /**
956
+ * If `true`, the radio group is required.
957
+ * @default false
958
+ */
535
959
  required?: RAC.RadioGroupProps['isRequired'];
960
+ /**
961
+ * If `true`, the radio group is disabled.
962
+ * @default false
963
+ */
536
964
  disabled?: RAC.RadioGroupProps['isDisabled'];
965
+ /**
966
+ * Set the radio group as read-only.
967
+ * @default false
968
+ */
537
969
  readOnly?: boolean;
970
+ /**
971
+ * The selected value of the radio group.
972
+ */
538
973
  value?: string;
974
+ /**
975
+ * Set the radio group direction.
976
+ * @default vertical
977
+ */
978
+ orientation?: 'horizontal' | 'vertical';
539
979
  }
540
980
  declare const _RadioGroup: ({ variant, size, label, error, disabled, required, readOnly, description, errorMessage, orientation, children, width, ...rest }: RadioGroupProps) => react_jsx_runtime.JSX.Element;
541
981
 
@@ -543,8 +983,16 @@ type RemovedProps$7 = 'className' | 'style' | 'children' | 'isDisabled';
543
983
  interface RadioProps extends Omit<RAC.RadioProps, RemovedProps$7> {
544
984
  variant?: string;
545
985
  size?: string;
986
+ /**
987
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
988
+ * @default full
989
+ */
546
990
  width?: string;
547
991
  children?: ReactNode;
992
+ /**
993
+ * Set the radio disabled.
994
+ * @default false
995
+ */
548
996
  disabled?: RAC.RadioProps['isDisabled'];
549
997
  }
550
998
  declare const _Radio: RadioComponent;
@@ -559,39 +1007,130 @@ interface RadioComponent extends ForwardRefExoticComponent<RadioProps & RefAttri
559
1007
 
560
1008
  type RemovedProps$6 = 'className' | 'style' | 'children' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly' | 'value' | 'defaultValue';
561
1009
  interface SearchFieldProps extends Omit<RAC.SearchFieldProps, RemovedProps$6>, Pick<FieldBaseProps<'label'>, 'label' | 'description' | 'errorMessage'> {
1010
+ /**
1011
+ * Icon element to display in the search field.
1012
+ */
562
1013
  icon?: ReactElement;
1014
+ /**
1015
+ * Action element to display in the search field.
1016
+ */
563
1017
  action?: ReactElement;
564
1018
  variant?: string;
565
1019
  size?: string;
1020
+ /**
1021
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
1022
+ * @default full
1023
+ */
566
1024
  width?: WidthProp['width'];
1025
+ /**
1026
+ * If `true`, the input is considered invalid and if set the `errorMessage` is shown instead of the `description`.
1027
+ * @default false
1028
+ */
567
1029
  error?: RAC.SearchFieldProps['isInvalid'];
1030
+ /**
1031
+ * If `true`, the input is disabled.
1032
+ * @default false
1033
+ */
568
1034
  disabled?: RAC.SearchFieldProps['isDisabled'];
1035
+ /**
1036
+ * If `true`, the input is required.
1037
+ * @default false
1038
+ */
569
1039
  required?: RAC.SearchFieldProps['isRequired'];
1040
+ /**
1041
+ * If `true`, the input is readOnly.
1042
+ * @default false
1043
+ */
570
1044
  readOnly?: RAC.SearchFieldProps['isReadOnly'];
1045
+ /**
1046
+ * The current value of the input field.
1047
+ * @default none
1048
+ */
571
1049
  value?: string;
1050
+ /**
1051
+ * The default value of the input field.
1052
+ * @default none
1053
+ */
572
1054
  defaultValue?: string;
1055
+ /**
1056
+ * Placeholder text for the input field.
1057
+ * @default none
1058
+ */
573
1059
  placeholder?: string;
574
1060
  }
575
1061
  declare const _SearchField: react.ForwardRefExoticComponent<SearchFieldProps & react.RefAttributes<HTMLInputElement>>;
576
1062
 
577
1063
  type RemoveProps$1 = 'children' | 'isInvalid' | 'isDisabled' | 'isOpen' | 'isRequired' | 'style' | 'className' | 'onSelectionChange';
578
1064
  interface SelectProps<T extends object> extends Omit<RAC.SelectProps<T>, RemoveProps$1> {
1065
+ /**
1066
+ * Set a label for the select.
1067
+ */
579
1068
  label?: string;
1069
+ /**
1070
+ * Set a description for the select.
1071
+ */
580
1072
  description?: string;
1073
+ /**
1074
+ * Set a error message for the select.
1075
+ */
581
1076
  errorMessage?: string | ((validation: ValidationResult) => string);
1077
+ /**
1078
+ * Items of the select.
1079
+ */
582
1080
  items?: Iterable<T>;
1081
+ /**
1082
+ * Children of the select.
1083
+ */
583
1084
  children: React.ReactNode | ((item: T) => React.ReactNode);
1085
+ /**
1086
+ * sets the variant of the select.
1087
+ */
584
1088
  variant?: string;
1089
+ /**
1090
+ * Sets the size of the select.
1091
+ */
585
1092
  size?: string;
1093
+ /**
1094
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
1095
+ */
586
1096
  width?: WidthProp['width'];
1097
+ /**
1098
+ * If the select should be required.
1099
+ *
1100
+ * @default false
1101
+ */
587
1102
  required?: boolean;
1103
+ /**
1104
+ * If the select should be disabled.
1105
+ *
1106
+ * @default false
1107
+ */
588
1108
  disabled?: boolean;
1109
+ /**
1110
+ * If the select list should be open.
1111
+ *
1112
+ * @default false
1113
+ */
589
1114
  open?: boolean;
1115
+ /**
1116
+ * If the select should throw an error.
1117
+ *
1118
+ * @default false
1119
+ */
590
1120
  error?: boolean;
1121
+ /**
1122
+ * Handler that is called when the selection changes.
1123
+ */
591
1124
  onChange?: RAC.SelectProps<object>['onSelectionChange'];
592
1125
  }
593
1126
  interface SelectComponent extends ForwardRefExoticComponent<SelectProps<object> & RefAttributes<HTMLDivElement>> {
1127
+ /**
1128
+ * Options of the Select.
1129
+ */
594
1130
  Option: typeof _ListBox.Item;
1131
+ /**
1132
+ * Section of the Select.
1133
+ */
595
1134
  Section: typeof _ListBox.Section;
596
1135
  }
597
1136
  declare const _Select: SelectComponent;
@@ -602,9 +1141,15 @@ declare const _SelectListItem: react.ForwardRefExoticComponent<SelectListItemPro
602
1141
 
603
1142
  type RemoveProps = 'style' | 'className' | 'onSelectionChange';
604
1143
  interface SelectListProps extends Omit<RAC.GridListProps<object>, RemoveProps> {
1144
+ /**
1145
+ * Handler that is called when the selection change.
1146
+ */
605
1147
  onChange?: RAC.GridListProps<object>['onSelectionChange'] | Dispatch<SetStateAction<any>>;
606
1148
  }
607
1149
  interface SelectListComponent extends ForwardRefExoticComponent<SelectListProps & RefAttributes<HTMLUListElement>> {
1150
+ /**
1151
+ * Items of the SelectList.
1152
+ */
608
1153
  Item: typeof _SelectListItem;
609
1154
  }
610
1155
  declare const _SelectList: SelectListComponent;
@@ -616,10 +1161,21 @@ interface ScrollableProps extends WidthProp {
616
1161
  declare const Scrollable: ({ children, width, height, ...props }: ScrollableProps) => react_jsx_runtime.JSX.Element;
617
1162
 
618
1163
  interface SliderProps<T> extends Omit<RAC.SliderProps<T>, 'isDisabled' | 'label'> {
1164
+ /**
1165
+ * Labels for the thumbs in the slider.
1166
+ */
619
1167
  thumbLabels?: string[];
1168
+ /**
1169
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
1170
+ * @default full
1171
+ */
620
1172
  width?: WidthProp['width'];
621
1173
  variant?: string;
622
1174
  size?: string;
1175
+ /**
1176
+ * If `true`, the input is disabled.
1177
+ * @default false
1178
+ */
623
1179
  disabled?: boolean;
624
1180
  }
625
1181
  declare const _Slider: react__default.ForwardRefExoticComponent<SliderProps<number | number[]> & react__default.RefAttributes<HTMLDivElement>>;
@@ -630,20 +1186,48 @@ declare const Split: (props: SplitProps) => react_jsx_runtime.JSX.Element;
630
1186
 
631
1187
  interface StackProps extends AlignmentProp, GapSpaceProp {
632
1188
  children?: ReactNode;
1189
+ /**
1190
+ * Stretch to fill space (vertical AND horizontal, useful if you want to change y alignment).
1191
+ * @default false
1192
+ */
633
1193
  stretch?: boolean;
1194
+ /**
1195
+ * Horizontal alignment for the children.
1196
+ * @default none
1197
+ */
634
1198
  alignX?: keyof typeof alignment.vertical.alignmentX;
1199
+ /**
1200
+ * Vertical alignment for the children.
1201
+ * @default none
1202
+ */
635
1203
  alignY?: keyof typeof alignment.vertical.alignmentY;
636
1204
  }
637
- declare const Stack: ({ children, space, stretch, orientation, alignX, alignY, ...props }: StackProps) => react_jsx_runtime.JSX.Element;
1205
+ declare const Stack: ({ children, space, stretch, alignX, alignY, ...props }: StackProps) => react_jsx_runtime.JSX.Element;
638
1206
 
639
1207
  type RemovedProps$5 = 'className' | 'isDisabled' | 'isReadOnly' | 'isSelected' | 'children';
640
1208
  interface SwitchProps extends Omit<RAC.SwitchProps, RemovedProps$5> {
641
1209
  variant?: string;
642
1210
  size?: string;
643
1211
  children?: ReactNode;
1212
+ /**
1213
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
1214
+ * @default full
1215
+ */
644
1216
  width?: WidthProp['width'];
1217
+ /**
1218
+ * Disables the switch.
1219
+ * @default false
1220
+ */
645
1221
  disabled?: RAC.SwitchProps['isDisabled'];
1222
+ /**
1223
+ * Set the switch to read-only.
1224
+ * @default false
1225
+ */
646
1226
  readOnly?: RAC.SwitchProps['isReadOnly'];
1227
+ /**
1228
+ * With this prop you can set the switch selected.
1229
+ * @default false
1230
+ */
647
1231
  selected?: RAC.SwitchProps['isSelected'];
648
1232
  }
649
1233
  declare const _Switch: react.ForwardRefExoticComponent<SwitchProps & react.RefAttributes<HTMLLabelElement>>;
@@ -651,8 +1235,20 @@ declare const _Switch: react.ForwardRefExoticComponent<SwitchProps & react.RefAt
651
1235
  interface TableProps extends Pick<AriaTableProps<object>, 'focusMode' | 'onRowAction' | 'onCellAction'>, Omit<TableStateProps<object>, 'showSelectionCheckboxes'> {
652
1236
  variant?: string;
653
1237
  size?: string;
1238
+ /**
1239
+ * Stretch table to fill the container.
1240
+ * @default false
1241
+ */
654
1242
  stretch?: boolean;
1243
+ /**
1244
+ * Make the column sticky to the top of the table.
1245
+ * @default true
1246
+ */
655
1247
  stickyHeader?: boolean;
1248
+ /**
1249
+ * Disable keyboard navigation. Use if you have input fields in your table. Be aware that this is bad for accessibility.
1250
+ * @default false
1251
+ */
656
1252
  disableKeyboardNavigation?: boolean;
657
1253
  }
658
1254
  interface RowProps extends RowProps$1<any> {
@@ -660,6 +1256,10 @@ interface RowProps extends RowProps$1<any> {
660
1256
  size?: string;
661
1257
  }
662
1258
  interface ColumnProps extends Omit<ColumnProps$1<any>, 'width'>, WidthProp {
1259
+ /**
1260
+ * Control the alignment of Column.
1261
+ * @default left
1262
+ */
663
1263
  align?: Exclude<JSX.IntrinsicElements['td']['align'], 'char'>;
664
1264
  }
665
1265
  declare const Table: Table;
@@ -677,8 +1277,15 @@ interface Table {
677
1277
  }
678
1278
 
679
1279
  interface TextProps extends Omit<HtmlProps<'p'>, 'className'>, TextAlignProp, FontSizeProp, FontWeightProp, FontStyleProp, CursorProp {
1280
+ /**
1281
+ * The children of the component
1282
+ */
680
1283
  children?: React.ReactNode;
681
1284
  variant?: string;
1285
+ /**
1286
+ * Set the text color.
1287
+ * @default currentColor
1288
+ */
682
1289
  color?: string;
683
1290
  size?: string;
684
1291
  }
@@ -688,14 +1295,51 @@ type RemovedProps$4 = 'className' | 'style' | 'children' | 'isDisabled' | 'isReq
688
1295
  interface TextAreaProps extends Omit<RAC.TextFieldProps, RemovedProps$4>, Pick<RAC.TextAreaProps, 'rows'>, Pick<FieldBaseProps<'label'>, 'label' | 'description' | 'errorMessage'> {
689
1296
  variant?: string;
690
1297
  size?: string;
1298
+ /**
1299
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
1300
+ * @default full
1301
+ */
691
1302
  width?: WidthProp['width'];
1303
+ /**
1304
+ * If `true`, the textarea is disabled.
1305
+ * @default false
1306
+ */
692
1307
  disabled?: RAC.TextFieldProps['isDisabled'];
1308
+ /**
1309
+ * If `true`, the textarea is required.
1310
+ * @default false
1311
+ */
693
1312
  required?: RAC.TextFieldProps['isRequired'];
1313
+ /**
1314
+ * If `true`, the field is considered invalid and if set the `errorMessage` is shown instead of the `description`.
1315
+ * @default false
1316
+ */
694
1317
  error?: RAC.TextFieldProps['isInvalid'];
1318
+ /**
1319
+ * If `true`, the textarea is read-only.
1320
+ * @default false
1321
+ */
695
1322
  readOnly?: RAC.TextFieldProps['isReadOnly'];
1323
+ /**
1324
+ * The value of the textarea.
1325
+ * @default none
1326
+ */
696
1327
  value?: string;
1328
+ /**
1329
+ * The default value of the textarea.
1330
+ * @default none
1331
+ */
697
1332
  defaultValue?: string;
1333
+ /**
1334
+ * Placeholder text for the textarea.
1335
+ * @default none
1336
+ */
698
1337
  placeholder?: string;
1338
+ /**
1339
+ * Sets the number of rows in the textarea.
1340
+ * @default none
1341
+ */
1342
+ rows?: number;
699
1343
  }
700
1344
  declare const _TextArea: react.ForwardRefExoticComponent<TextAreaProps & react.RefAttributes<HTMLTextAreaElement>>;
701
1345
 
@@ -703,23 +1347,78 @@ type RemovedProps$3 = 'className' | 'style' | 'children' | 'isDisabled' | 'isReq
703
1347
  interface TextFieldProps extends Omit<RAC.TextFieldProps, RemovedProps$3>, Pick<FieldBaseProps<'label'>, 'label' | 'description' | 'errorMessage'> {
704
1348
  variant?: string;
705
1349
  size?: string;
1350
+ /**
1351
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
1352
+ * @default full
1353
+ */
706
1354
  width?: WidthProp['width'];
1355
+ /**
1356
+ * If `true`, the input is disabled.
1357
+ * @default false
1358
+ */
707
1359
  disabled?: RAC.TextFieldProps['isDisabled'];
1360
+ /**
1361
+ * If `true`, the input is required.
1362
+ * @default false
1363
+ */
708
1364
  required?: RAC.TextFieldProps['isRequired'];
1365
+ /**
1366
+ * If `true`, the field is considered invalid and if set the `errorMessage` is shown instead of the `description`.
1367
+ * @default false
1368
+ */
709
1369
  error?: RAC.TextFieldProps['isInvalid'];
1370
+ /**
1371
+ * If `true`, the input is readOnly.
1372
+ * @default false
1373
+ */
710
1374
  readOnly?: RAC.TextFieldProps['isReadOnly'];
1375
+ /**
1376
+ * The minimum value for the input field.
1377
+ * @default none
1378
+ */
711
1379
  min?: HTMLInputElement['min'];
1380
+ /**
1381
+ * The maximum value for the input field.
1382
+ * @default none
1383
+ */
712
1384
  max?: HTMLInputElement['max'];
1385
+ /**
1386
+ * The value of the input field.
1387
+ * @default none
1388
+ */
713
1389
  value?: string;
1390
+ /**
1391
+ * The default value of the input field.
1392
+ * @default none
1393
+ */
714
1394
  defaultValue?: string;
1395
+ /**
1396
+ * Placeholder text for the input field.
1397
+ * @default none
1398
+ */
715
1399
  placeholder?: string;
716
1400
  }
717
1401
  declare const _TextField: react.ForwardRefExoticComponent<TextFieldProps & react.RefAttributes<HTMLInputElement>>;
718
1402
 
719
1403
  interface TilesProps extends GapSpaceProp {
1404
+ /**
1405
+ * The children of the component.
1406
+ */
720
1407
  children: ReactNode;
1408
+ /**
1409
+ * Set minimum width for all items inside.
1410
+ * @default '250px'
1411
+ */
721
1412
  tilesWidth: string;
1413
+ /**
1414
+ * Tiles will stretch to available width and will distribute their width equally. Note that this can make them wider than the specified tiles width, but not smaller than the given "tilesWidth". Basically, this is full responsive mode.
1415
+ * @default false
1416
+ */
722
1417
  stretch?: boolean;
1418
+ /**
1419
+ * If true, all items will have the size of the biggest item.
1420
+ * @default false
1421
+ */
723
1422
  equalHeight?: boolean;
724
1423
  }
725
1424
  declare const Tiles: ({ space, stretch, equalHeight, tilesWidth, children, ...props }: TilesProps) => react_jsx_runtime.JSX.Element;
@@ -732,9 +1431,15 @@ interface TooltipTriggerProps extends Omit<RAC.TooltipTriggerComponentProps, Rem
732
1431
 
733
1432
  type RemovedProps$1 = 'className' | 'isOpen' | 'style';
734
1433
  interface TooltipProps extends Omit<RAC.TooltipProps, RemovedProps$1> {
1434
+ /**
1435
+ * The children of the component.
1436
+ */
735
1437
  children?: ReactNode;
736
1438
  variant?: string;
737
1439
  size?: string;
1440
+ /**
1441
+ * Whether the element is rendered.
1442
+ */
738
1443
  open?: RAC.TooltipProps['isOpen'];
739
1444
  }
740
1445
  declare const _Tooltip: {
@@ -746,7 +1451,15 @@ type RemovedProps = 'className' | 'style' | 'children' | 'isRequired';
746
1451
  interface TagGroupProps extends Omit<RAC.TagGroupProps, RemovedProps>, Pick<TagListProps<object>, 'items' | 'children' | 'renderEmptyState'>, Pick<FieldBaseProps<'label'>, 'label' | 'description'> {
747
1452
  variant?: string;
748
1453
  size?: string;
1454
+ /**
1455
+ * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
1456
+ * @default full
1457
+ */
749
1458
  width?: WidthProp['width'];
1459
+ /**
1460
+ * Displays a remove button on each tag.
1461
+ * @default false
1462
+ */
750
1463
  allowsRemoving?: boolean;
751
1464
  }
752
1465
 
@@ -775,6 +1488,10 @@ interface TabListProps extends Omit<RAC.TabListProps<Object>, 'className' | 'sty
775
1488
  }
776
1489
 
777
1490
  interface TabsProps extends Omit<RAC.TabsProps, 'className' | 'style' | 'isDisabled' | 'orientation'> {
1491
+ /**
1492
+ * Set All TabPanel disabled
1493
+ * @default false
1494
+ */
778
1495
  disabled?: boolean;
779
1496
  size?: 'small' | 'medium' | 'large';
780
1497
  variant?: string;
@@ -786,4 +1503,4 @@ declare const _Tabs: {
786
1503
  Item: (props: TabProps) => react_jsx_runtime.JSX.Element;
787
1504
  };
788
1505
 
789
- export { Accordion, AccordionItem, type AccordionItemProps, type AccordionOwnItemProps, type AccordionProps, ActionMenu, type GridAreaProps as AreaProps, Aside, type AsideProps, Aspect, type AspectProps, _Autocomplete as Autocomplete, type AutocompleteProps, Badge, type BadgeProps, Body, type BodyProps, Breakout, type BreakoutProps, _Button as Button, type ButtonProps, _Calendar as Calendar, type CalendarProps, Card, type CardProps, Center, type CenterProps, _Checkbox as Checkbox, _CheckboxGroup as CheckboxGroup, type CheckboxGroupProps, type CheckboxProps, CloseButton, Columns, type ColumnsProps, _ComboBox as ComboBox, type ComboBoxProps, Container, type ContainerProps, type CustomCheckboxProps, _DateField as DateField, type DateFieldProps, _DatePicker as DatePicker, type DatePickerProps, _Dialog as Dialog, type DialogProps, _Divider as Divider, type DividerProps, FieldBase, type FieldBaseProps, FieldGroup, FieldGroupContext, type FieldGroupContextProps, type FieldGroupProps, Footer, type FooterProps, Grid, type GridProps, _Header as Header, type HeaderProps, _Headline as Headline, type HeadlineProps, Image, type ImageProps, Inline, type InlineProps, _Input as Input, type InputProps, Inset, type InsetProps, _Label as Label, type LabelProps, _Link as Link, type LinkProps, List, type ListProps, MarigoldProvider, type MarigoldProviderProps, _Menu as Menu, type MenuProps, Message, type MessageProps, _Modal as Modal, type ModalProps, type MultiSelectItemProps, type MultiSelectProps, Multiselect, _NumberField as NumberField, type NumberFieldProps, OverlayContainerProvider, _Popover as Popover, type PopoverProps, _Radio as Radio, type RadioComponent, _RadioGroup as RadioGroup, type RadioGroupProps, type RadioProps, type RowProps, Scrollable, type ScrollableProps, _SearchField as SearchField, type SearchFieldProps, _Select as Select, type SelectComponent, _SelectList as SelectList, type SelectListProps, type SelectProps, _Slider as Slider, type SliderProps, Split, type SplitProps, Stack, type StackProps, _Switch as Switch, type SwitchProps, Table, type TableProps, _Tabs as Tabs, type TabsProps, _Tag as Tag, type TagProps, type TemplateValue, Text, _TextArea as TextArea, type TextAreaProps, _TextField as TextField, type TextFieldProps, type TextProps, Tiles, type TilesProps, _Tooltip as Tooltip, type TooltipProps, Underlay, type UnderlayProps, XLoader, _Calendar, useFieldGroupContext, usePortalContainer };
1506
+ export { Accordion, AccordionItem, type AccordionItemProps, type AccordionOwnItemProps, type AccordionProps, ActionMenu, type GridAreaProps as AreaProps, Aside, type AsideProps, Aspect, type AspectProps, _Autocomplete as Autocomplete, type AutocompleteProps, Badge, type BadgeProps, Body, type BodyProps, Breakout, type BreakoutProps, _Button as Button, type ButtonProps, _Calendar as Calendar, type CalendarProps, Card, type CardProps, Center, type CenterProps, _Checkbox as Checkbox, _CheckboxGroup as CheckboxGroup, type CheckboxGroupProps, type CheckboxProps, CloseButton, type ColumnProps, Columns, type ColumnsProps, _ComboBox as ComboBox, type ComboBoxProps, Container, type ContainerProps, type CustomCheckboxProps, _DateField as DateField, type DateFieldProps, _DatePicker as DatePicker, type DatePickerProps, _Dialog as Dialog, type DialogProps, _Divider as Divider, type DividerProps, FieldBase, type FieldBaseProps, FieldGroup, FieldGroupContext, type FieldGroupContextProps, type FieldGroupProps, Footer, type FooterProps, Grid, type GridProps, _Header as Header, type HeaderProps, _Headline as Headline, type HeadlineProps, Image, type ImageProps, Inline, type InlineProps, _Input as Input, type InputProps, Inset, type InsetProps, _Label as Label, type LabelProps, _Link as Link, type LinkProps, List, type ListProps, MarigoldProvider, type MarigoldProviderProps, _Menu as Menu, type MenuProps, _Modal as Modal, type ModalProps, type MultiSelectItemProps, type MultiSelectProps, Multiselect, _NumberField as NumberField, type NumberFieldProps, OverlayContainerProvider, _Popover as Popover, type PopoverProps, _Radio as Radio, type RadioComponent, _RadioGroup as RadioGroup, type RadioGroupProps, type RadioProps, type RowProps, Scrollable, type ScrollableProps, _SearchField as SearchField, type SearchFieldProps, SectionMessage, type SectionMessageProps, _Select as Select, type SelectComponent, _SelectList as SelectList, type SelectListProps, type SelectProps, _Slider as Slider, type SliderProps, Split, type SplitProps, Stack, type StackProps, _Switch as Switch, type SwitchProps, Table, type TableProps, _Tabs as Tabs, type TabsProps, _Tag as Tag, type TagProps, type TemplateValue, Text, _TextArea as TextArea, type TextAreaProps, _TextField as TextField, type TextFieldProps, type TextProps, Tiles, type TilesProps, _Tooltip as Tooltip, type TooltipProps, Underlay, type UnderlayProps, XLoader, _Calendar, useFieldGroupContext, usePortalContainer };