@form-engine-ts/mui 2.9.6 → 3.1.0

package/dist/index.d.cts

@@ -1,28 +1,59 @@
-import { BuilderActionIconType, BuilderButtonProps, BuilderCheckboxProps, BuilderErrorMessageProps, BuilderFieldsetProps, BuilderIconButtonProps, BuilderSectionProps, BuilderSelectProps, BuilderTextAreaProps, BuilderTextInputProps, FormBuilderComponents, FormBuilderSlots, FormBuilderProps, BuilderFieldEditorSlotProps, BuilderLocalizationSlotProps, BuilderOptionEditorSlotProps, BuilderToolbarSlotProps } from '@form-engine-ts/react';
+import { BuilderActionIconType, LocalizationSummaryContext, BuilderButtonProps, BuilderCheckboxProps, BuilderErrorMessageProps, BuilderFieldsetProps, BuilderIconButtonProps, BuilderSectionProps, BuilderSelectProps, BuilderTextAreaProps, BuilderTextInputProps, FormBuilderComponents, FormBuilderSlots, FormBuilderProps, QuestionType, BuilderFieldEditorSlotProps, BuilderLocalizationSlotProps, BuilderOptionEditorSlotProps, BuilderToolbarSlotProps } from '@form-engine-ts/react';
 import * as react from 'react';
-import { ComponentType, ReactNode } from 'react';
-import { CardProps, PaperProps, StackProps, AccordionProps } from '@mui/material';
+import { ReactNode, ComponentType } from 'react';
+import { CardProps, PaperProps, AccordionProps, StackProps, TextFieldProps, SelectProps, MenuProps, CheckboxProps, ButtonProps, IconButtonProps } from '@mui/material';
 
 type BuilderSectionName = "basicSettings" | "completionMessage" | "questions" | "addQuestion" | "localization";
 type MuiButtonVariant = "contained" | "outlined" | "text";
+type MuiComponentSlotProps<T> = Partial<T> & {
+    readonly [key: `data-${string}`]: string | number | boolean | undefined;
+};
+interface LocaleOptionItem {
+    readonly value: string;
+    readonly label: string;
+}
+type LocalizationSectionPlacement = "top" | "beforeQuestions" | "afterQuestions" | "bottom";
 interface MuiLayoutOptions {
     readonly sectionOrder?: readonly BuilderSectionName[];
 }
 interface MuiLocalizationOptions {
+    readonly availableLocales?: readonly (LocaleOptionItem | string)[];
+    readonly placement?: LocalizationSectionPlacement;
     readonly collapsible?: boolean;
     readonly defaultExpanded?: boolean | "when-configured" | "always";
     readonly showSummary?: boolean;
+    readonly renderSummary?: (context: LocalizationSummaryContext) => ReactNode;
     readonly emptyStateMessage?: string;
     readonly defaultLocaleControl?: "editable" | "readOnly" | "hidden";
+    readonly noWrapActions?: boolean;
+    readonly autoFocusNewTab?: boolean;
 }
 interface MuiFieldEditorOptions {
     readonly description?: "editable" | "readOnly" | "hidden";
 }
