@octoguide/mui-ui-toolkit 0.3.1 → 0.5.0

package/dist/index.d.mts

@@ -2,8 +2,8 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
 import { Theme } from '@mui/material/styles';
 import * as _mui_material from '@mui/material';
-import { ButtonProps as ButtonProps$1, ChipProps as ChipProps$1, CardProps as CardProps$1, CardActions as CardActions$1, TextFieldProps as TextFieldProps$1, AlertProps as AlertProps$1, AlertTitleProps as AlertTitleProps$1, AccordionProps as AccordionProps$1, AccordionDetailsProps as AccordionDetailsProps$1, AccordionSummaryProps as AccordionSummaryProps$1, ToggleButtonProps as ToggleButtonProps$1, ToggleButtonGroupProps as ToggleButtonGroupProps$1, Grid2Props, TypographyProps } from '@mui/material';
-export { CardActionsProps, CardHeaderProps } from '@mui/material';
+import { TextFieldProps as TextFieldProps$1, ButtonProps as ButtonProps$1, ChipProps as ChipProps$1, CardProps as CardProps$1, CardActions as CardActions$1, AlertProps as AlertProps$1, AlertTitleProps as AlertTitleProps$1, AccordionProps as AccordionProps$1, AccordionDetailsProps as AccordionDetailsProps$1, AccordionSummaryProps as AccordionSummaryProps$1, ToggleButtonProps as ToggleButtonProps$1, ToggleButtonGroupProps as ToggleButtonGroupProps$1, Grid2Props, TableProps as TableProps$1, TableBodyProps as TableBodyProps$1, TableCellProps as TableCellProps$1, TableContainerProps as TableContainerProps$1, TableHeadProps as TableHeadProps$1, TableRowProps as TableRowProps$1, TypographyProps } from '@mui/material';
+export { CardActionsProps, CardHeaderProps, TablePaginationProps, TableSortLabelProps } from '@mui/material';
 import * as _mui_material_OverridableComponent from '@mui/material/OverridableComponent';
 import * as _emotion_styled from '@emotion/styled';
 import * as _mui_material_transitions from '@mui/material/transitions';
@@ -26,6 +26,7 @@ import { DateTimeFieldProps as DateTimeFieldProps$1 } from '@mui/x-date-pickers/
 import { StaticDateTimePickerProps as StaticDateTimePickerProps$1 } from '@mui/x-date-pickers/StaticDateTimePicker';
 import { DateCalendarProps as DateCalendarProps$1 } from '@mui/x-date-pickers/DateCalendar';
 import { Dayjs } from 'dayjs';
+import { PaginationProps as PaginationProps$1 } from '@mui/material/Pagination';
 export { default as AvatarGroup, AvatarGroupProps } from '@mui/material/AvatarGroup';
 
 /**
@@ -414,6 +415,38 @@ declare function createMuiTheme(tokens: ThemeTokens): Theme;
  */
 declare function resolveThemeName(): ThemeName;
 
