@form-engine-ts/mui 2.9.6 → 3.1.0

package/README.md

@@ -25,13 +25,24 @@ import { MuiFormBuilder } from "@form-engine-ts/mui";
     sectionOrder: ["basicSettings", "completionMessage", "questions", "addQuestion", "localization"]
   }}
   localizationOptions={{
+    availableLocales: [
+      { value: "ja", label: "日本語" },
+      { value: "en", label: "English" }
+    ],
+    placement: "afterQuestions",
     collapsible: true,
     defaultExpanded: "when-configured",
     showSummary: true,
     emptyStateMessage: "No translation locales have been added yet.",
     defaultLocaleControl: "readOnly"
   }}
-  muiSlotProps={{ card: { sx: { p: 2 } }, accordion: { elevation: 0 } }}
+  muiSlotProps={{
+    card: { sx: { p: 2 } },
+    accordion: { elevation: 0 },
+    textField: { "data-testid": "builder-input" },
+    select: { variant: "filled" },
+    selectMenu: { PaperProps: { elevation: 4 } }
+  }}
 />;
 ```
 
@@ -56,12 +67,21 @@ slots as it does for the standard builder.
 width options. `fieldEditorOptions.description` and `localizationOptions.defaultLocaleControl` independently make those
 controls editable, read-only, or hidden. Set `dense` to reduce section, editor, option, and toolbar spacing.
 `buttonVariants` can override the MUI variant for `primary`, `secondary`, and `danger` actions independently.
-`localizationOptions.showSummary` adds a locale summary badge to the localization heading, and
-`localizationOptions.emptyStateMessage` customizes the guidance shown before a translation locale is added. The
-`defaultExpanded` option also accepts `"always"`.
+`localizationOptions.availableLocales` supplies display-ready locale candidates independently from the policy; when
+both are present, only candidates allowed by `allowedLocales` are shown. `placement` supports `top`,
+`beforeQuestions`, `afterQuestions`, and `bottom` section presets. `showSummary` renders a status alert, while
+`renderSummary` can provide a custom summary. `emptyStateMessage` customizes the guidance shown before a translation
+locale is added. `defaultExpanded` also accepts `"always"`; `autoFocusNewTab` focuses a newly added locale tab by
+default.
 `layoutOptions`, `localizationOptions`, and `muiSlotProps` are also accepted in `muiOptions` for low-level factories such
 as `createMuiBuilderSlots`; the dedicated `MuiFormBuilder` props take precedence.
 
+Select options in the MUI adapter support icons, descriptions, custom metadata, and custom `renderOption`/`renderValue`
+callbacks. Without a custom renderer, icons appear beside labels in the menu and in the selected value. The standard
+MUI field editor supplies icons for every field type and accepts `slots.fieldTypeSelect` and `slots.fieldEditorHeader`
+for focused customization. `muiSlotProps` also supports `textField`, `select`, `selectMenu`, `checkbox`, `button`, and
+`iconButton` MUI props in addition to the layout props.
+
 `MuiFormBuilder` supplies options through `MuiFormBuilderContext` to module-stable adapter and slot component types.
 Controlled schema updates therefore preserve input focus and uncontrolled MUI state such as an open localization
 accordion even when the parent passes inline option objects.