@dragunio/fe-libs 0.1.4 → 0.1.6

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import * as react from 'react';
-import { ButtonHTMLAttributes, ReactNode, SVGProps, TableHTMLAttributes, HTMLAttributes, InputHTMLAttributes, KeyboardEventHandler, TextareaHTMLAttributes, ReactElement } from 'react';
+import { ButtonHTMLAttributes, ReactNode, TableHTMLAttributes, HTMLAttributes, InputHTMLAttributes, TextareaHTMLAttributes, KeyboardEventHandler, ChangeEvent, ReactElement } from 'react';
+export { ChevronDownIcon, ChevronUpIcon, CloseIcon, IconProps, PlusIcon, SearchIcon, arrow_left, check_square_fill, chevron_down, chevron_left, chevron_right, chevron_up, copy, key, lock, lock_unlocked, log_out, minus_square, plus, plus_square, search, trash, x_close } from './icons.js';
 
 type ButtonHierarchy = 'primary' | 'secondary-gray' | 'secondary-color' | 'tertiary-gray' | 'tertiary-color';
 type ButtonSize = '24' | '32' | '40';
@@ -43,14 +44,6 @@ declare const Button: react.ForwardRefExoticComponent<Omit<ButtonHTMLAttributes<
     variant?: ButtonVariant;
 } & react.RefAttributes<HTMLButtonElement>>;
 
-type IconProps = SVGProps<SVGSVGElement> & {
-    size?: number | string;
-};
-declare function PlusIcon(props: IconProps): react.JSX.Element;
-declare function ChevronDownIcon(props: IconProps): react.JSX.Element;
-declare function CloseIcon(props: IconProps): react.JSX.Element;
-declare function SearchIcon(props: IconProps): react.JSX.Element;
-
 type TableData = readonly (readonly ReactNode[])[];
 type ColumnResizeHandler = (columnSizes: number[], columnIndex: number) => void;
 type TablePaginationPosition = 'top-right' | 'bottom-right' | 'bottom-center' | 'middle-bottom';
@@ -99,12 +92,16 @@ type ToggleProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'color' | 'type'>
     color?: string;
     /** Optional text displayed next to the switch. */
     label?: ReactNode;