+type TextFieldProps = TextFieldProps$1 & {
+    /** When true and type="password", renders a visibility toggle icon button as end adornment. */
+    showPasswordToggle?: boolean;
+};
+declare const TextField: React.ForwardRefExoticComponent<(Omit<_mui_material.OutlinedTextFieldProps & {
+    /** When true and type="password", renders a visibility toggle icon button as end adornment. */
+    showPasswordToggle?: boolean;
+}, "ref"> | Omit<_mui_material.FilledTextFieldProps & {
+    /** When true and type="password", renders a visibility toggle icon button as end adornment. */
+    showPasswordToggle?: boolean;
+}, "ref"> | Omit<_mui_material.StandardTextFieldProps & {
+    /** When true and type="password", renders a visibility toggle icon button as end adornment. */
+    showPasswordToggle?: boolean;
+}, "ref">) & React.RefAttributes<HTMLInputElement>>;
+
+interface ABNInputProps extends Omit<TextFieldProps, 'onChange'> {
+    /** Marks the field as invalid — maps to MUI's `error` prop */
+    isInvalid?: boolean;
+    /** Shows a loading spinner in the end adornment */
+    isLoading?: boolean;
+    /** Makes the input read-only */
+    readOnly?: boolean;
+    /** Called with the synthetic event and `{ value, unformattedValue }` */
+    onChange?: (event: React.ChangeEvent<HTMLInputElement>, values: {
+        value: string;
+        unformattedValue: string;
+    }) => void;
+    /** Current value — digits or pre-formatted ABN string */
+    value?: string;
+}
+declare const ABNInput: React.ForwardRefExoticComponent<Omit<ABNInputProps, "ref"> & React.RefAttributes<HTMLInputElement>>;
+
 interface ButtonProps extends ButtonProps$1 {
     /** Show a loading spinner and disable interaction */
     loading?: boolean;
@@ -449,21 +482,6 @@ declare const CardContent: _mui_material_OverridableComponent.OverridableCompone
 declare const CardHeader: _mui_material.OverridableCardHeader;
 declare const CardActions: typeof CardActions$1;
 
-type TextFieldProps = TextFieldProps$1 & {
-    /** When true and type="password", renders a visibility toggle icon button as end adornment. */
-    showPasswordToggle?: boolean;
-};
-declare const TextField: React.ForwardRefExoticComponent<(Omit<_mui_material.OutlinedTextFieldProps & {
-    /** When true and type="password", renders a visibility toggle icon button as end adornment. */
-    showPasswordToggle?: boolean;
-}, "ref"> | Omit<_mui_material.FilledTextFieldProps & {
-    /** When true and type="password", renders a visibility toggle icon button as end adornment. */
-    showPasswordToggle?: boolean;
-}, "ref"> | Omit<_mui_material.StandardTextFieldProps & {
-    /** When true and type="password", renders a visibility toggle icon button as end adornment. */
-    showPasswordToggle?: boolean;
-}, "ref">) & React.RefAttributes<HTMLInputElement>>;
-
 type AlertProps = AlertProps$1;
 type AlertTitleProps = AlertTitleProps$1;
 /**
@@ -711,95 +729,230 @@ declare namespace Grid {
     var displayName: string;
 }
 
-interface H1Props extends Omit<TypographyProps, 'variant'> {
+interface InternalLinkItemProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> {
+    /** URL for the anchor href */
+    link?: string;
+    /** The label to display */
+    label: string;
+    /** Secondary text displayed beneath the label */
+    caption?: string;
+    /** Optional icon rendered on the left */
+    icon?: React.ReactNode;
+    /**
+     * Swap the rendered element — pass a React Router `<Link>` or any
+     * component that accepts an `href`/`to` prop.
+     * Defaults to a plain `<a>`.
+     */
+    component?: React.ElementType;
 }
