@form-engine-ts/react 1.1.0 → 2.1.0

package/README.md

@@ -50,3 +50,38 @@ on the next mount:
 `FormProvider` resolves authoring-time translations synchronously whenever `locale` changes. `FormBuilder` includes page
 membership controls and localization editors; pass an `AsyncTranslationAdapter` as `translationAdapter` to enable its
 batch-translation action.
+
+## Headless builder and renderer lifecycle
+
+`useFormBuilder({ schema, onChange, policy, idFactory, factories })` exposes controlled field, option, page, condition,
+source-text, and localized-text actions. Core's `FormPolicy` enforces allowed field types, field/option limits, text and
+schema-byte limits, and required locales identically in browser and server code. Every mutation returns a typed
+`BuilderActionResult`; invalid, empty, or duplicate generated IDs leave the schema unchanged. `BuilderFactories` injects
+initial field, option, and page shapes. `<FormBuilder>` delegates its UI mutations to this hook and accepts the same
+options. Its completion-message editors cover both source and locale text. `translationOptions` and
+`onTranslationReport` expose automatic-translation policy and reporting.
+
+`FormRenderer` can also be used without an explicit provider:
+
+```tsx
+<FormRenderer
+  schema={schema}
+  locale="en"
+  beforeSubmit={async (values) => (await confirmValues(values) ? "continue" : "cancel")}
+  onSubmit={saveValues}
+  onDraftSave={saveDraft}
+  slots={{
+    renderHeader: ({ title }) => <MyHeader>{title}</MyHeader>,
+    renderPageHeader: ({ page }) => <MyPageHeader page={page} />,
+    renderField: (props) => <MyField {...props} />,
+    renderSubmitButton: ({ isSubmitting, onSubmit }) => (
+      <MyButton disabled={isSubmitting} onClick={onSubmit}>Save</MyButton>
+    ),
+    renderSubmitError: ({ error, onRetry }) => <MyError error={error} onRetry={onRetry} />
+  }}
+/>
+```
+
+Validation runs before `beforeSubmit`. A `"cancel"` result does not call `onSubmit` and preserves values and drafts.
+Header, page-header, field, navigation, submit, validation-summary, completion, and submit-error slots can replace the
+default UI. The localized `completionMessage` is displayed after a successful submission.