+    /** Places the label above or to the right of the switch. Defaults to `right`. */
+    labelPosition?: 'top' | 'right';
 };
 declare const Toggle: react.ForwardRefExoticComponent<Omit<InputHTMLAttributes<HTMLInputElement>, "color" | "type"> & {
     /** Active track color. Accepts any valid CSS color, for example `#16a34a`. */
     color?: string;
     /** Optional text displayed next to the switch. */
     label?: ReactNode;
+    /** Places the label above or to the right of the switch. Defaults to `right`. */
+    labelPosition?: "top" | "right";
 } & react.RefAttributes<HTMLInputElement>>;
 
 type DrawerProps = Omit<HTMLAttributes<HTMLElement>, 'title'> & {
@@ -125,35 +122,75 @@ type DrawerProps = Omit<HTMLAttributes<HTMLElement>, 'title'> & {
 declare function Drawer({ open, onClose, title, footer, side, width, fullScreen, children, closeOnBackdropClick, className, style, ...props }: DrawerProps): react.ReactPortal | null;
 
 type FieldError = boolean | ReactNode;
-type TextFieldBaseProps = {
+type DescriptionDisplay = 'inline' | 'tooltip';
+type FieldBaseProps = {
     label?: ReactNode;
+    /** Marks the field as required and displays a red asterisk. */
+    isRequired?: boolean;
+    /** Supporting text below the field. Takes precedence over helperText. */
+    description?: ReactNode;
+    /** Displays description below the field or from the label's information icon. */
+    descriptionDisplay?: DescriptionDisplay;
+    /** @deprecated Use description instead. Kept for backwards compatibility. */
     helperText?: ReactNode;
-    /** A string/node is displayed beneath the control; `true` uses a default message. */
+    /** A string/node is displayed beneath the control; true uses a default message. */
     error?: FieldError;
     errorMessage?: ReactNode;
+};
+type TextFieldBaseProps = FieldBaseProps & {
     clearable?: boolean;
     onClear?: () => void;
     onValueChange?: (value: string) => void;
     clearLabel?: string;
 };
-type TextInputProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'size' | 'value' | 'defaultValue'> & TextFieldBaseProps & {
+
+/** A text field with helper/error text and a Button-powered clear action. */
+declare const TextInput: react.ForwardRefExoticComponent<Omit<react.InputHTMLAttributes<HTMLInputElement>, "size" | "prefix" | "value" | "defaultValue"> & FieldBaseProps & {
+    clearable?: boolean;
+    onClear?: () => void;
+    onValueChange?: (value: string) => void;
+    clearLabel?: string;
+} & {
     value?: string;
     defaultValue?: string;
-};
-type TextAreaProps = Omit<TextareaHTMLAttributes<HTMLTextAreaElement>, 'value' | 'defaultValue'> & TextFieldBaseProps & {
+    prefix?: react.ReactNode;
+    suffix?: react.ReactNode;
+    Prefix?: react.ReactNode;
+    Suffix?: react.ReactNode;
+} & react.RefAttributes<HTMLInputElement>>;
+
+type TextInputProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'size' | 'value' | 'defaultValue' | 'prefix'> & TextFieldBaseProps & {
     value?: string;
     defaultValue?: string;
+    /** Content rendered inside the control before the input value. */
+    prefix?: ReactNode;
+    /** Content rendered inside the control after the input value. */
+    suffix?: ReactNode;
+    /** Alias for prefix. */
+    Prefix?: ReactNode;
+    /** Alias for suffix. */
+    Suffix?: ReactNode;
 };
-/** A text field with helper/error text and a Button-powered clear action. */
-declare const TextInput: react.ForwardRefExoticComponent<Omit<InputHTMLAttributes<HTMLInputElement>, "size" | "value" | "defaultValue"> & TextFieldBaseProps & {
-    value?: string;
-    defaultValue?: string;
-} & react.RefAttributes<HTMLInputElement>>;
+
 /** A multi-line text field with helper/error text and a Button-powered clear action. */
-declare const TextArea: react.ForwardRefExoticComponent<Omit<TextareaHTMLAttributes<HTMLTextAreaElement>, "value" | "defaultValue"> & TextFieldBaseProps & {
+declare const TextArea: react.ForwardRefExoticComponent<Omit<react.TextareaHTMLAttributes<HTMLTextAreaElement>, "value" | "defaultValue"> & FieldBaseProps & {
+    clearable?: boolean;
+    onClear?: () => void;
+    onValueChange?: (value: string) => void;
+    clearLabel?: string;
+} & {
+    autosize?: boolean;
     value?: string;
     defaultValue?: string;
 } & react.RefAttributes<HTMLTextAreaElement>>;
+
+type TextAreaProps = Omit<TextareaHTMLAttributes<HTMLTextAreaElement>, 'value' | 'defaultValue'> & TextFieldBaseProps & {
+    /** Expands the textarea to fit its content. */
+    autosize?: boolean;
+    value?: string;
+    defaultValue?: string;
+};
+
 type SelectionOption = {
     label: ReactNode;
     value: string | number;
@@ -163,8 +200,13 @@ type SelectionOption = {
 type SelectionValue = string | number | Array<string | number>;
 type SelectionProps = Omit<HTMLAttributes<HTMLDivElement>, 'onChange' | 'defaultValue' | 'value' | 'onKeyDown'> & {
     label?: ReactNode;
+    /** Marks the field as required and displays a red asterisk. */
+    isRequired?: boolean;
+    description?: ReactNode;
+    descriptionDisplay?: DescriptionDisplay;
     helperText?: ReactNode;
-    error?: boolean;
+    error?: FieldError;
+    errorMessage?: ReactNode;
     options: SelectionOption[];
     placeholder?: string;
     size?: 'small' | 'medium';
@@ -179,11 +221,16 @@ type SelectionProps = Omit<HTMLAttributes<HTMLDivElement>, 'onChange' | 'default
     name?: string;
     onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
 };
+
 /** A rounded, searchable custom dropdown with single, multiple, and tag modes. */
-declare const Selection: react.ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLDivElement>, "value" | "defaultValue" | "onChange" | "onKeyDown"> & {
-    label?: ReactNode;
-    helperText?: ReactNode;
-    error?: boolean;
+declare const Selection: react.ForwardRefExoticComponent<Omit<react.HTMLAttributes<HTMLDivElement>, "value" | "defaultValue" | "onChange" | "onKeyDown"> & {
+    label?: react.ReactNode;
+    isRequired?: boolean;
+    description?: react.ReactNode;
+    descriptionDisplay?: DescriptionDisplay;
+    helperText?: react.ReactNode;
+    error?: FieldError;
+    errorMessage?: react.ReactNode;
     options: SelectionOption[];
     placeholder?: string;
     size?: "small" | "medium";
@@ -196,30 +243,33 @@ declare const Selection: react.ForwardRefExoticComponent<Omit<HTMLAttributes<HTM
     clearable?: boolean;
     disabled?: boolean;
     name?: string;
-    onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
+    onKeyDown?: react.KeyboardEventHandler<HTMLButtonElement>;
 } & react.RefAttributes<HTMLDivElement>>;
-type NumberInputProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'type' | 'value' | 'defaultValue' | 'onChange' | 'min' | 'max'> & {
+
+declare function formatNumber(value: number, decimals?: number, thousandSeparator?: string, decimalSeparator?: string): string;
+/** A text input that displays numbers as 1,000.05 by default. */
+declare const NumberInput: react.ForwardRefExoticComponent<Omit<react.InputHTMLAttributes<HTMLInputElement>, "type" | "value" | "defaultValue" | "onChange" | "step" | "max" | "min"> & {
     value?: number | null;
     defaultValue?: number | null;
     onValueChange?: (value: number | null) => void;
-    /** Allows the decimal separator and fractional digits. Defaults to true. */
     allowDecimal?: boolean;
-    /** Maximum number of fractional digits when allowDecimal is enabled. Defaults to 2. */
     decimals?: number;
-    /** Numeric limits applied immediately as the value changes. */
     min?: number;
     max?: number;
     decimalSeparator?: string;
     thousandSeparator?: string;
-    label?: ReactNode;
-    helperText?: ReactNode;
-    /** A string/node is displayed beneath the control; `true` uses a default message. */
-    error?: FieldError;
-    errorMessage?: ReactNode;
-};
-declare function formatNumber(value: number, decimals?: number, thousandSeparator?: string, decimalSeparator?: string): string;
-/** A text input that displays numbers as 1,000.05 by default. */
-declare const NumberInput: react.ForwardRefExoticComponent<Omit<InputHTMLAttributes<HTMLInputElement>, "type" | "value" | "defaultValue" | "onChange" | "max" | "min"> & {
+    prefix?: react.ReactNode;
+    suffix?: react.ReactNode;
+    Prefix?: react.ReactNode;
+    Suffix?: react.ReactNode;
+    endAdornment?: react.ReactNode;
+    step?: number;
+    showStepper?: boolean;
+    incrementLabel?: string;
+    decrementLabel?: string;
+} & FieldBaseProps & react.RefAttributes<HTMLInputElement>>;
+
+type NumberInputProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'type' | 'value' | 'defaultValue' | 'onChange' | 'min' | 'max' | 'step'> & {
     value?: number | null;
     defaultValue?: number | null;
     onValueChange?: (value: number | null) => void;
@@ -232,29 +282,44 @@ declare const NumberInput: react.ForwardRefExoticComponent<Omit<InputHTMLAttribu
     max?: number;
     decimalSeparator?: string;
     thousandSeparator?: string;
-    label?: ReactNode;
-    helperText?: ReactNode;
-    /** A string/node is displayed beneath the control; `true` uses a default message. */
-    error?: FieldError;
-    errorMessage?: ReactNode;
-} & react.RefAttributes<HTMLInputElement>>;
+    /** Content rendered inside the control before the numeric value. */
+    prefix?: ReactNode;
+    /** Content rendered inside the control after the numeric value. */
+    suffix?: ReactNode;
+    /** Alias for prefix. */
+    Prefix?: ReactNode;
+    /** Alias for suffix. */
+    Suffix?: ReactNode;
+    /** Content rendered inside the control after the numeric value. */
+    endAdornment?: ReactNode;
+    /** Amount added or subtracted by the increment and decrement controls. Defaults to 1. */
+    step?: number;
+    /** Shows the increment and decrement controls. Defaults to true. */
+    showStepper?: boolean;
+    /** Accessible label for the increment control. */
+    incrementLabel?: string;
+    /** Accessible label for the decrement control. */
+    decrementLabel?: string;
+} & FieldBaseProps;
+
 type Currency = {
     code: string;
     label?: string;
     suffix?: string;
 };
-type CurrencyInputProps = Omit<NumberInputProps, 'suffix'> & {
+type CurrencyInputProps = Omit<NumberInputProps, 'suffix' | 'endAdornment'> & {
     suffix?: ReactNode;
     currencies?: Currency[];
     currency?: string;
     defaultCurrency?: string;
     onCurrencyChange?: (currency: Currency) => void;
 };
+
 /** NumberInput with an optional currency suffix or currency list dropdown. */
-declare function CurrencyInput({ suffix, currencies, currency, defaultCurrency, onCurrencyChange, className, ...props }: CurrencyInputProps): react.JSX.Element;
+declare function CurrencyInput({ suffix, currencies, currency, defaultCurrency, onCurrencyChange, className, disabled, ...props }: CurrencyInputProps): react.JSX.Element;
+
 type DateRange = [Date | null, Date | null];
-type DateTimeBaseProps = Omit<HTMLAttributes<HTMLDivElement>, 'onChange' | 'defaultValue'> & {
-    label?: ReactNode;
+type DateTimeBaseProps = Omit<HTMLAttributes<HTMLDivElement>, 'onChange' | 'defaultValue'> & FieldBaseProps & {
     format?: string;
     disabled?: boolean;
     placeholder?: string;
@@ -273,9 +338,72 @@ type DateTimePickerRangeProps = DateTimeBaseProps & {
     onChange?: (value: DateRange) => void;
 };
 type DateTimePickerProps = DateTimePickerSingleProps | DateTimePickerRangeProps;
+
 /** Calendar and time picker. Supports a single Date or [start, end] range. */
 declare function DateTimePicker(props: DateTimePickerProps): react.JSX.Element;
 
+type ControlLabelPosition = 'top' | 'right';
+type CheckboxProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'type'> & {
+    /** Optional text associated with the checkbox. */
+    label?: ReactNode;
+    /** Places the label above or to the right of the checkbox. Defaults to `right`. */
+    labelPosition?: ControlLabelPosition;
+};
+
+/** A native checkbox with an accessible, custom visual control. */
+declare const Checkbox: react.ForwardRefExoticComponent<Omit<react.InputHTMLAttributes<HTMLInputElement>, "type"> & {
+    label?: react.ReactNode;
+    labelPosition?: ControlLabelPosition;
+} & react.RefAttributes<HTMLInputElement>>;
+
+/** A native radio input with an accessible, custom visual control. */
+declare const RadioButton: react.ForwardRefExoticComponent<Omit<react.InputHTMLAttributes<HTMLInputElement>, "type"> & {
+    label?: react.ReactNode;
+    labelPosition?: ControlLabelPosition;
+} & react.RefAttributes<HTMLInputElement>>;
+
+type RadioButtonProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'type'> & {
+    /** Optional text associated with the radio button. */
+    label?: ReactNode;
+    /** Places the label above or to the right of the radio button. Defaults to `right`. */
+    labelPosition?: ControlLabelPosition;
+};
+
+type RadioValue = string | number;
+type RadioGroupOption = {
+    label: ReactNode;
+    value: RadioValue;
+    disabled?: boolean;
+};
+type RadioGroupProps = Omit<HTMLAttributes<HTMLDivElement>, 'onChange' | 'defaultValue' | 'value'> & {
+    /** Optional text that names the radio group. */
+    label?: ReactNode;
+    /** Places the group label above or to the right of its options. Defaults to `top`. */
+    labelPosition?: ControlLabelPosition;
+    options: RadioGroupOption[];
+    name?: string;
+    value?: RadioValue;
+    defaultValue?: RadioValue;
+    onChange?: (value: RadioValue, option: RadioGroupOption, event: ChangeEvent<HTMLInputElement>) => void;
+    disabled?: boolean;
+    direction?: 'horizontal' | 'vertical';
+    isRequired?: boolean;
+};
+
+/** A named collection of native radio buttons with controlled and uncontrolled values. */
+declare const RadioGroup: react.ForwardRefExoticComponent<Omit<react.HTMLAttributes<HTMLDivElement>, "value" | "defaultValue" | "onChange"> & {
+    label?: react.ReactNode;
+    labelPosition?: ControlLabelPosition;
+    options: RadioGroupOption[];
+    name?: string;
+    value?: RadioValue;
+    defaultValue?: RadioValue;
+    onChange?: (value: RadioValue, option: RadioGroupOption, event: ChangeEvent<HTMLInputElement>) => void;
+    disabled?: boolean;
+    direction?: "horizontal" | "vertical";
+    isRequired?: boolean;
+} & react.RefAttributes<HTMLDivElement>>;
+
 type TooltipProps = Omit<HTMLAttributes<HTMLSpanElement>, 'content'> & {
     content: ReactNode;
     children: ReactElement;
@@ -478,4 +606,4 @@ type SnackbarProps = Omit<HTMLAttributes<HTMLDivElement>, 'onClose'> & {
 /** A controlled, temporary notification surface. */
 declare function Snackbar({ open, message, autoHideDuration, onClose, action, anchorOrigin, closeLabel, className, ...props }: SnackbarProps): react.JSX.Element | null;
 
-export { Button, type ButtonColor, type ButtonHierarchy, type ButtonProps, type ButtonSize, type ButtonVariant, ChevronDownIcon, Chip, type ChipProps, type ChipStatus, type ChipVariant, CloseIcon, type ColumnResizeHandler, type Currency, CurrencyInput, type CurrencyInputProps, type DateRange, DateTimePicker, type DateTimePickerProps, type DateTimePickerRangeProps, type DateTimePickerSingleProps, Drawer, type DrawerProps, ExpandableSection, type ExpandableSectionProps, type FieldError, type IconProps, Loading, type LoadingProps, type LoadingSize, Message, type MessageOptions, type MessageProps, type MessageSeverity, Modal, type ModalAction, type ModalProps, type ModalSize, NumberInput, type NumberInputProps, Pagination, type PaginationProps, PlusIcon, ProgressBar, type ProgressBarProps, type ProgressBarSize, SearchIcon, Selection, type SelectionOption, type SelectionProps, type SelectionValue, Skeleton, SkeletonBox, type SkeletonBoxProps, SkeletonCircle, SkeletonLine, type SkeletonProps, type SkeletonSizeProps, SkeletonSquare, type SkeletonVariant, Snackbar, type SnackbarAnchorOrigin, type SnackbarProps, Table, TableBody, TableCaption, TableCell, type TableData, TableHead, TableHeader, type TablePaginationPosition, type TableProps, TableRow, TextArea, type TextAreaProps, TextInput, type TextInputProps, Toggle, type ToggleProps, Tooltip, type TooltipProps, formatNumber, getIconSize, message };
+export { Button, type ButtonColor, type ButtonHierarchy, type ButtonProps, type ButtonSize, type ButtonVariant, Checkbox, type CheckboxProps, Chip, type ChipProps, type ChipStatus, type ChipVariant, type ColumnResizeHandler, type ControlLabelPosition, type Currency, CurrencyInput, type CurrencyInputProps, type DateRange, DateTimePicker, type DateTimePickerProps, type DateTimePickerRangeProps, type DateTimePickerSingleProps, type DescriptionDisplay, Drawer, type DrawerProps, ExpandableSection, type ExpandableSectionProps, type FieldError, Loading, type LoadingProps, type LoadingSize, Message, type MessageOptions, type MessageProps, type MessageSeverity, Modal, type ModalAction, type ModalProps, type ModalSize, NumberInput, type NumberInputProps, Pagination, type PaginationProps, ProgressBar, type ProgressBarProps, type ProgressBarSize, RadioButton, type RadioButtonProps, RadioGroup, type RadioGroupOption, type RadioGroupProps, type RadioValue, Selection, type SelectionOption, type SelectionProps, type SelectionValue, Skeleton, SkeletonBox, type SkeletonBoxProps, SkeletonCircle, SkeletonLine, type SkeletonProps, type SkeletonSizeProps, SkeletonSquare, type SkeletonVariant, Snackbar, type SnackbarAnchorOrigin, type SnackbarProps, Table, TableBody, TableCaption, TableCell, type TableData, TableHead, TableHeader, type TablePaginationPosition, type TableProps, TableRow, TextArea, type TextAreaProps, TextInput, type TextInputProps, Toggle, type ToggleProps, Tooltip, type TooltipProps, formatNumber, getIconSize, message };