@form-engine-ts/react 4.7.0 → 5.0.0

package/README.md

@@ -80,11 +80,24 @@ single-slot or batch translation with stale/manual status handling. The MUI pack
 schema-driven pre-submit confirmation controls in the builder.
 
 `useTranslationWorkspace` validates added locales against `policy.allowedLocales` and `policy.maxLocales` and returns
-a structured `{ success, error }` result from `addLocale`. Built-in BCP 47, duplicate, and policy checks always run
-before the optional `validateLocale` callback, which receives the locale, default locale, current locales, and policy.
+a structured `{ success, error }` result from `addLocale`, `translateAll`, and `translateSlot`. Errors use the exported
+`TranslationWorkspaceError` discriminated union. Built-in BCP 47, duplicate, and policy checks always run
+before the optional `validateLocale` callback, which receives the canonical locale and a plain context object containing
+the canonical default locale, current locales, and policy.
+Locale input is normalized to its canonical BCP 47 form before duplicate, policy, custom-validation, and schema updates;
+underscore-separated values such as `EN_us` are accepted as compatibility input.
 Use `isAddLocaleAllowed` to disable locale controls before submission. Removing a locale also clears its
 localized values and metadata; the default locale remains protected.
 
+Wrap a builder or renderer in `FormEngineI18nProvider` to supply a UI locale and typed Core translator independently
+from the schema's `defaultLocale` and `supportedLocales`:
+
+```tsx
+<FormEngineI18nProvider locale="ja">
+  <MuiFormBuilder schema={schema} onChange={setSchema} />
+</FormEngineI18nProvider>
+```
+
 ## Headless builder and renderer lifecycle
 
 `useFormBuilder({ schema, onChange, policy, idFactory, factories })` exposes controlled field, option, page, condition,