plume-ui-react 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { CSSProperties, ReactNode, RefObject, ChangeEvent, LazyExoticComponent, HTMLAttributes, ButtonHTMLAttributes, InputHTMLAttributes, Ref, ReactElement, LiHTMLAttributes, HtmlHTMLAttributes, TextareaHTMLAttributes } from 'react';
+import { CSSProperties, ReactNode, RefObject, ChangeEvent, LazyExoticComponent, HTMLAttributes, ButtonHTMLAttributes, InputHTMLAttributes, MouseEvent, Ref, AnchorHTMLAttributes, ReactElement, LiHTMLAttributes, HtmlHTMLAttributes, TextareaHTMLAttributes } from 'react';
 
 type RadiusValue = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 'full';
 type SizeValue = 'max' | 'min' | 'full';
@@ -282,6 +282,8 @@ type CardHeaderProps = Omit<ComponentProps, 'index'> & CardHeaderRootAttributes;
 declare const CardHeader: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & CardHeaderRootAttributes & react.RefAttributes<HTMLDivElement>>;
 
 interface CheckboxOwnProps {
+    inputClassName?: string;
+    labelClassName?: string;
     colorScheme?: ColorScheme;
     indeterminate?: boolean;
     readOnly?: boolean;
@@ -295,6 +297,23 @@ declare const Checkbox: react.ForwardRefExoticComponent<Omit<ComponentProps, "in
     labelsItself: boolean;
 };
 
