@form-engine-ts/react 2.9.6 → 3.1.0

package/README.md

@@ -29,7 +29,7 @@ export function ContactForm() {
       schema={schema}
       locale="en"
       translator={mockTranslator}
-      onSubmit={async (values) => console.log(values)}
+      onSubmit={async (values, context) => console.log(values, context.attemptId)}
     >
       <FormRenderer />
     </FormProvider>
@@ -95,7 +95,25 @@ translation lifecycle.
 When either is enabled, the builder omits its `form-engine-builder` and `feb-*` classes. Injected `TextInput`, `TextArea`,
 and `Select` components receive the field `label` and accessibility attributes and are responsible for rendering their
 own labels. Builder action icons can be supplied with `renderIcon`, which resolves `actionType` values such as
-`moveUp`, `moveDown`, `delete`, and `add`.
+`moveUp`, `moveDown`, `delete`, and `add`. `renderFieldTypeIcon` supplies icons for field-type selectors. Select
+options may be strings or `BuilderSelectOption` objects with `icon`, `description`, `kind`, and `metadata`; custom
+`renderOption` and `renderValue` functions can control their presentation. `BUILDER_TRANSLATION_KEYS` exposes the
+canonical typed builder translation keys while legacy catalog aliases remain supported.
+
+The `fieldEditor` slot can expose only the type selector or header through `fieldTypeSelect` and `fieldEditorHeader`:
+
+```tsx
+<FormBuilder
+  schema={schema}
+  onChange={setSchema}
+  slots={{
+    fieldTypeSelect: ({ currentType, onChangeType }) => (
+      <button type="button" onClick={() => onChangeType("textarea")}>{currentType}</button>
+    ),
+    fieldEditorHeader: ({ field }) => <h3>{field.title}</h3>
+  }}
+/>
+```
 
 ```tsx
 <FormBuilder
@@ -149,14 +167,15 @@ and `useSubmissionReceipts` loads multiple form/version receipts for list and da
 
 Receipt persistence is best-effort: `onReceiptError` observes storage failures while the successful completion screen is
 preserved. Pass an SSR-safe `createLocalStorageSubmissionAttemptStore()` as `attemptStore` to reserve an ID immediately
-before submission. Renderer injects it as `attemptId` and `submissionId`, retains it after a failed request, promotes it
-to the receipt after success, and then clears the attempt. Custom receipt stores may omit `getBatch`; the hook falls back
-to concurrent `get` calls.
-
-After success, completion rendering receives a snapshot of `answers`, `schema`, the optional response, and
-`submittedItems`. Each summary item includes the field title, raw value, formatted display value, visibility, and field
-metadata. Use `renderSubmittedValues` for a typed summary slot; hidden fields are omitted by default and can be included
-with `showHiddenFieldsInSummary`. Server validation can be returned by throwing `FormSubmissionError` with `fieldErrors`
-and `formError`; field messages are mapped back to the form and the first invalid control is focused. Use
-`submissionConfirmationRenderMode="replace"` or `"dialog"` for alternate confirmation presentations, and
-`fieldsClassName` or `renderFields` to control the fields wrapper.
+before submission. `onSubmit(answers, context)` keeps `attemptId`, `formId`, `formVersion`, `locale`, and `submittedAt`
+outside the answers object, retains the same attempt after a failed request, promotes it to the receipt after success,
+and then clears the attempt. Custom receipt stores may omit `getBatch`; the hook falls back to concurrent `get` calls.
+
+After success, completion rendering receives a typed `FormCompletionSlotProps` snapshot of `answers`, `schema`, the
+optional response, and `submittedItems`. Each summary item includes the field title, raw value, formatted display value,
+visibility, and field metadata. Use `renderSubmittedValues` for a typed summary slot; hidden fields are omitted by default
+and can be included with `showHiddenFieldsInSummary`. Supply `messages` or `messageResolver` to localize standard buttons,
+validation, retry, already-submitted, server-error, and sensitive-data confirmation UI. Server validation can be returned
+by throwing `FormSubmissionError` or a payload with `fieldErrors` and `formError`; field messages are mapped back to the
+form, scrolled into view, and focused. Use `submissionConfirmationRenderMode="replace"` or `"dialog"` for alternate
+confirmation presentations, and `fieldsClassName` or `renderFields` to control the fields wrapper.