@marigold/components 11.3.0 → 11.4.1

package/dist/index.d.mts

@@ -6,7 +6,7 @@ import RAC, { ValidationResult, Key, DateValue, SlotProps, TagListProps, Progres
 export { Form, FormProps, RouterProvider } from 'react-aria-components';
 import * as react from 'react';
 import react__default, { ReactNode, ReactElement, ElementType, ComponentPropsWithRef, ForwardRefExoticComponent, RefAttributes, Key as Key$1, CSSProperties, Dispatch, SetStateAction, JSX } from 'react';
-import { GapSpaceProp, AspectProp, WidthProp, PaddingSpaceProp, PaddingRightProp, PaddingLeftProp, PaddingBottomProp, PaddingTopProp, PaddingSpacePropX, PaddingSpacePropY, PlaceItemsProp, TextAlignProp, HeightProp, ObjectFitProp, ObjectPositionProp, alignment, Theme, ThemeProviderProps, FontSizeProp, FontWeightProp, FontStyleProp, CursorProp } from '@marigold/system';
+import { GapSpaceProp, AspectProp, WidthProp, PaddingSpaceProp, PaddingRightProp, PaddingLeftProp, PaddingBottomProp, PaddingTopProp, PaddingSpacePropX, PaddingSpacePropY, PlaceItemsProp, HeightProp, TextAlignProp, ObjectFitProp, ObjectPositionProp, alignment, Theme, ThemeProviderProps, FontSizeProp, FontWeightProp, FontStyleProp, CursorProp } from '@marigold/system';
 export { ThemeProvider, useTheme } from '@marigold/system';
 import { AriaRegionProps, NonZeroPercentage, DistributiveOmit, HtmlProps, AriaLabelingProps } from '@marigold/types';
 import { Props } from 'react-select';
@@ -16,8 +16,8 @@ import { AriaTableProps } from '@react-aria/table';
 import { TableStateProps, TableBody, Cell, TableHeader, ColumnProps as ColumnProps$1, RowProps as RowProps$1 } from '@react-stately/table';
 export { VisuallyHidden } from '@react-aria/visually-hidden';
 
-type RemovedProps$q = 'isDisabled' | 'isExpanded';
-interface DisclosureProps extends Omit<RAC.DisclosureProps, RemovedProps$q> {
+type RemovedProps$r = 'isDisabled' | 'isExpanded';
+interface DisclosureProps extends Omit<RAC.DisclosureProps, RemovedProps$r> {
     /** Whether the item is disabled. */
     disabled?: RAC.DisclosureProps['isDisabled'];
     /** Whether the item is expanded (controlled). */
@@ -33,8 +33,8 @@ interface AccordionHeaderProps {
     children?: ReactNode;
 }
 
-type RemovedProps$p = 'isDisabled';
-interface AccordionProps extends Omit<RAC.DisclosureGroupProps, RemovedProps$p> {
+type RemovedProps$q = 'isDisabled';
+interface AccordionProps extends Omit<RAC.DisclosureGroupProps, RemovedProps$q> {
     /** Whether all items are disabled. */
     disabled?: RAC.DisclosureGroupProps['isDisabled'];
     variant?: string;
@@ -152,8 +152,8 @@ interface ListBoxComponent extends ForwardRefExoticComponent<ListBoxProps & RefA
 }
 declare const _ListBox: ListBoxComponent;
 
-type RemovedProps$o = 'className' | 'style' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly' | 'inputValue' | 'onInputChange' | 'defaultValue' | 'validate' | 'validationState' | 'slot';
-interface AutocompleteProps extends Omit<RAC.ComboBoxProps<object>, RemovedProps$o>, Pick<FieldBaseProps<'label'>, 'width' | 'label' | 'description' | 'errorMessage'> {
+type RemovedProps$p = 'className' | 'style' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly' | 'inputValue' | 'onInputChange' | 'defaultValue' | 'validate' | 'validationState' | 'slot';
+interface AutocompleteProps extends Omit<RAC.ComboBoxProps<object>, RemovedProps$p>, Pick<FieldBaseProps<'label'>, 'width' | 'label' | 'description' | 'errorMessage'> {
     /**
      * The value of the input (uncontrolled).
      */
@@ -220,8 +220,8 @@ interface AutocompleteComponent extends ForwardRefExoticComponent<AutocompletePr
 }
 declare const _Autocomplete: AutocompleteComponent;
 
-type RemovedProps$n = 'className' | 'style' | 'children' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly' | 'defaultInputValue' | 'inputValue' | 'onInputChange';
-interface ComboBoxProps extends Omit<RAC.ComboBoxProps<any>, RemovedProps$n>, Pick<FieldBaseProps<'label'>, 'width' | 'label' | 'description' | 'errorMessage'> {
+type RemovedProps$o = 'className' | 'style' | 'children' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly' | 'defaultInputValue' | 'inputValue' | 'onInputChange';
+interface ComboBoxProps extends Omit<RAC.ComboBoxProps<any>, RemovedProps$o>, Pick<FieldBaseProps<'label'>, 'width' | 'label' | 'description' | 'errorMessage'> {
     variant?: string;
     size?: string;
     /**
@@ -302,8 +302,8 @@ interface BodyProps extends Omit<HtmlProps<'section'>, 'className'> {
 }
 declare const Body: ({ children, variant, size, ...props }: BodyProps) => react_jsx_runtime.JSX.Element;
 
-type RemovedProps$m = 'isDisabled' | 'isPending';
-interface ButtonProps extends Omit<RAC.ButtonProps, RemovedProps$m> {
+type RemovedProps$n = 'isDisabled' | 'isPending';
+interface ButtonProps extends Omit<RAC.ButtonProps, RemovedProps$n> {
     variant?: string;
     size?: string;
     /**
@@ -361,8 +361,8 @@ interface CenterProps extends GapSpaceProp, AriaRegionProps {
 }
 declare const Center: ({ maxWidth, space, children, ...props }: CenterProps) => react_jsx_runtime.JSX.Element;
 
-type RemovedProps$l = 'className' | 'style' | 'children' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly';
-interface CheckboxGroupProps extends Omit<RAC.CheckboxGroupProps, RemovedProps$l>, Pick<FieldBaseProps<'label'>, 'label' | 'description' | 'errorMessage'> {
+type RemovedProps$m = 'className' | 'style' | 'children' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly';
+interface CheckboxGroupProps extends Omit<RAC.CheckboxGroupProps, RemovedProps$m>, Pick<FieldBaseProps<'label'>, 'label' | 'description' | 'errorMessage'> {
     /**
      * The children of the component
      */
@@ -402,8 +402,8 @@ interface CheckboxGroupProps extends Omit<RAC.CheckboxGroupProps, RemovedProps$l
 }
 declare const _CheckboxGroup: ({ children, variant, size, required, disabled, readOnly, error, width, orientation, ...rest }: CheckboxGroupProps) => react_jsx_runtime.JSX.Element;
 
-type RemovedProps$k = 'className' | 'style' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly' | 'isSelected' | 'isIndeterminate' | 'defaultSelected';
-interface CheckboxProps extends Omit<RAC.CheckboxProps, RemovedProps$k> {
+type RemovedProps$l = 'className' | 'style' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly' | 'isSelected' | 'isIndeterminate' | 'defaultSelected';
+interface CheckboxProps extends Omit<RAC.CheckboxProps, RemovedProps$l> {
     /**
      * Whether the element should be checked (controlled).
      */
@@ -507,7 +507,7 @@ interface ContainerProps extends GapSpaceProp, AriaRegionProps {
 }
 declare const Container: ({ contentLength, align, alignItems, space, children, ...props }: ContainerProps) => react_jsx_runtime.JSX.Element;
 
-interface DialogContentProps {
+interface DialogActions {
     /**
      * Children of the component.
      */
@@ -515,64 +515,35 @@ interface DialogContentProps {
     variant?: string;
     size?: string;
 }
+declare const DialogActions: ({ variant, size, children }: DialogActions) => react_jsx_runtime.JSX.Element;
 
-interface HeadlineProps extends AriaLabelingProps, TextAlignProp {
-    /**
-     * Set the color of the headline.
-     */
-    color?: string;
-    variant?: string;
-    size?: string;
-    /**
-     * Set a different level.
-     */
-    level?: '1' | '2' | '3' | '4' | '5' | '6' | 1 | 2 | 3 | 4 | 5 | 6;
+interface DialogContentProps {
     /**
      * Children of the component.
      */
     children?: ReactNode;
-    /**
-     * A slot to place the element in.
-     */
-    slot?: string;
+    variant?: string;
+    size?: string;
 }
-declare const _Headline: ({ variant, size, children, align, color, level, ...props }: HeadlineProps) => react_jsx_runtime.JSX.Element;
+declare const DialogContent: ({ variant, size, children, }: DialogContentProps) => react_jsx_runtime.JSX.Element;
 
-interface DialogTitleProps extends Omit<HeadlineProps, 'slot'> {
+interface DialogTitleProps {
+    children?: React.ReactNode;
     variant?: string;
     size?: string;
 }
+declare const DialogTitle: ({ variant, size, children }: DialogTitleProps) => react_jsx_runtime.JSX.Element;
 
-interface DialogTriggerProps extends Omit<RAC.DialogTriggerProps, 'isOpen'> {
-    /**
-     * Whether the dialog is open by default (controlled).
-     * @default false
-     */
+type RemovedProps$k = 'children' | 'isOpen' | 'isDismissable' | 'isKeyboardDismissDisabled';
+interface ModalProps$1 extends RAC.ModalOverlayProps {
     open?: boolean;
-    /**
-     * Whether to close the overlay when the user interacts outside it.
-     * @default false
-     */
     dismissable?: boolean;
-    /**
-     * Whether pressing the escape key to close the overlay should be disabled.
-     */
     keyboardDismissable?: boolean;
-    /**
-     * If `true`, the dialog will be non-modal, meaning it will not block interaction with the background content.
-     */
-    isNonModal?: boolean;
-}
-
-interface DialogActions {
-    /**
-     * Children of the component.
-     */
-    children?: ReactNode;
-    variant?: string;
     size?: string;
 }
-declare const DialogActions: ({ variant, size, children }: DialogActions) => react_jsx_runtime.JSX.Element;
+interface DialogTriggerProps extends Omit<RAC.DialogTriggerProps, 'isOpen'>, Omit<ModalProps$1, RemovedProps$k> {
+}
+declare const _DialogTrigger: ({ open, dismissable, keyboardDismissable, size, ...rest }: DialogTriggerProps) => ReactNode;
 
 interface DialogProps extends Omit<RAC.DialogProps, 'className' | 'style'> {
     variant?: string;
@@ -581,19 +552,17 @@ interface DialogProps extends Omit<RAC.DialogProps, 'className' | 'style'> {
      * Show the close button.
      */
     closeButton?: boolean;
+}
+interface DialogComponent extends ForwardRefExoticComponent<DialogProps & RefAttributes<HTMLInputElement>> {
     /**
-     * If `true`, the dialog will be non-modal, meaning it will not block interaction with the background content.
-     * @default false
+     * Options for the Combobox.
      */
-    isNonModal?: boolean;
+    Trigger: typeof _DialogTrigger;
+    Title: typeof DialogTitle;
+    Content: typeof DialogContent;
+    Actions: typeof DialogActions;
 }
-declare const _Dialog: {
-    ({ variant, size, closeButton, isNonModal, ...props }: DialogProps): react_jsx_runtime.JSX.Element;
-    Trigger: ({ open, dismissable, keyboardDismissable, isNonModal, ...rest }: DialogTriggerProps) => react_jsx_runtime.JSX.Element;
-    Title: ({ level, variant, size, children, }: DialogTitleProps) => react_jsx_runtime.JSX.Element;
-    Content: ({ variant, size, children, }: DialogContentProps) => react_jsx_runtime.JSX.Element;
-    Actions: ({ variant, size, children }: DialogActions) => react_jsx_runtime.JSX.Element;
-};
+declare const _Dialog: DialogComponent;
 
 interface DividerProps extends RAC.SeparatorProps {
     variant?: string;
@@ -655,6 +624,28 @@ interface HeaderProps extends Omit<RAC.HeadingProps, 'children'> {
 }
 declare const _Header: ({ variant, size, ...props }: HeaderProps) => react_jsx_runtime.JSX.Element;
 
+interface HeadlineProps extends AriaLabelingProps, TextAlignProp {
+    /**
+     * Set the color of the headline.
+     */
+    color?: string;
+    variant?: string;
+    size?: string;
+    /**
+     * Set a different level.
+     */
+    level?: '1' | '2' | '3' | '4' | '5' | '6' | 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+     * Children of the component.
+     */
+    children?: ReactNode;
+    /**
+     * A slot to place the element in.
+     */
+    slot?: string;
+}
+declare const _Headline: ({ variant, size, children, align, color, level, ...props }: HeadlineProps) => react_jsx_runtime.JSX.Element;
+
 interface ImageProps extends Pick<HtmlProps<'img'>, 'src' | 'srcSet' | 'sizes' | 'slot' | 'title' | 'height' | 'width' | 'role' | 'datatype'>, ObjectFitProp, ObjectPositionProp {
     variant?: string;
     size?: string;
@@ -973,21 +964,107 @@ declare const SectionMessage: {
     Content: ({ children, }: SectionMessageContentProps) => react_jsx_runtime.JSX.Element;
 };
 
-type PickedProps = 'autoFocus' | 'isOptionDisabled' | 'noOptionsMessage' | 'onBlur' | 'onFocus' | 'aria-errormessage' | 'aria-invalid' | 'aria-label' | 'aria-labelledby' | 'aria-live' | 'ariaLiveMessages';
-interface MultipleSelectProps extends Pick<FieldBaseProps<'label'>, 'width' | 'size' | 'variant' | 'label' | 'description' | 'errorMessage'>, Pick<Props, PickedProps> {
+interface MultipleSelectProps extends Pick<FieldBaseProps<'label'>, 'width' | 'size' | 'variant' | 'label' | 'description' | 'errorMessage'> {
+    /**
+     * If the select should be disabled.
+     *
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * If the select should be required.
+     *
+     * @default false
+     */
     required?: boolean;
+    /**
+     * If the select should be read only.
+     *
+     * @default false
+     */
     readOnly?: boolean;
+    /**
+     * If the select should throw an error.
+     *
+     * @default false
+     */
     error?: boolean;
+    /**
+     * The items of the select.
+     */
     items?: Props['options'];
+    /**
+     * Set a error message for the select.
+     */
     errorMessage?: string | ((validation: ValidationResult) => string);
+    /**
+     * The placdeholder of the select when it is empty.
+     */
     placeholder?: string;
+    /**
+     * Items that should be selected by default (uncontrolled).
+     */
     defaultSelectedItems?: Props['defaultValue'];
+    /**
+     * Selected items (controlled):
+     */
+    selectedItems?: Props['value'];
+    /**
+     * Input text that should be set by default.
+     */
     defaultValue?: Props['defaultInputValue'];
+    /**
+     * Handler that is called when the input changes.
+     */
     onChange?: Props['onInputChange'];
+    /**
+     * Handler that is called when the selection changes.
+     */
     onSelectionChange?: Props['onChange'];
+    /** Focus the control when it is mounted */
+    autoFocus?: Props['autoFocus'];
+    /**
+     * Override the built-in logic to detect whether an option is disabled
+     * */
+    isOptionDisabled?: Props['isOptionDisabled'];
+    /**
+     * Text to display when there are no options
+     * */
+    noOptionsMessage?: Props['noOptionsMessage'];
+    /**
+     * Handle blur events on the control
+     */
+    onBlur?: Props['onBlur'];
+    /**
+     * Handle focus events on the control
+     */
+    onFocus?: Props['onFocus'];
+    /**
+     * HTML ID of an element containing an error message related to the input*
+     */
+    'aria-errormessage'?: Props['aria-errormessage'];
+    /**
+     * Indicate if the value entered in the field is invalid *
+     */
+    'aria-invalid'?: Props['aria-invalid'];
+    /**
+     * Aria label (for assistive tech)
+     */
+    'aria-label'?: Props['aria-label'];
+    /**
+     * HTML ID of an element that should be used as the label (for assistive tech)
+     */
+    'aria-labelledby'?: Props['aria-labelledby'];
+    /**
+     * Used to set the priority with which screen reader should treat updates to live regions. The possible settings are: off, polite (default) or assertive
+     */
+    'aria-live'?: Props['aria-live'];
+    /**
+     * Customise the messages used by the aria-live component
+     */
+    ariaLiveMessages?: Props['ariaLiveMessages'];
 }
-declare const Multiselect: ({ disabled, readOnly, items, defaultSelectedItems, defaultValue, error, errorMessage, size, variant, placeholder, description, onChange, onSelectionChange, ...rest }: MultipleSelectProps) => react_jsx_runtime.JSX.Element;
+declare const Multiselect: ({ disabled, readOnly, items, selectedItems, defaultSelectedItems, defaultValue, error, errorMessage, size, variant, placeholder, description, onChange, onSelectionChange, ...rest }: MultipleSelectProps) => react_jsx_runtime.JSX.Element;
 
 type RemovedProps$a = 'className' | 'style' | 'children' | 'isDisabled' | 'isRequired' | 'isInvalid' | 'isReadOnly' | 'size';
 interface NumberFieldProps extends Omit<RAC.NumberFieldProps, RemovedProps$a>, Pick<FieldBaseProps<'label'>, 'label' | 'description' | 'errorMessage'> {
@@ -1793,4 +1870,4 @@ declare const _Tabs: {
     Item: (props: TabProps) => react_jsx_runtime.JSX.Element;
 };
 
-export { Accordion, AccordionItem, 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, type CheckboxComponent, _CheckboxGroup as CheckboxGroup, type CheckboxGroupProps, type CheckboxProps, CloseButton, type ColumnProps, Columns, type ColumnsProps, _ComboBox as ComboBox, type ComboBoxProps, Container, type ContainerProps, _DateField as DateField, type DateFieldProps, _DatePicker as DatePicker, type DatePickerProps, _Dialog as Dialog, type DialogProps, type DisclosureProps, _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, Multiselect, NonModal, type NonModalProps, type NonModalRenderProps, _NumberField as NumberField, type NumberFieldProps, OverlayContainerProvider, _Pagination as Pagination, type PaginationProps, _Popover as Popover, type PopoverProps, _Radio as Radio, type RadioComponent, _RadioGroup as RadioGroup, type RadioGroupProps, type RadioProps, type RemovedProps$k as RemovedProps, 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 as 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, type XLoaderProps, _Calendar, gridColsAlign, gridColumn, useFieldGroupContext, usePortalContainer };
+export { Accordion, AccordionItem, 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, type CheckboxComponent, _CheckboxGroup as CheckboxGroup, type CheckboxGroupProps, type CheckboxProps, CloseButton, type ColumnProps, Columns, type ColumnsProps, _ComboBox as ComboBox, type ComboBoxProps, Container, type ContainerProps, _DateField as DateField, type DateFieldProps, _DatePicker as DatePicker, type DatePickerProps, _Dialog as Dialog, type DialogProps, type DisclosureProps, _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, Multiselect, NonModal, type NonModalProps, type NonModalRenderProps, _NumberField as NumberField, type NumberFieldProps, OverlayContainerProvider, _Pagination as Pagination, type PaginationProps, _Popover as Popover, type PopoverProps, _Radio as Radio, type RadioComponent, _RadioGroup as RadioGroup, type RadioGroupProps, type RadioProps, type RemovedProps$l as RemovedProps, 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 as 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, type XLoaderProps, _Calendar, gridColsAlign, gridColumn, useFieldGroupContext, usePortalContainer };