+type ChipPart = 'icon' | 'label' | 'remove';
+type ChipVariant = 'solid' | 'outline' | 'subtle' | 'unstyled';
+interface ChipOwnProps {
+    classNames?: Partial<Record<ChipPart, string>>;
+    colorScheme?: ColorScheme;
+    disabled?: boolean;
+    icon?: ReactNode;
+    onRemove?: (event: MouseEvent<HTMLButtonElement>) => void;
+    removeLabel?: string;
+    shape?: Shape;
+    size?: Size;
+    variant?: ChipVariant;
+}
+type ChipRootAttributes = Pick<HTMLAttributes<HTMLSpanElement>, 'aria-label' | 'aria-labelledby' | 'children' | 'hidden' | 'id' | 'title'>;
+type ChipProps = Omit<ComponentProps, 'index'> & ChipRootAttributes & ChipOwnProps;
+declare const Chip: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & ChipRootAttributes & ChipOwnProps & react.RefAttributes<HTMLSpanElement>>;
+
 interface DatePickerOwnProps {
     colorScheme?: ColorScheme;
     config?: DatePickerConfig;
@@ -329,6 +348,59 @@ type DatePickerRootAttributes = Pick<InputHTMLAttributes<HTMLInputElement>, 'ari
 type DatePickerProps = ComponentProps & DatePickerRootAttributes & DatePickerOwnProps;
 declare const DatePicker: react.ForwardRefExoticComponent<ComponentProps & DatePickerRootAttributes & DatePickerOwnProps & react.RefAttributes<HTMLDivElement>>;
 
+type Side = 'top' | 'bottom' | 'left' | 'right';
+type Align = 'start' | 'center' | 'end';
+type Placement = Side | `${Side}-${Align}`;
+
+type DropdownVariant = 'elevated' | 'outline' | 'unstyled';
+
+interface DropdownProps {
+    children: ReactNode;
+    closeOnSelect?: boolean;
+    defaultOpen?: boolean;
+    flip?: boolean;
+    offset?: number;
+    onOpenChange?: (open: boolean) => void;
+    open?: boolean;
+    placement?: Placement;
+    shift?: boolean;
+    size?: Size;
+    variant?: DropdownVariant;
+}
+declare function Dropdown({ children, closeOnSelect, defaultOpen, flip, offset, onOpenChange, open: openProp, placement, shift, size, variant, }: Readonly<DropdownProps>): ReactNode;
+
+interface DropdownItemOwnProps {
+    children?: ReactNode;
+    closeOnSelect?: boolean;
+    disabled?: boolean;
+    href?: string;
+    icon?: ReactNode;
+    onSelect?: (event: MouseEvent<HTMLElement>) => void;
+    rel?: string;
+    shortcut?: ReactNode;
+    target?: string;
+}
+type DropdownItemRootAttributes = Pick<AnchorHTMLAttributes<HTMLElement>, 'aria-label'>;
+type DropdownItemProps = Omit<ComponentProps, 'index'> & DropdownItemRootAttributes & DropdownItemOwnProps;
+declare const DropdownItem: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & DropdownItemRootAttributes & DropdownItemOwnProps & react.RefAttributes<HTMLElement>>;
+
+type DropdownLabelRootAttributes = Pick<HTMLAttributes<HTMLDivElement>, 'children'>;
+type DropdownLabelProps = Omit<ComponentProps, 'index'> & DropdownLabelRootAttributes;
+declare const DropdownLabel: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & DropdownLabelRootAttributes & react.RefAttributes<HTMLDivElement>>;
+
+type DropdownMenuRootAttributes = Pick<HTMLAttributes<HTMLDivElement>, 'aria-label' | 'aria-labelledby' | 'children'>;
+type DropdownMenuProps = Omit<ComponentProps, 'index'> & DropdownMenuRootAttributes;
+declare const DropdownMenu: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & DropdownMenuRootAttributes & react.RefAttributes<HTMLDivElement>>;
+
+type DropdownSeparatorProps = Omit<ComponentProps, 'index'>;
+declare const DropdownSeparator: react.ForwardRefExoticComponent<DropdownSeparatorProps & react.RefAttributes<HTMLHRElement>>;
+
+interface DropdownTriggerProps {
+    children: ReactNode;
+    className?: string;
+}
+declare const DropdownTrigger: react.ForwardRefExoticComponent<DropdownTriggerProps & react.RefAttributes<HTMLElement>>;
+
 interface FieldOwnProps {
     disabled?: boolean;
     errorText?: ReactNode;
@@ -458,8 +530,11 @@ type ModalCloseProps = OverlayCloseProps;
 declare const ModalClose: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & OverlayCloseOwnProps & react.RefAttributes<HTMLElement>>;
 
 type ModalContentRootAttributes = Pick<HTMLAttributes<HTMLDialogElement>, 'aria-describedby' | 'aria-label' | 'aria-labelledby' | 'children'>;
-type ModalContentProps = Omit<ComponentProps, 'index'> & ModalContentRootAttributes;
-declare const ModalContent: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & ModalContentRootAttributes & react.RefAttributes<HTMLDialogElement>>;
+interface ModalContentOwnProps {
+    backdropClassName?: string;
+}
+type ModalContentProps = Omit<ComponentProps, 'index'> & ModalContentRootAttributes & ModalContentOwnProps;
+declare const ModalContent: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & ModalContentRootAttributes & ModalContentOwnProps & react.RefAttributes<HTMLDialogElement>>;
 
 type ModalFooterRootAttributes = Pick<HTMLAttributes<HTMLDivElement>, 'children'>;
 type ModalFooterProps = Omit<ComponentProps, 'index'> & ModalFooterRootAttributes;
@@ -478,10 +553,6 @@ interface ModalTriggerProps {
 }
 declare const ModalTrigger: react.ForwardRefExoticComponent<ModalTriggerProps & react.RefAttributes<HTMLElement>>;
 
-type Side = 'top' | 'bottom' | 'left' | 'right';
-type Align = 'start' | 'center' | 'end';
-type Placement = Side | `${Side}-${Align}`;
-
 type PopoverVariant = 'elevated' | 'outline' | 'unstyled';
 
 interface PopoverProps {
@@ -512,6 +583,8 @@ interface PopoverTriggerProps {
 declare const PopoverTrigger: react.ForwardRefExoticComponent<PopoverTriggerProps & react.RefAttributes<HTMLElement>>;
 
 interface RadioOwnProps {
+    inputClassName?: string;
+    labelClassName?: string;
     colorScheme?: ColorScheme;
     readOnly?: boolean;
     size?: Size;
@@ -542,6 +615,105 @@ type RadioGroupRootAttributes = Pick<HTMLAttributes<HTMLDivElement>, 'aria-descr
 type RadioGroupProps = Omit<ComponentProps, 'index'> & RadioGroupRootAttributes & RadioGroupOwnProps;
 declare const RadioGroup: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & RadioGroupRootAttributes & RadioGroupOwnProps & react.RefAttributes<HTMLDivElement>>;
 
+type SelectVariant = 'outline' | 'filled' | 'underline' | 'unstyled';
+interface SelectedOption {
+    icon?: ReactNode;
+    label: string;
+    value: string;
+}
+
+interface SelectBaseProps {
+    'aria-describedby'?: string;
+    'aria-invalid'?: boolean | 'true' | 'false';
+    children: ReactNode;
+    clearable?: boolean;
+    closeOnSelect?: boolean;
+    colorScheme?: ColorScheme;
+    defaultOpen?: boolean;
+    disabled?: boolean;
+    flip?: boolean;
+    id?: string;
+    name?: string;
+    offset?: number;
+    onOpenChange?: (open: boolean) => void;
+    open?: boolean;
+    placement?: Placement;
+    readOnly?: boolean;
+    required?: boolean;
+    searchable?: boolean;
+    shape?: Shape;
+    shift?: boolean;
+    size?: Size;
+    variant?: SelectVariant;
+}
+interface SelectSingleProps {
+    defaultValue?: string;
+    multiple?: false;
+    onValueChange?: (value: string) => void;
+    value?: string;
+}
+interface SelectMultipleProps {
+    defaultValue?: string[];
+    multiple: true;
+    onValueChange?: (value: string[]) => void;
+    value?: string[];
+}
+type SelectProps = SelectBaseProps & (SelectMultipleProps | SelectSingleProps);
+declare function Select({ 'aria-describedby': describedBy, 'aria-invalid': ariaInvalid, children, clearable, closeOnSelect, colorScheme, defaultOpen, defaultValue, disabled, flip, id, multiple, name, offset, onOpenChange, onValueChange, open: openProp, placement, readOnly, required, searchable, shape, shift, size, value, variant, }: Readonly<SelectProps>): ReactNode;
+
+type SelectContentRootAttributes = Pick<HTMLAttributes<HTMLDivElement>, 'aria-label' | 'children'>;
+type SelectContentPart = 'empty' | 'list' | 'search' | 'searchInput';
+interface SelectContentOwnProps {
+    classNames?: Partial<Record<SelectContentPart, string>>;
+    emptyText?: ReactNode;
+    searchLabel?: string;
+    searchPlaceholder?: string;
+}
+type SelectContentProps = Omit<ComponentProps, 'index'> & SelectContentRootAttributes & SelectContentOwnProps;
+declare const SelectContent: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & SelectContentRootAttributes & SelectContentOwnProps & react.RefAttributes<HTMLDivElement>>;
+
+interface SelectGroupOwnProps {
+    children?: ReactNode;
+    label: ReactNode;
+    labelClassName?: string;
+}
+type SelectGroupProps = Omit<ComponentProps, 'index'> & SelectGroupOwnProps;
+declare const SelectGroup: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & SelectGroupOwnProps & react.RefAttributes<HTMLDivElement>>;
+
+type SelectOptionPart = 'check' | 'checkbox' | 'description' | 'icon';
+interface SelectOptionOwnProps {
+    children?: ReactNode;
+    classNames?: Partial<Record<SelectOptionPart, string>>;
+    description?: ReactNode;
+    disabled?: boolean;
+    icon?: ReactNode;
+    label?: string;
+    value: string;
+}
+type SelectOptionProps = Omit<ComponentProps, 'index'> & SelectOptionOwnProps;
+declare const SelectOption: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & SelectOptionOwnProps & react.RefAttributes<HTMLDivElement>>;
+
+type SelectTriggerPart = 'chevron' | 'chip' | 'chipRemove' | 'clear' | 'field' | 'trigger';
+interface SelectTriggerOwnProps {
+    'aria-label'?: string;
+    'aria-labelledby'?: string;
+    children?: ReactNode;
+    classNames?: Partial<Record<SelectTriggerPart, string>>;
+    clearLabel?: string;
+    display?: 'chips' | 'text';
+    maxDisplay?: number;
+    placeholder?: ReactNode;
+    removeLabel?: (label: string) => string;
+}
+type SelectTriggerProps = Omit<ComponentProps, 'index'> & SelectTriggerOwnProps;
+declare const SelectTrigger: react.ForwardRefExoticComponent<Omit<ComponentProps, "index"> & SelectTriggerOwnProps & react.RefAttributes<HTMLButtonElement>>;
+
+interface SelectValueProps {
+    children?: (selected: readonly SelectedOption[]) => ReactNode;
+    placeholder?: ReactNode;
+}
+declare function SelectValue({ children, placeholder }: Readonly<SelectValueProps>): ReactNode;
+
 interface SpinnerOwnProps {
     color?: ColorShade;
     size?: Size;
@@ -634,9 +806,11 @@ declare function useToast(): ToastApi;
 
 type ToastPosition = 'top-start' | 'top' | 'top-end' | 'center-start' | 'center' | 'center-end' | 'bottom-start' | 'bottom' | 'bottom-end';
 type ToastVariant = 'solid' | 'subtle' | 'outline' | 'unstyled';
+type ToastPart = 'action' | 'content' | 'description' | 'dismiss' | 'icon' | 'title';
 interface ToastProviderProps {
     children: ReactNode;
     className?: string;
+    classNames?: Partial<Record<ToastPart, string>>;
     dismissLabel?: string;
     duration?: number;
     icons?: false | ToastIcons;
@@ -646,9 +820,11 @@ interface ToastProviderProps {
     toastClassName?: string;
     variant?: ToastVariant;
 }
-declare function ToastProvider({ children, className, dismissLabel, duration, icons, max, position, regionLabel, toastClassName, variant, }: Readonly<ToastProviderProps>): ReactNode;
+declare function ToastProvider({ children, className, classNames, dismissLabel, duration, icons, max, position, regionLabel, toastClassName, variant, }: Readonly<ToastProviderProps>): ReactNode;
 
 interface ToggleOwnProps {
+    inputClassName?: string;
+    labelClassName?: string;
     colorScheme?: ColorScheme;
     readOnly?: boolean;
     size?: Size;
@@ -680,4 +856,4 @@ interface TooltipProps {
 type TooltipVariant = 'solid' | 'outline' | 'unstyled';
 declare function Tooltip({ children, className, closeDelay, content, defaultOpen, disabled, offset, onOpenChange, open: openProp, openDelay, placement, size, style, variant, }: Readonly<TooltipProps>): ReactNode;
 
-export { Badge, type BadgeProps, type Breakpoints, Button, type ButtonProps, Card, CardBody, type CardBodyProps, CardFooter, type CardFooterProps, CardHeader, type CardHeaderProps, type CardProps, Checkbox, type CheckboxProps, type ColorMode, type ColorModeSetting, type ColorPalette, type ColorScheme, type ColorShade, type ComponentProps, DatePicker, type DatePickerConfig, type DatePickerProps, type DateRange, type DeepPartial, Field, type FieldControlProps, type FieldOrientation, type FieldProps, type FontSizes, type FontWeights, Icon, type IconProps, Input, type InputProps, type LazyLoadedComponent, type LineHeights, List, ListDivider, type ListDividerProps, ListItem, ListItemButton, type ListItemButtonProps, ListItemIcon, type ListItemIconProps, type ListItemProps, ListItemText, type ListItemTextProps, type ListProps, ListSubheader, type ListSubheaderProps, type MaskChangeHandler, Modal, ModalBody, type ModalBodyProps, ModalClose, type ModalCloseProps, ModalContent, type ModalContentProps, ModalFooter, type ModalFooterProps, ModalHeader, type ModalHeaderProps, type ModalProps, ModalTrigger, type ModalTriggerProps, Popover, PopoverClose, type PopoverCloseProps, PopoverContent, type PopoverContentProps, type PopoverProps, PopoverTrigger, type PopoverTriggerProps, type Radii, Radio, RadioGroup, type RadioGroupProps, type RadioProps, type SemanticColors, type Shade, type ShadeLevel, type Shadows, type Shape, type Size, type Sizes, type Spaces, Spinner, type SpinnerProps, Tab, TabList, type TabListProps, TabPanel, type TabPanelProps, TabPanels, type TabPanelsProps, type TabProps, Tabs, type TabsProps, Textarea, type TextareaProps, type Theme, type ThemeContextValue, ThemeProvider, type ThemeProviderProps, type ToastAction, type ToastApi, type ToastContent, type ToastIcons, type ToastOptions, type ToastPosition, ToastProvider, type ToastProviderProps, type ToastStatus, type ToastVariant, Toggle, type ToggleProps, Tooltip, type TooltipProps, type Typography, type UseClickOutsideProps, type UseDebounceProps, type UseMaskProps, type UseMaskResult, type ZIndeces, applyMask, colorVar, deepMerge, defaultDarkTheme, defaultTheme, formatDate, getContrastColor, getContrastRatio, getDarkenColor, getDateFormatByLanguage, getDateFromDateString, getDateStringByLanguage, getDaysOfWeekByLanguage, getLightenColor, getMonthsByLanguage, lazyLoadContent, themeToCssVars, useClickOutside, useDebounce, useMask, useTheme, useToast, validateFormatDate };
+export { Badge, type BadgeProps, type Breakpoints, Button, type ButtonProps, Card, CardBody, type CardBodyProps, CardFooter, type CardFooterProps, CardHeader, type CardHeaderProps, type CardProps, Checkbox, type CheckboxProps, Chip, type ChipPart, type ChipProps, type ChipVariant, type ColorMode, type ColorModeSetting, type ColorPalette, type ColorScheme, type ColorShade, type ComponentProps, DatePicker, type DatePickerConfig, type DatePickerProps, type DateRange, type DeepPartial, Dropdown, DropdownItem, type DropdownItemProps, DropdownLabel, type DropdownLabelProps, DropdownMenu, type DropdownMenuProps, type DropdownProps, DropdownSeparator, type DropdownSeparatorProps, DropdownTrigger, type DropdownTriggerProps, Field, type FieldControlProps, type FieldOrientation, type FieldProps, type FontSizes, type FontWeights, Icon, type IconProps, Input, type InputProps, type LazyLoadedComponent, type LineHeights, List, ListDivider, type ListDividerProps, ListItem, ListItemButton, type ListItemButtonProps, ListItemIcon, type ListItemIconProps, type ListItemProps, ListItemText, type ListItemTextProps, type ListProps, ListSubheader, type ListSubheaderProps, type MaskChangeHandler, Modal, ModalBody, type ModalBodyProps, ModalClose, type ModalCloseProps, ModalContent, type ModalContentProps, ModalFooter, type ModalFooterProps, ModalHeader, type ModalHeaderProps, type ModalProps, ModalTrigger, type ModalTriggerProps, Popover, PopoverClose, type PopoverCloseProps, PopoverContent, type PopoverContentProps, type PopoverProps, PopoverTrigger, type PopoverTriggerProps, type Radii, Radio, RadioGroup, type RadioGroupProps, type RadioProps, Select, SelectContent, type SelectContentPart, type SelectContentProps, SelectGroup, type SelectGroupProps, SelectOption, type SelectOptionPart, type SelectOptionProps, type SelectProps, SelectTrigger, type SelectTriggerPart, type SelectTriggerProps, SelectValue, type SelectValueProps, type SelectVariant, type SelectedOption, type SemanticColors, type Shade, type ShadeLevel, type Shadows, type Shape, type Size, type Sizes, type Spaces, Spinner, type SpinnerProps, Tab, TabList, type TabListProps, TabPanel, type TabPanelProps, TabPanels, type TabPanelsProps, type TabProps, Tabs, type TabsProps, Textarea, type TextareaProps, type Theme, type ThemeContextValue, ThemeProvider, type ThemeProviderProps, type ToastAction, type ToastApi, type ToastContent, type ToastIcons, type ToastOptions, type ToastPart, type ToastPosition, ToastProvider, type ToastProviderProps, type ToastStatus, type ToastVariant, Toggle, type ToggleProps, Tooltip, type TooltipProps, type Typography, type UseClickOutsideProps, type UseDebounceProps, type UseMaskProps, type UseMaskResult, type ZIndeces, applyMask, colorVar, deepMerge, defaultDarkTheme, defaultTheme, formatDate, getContrastColor, getContrastRatio, getDarkenColor, getDateFormatByLanguage, getDateFromDateString, getDateStringByLanguage, getDaysOfWeekByLanguage, getLightenColor, getMonthsByLanguage, lazyLoadContent, themeToCssVars, useClickOutside, useDebounce, useMask, useTheme, useToast, validateFormatDate };