-declare function H1({ color, children, ...props }: H1Props): react_jsx_runtime.JSX.Element;
-declare namespace H1 {
+declare function InternalLinkItem({ link, icon, label, caption, component, ...restProps }: InternalLinkItemProps): react_jsx_runtime.JSX.Element;
+declare namespace InternalLinkItem {
     var displayName: string;
 }
 
-interface H2Props extends Omit<TypographyProps, 'variant'> {
+declare const Variant: {
+    readonly standard: "standard";
+    readonly external: "external";
+    readonly file: "file";
+};
+interface LinkProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'color'> {
+    /** Content of the link */
+    children: React.ReactNode;
+    /** Visual variant — controls icon and default target */
+    variant?: 'standard' | 'external' | 'file';
+    /** Custom icon component (standard variant only) */
+    icon?: React.ElementType;
+    /** Render the icon on the right instead of the left */
+    iconToRight?: boolean;
+    /** Extra padding, renders the link as a standalone block-level call-to-action */
+    standalone?: boolean;
+    /** High-contrast mode for use on dark backgrounds */
+    isOnDarkBg?: boolean;
+    /** Link colour */
+    color?: 'black' | 'primary' | 'error';
+    /** Link URL */
+    href?: string;
+    /** Swap the rendered element — pass a React Router `<Link>` or similar */
+    component?: React.ElementType;
+}
+declare const Link: React.ForwardRefExoticComponent<LinkProps & React.RefAttributes<HTMLAnchorElement>>;
+
+interface LogoLinkProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> {
+    /** Logo content — pass an `<img>`, inline SVG, or any React node */
+    children: React.ReactNode;
+    /** Link destination, defaults to '/' */
+    href?: string;
+    /** Compact height mode (45px instead of 55px) */
+    isSmall?: boolean;
+    /** Accessible title for the link, defaults to 'Home' */
+    title?: string;
+    /** Swap the rendered element — pass a React Router `<Link>` or similar */
+    component?: React.ElementType;
+}
+declare const LogoLink: React.ForwardRefExoticComponent<LogoLinkProps & React.RefAttributes<HTMLAnchorElement>>;
+
+interface PageSpinnerProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'role'> {
+    /** Loading message shown below the spinner */
+    message?: string;
+    /** Override the visible message with a React node (the `message` prop is still announced to screen readers) */
+    customMessageLayout?: React.ReactNode;
+    /** Use light-on-dark colour scheme */
+    isOnDarkBg?: boolean;
+    /** Additional screen reader text when no visible message is needed */
+    srText?: string;
+    /** DOM node to portal into (defaults to document.body) */
+    rootNode?: Element;
+    /** Aria-live politeness for the screen reader announcement */
+    messageTone?: 'assertive' | 'polite';
+}
+declare const PageSpinner: React.ForwardRefExoticComponent<PageSpinnerProps & React.RefAttributes<HTMLDivElement>>;
+
+type PaginationVariant = 'text' | 'outlined' | 'soft';
+type PaginationShape = 'circular' | 'rounded';
+type PaginationColor = 'default' | 'primary' | 'secondary' | 'info' | 'success' | 'warning' | 'error';
+interface PaginationProps extends Omit<PaginationProps$1, 'variant' | 'color' | 'shape'> {
+    /** Visual style variant */
+    variant?: PaginationVariant;
+    /** Shape of pagination items */
+    shape?: PaginationShape;
+    /** Color applied to the selected/active item */
+    color?: PaginationColor;
+}
+declare const Pagination: React.ForwardRefExoticComponent<Omit<PaginationProps, "ref"> & React.RefAttributes<HTMLElement>>;
+
+interface ParagraphProps extends Omit<React.HTMLAttributes<HTMLParagraphElement>, 'color'> {
+    /** Visual style variant */
+    variant?: 'regular' | 'semibold' | 'bold' | 'overline' | 'primary' | 'secondary';
+    /** Renders the correct text colour on a dark background */
+    isOnDarkBg?: boolean;
+    children: React.ReactNode;
 }
-declare function H2({ color, children, ...props }: H2Props): react_jsx_runtime.JSX.Element;
-declare namespace H2 {
+declare const Paragraph: React.ForwardRefExoticComponent<ParagraphProps & React.RefAttributes<HTMLParagraphElement>>;
+
+type SpinnerSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+
+interface SpinnerProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'role'> {
+    /** Size of the spinner */
+    size?: SpinnerSize;
+    /** Message displayed below (or beside when isInline) the spinner */
+    message?: React.ReactNode;
+    /** Use light-on-dark colour scheme */
+    isOnDarkBg?: boolean;
+    /** Screen reader text when no visible message is provided */
+    srText?: string;
+    /** Display the spinner and message side by side */
+    isInline?: boolean;
+}
+declare const Spinner: React.ForwardRefExoticComponent<SpinnerProps & React.RefAttributes<HTMLDivElement>>;
+
+interface ToggleProps extends Omit<React.HTMLAttributes<HTMLFieldSetElement>, 'onChange'> {
+    /** Unique name for the radio inputs */
+    name: string;
+    /** Whether the toggle is in the "on" state */
+    checked?: boolean;
+    /** Label displayed above the toggle */
+    label?: string;
+    /** Helper text displayed beneath the label */
+    description?: string;
+    /** Error message */
+    error?: string;
+    /** Callback with the new boolean value when the toggle changes */
+    onChange?: (value: boolean) => void;
+    /** Blur handler forwarded to both radio inputs */
+    onBlur?: () => void;
+}
+declare function Toggle({ name, checked, label, description, error, onChange, onBlur, ...restProps }: ToggleProps): react_jsx_runtime.JSX.Element;
+declare namespace Toggle {
     var displayName: string;
 }
 
-interface H3Props extends Omit<TypographyProps, 'variant'> {
+type TableProps = TableProps$1;
+type TableHeadProps = TableHeadProps$1;
+type TableBodyProps = TableBodyProps$1;
+type TableRowProps = TableRowProps$1;
+type TableCellProps = TableCellProps$1;
+type TableContainerProps = TableContainerProps$1;
+declare function Table(props: TableProps): react_jsx_runtime.JSX.Element;
+declare namespace Table {
+    var displayName: string;
 }
-declare function H3({ color, children, ...props }: H3Props): react_jsx_runtime.JSX.Element;
-declare namespace H3 {
+declare function TableHead(props: TableHeadProps): react_jsx_runtime.JSX.Element;
+declare namespace TableHead {
     var displayName: string;
 }
-
-interface H4Props extends Omit<TypographyProps, 'variant'> {
+declare function TableBody(props: TableBodyProps): react_jsx_runtime.JSX.Element;
+declare namespace TableBody {
+    var displayName: string;
 }
-declare function H4({ color, children, ...props }: H4Props): react_jsx_runtime.JSX.Element;
-declare namespace H4 {
+declare function TableRow(props: TableRowProps): react_jsx_runtime.JSX.Element;
+declare namespace TableRow {
     var displayName: string;
 }
-
-interface H5Props extends Omit<TypographyProps, 'variant'> {
+declare function TableCell(props: TableCellProps): react_jsx_runtime.JSX.Element;
+declare namespace TableCell {
+    var displayName: string;
+}
+declare function TableHeadCell(props: TableCellProps): react_jsx_runtime.JSX.Element;
+declare namespace TableHeadCell {
+    var displayName: string;
 }
-declare function H5({ color, children, ...props }: H5Props): react_jsx_runtime.JSX.Element;
-declare namespace H5 {
+declare function TableContainer(props: TableContainerProps): react_jsx_runtime.JSX.Element;
+declare namespace TableContainer {
     var displayName: string;
 }
+declare const TablePagination: _mui_material_OverridableComponent.OverridableComponent<_mui_material.TablePaginationTypeMap<{}, React.JSXElementConstructor<_mui_material.TablePaginationBaseProps>>>;
+declare const TableSortLabel: _mui_material.ExtendButtonBase<_mui_material.TableSortLabelTypeMap<{}, "span">>;
 
-interface H6Props extends Omit<TypographyProps, 'variant'> {
+interface H1Props extends Omit<TypographyProps, 'variant'> {
 }
-declare function H6({ color, children, ...props }: H6Props): react_jsx_runtime.JSX.Element;
-declare namespace H6 {
-    var displayName: string;
+declare const H1: React.ForwardRefExoticComponent<Omit<H1Props, "ref"> & React.RefAttributes<HTMLElement>>;
+
+interface H2Props extends Omit<TypographyProps, 'variant'> {
 }
+declare const H2: React.ForwardRefExoticComponent<Omit<H2Props, "ref"> & React.RefAttributes<HTMLElement>>;
 
-interface Subtitle1Props extends Omit<TypographyProps, 'variant'> {
+interface H3Props extends Omit<TypographyProps, 'variant'> {
 }
-declare function Subtitle1({ color, children, ...props }: Subtitle1Props): react_jsx_runtime.JSX.Element;
-declare namespace Subtitle1 {
-    var displayName: string;
+declare const H3: React.ForwardRefExoticComponent<Omit<H3Props, "ref"> & React.RefAttributes<HTMLElement>>;
+
+interface H4Props extends Omit<TypographyProps, 'variant'> {
 }
+declare const H4: React.ForwardRefExoticComponent<Omit<H4Props, "ref"> & React.RefAttributes<HTMLElement>>;
 
-interface Subtitle2Props extends Omit<TypographyProps, 'variant'> {
+interface H5Props extends Omit<TypographyProps, 'variant'> {
 }
-declare function Subtitle2({ color, children, ...props }: Subtitle2Props): react_jsx_runtime.JSX.Element;
-declare namespace Subtitle2 {
-    var displayName: string;
+declare const H5: React.ForwardRefExoticComponent<Omit<H5Props, "ref"> & React.RefAttributes<HTMLElement>>;
+
+interface H6Props extends Omit<TypographyProps, 'variant'> {
 }
+declare const H6: React.ForwardRefExoticComponent<Omit<H6Props, "ref"> & React.RefAttributes<HTMLElement>>;
 
-interface Body1Props extends Omit<TypographyProps, 'variant'> {
+interface Subtitle1Props extends Omit<TypographyProps, 'variant'> {
 }
-declare function Body1({ color, children, ...props }: Body1Props): react_jsx_runtime.JSX.Element;
-declare namespace Body1 {
-    var displayName: string;
+declare const Subtitle1: React.ForwardRefExoticComponent<Omit<Subtitle1Props, "ref"> & React.RefAttributes<HTMLElement>>;
+
+interface Subtitle2Props extends Omit<TypographyProps, 'variant'> {
 }
+declare const Subtitle2: React.ForwardRefExoticComponent<Omit<Subtitle2Props, "ref"> & React.RefAttributes<HTMLElement>>;
 
-interface Body2Props extends Omit<TypographyProps, 'variant'> {
+interface Body1Props extends Omit<TypographyProps, 'variant'> {
 }
-declare function Body2({ color, children, ...props }: Body2Props): react_jsx_runtime.JSX.Element;
-declare namespace Body2 {
-    var displayName: string;
+declare const Body1: React.ForwardRefExoticComponent<Omit<Body1Props, "ref"> & React.RefAttributes<HTMLElement>>;
+
+interface Body2Props extends Omit<TypographyProps, 'variant'> {
 }
+declare const Body2: React.ForwardRefExoticComponent<Omit<Body2Props, "ref"> & React.RefAttributes<HTMLElement>>;
 
 interface CaptionProps extends Omit<TypographyProps, 'variant'> {
 }
-declare function Caption({ color, children, ...props }: CaptionProps): react_jsx_runtime.JSX.Element;
-declare namespace Caption {
-    var displayName: string;
-}
+declare const Caption: React.ForwardRefExoticComponent<Omit<CaptionProps, "ref"> & React.RefAttributes<HTMLElement>>;
 
 interface OverlineProps extends Omit<TypographyProps, 'variant'> {
 }
-declare function Overline({ color, children, ...props }: OverlineProps): react_jsx_runtime.JSX.Element;
-declare namespace Overline {
-    var displayName: string;
-}
+declare const Overline: React.ForwardRefExoticComponent<Omit<OverlineProps, "ref"> & React.RefAttributes<HTMLElement>>;
 
 interface TypographyButtonProps extends Omit<TypographyProps, 'variant'> {
 }
-declare function TypographyButton({ color, children, ...props }: TypographyButtonProps): react_jsx_runtime.JSX.Element;
-declare namespace TypographyButton {
-    var displayName: string;
-}
+declare const TypographyButton: React.ForwardRefExoticComponent<Omit<TypographyButtonProps, "ref"> & React.RefAttributes<HTMLElement>>;
 
-export { Accordion, AccordionDetails, type AccordionDetailsProps, type AccordionProps, AccordionSummary, type AccordionSummaryProps, Alert, type AlertProps, AlertTitle, type AlertTitleProps, Avatar, type AvatarProps, type AvatarSize, Body1, type Body1Props, Body2, type Body2Props, type BorderRadiusTokens, Button, type ButtonProps, Caption, type CaptionProps, Card, CardActions, CardContent, CardHeader, type CardProps, Chip, type ChipProps, type ColorTokens, type ComponentTokens, DateCalendar, type DateCalendarProps, DateField, type DateFieldProps, DateLocalizationProvider, type DateLocalizationProviderProps, DatePicker, type DatePickerProps, DateRangePickerCalendar, type DateRangePickerCalendarProps, DateRangePickerInput, type DateRangePickerInputProps, type DateRangeValue, DateTimeField, type DateTimeFieldProps, DateTimePicker, type DateTimePickerProps, DesktopDatePicker, type DesktopDatePickerProps, DesktopDateTimePicker, type DesktopDateTimePickerProps, DesktopTimePicker, type DesktopTimePickerProps, Grid, type GridProps, H1, type H1Props, H2, type H2Props, H3, type H3Props, H4, type H4Props, H5, type H5Props, H6, type H6Props, MobileDatePicker, type MobileDatePickerProps, MobileDateTimePicker, type MobileDateTimePickerProps, MobileTimePicker, type MobileTimePickerProps, Overline, type OverlineProps, type ShadowTokens, type SpacingTokens, StandaloneAccordion, StaticDatePicker, type StaticDatePickerProps, StaticDateTimePicker, type StaticDateTimePickerProps, StaticTimePicker, type StaticTimePickerProps, Subtitle1, type Subtitle1Props, Subtitle2, type Subtitle2Props, TextField, type TextFieldProps, type ThemeName, type ThemeTokens, TimeField, type TimeFieldProps, TimePicker, type TimePickerProps, ToggleButton, ToggleButtonGroup, type ToggleButtonGroupProps, type ToggleButtonProps, ToolkitThemeProvider, type TransitionTokens, TypographyButton, type TypographyButtonProps, type TypographyTokens, type ZIndexTokens, createMuiTheme, getThemeTokens, resolveThemeName, themeRegistry };
+export { ABNInput, type ABNInputProps, Accordion, AccordionDetails, type AccordionDetailsProps, type AccordionProps, AccordionSummary, type AccordionSummaryProps, Alert, type AlertProps, AlertTitle, type AlertTitleProps, Avatar, type AvatarProps, type AvatarSize, Body1, type Body1Props, Body2, type Body2Props, type BorderRadiusTokens, Button, type ButtonProps, Caption, type CaptionProps, Card, CardActions, CardContent, CardHeader, type CardProps, Chip, type ChipProps, type ColorTokens, type ComponentTokens, DateCalendar, type DateCalendarProps, DateField, type DateFieldProps, DateLocalizationProvider, type DateLocalizationProviderProps, DatePicker, type DatePickerProps, DateRangePickerCalendar, type DateRangePickerCalendarProps, DateRangePickerInput, type DateRangePickerInputProps, type DateRangeValue, DateTimeField, type DateTimeFieldProps, DateTimePicker, type DateTimePickerProps, DesktopDatePicker, type DesktopDatePickerProps, DesktopDateTimePicker, type DesktopDateTimePickerProps, DesktopTimePicker, type DesktopTimePickerProps, Grid, type GridProps, H1, type H1Props, H2, type H2Props, H3, type H3Props, H4, type H4Props, H5, type H5Props, H6, type H6Props, InternalLinkItem, type InternalLinkItemProps, Link, type LinkProps, LogoLink, type LogoLinkProps, MobileDatePicker, type MobileDatePickerProps, MobileDateTimePicker, type MobileDateTimePickerProps, MobileTimePicker, type MobileTimePickerProps, Overline, type OverlineProps, PageSpinner, type PageSpinnerProps, Pagination, type PaginationColor, type PaginationProps, type PaginationShape, type PaginationVariant, Paragraph, type ParagraphProps, type ShadowTokens, type SpacingTokens, Spinner, type SpinnerProps, type SpinnerSize, StandaloneAccordion, StaticDatePicker, type StaticDatePickerProps, StaticDateTimePicker, type StaticDateTimePickerProps, StaticTimePicker, type StaticTimePickerProps, Subtitle1, type Subtitle1Props, Subtitle2, type Subtitle2Props, Table, TableBody, type TableBodyProps, TableCell, type TableCellProps, TableContainer, type TableContainerProps, TableHead, TableHeadCell, type TableHeadProps, TablePagination, type TableProps, TableRow, type TableRowProps, TableSortLabel, TextField, type TextFieldProps, type ThemeName, type ThemeTokens, TimeField, type TimeFieldProps, TimePicker, type TimePickerProps, Toggle, ToggleButton, ToggleButtonGroup, type ToggleButtonGroupProps, type ToggleButtonProps, type ToggleProps, ToolkitThemeProvider, type TransitionTokens, TypographyButton, type TypographyButtonProps, type TypographyTokens, Variant, type ZIndexTokens, createMuiTheme, getThemeTokens, resolveThemeName, themeRegistry };