-interface MuiBuilderSlotProps {
+interface MuiSlotProps {
     readonly card?: Partial<CardProps>;
     readonly paper?: Partial<PaperProps>;
+    readonly accordion?: Partial<AccordionProps>;
     readonly stack?: Partial<StackProps>;
+    readonly textField?: MuiComponentSlotProps<TextFieldProps>;
+    readonly select?: MuiComponentSlotProps<SelectProps>;
+    readonly selectMenu?: Partial<MenuProps>;
+    readonly checkbox?: MuiComponentSlotProps<CheckboxProps>;
+    readonly button?: MuiComponentSlotProps<ButtonProps>;
+    readonly iconButton?: MuiComponentSlotProps<IconButtonProps>;
+}
+interface MuiBuilderSlotProps {
+    readonly card?: Partial<CardProps>;
+    readonly paper?: Partial<PaperProps>;
     readonly accordion?: Partial<AccordionProps>;
+    readonly stack?: Partial<StackProps>;
+    readonly textField?: MuiComponentSlotProps<TextFieldProps>;
+    readonly select?: MuiComponentSlotProps<SelectProps>;
+    readonly selectMenu?: Partial<MenuProps>;
+    readonly checkbox?: MuiComponentSlotProps<CheckboxProps>;
+    readonly button?: MuiComponentSlotProps<ButtonProps>;
+    readonly iconButton?: MuiComponentSlotProps<IconButtonProps>;
 }
 interface MuiAdapterOptions {
     readonly size?: "small" | "medium";
@@ -65,6 +96,7 @@ interface ResolvedMuiAdapterOptions {
     readonly muiSlotProps?: MuiBuilderSlotProps;
 }
 declare const DEFAULT_MUI_SECTION_ORDER: readonly BuilderSectionName[];
+declare const MUI_LOCALIZATION_SECTION_ORDERS: Readonly<Record<LocalizationSectionPlacement, readonly BuilderSectionName[]>>;
 declare function resolveMuiAdapterOptions(options?: MuiAdapterOptions): ResolvedMuiAdapterOptions;
 
 declare function createMuiButtonAdapter(options?: MuiAdapterOptions): ComponentType<BuilderButtonProps>;
@@ -112,6 +144,7 @@ declare function mergeMuiAdapterOptions(base?: MuiAdapterOptions, overrides?: Mu
 declare function useResolvedMuiAdapterOptions(overrides?: MuiAdapterOptions): ResolvedMuiAdapterOptions;
 
 declare function muiDefaultIconResolver(actionType: BuilderActionIconType): ReactNode;
+declare function muiDefaultFieldTypeIcon(type: QuestionType): ReactNode;
 
 interface MuiFormBuilderProps extends Omit<FormBuilderProps, "components" | "disableDefaultStyles" | "slots" | "unstyled"> {
     readonly muiOptions?: MuiAdapterOptions;
@@ -138,4 +171,4 @@ declare const MuiToolbarSlot: NonNullable<FormBuilderSlots["toolbar"]>;
 declare const muiBuilderSlots: FormBuilderSlots;
 declare function createMuiBuilderSlots(options?: MuiAdapterOptions, customOverrides?: Partial<FormBuilderSlots>): FormBuilderSlots;
 
-export { type BuilderSectionName, DEFAULT_MUI_SECTION_ORDER, type MuiAdapterOptions, type MuiBuilderOverrides, type MuiBuilderSlotProps, MuiButtonAdapter, type MuiButtonVariant, MuiCheckboxAdapter, MuiErrorMessageAdapter, type MuiFieldEditorOptions, MuiFieldEditorSlot, MuiFieldsetAdapter, MuiFormBuilder, MuiFormBuilderContext, type MuiFormBuilderContextValue, type MuiFormBuilderProps, MuiIconButtonAdapter, type MuiLayoutOptions, type MuiLocalizationOptions, MuiLocalizationSlot, MuiOptionEditorSlot, MuiSectionAdapter, MuiSelectAdapter, MuiTextAreaAdapter, MuiTextInputAdapter, MuiToolbarSlot, type ResolvedMuiAdapterOptions, createMuiBuilderComponents, createMuiBuilderProps, createMuiBuilderSlots, createMuiButtonAdapter, createMuiCheckboxAdapter, createMuiErrorMessageAdapter, createMuiFieldEditorSlot, createMuiFieldsetAdapter, createMuiIconButtonAdapter, createMuiLocalizationSlot, createMuiOptionEditorSlot, createMuiSectionAdapter, createMuiSelectAdapter, createMuiTextAreaAdapter, createMuiTextInputAdapter, createMuiToolbarSlot, mergeMuiAdapterOptions, muiBuilderComponents, muiBuilderSlots, muiDefaultIconResolver, resolveMuiAdapterOptions, useResolvedMuiAdapterOptions };
+export { type BuilderSectionName, DEFAULT_MUI_SECTION_ORDER, type LocaleOptionItem, type LocalizationSectionPlacement, MUI_LOCALIZATION_SECTION_ORDERS, type MuiAdapterOptions, type MuiBuilderOverrides, type MuiBuilderSlotProps, MuiButtonAdapter, type MuiButtonVariant, MuiCheckboxAdapter, MuiErrorMessageAdapter, type MuiFieldEditorOptions, MuiFieldEditorSlot, MuiFieldsetAdapter, MuiFormBuilder, MuiFormBuilderContext, type MuiFormBuilderContextValue, type MuiFormBuilderProps, MuiIconButtonAdapter, type MuiLayoutOptions, type MuiLocalizationOptions, MuiLocalizationSlot, MuiOptionEditorSlot, MuiSectionAdapter, MuiSelectAdapter, type MuiSlotProps, MuiTextAreaAdapter, MuiTextInputAdapter, MuiToolbarSlot, type ResolvedMuiAdapterOptions, createMuiBuilderComponents, createMuiBuilderProps, createMuiBuilderSlots, createMuiButtonAdapter, createMuiCheckboxAdapter, createMuiErrorMessageAdapter, createMuiFieldEditorSlot, createMuiFieldsetAdapter, createMuiIconButtonAdapter, createMuiLocalizationSlot, createMuiOptionEditorSlot, createMuiSectionAdapter, createMuiSelectAdapter, createMuiTextAreaAdapter, createMuiTextInputAdapter, createMuiToolbarSlot, mergeMuiAdapterOptions, muiBuilderComponents, muiBuilderSlots, muiDefaultFieldTypeIcon, muiDefaultIconResolver, resolveMuiAdapterOptions, useResolvedMuiAdapterOptions };

package/dist/index.d.ts

@@ -1,28 +1,59 @@
-import { BuilderActionIconType, BuilderButtonProps, BuilderCheckboxProps, BuilderErrorMessageProps, BuilderFieldsetProps, BuilderIconButtonProps, BuilderSectionProps, BuilderSelectProps, BuilderTextAreaProps, BuilderTextInputProps, FormBuilderComponents, FormBuilderSlots, FormBuilderProps, BuilderFieldEditorSlotProps, BuilderLocalizationSlotProps, BuilderOptionEditorSlotProps, BuilderToolbarSlotProps } from '@form-engine-ts/react';
+import { BuilderActionIconType, LocalizationSummaryContext, BuilderButtonProps, BuilderCheckboxProps, BuilderErrorMessageProps, BuilderFieldsetProps, BuilderIconButtonProps, BuilderSectionProps, BuilderSelectProps, BuilderTextAreaProps, BuilderTextInputProps, FormBuilderComponents, FormBuilderSlots, FormBuilderProps, QuestionType, BuilderFieldEditorSlotProps, BuilderLocalizationSlotProps, BuilderOptionEditorSlotProps, BuilderToolbarSlotProps } from '@form-engine-ts/react';
 import * as react from 'react';
-import { ComponentType, ReactNode } from 'react';
-import { CardProps, PaperProps, StackProps, AccordionProps } from '@mui/material';
+import { ReactNode, ComponentType } from 'react';
+import { CardProps, PaperProps, AccordionProps, StackProps, TextFieldProps, SelectProps, MenuProps, CheckboxProps, ButtonProps, IconButtonProps } from '@mui/material';
 
 type BuilderSectionName = "basicSettings" | "completionMessage" | "questions" | "addQuestion" | "localization";
 type MuiButtonVariant = "contained" | "outlined" | "text";
+type MuiComponentSlotProps<T> = Partial<T> & {
+    readonly [key: `data-${string}`]: string | number | boolean | undefined;
+};
+interface LocaleOptionItem {
+    readonly value: string;
+    readonly label: string;
+}
+type LocalizationSectionPlacement = "top" | "beforeQuestions" | "afterQuestions" | "bottom";
 interface MuiLayoutOptions {
     readonly sectionOrder?: readonly BuilderSectionName[];
 }
 interface MuiLocalizationOptions {
+    readonly availableLocales?: readonly (LocaleOptionItem | string)[];
+    readonly placement?: LocalizationSectionPlacement;
     readonly collapsible?: boolean;
     readonly defaultExpanded?: boolean | "when-configured" | "always";
     readonly showSummary?: boolean;
+    readonly renderSummary?: (context: LocalizationSummaryContext) => ReactNode;
     readonly emptyStateMessage?: string;
     readonly defaultLocaleControl?: "editable" | "readOnly" | "hidden";
+    readonly noWrapActions?: boolean;
+    readonly autoFocusNewTab?: boolean;
 }
 interface MuiFieldEditorOptions {
     readonly description?: "editable" | "readOnly" | "hidden";
 }
-interface MuiBuilderSlotProps {
+interface MuiSlotProps {
     readonly card?: Partial<CardProps>;
     readonly paper?: Partial<PaperProps>;
+    readonly accordion?: Partial<AccordionProps>;
     readonly stack?: Partial<StackProps>;
+    readonly textField?: MuiComponentSlotProps<TextFieldProps>;
+    readonly select?: MuiComponentSlotProps<SelectProps>;
+    readonly selectMenu?: Partial<MenuProps>;
+    readonly checkbox?: MuiComponentSlotProps<CheckboxProps>;
+    readonly button?: MuiComponentSlotProps<ButtonProps>;
+    readonly iconButton?: MuiComponentSlotProps<IconButtonProps>;
+}
+interface MuiBuilderSlotProps {
+    readonly card?: Partial<CardProps>;
+    readonly paper?: Partial<PaperProps>;
     readonly accordion?: Partial<AccordionProps>;
+    readonly stack?: Partial<StackProps>;
+    readonly textField?: MuiComponentSlotProps<TextFieldProps>;
+    readonly select?: MuiComponentSlotProps<SelectProps>;
+    readonly selectMenu?: Partial<MenuProps>;
+    readonly checkbox?: MuiComponentSlotProps<CheckboxProps>;
+    readonly button?: MuiComponentSlotProps<ButtonProps>;
+    readonly iconButton?: MuiComponentSlotProps<IconButtonProps>;
 }
 interface MuiAdapterOptions {
     readonly size?: "small" | "medium";
@@ -65,6 +96,7 @@ interface ResolvedMuiAdapterOptions {
     readonly muiSlotProps?: MuiBuilderSlotProps;
 }
 declare const DEFAULT_MUI_SECTION_ORDER: readonly BuilderSectionName[];
+declare const MUI_LOCALIZATION_SECTION_ORDERS: Readonly<Record<LocalizationSectionPlacement, readonly BuilderSectionName[]>>;
 declare function resolveMuiAdapterOptions(options?: MuiAdapterOptions): ResolvedMuiAdapterOptions;
 
 declare function createMuiButtonAdapter(options?: MuiAdapterOptions): ComponentType<BuilderButtonProps>;
@@ -112,6 +144,7 @@ declare function mergeMuiAdapterOptions(base?: MuiAdapterOptions, overrides?: Mu
 declare function useResolvedMuiAdapterOptions(overrides?: MuiAdapterOptions): ResolvedMuiAdapterOptions;
 
 declare function muiDefaultIconResolver(actionType: BuilderActionIconType): ReactNode;
+declare function muiDefaultFieldTypeIcon(type: QuestionType): ReactNode;
 
 interface MuiFormBuilderProps extends Omit<FormBuilderProps, "components" | "disableDefaultStyles" | "slots" | "unstyled"> {
     readonly muiOptions?: MuiAdapterOptions;
@@ -138,4 +171,4 @@ declare const MuiToolbarSlot: NonNullable<FormBuilderSlots["toolbar"]>;
 declare const muiBuilderSlots: FormBuilderSlots;
 declare function createMuiBuilderSlots(options?: MuiAdapterOptions, customOverrides?: Partial<FormBuilderSlots>): FormBuilderSlots;
 
-export { type BuilderSectionName, DEFAULT_MUI_SECTION_ORDER, type MuiAdapterOptions, type MuiBuilderOverrides, type MuiBuilderSlotProps, MuiButtonAdapter, type MuiButtonVariant, MuiCheckboxAdapter, MuiErrorMessageAdapter, type MuiFieldEditorOptions, MuiFieldEditorSlot, MuiFieldsetAdapter, MuiFormBuilder, MuiFormBuilderContext, type MuiFormBuilderContextValue, type MuiFormBuilderProps, MuiIconButtonAdapter, type MuiLayoutOptions, type MuiLocalizationOptions, MuiLocalizationSlot, MuiOptionEditorSlot, MuiSectionAdapter, MuiSelectAdapter, MuiTextAreaAdapter, MuiTextInputAdapter, MuiToolbarSlot, type ResolvedMuiAdapterOptions, createMuiBuilderComponents, createMuiBuilderProps, createMuiBuilderSlots, createMuiButtonAdapter, createMuiCheckboxAdapter, createMuiErrorMessageAdapter, createMuiFieldEditorSlot, createMuiFieldsetAdapter, createMuiIconButtonAdapter, createMuiLocalizationSlot, createMuiOptionEditorSlot, createMuiSectionAdapter, createMuiSelectAdapter, createMuiTextAreaAdapter, createMuiTextInputAdapter, createMuiToolbarSlot, mergeMuiAdapterOptions, muiBuilderComponents, muiBuilderSlots, muiDefaultIconResolver, resolveMuiAdapterOptions, useResolvedMuiAdapterOptions };
+export { type BuilderSectionName, DEFAULT_MUI_SECTION_ORDER, type LocaleOptionItem, type LocalizationSectionPlacement, MUI_LOCALIZATION_SECTION_ORDERS, type MuiAdapterOptions, type MuiBuilderOverrides, type MuiBuilderSlotProps, MuiButtonAdapter, type MuiButtonVariant, MuiCheckboxAdapter, MuiErrorMessageAdapter, type MuiFieldEditorOptions, MuiFieldEditorSlot, MuiFieldsetAdapter, MuiFormBuilder, MuiFormBuilderContext, type MuiFormBuilderContextValue, type MuiFormBuilderProps, MuiIconButtonAdapter, type MuiLayoutOptions, type MuiLocalizationOptions, MuiLocalizationSlot, MuiOptionEditorSlot, MuiSectionAdapter, MuiSelectAdapter, type MuiSlotProps, MuiTextAreaAdapter, MuiTextInputAdapter, MuiToolbarSlot, type ResolvedMuiAdapterOptions, createMuiBuilderComponents, createMuiBuilderProps, createMuiBuilderSlots, createMuiButtonAdapter, createMuiCheckboxAdapter, createMuiErrorMessageAdapter, createMuiFieldEditorSlot, createMuiFieldsetAdapter, createMuiIconButtonAdapter, createMuiLocalizationSlot, createMuiOptionEditorSlot, createMuiSectionAdapter, createMuiSelectAdapter, createMuiTextAreaAdapter, createMuiTextInputAdapter, createMuiToolbarSlot, mergeMuiAdapterOptions, muiBuilderComponents, muiBuilderSlots, muiDefaultFieldTypeIcon, muiDefaultIconResolver, resolveMuiAdapterOptions, useResolvedMuiAdapterOptions };