@dragunio/fe-libs 0.1.2 → 0.1.4

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { ButtonHTMLAttributes, ReactNode, SVGProps, TableHTMLAttributes, HTMLAttributes, InputHTMLAttributes, KeyboardEventHandler, ReactElement } from 'react';
+import { ButtonHTMLAttributes, ReactNode, SVGProps, TableHTMLAttributes, HTMLAttributes, InputHTMLAttributes, KeyboardEventHandler, TextareaHTMLAttributes, ReactElement } from 'react';
 
 type ButtonHierarchy = 'primary' | 'secondary-gray' | 'secondary-color' | 'tertiary-gray' | 'tertiary-color';
 type ButtonSize = '24' | '32' | '40';
@@ -53,6 +53,7 @@ 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';
 type TableProps = TableHTMLAttributes<HTMLTableElement> & {
     /** Enables alternating background colors for body rows. */
     striped?: boolean;
@@ -68,12 +69,24 @@ type TableProps = TableHTMLAttributes<HTMLTableElement> & {
     onColumnResize?: ColumnResizeHandler;
     /** Smallest width, in pixels, that a user can resize a column to. */
     minColumnWidth?: number;
+    /** Shows the built-in Pagination for data-driven tables. Enabled by pageSize as well. */
+    pagination?: boolean;
+    /** Number of data rows shown on each page. Defaults to 10 when pagination is enabled. */
+    pageSize?: number;
+    /** Controlled one-based page number. */
+    page?: number;
+    /** Initial page number for uncontrolled pagination. */
+    defaultPage?: number;
+    /** Called with the newly selected one-based page number. */
+    onPageChange?: (page: number) => void;
+    /** Location of the built-in Pagination. Defaults to bottom-right. */
+    paginationPosition?: TablePaginationPosition;
 };
 /**
  * A semantic table. Use its child primitives for custom markup, or pass headers
  * and data for an automatically sized, striped and resizable table.
  */
-declare function Table({ headers, data, striped, children, ...props }: TableProps): react.JSX.Element;
+declare function Table({ headers, data, striped, children, pagination, pageSize, page, defaultPage, onPageChange, paginationPosition, ...props }: TableProps): react.JSX.Element;
 declare function TableHead(props: HTMLAttributes<HTMLTableSectionElement>): react.JSX.Element;
 declare function TableBody(props: HTMLAttributes<HTMLTableSectionElement>): react.JSX.Element;
 declare function TableRow({ children, ...props }: HTMLAttributes<HTMLTableRowElement>): react.JSX.Element;
@@ -111,6 +124,36 @@ type DrawerProps = Omit<HTMLAttributes<HTMLElement>, 'title'> & {
 /** A modal panel with fixed header/footer regions and a scrollable body. */
 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 = {
+    label?: ReactNode;
+    helperText?: ReactNode;
+    /** A string/node is displayed beneath the control; `true` uses a default message. */
+    error?: FieldError;
+    errorMessage?: ReactNode;
+    clearable?: boolean;
+    onClear?: () => void;
+    onValueChange?: (value: string) => void;
+    clearLabel?: string;
+};
+type TextInputProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'size' | 'value' | 'defaultValue'> & TextFieldBaseProps & {
+    value?: string;
+    defaultValue?: string;
+};
+type TextAreaProps = Omit<TextareaHTMLAttributes<HTMLTextAreaElement>, 'value' | 'defaultValue'> & TextFieldBaseProps & {
+    value?: string;
+    defaultValue?: string;
+};
+/** 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 & {
+    value?: string;
+    defaultValue?: string;
+} & react.RefAttributes<HTMLTextAreaElement>>;
 type SelectionOption = {
     label: ReactNode;
     value: string | number;
@@ -170,7 +213,9 @@ type NumberInputProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'type' | 'va
     thousandSeparator?: string;
     label?: ReactNode;
     helperText?: ReactNode;
-    error?: boolean;
+    /** 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. */
@@ -189,7 +234,9 @@ declare const NumberInput: react.ForwardRefExoticComponent<Omit<InputHTMLAttribu
     thousandSeparator?: string;
     label?: ReactNode;
     helperText?: ReactNode;
-    error?: boolean;
+    /** A string/node is displayed beneath the control; `true` uses a default message. */
+    error?: FieldError;
+    errorMessage?: ReactNode;
 } & react.RefAttributes<HTMLInputElement>>;
 type Currency = {
     code: string;
@@ -249,4 +296,186 @@ type ExpandableSectionProps = Omit<HTMLAttributes<HTMLDivElement>, 'title'> & {
 /** An outlined section that can be expanded or collapsed. */
 declare function ExpandableSection({ title, children, expanded, defaultExpanded, onExpandedChange, disabled, className, ...props }: ExpandableSectionProps): react.JSX.Element;
 
-export { Button, type ButtonColor, type ButtonHierarchy, type ButtonProps, type ButtonSize, type ButtonVariant, ChevronDownIcon, CloseIcon, type ColumnResizeHandler, type Currency, CurrencyInput, type CurrencyInputProps, type DateRange, DateTimePicker, type DateTimePickerProps, type DateTimePickerRangeProps, type DateTimePickerSingleProps, Drawer, type DrawerProps, ExpandableSection, type ExpandableSectionProps, type IconProps, NumberInput, type NumberInputProps, PlusIcon, SearchIcon, Selection, type SelectionOption, type SelectionProps, type SelectionValue, Table, TableBody, TableCaption, TableCell, type TableData, TableHead, TableHeader, type TableProps, TableRow, Toggle, type ToggleProps, Tooltip, type TooltipProps, formatNumber, getIconSize };
+type LoadingSize = 'small' | 'medium' | 'large' | number;
+type LoadingProps = HTMLAttributes<HTMLSpanElement> & {
+    /** Diameter of the spinner. Accepts presets or a pixel value. */
+    size?: LoadingSize;
+    /** Spinner color. Accepts every valid CSS color. */
+    color?: string;
+    /** Optional visible status text. */
+    label?: ReactNode;
+};
+/** An accessible circular loading indicator with three preset sizes. */
+declare function Loading({ size, color, label, className, style, ...props }: LoadingProps): react.JSX.Element;
+
+type SkeletonVariant = 'box' | 'circle' | 'line';
+type SkeletonProps = HTMLAttributes<HTMLDivElement> & {
+    /** Visual shape. `box` is the default. */
+    variant?: SkeletonVariant;
+    /** Alias for variant, useful when describing the visual shape. */
+    shape?: SkeletonVariant;
+    width?: number | string;
+    height?: number | string;
+    /** Render multiple stacked placeholders. */
+    count?: number;
+    /** Turns off the shimmer animation. */
+    animated?: boolean;
+};
+type SkeletonSizeProps = Omit<SkeletonProps, 'variant' | 'shape' | 'width' | 'height' | 'count'> & {
+    /** Diameter/edge length. A number is converted to pixels. */
+    size?: number | string;
+};
+type SkeletonBoxProps = Omit<SkeletonProps, 'variant' | 'shape' | 'count'>;
+/** A shimmer placeholder for rectangular boxes, avatars, and text lines. */
+declare function SkeletonBase({ variant, shape, width, height, count, animated, className, style, ...props }: SkeletonProps): react.JSX.Element;
+/** A circular placeholder, useful for avatars and icon buttons. */
+declare function SkeletonCircle({ size, ...props }: SkeletonSizeProps): react.JSX.Element;
+/** A square placeholder, useful for thumbnails and image previews. */
+declare function SkeletonSquare({ size, ...props }: SkeletonSizeProps): react.JSX.Element;
+/** A rectangular placeholder with explicit width and height. */
+declare function SkeletonBox({ width, height, ...props }: SkeletonBoxProps): react.JSX.Element;
+/** A text-line placeholder with explicit width and height. */
+declare function SkeletonLine({ width, height, ...props }: SkeletonBoxProps): react.JSX.Element;
+type SkeletonComponent = typeof SkeletonBase & {
+    Circle: typeof SkeletonCircle;
+    Square: typeof SkeletonSquare;
+    Box: typeof SkeletonBox;
+    Line: typeof SkeletonLine;
+};
+/**
+ * A shimmer placeholder. Use the focused helpers for new code:
+ * `Skeleton.Circle`, `Skeleton.Square`, `Skeleton.Box`, and `Skeleton.Line`.
+ */
+declare const Skeleton: SkeletonComponent;
+
+type ModalSize = 'small' | 'medium' | 'large' | 'xlarge' | 'full';
+type ModalAction = Omit<ButtonProps, 'children' | 'content'> & {
+    label: ReactNode;
+};
+type ModalProps = Omit<HTMLAttributes<HTMLDivElement>, 'title'> & {
+    open: boolean;
+    onClose: () => void;
+    title?: ReactNode;
+    description?: ReactNode;
+    children?: ReactNode;
+    /** Custom footer content, rendered before actions. */
+    footer?: ReactNode;
+    /** Actions rendered with the library Button component. */
+    actions?: ModalAction[];
+    size?: ModalSize;
+    closeOnBackdropClick?: boolean;
+    closeButton?: boolean;
+    closeLabel?: string;
+};
+/** A centered, portal-based dialog with Button-powered close and footer actions. */
+declare function Modal({ open, onClose, title, description, children, footer, actions, size, closeOnBackdropClick, closeButton, closeLabel, className, ...props }: ModalProps): react.ReactPortal | null;
+
+type ProgressBarSize = 'small' | 'medium' | 'large';
+type ProgressBarProps = HTMLAttributes<HTMLDivElement> & {
+    /** Current value. Omit it for the indeterminate, bouncing state. */
+    value?: number | null;
+    max?: number;
+    label?: ReactNode;
+    showValue?: boolean;
+    size?: ProgressBarSize;
+    color?: string;
+};
+/** A determinate percentage bar or an indeterminate bar that moves back and forth. */
+declare function ProgressBar({ value, max, label, showValue, size, color, className, style, 'aria-label': ariaLabel, ...props }: ProgressBarProps): react.JSX.Element;
+
+type ChipStatus = 'default' | 'info' | 'success' | 'warning' | 'error' | 'neutral' | 'pending' | 'processing';
+type ChipVariant = 'subtle' | 'solid' | 'outline';
+type ChipProps = HTMLAttributes<HTMLSpanElement> & {
+    children: ReactNode;
+    /** Status color palette: default, success, error, info, warning, plus neutral/pending/processing. */
+    status?: ChipStatus;
+    /** Any CSS color. Overrides the status palette. */
+    color?: string;
+    variant?: ChipVariant;
+    dot?: boolean;
+    onRemove?: () => void;
+    removeLabel?: string;
+};
+/** A compact status label with status palettes and custom CSS colors. */
+declare function Chip({ children, status, color, variant, dot, onRemove, removeLabel, className, style, ...props }: ChipProps): react.JSX.Element;
+
+type PaginationProps = Omit<HTMLAttributes<HTMLElement>, 'onChange'> & {
+    /** Current page (one-based). Provide this with onPageChange for controlled use. */
+    page?: number;
+    /** Starting page for uncontrolled use. */
+    defaultPage?: number;
+    /** Total number of pages. */
+    totalPages: number;
+    /** Called whenever the selected page changes. */
+    onPageChange?: (page: number) => void;
+    /** Number of page buttons shown around the current page. */
+    siblingCount?: number;
+    /** Number of page buttons retained at each edge. */
+    boundaryCount?: number;
+    disabled?: boolean;
+    previousLabel?: string;
+    nextLabel?: string;
+};
+/** A compact, accessible page navigator with controlled and uncontrolled APIs. */
+declare function Pagination({ page, defaultPage, totalPages, onPageChange, siblingCount, boundaryCount, disabled, previousLabel, nextLabel, className, ...props }: PaginationProps): react.JSX.Element;
+
+type MessageSeverity = 'success' | 'info' | 'warning' | 'error';
+type MessageOptions = {
+    content: ReactNode;
+    severity?: MessageSeverity;
+    title?: ReactNode;
+    /** Set to null to leave the message visible until manually dismissed. */
+    duration?: number | null;
+    action?: ReactNode;
+    onClose?: () => void;
+};
+declare function dismiss(id: number): void;
+declare function show({ duration, severity, ...options }: MessageOptions): number;
+declare const message: {
+    show: typeof show;
+    success: (content: ReactNode, options?: Omit<MessageOptions, "content" | "severity">) => number;
+    info: (content: ReactNode, options?: Omit<MessageOptions, "content" | "severity">) => number;
+    warning: (content: ReactNode, options?: Omit<MessageOptions, "content" | "severity">) => number;
+    error: (content: ReactNode, options?: Omit<MessageOptions, "content" | "severity">) => number;
+    dismiss: typeof dismiss;
+    clear: () => void;
+};
+type MessageProps = HTMLAttributes<HTMLDivElement> & {
+    /** Maximum notifications shown at the same time. */
+    maxCount?: number;
+    closeLabel?: string;
+};
+/**
+ * Notification viewport for the global `message` trigger.
+ * Mount once near the application root, then call `message.success(...)`.
+ */
+declare function Message({ maxCount, closeLabel, className, ...props }: MessageProps): react.JSX.Element;
+/** Imperative trigger aliases, available as `Message.success(...)` as well. */
+declare namespace Message {
+    const show: ({ duration, severity, ...options }: MessageOptions) => number;
+    const success: (content: ReactNode, options?: Omit<MessageOptions, "content" | "severity">) => number;
+    const info: (content: ReactNode, options?: Omit<MessageOptions, "content" | "severity">) => number;
+    const warning: (content: ReactNode, options?: Omit<MessageOptions, "content" | "severity">) => number;
+    const error: (content: ReactNode, options?: Omit<MessageOptions, "content" | "severity">) => number;
+    const dismiss: (id: number) => void;
+    const clear: () => void;
+}
+
+type SnackbarAnchorOrigin = {
+    vertical?: 'top' | 'bottom';
+    horizontal?: 'left' | 'center' | 'right';
+};
+type SnackbarProps = Omit<HTMLAttributes<HTMLDivElement>, 'onClose'> & {
+    open: boolean;
+    message: ReactNode;
+    /** Set to null to keep the snackbar open until dismissed. */
+    autoHideDuration?: number | null;
+    onClose?: (reason: 'timeout' | 'closeButton' | 'escapeKeyDown') => void;
+    action?: ReactNode;
+    anchorOrigin?: SnackbarAnchorOrigin;
+    closeLabel?: string;
+};
+/** 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 };