@marigold/components 8.0.0 → 8.0.2

package/dist/index.d.mts

@@ -122,6 +122,9 @@ interface FieldGroupContextProps {
 declare const FieldGroupContext: react.Context<FieldGroupContextProps>;
 declare const useFieldGroupContext: () => FieldGroupContextProps;
 interface FieldGroupProps {
+    /**
+     * Sets the width of all Fields labels used inside the `FieldGroup`
+     */
     labelWidth?: string;
     children: ReactNode;
 }
@@ -684,7 +687,7 @@ interface DatePickerProps extends Omit<RAC.DatePickerProps<DateValue>, RemovedPr
      */
     width?: WidthProp['width'];
 }
-declare const _DatePicker: ({ disabled, required, readOnly, error, variant, size, open, granularity, ...rest }: DatePickerProps) => react_jsx_runtime.JSX.Element;
+declare const _DatePicker: react__default.ForwardRefExoticComponent<DatePickerProps & react__default.RefAttributes<HTMLDivElement>>;
 
 type InsetProps = {
     /**
@@ -1059,22 +1062,75 @@ declare const _SearchField: react.ForwardRefExoticComponent<SearchFieldProps & r
 
 type RemoveProps$1 = 'children' | 'isInvalid' | 'isDisabled' | 'isOpen' | 'isRequired' | 'style' | 'className' | 'onSelectionChange';
 interface SelectProps<T extends object> extends Omit<RAC.SelectProps<T>, RemoveProps$1> {
+    /**
+     * Set a label for the select.
+     */
     label?: string;
+    /**
+     * Set a description for the select.
+     */
     description?: string;
+    /**
+     * Set a error message for the select.
+     */
     errorMessage?: string | ((validation: ValidationResult) => string);
+    /**
+     * Items of the select.
+     */
     items?: Iterable<T>;
+    /**
+     * Children of the select.
+     */
     children: React.ReactNode | ((item: T) => React.ReactNode);
+    /**
+     * sets the variant of the select.
+     */
     variant?: string;
+    /**
+     * Sets the size of the select.
+     */
     size?: string;
+    /**
+     * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
+     */
     width?: WidthProp['width'];
+    /**
+     * If the select should be required.
+     *
+     * @default false
+     */
     required?: boolean;
+    /**
+     * If the select should be disabled.
+     *
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * If the select list should be open.
+     *
+     * @default false
+     */
     open?: boolean;
+    /**
+     * If the select should throw an error.
+     *
+     * @default false
+     */
     error?: boolean;
+    /**
+     * Handler that is called when the selection changes.
+     */
     onChange?: RAC.SelectProps<object>['onSelectionChange'];
 }
 interface SelectComponent extends ForwardRefExoticComponent<SelectProps<object> & RefAttributes<HTMLDivElement>> {
+    /**
+     * Options of the Select.
+     */
     Option: typeof _ListBox.Item;
+    /**
+     * Section of the Select.
+     */
     Section: typeof _ListBox.Section;
 }
 declare const _Select: SelectComponent;
@@ -1085,9 +1141,15 @@ declare const _SelectListItem: react.ForwardRefExoticComponent<SelectListItemPro
 
 type RemoveProps = 'style' | 'className' | 'onSelectionChange';
 interface SelectListProps extends Omit<RAC.GridListProps<object>, RemoveProps> {
+    /**
+     * Handler that is called when the selection change.
+     */
     onChange?: RAC.GridListProps<object>['onSelectionChange'] | Dispatch<SetStateAction<any>>;
 }
 interface SelectListComponent extends ForwardRefExoticComponent<SelectListProps & RefAttributes<HTMLUListElement>> {
+    /**
+     * Items of the SelectList.
+     */
     Item: typeof _SelectListItem;
 }
 declare const _SelectList: SelectListComponent;

package/dist/index.d.ts

@@ -122,6 +122,9 @@ interface FieldGroupContextProps {
 declare const FieldGroupContext: react.Context<FieldGroupContextProps>;
 declare const useFieldGroupContext: () => FieldGroupContextProps;
 interface FieldGroupProps {
+    /**
+     * Sets the width of all Fields labels used inside the `FieldGroup`
+     */
     labelWidth?: string;
     children: ReactNode;
 }
@@ -684,7 +687,7 @@ interface DatePickerProps extends Omit<RAC.DatePickerProps<DateValue>, RemovedPr
      */
     width?: WidthProp['width'];
 }
-declare const _DatePicker: ({ disabled, required, readOnly, error, variant, size, open, granularity, ...rest }: DatePickerProps) => react_jsx_runtime.JSX.Element;
+declare const _DatePicker: react__default.ForwardRefExoticComponent<DatePickerProps & react__default.RefAttributes<HTMLDivElement>>;
 
 type InsetProps = {
     /**
@@ -1059,22 +1062,75 @@ declare const _SearchField: react.ForwardRefExoticComponent<SearchFieldProps & r
 
 type RemoveProps$1 = 'children' | 'isInvalid' | 'isDisabled' | 'isOpen' | 'isRequired' | 'style' | 'className' | 'onSelectionChange';
 interface SelectProps<T extends object> extends Omit<RAC.SelectProps<T>, RemoveProps$1> {
+    /**
+     * Set a label for the select.
+     */
     label?: string;
+    /**
+     * Set a description for the select.
+     */
     description?: string;
+    /**
+     * Set a error message for the select.
+     */
     errorMessage?: string | ((validation: ValidationResult) => string);
+    /**
+     * Items of the select.
+     */
     items?: Iterable<T>;
+    /**
+     * Children of the select.
+     */
     children: React.ReactNode | ((item: T) => React.ReactNode);
+    /**
+     * sets the variant of the select.
+     */
     variant?: string;
+    /**
+     * Sets the size of the select.
+     */
     size?: string;
+    /**
+     * Sets the width of the field. You can see allowed tokens here: https://tailwindcss.com/docs/width
+     */
     width?: WidthProp['width'];
+    /**
+     * If the select should be required.
+     *
+     * @default false
+     */
     required?: boolean;
+    /**
+     * If the select should be disabled.
+     *
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * If the select list should be open.
+     *
+     * @default false
+     */
     open?: boolean;
+    /**
+     * If the select should throw an error.
+     *
+     * @default false
+     */
     error?: boolean;
+    /**
+     * Handler that is called when the selection changes.
+     */
     onChange?: RAC.SelectProps<object>['onSelectionChange'];
 }
 interface SelectComponent extends ForwardRefExoticComponent<SelectProps<object> & RefAttributes<HTMLDivElement>> {
+    /**
+     * Options of the Select.
+     */
     Option: typeof _ListBox.Item;
+    /**
+     * Section of the Select.
+     */
     Section: typeof _ListBox.Section;
 }
 declare const _Select: SelectComponent;
@@ -1085,9 +1141,15 @@ declare const _SelectListItem: react.ForwardRefExoticComponent<SelectListItemPro
 
 type RemoveProps = 'style' | 'className' | 'onSelectionChange';
 interface SelectListProps extends Omit<RAC.GridListProps<object>, RemoveProps> {
+    /**
+     * Handler that is called when the selection change.
+     */
     onChange?: RAC.GridListProps<object>['onSelectionChange'] | Dispatch<SetStateAction<any>>;
 }
 interface SelectListComponent extends ForwardRefExoticComponent<SelectListProps & RefAttributes<HTMLUListElement>> {
+    /**
+     * Items of the SelectList.
+     */
     Item: typeof _SelectListItem;
 }
 declare const _SelectList: SelectListComponent;