@octoguide/mui-ui-toolkit 0.6.0 → 0.7.1

package/dist/index.d.mts

@@ -2,7 +2,7 @@ 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 { 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';
+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, SvgIconProps, 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';
@@ -358,6 +358,11 @@ interface ToolkitThemeProviderProps {
      * Defaults to true.
      */
     injectCssBaseline?: boolean;
+    /**
+     * Enable dark mode. When true, palette.mode is set to 'dark' and
+     * component overrides adapt accordingly.
+     */
+    darkMode?: boolean;
 }
 /**
  * Drop-in ThemeProvider for any app using the mui-ui-toolkit.
@@ -380,7 +385,7 @@ interface ToolkitThemeProviderProps {
  *     <App />
  *   </ToolkitThemeProvider>
  */
-declare function ToolkitThemeProvider({ theme, children, injectCssBaseline, }: ToolkitThemeProviderProps): react_jsx_runtime.JSX.Element;
+declare function ToolkitThemeProvider({ theme, children, injectCssBaseline, darkMode, }: ToolkitThemeProviderProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Takes a ThemeTokens object and produces a fully configured MUI Theme.
@@ -393,7 +398,7 @@ declare function ToolkitThemeProvider({ theme, children, injectCssBaseline, }: T
  * augmentation in types/mui.d.ts) so components can read any token
  * not already exposed by MUI's built-in theme shape.
  */
-declare function createMuiTheme(tokens: ThemeTokens): Theme;
+declare function createMuiTheme(tokens: ThemeTokens, darkMode?: boolean): Theme;
 
 /**
  * Resolves the active theme name from the environment.
@@ -729,6 +734,24 @@ declare namespace Grid {
     var displayName: string;
 }
 
+interface IconTextSymbol {
+    content?: string;
+    id?: string;
+    viewBox?: string;
+    isMounted?: boolean;
+}
+interface IconTextProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** SVG symbol object (e.g. from @online/symbols or an inline SVG descriptor) */
+    symbol: IconTextSymbol;
+    /** Props forwarded to the MUI SvgIcon wrapper */
+    symbolProps?: Omit<SvgIconProps, 'children'>;
+    /** Render the icon before or after children */
+    symbolPosition?: 'front' | 'end';
+    /** Inherit font-family and line-height from the parent (useful inside buttons, links) */
+    inheritFontFamily?: boolean;
+}
+declare const IconText: React.ForwardRefExoticComponent<IconTextProps & React.RefAttributes<HTMLDivElement>>;
+
 interface InternalLinkItemProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> {
     /** URL for the anchor href */
     link?: string;
@@ -845,6 +868,7 @@ declare const Password: React.ForwardRefExoticComponent<PasswordProps & React.Re
 interface PasswordCriteriaProps {
     show?: boolean;
     value?: string;
+    id?: string;
 }
 declare const PasswordRules: {
     key: string;
@@ -852,7 +876,7 @@ declare const PasswordRules: {
 }[];
 declare const passwordValidator: (value: string) => Record<string, boolean>;
 declare const PasswordCriteria: {
-    ({ show, value }: PasswordCriteriaProps): react_jsx_runtime.JSX.Element;
+    ({ show, value, id }: PasswordCriteriaProps): react_jsx_runtime.JSX.Element;
     displayName: string;
 };
 
@@ -992,4 +1016,4 @@ interface TypographyButtonProps extends Omit<TypographyProps, 'variant'> {
 }
 declare const TypographyButton: React.ForwardRefExoticComponent<Omit<TypographyButtonProps, "ref"> & React.RefAttributes<HTMLElement>>;
 
-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, Password, PasswordCriteria, type PasswordCriteriaProps, type PasswordProps, PasswordRule, type PasswordRuleProps, PasswordRules, 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, passwordValidator, 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, IconText, type IconTextProps, type IconTextSymbol, 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, Password, PasswordCriteria, type PasswordCriteriaProps, type PasswordProps, PasswordRule, type PasswordRuleProps, PasswordRules, 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, passwordValidator, resolveThemeName, themeRegistry };

package/dist/index.d.ts

@@ -2,7 +2,7 @@ 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 { 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';
+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, SvgIconProps, 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';
@@ -358,6 +358,11 @@ interface ToolkitThemeProviderProps {
      * Defaults to true.
      */
     injectCssBaseline?: boolean;
+    /**
+     * Enable dark mode. When true, palette.mode is set to 'dark' and
+     * component overrides adapt accordingly.
+     */
+    darkMode?: boolean;
 }
 /**
  * Drop-in ThemeProvider for any app using the mui-ui-toolkit.
@@ -380,7 +385,7 @@ interface ToolkitThemeProviderProps {
  *     <App />
  *   </ToolkitThemeProvider>
  */
-declare function ToolkitThemeProvider({ theme, children, injectCssBaseline, }: ToolkitThemeProviderProps): react_jsx_runtime.JSX.Element;
+declare function ToolkitThemeProvider({ theme, children, injectCssBaseline, darkMode, }: ToolkitThemeProviderProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Takes a ThemeTokens object and produces a fully configured MUI Theme.
@@ -393,7 +398,7 @@ declare function ToolkitThemeProvider({ theme, children, injectCssBaseline, }: T
  * augmentation in types/mui.d.ts) so components can read any token
  * not already exposed by MUI's built-in theme shape.
  */
-declare function createMuiTheme(tokens: ThemeTokens): Theme;
+declare function createMuiTheme(tokens: ThemeTokens, darkMode?: boolean): Theme;
 
 /**
  * Resolves the active theme name from the environment.
@@ -729,6 +734,24 @@ declare namespace Grid {
     var displayName: string;
 }
 
+interface IconTextSymbol {
+    content?: string;
+    id?: string;
+    viewBox?: string;
+    isMounted?: boolean;
+}
+interface IconTextProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** SVG symbol object (e.g. from @online/symbols or an inline SVG descriptor) */
+    symbol: IconTextSymbol;
+    /** Props forwarded to the MUI SvgIcon wrapper */
+    symbolProps?: Omit<SvgIconProps, 'children'>;
+    /** Render the icon before or after children */
+    symbolPosition?: 'front' | 'end';
+    /** Inherit font-family and line-height from the parent (useful inside buttons, links) */
+    inheritFontFamily?: boolean;
+}
+declare const IconText: React.ForwardRefExoticComponent<IconTextProps & React.RefAttributes<HTMLDivElement>>;
+
 interface InternalLinkItemProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> {
     /** URL for the anchor href */
     link?: string;
@@ -845,6 +868,7 @@ declare const Password: React.ForwardRefExoticComponent<PasswordProps & React.Re
 interface PasswordCriteriaProps {
     show?: boolean;
     value?: string;
+    id?: string;
 }
 declare const PasswordRules: {
     key: string;
@@ -852,7 +876,7 @@ declare const PasswordRules: {
 }[];
 declare const passwordValidator: (value: string) => Record<string, boolean>;
 declare const PasswordCriteria: {
-    ({ show, value }: PasswordCriteriaProps): react_jsx_runtime.JSX.Element;
+    ({ show, value, id }: PasswordCriteriaProps): react_jsx_runtime.JSX.Element;
     displayName: string;
 };
 
@@ -992,4 +1016,4 @@ interface TypographyButtonProps extends Omit<TypographyProps, 'variant'> {
 }
 declare const TypographyButton: React.ForwardRefExoticComponent<Omit<TypographyButtonProps, "ref"> & React.RefAttributes<HTMLElement>>;
 
-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, Password, PasswordCriteria, type PasswordCriteriaProps, type PasswordProps, PasswordRule, type PasswordRuleProps, PasswordRules, 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, passwordValidator, 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, IconText, type IconTextProps, type IconTextSymbol, 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, Password, PasswordCriteria, type PasswordCriteriaProps, type PasswordProps, PasswordRule, type PasswordRuleProps, PasswordRules, 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, passwordValidator, resolveThemeName, themeRegistry };