@tesouro/embedded-components-react 0.3.42 → 0.3.44

package/README.md

@@ -51,7 +51,7 @@ boundary.
 
 | Import path                                       | What you get                                                                         |
 | ------------------------------------------------- | ------------------------------------------------------------------------------------ |
-| `@tesouro/embedded-components-react`              | All widgets plus `RootWidgetProvider` / `WidgetProvider`.                            |
+| `@tesouro/embedded-components-react`              | All widgets, `WidgetSuite`, plus `RootWidgetProvider` / `WidgetProvider`.            |
 | `@tesouro/embedded-components-react/styles.css`   | The widget stylesheet — see [About the stylesheet](#about-the-stylesheet).           |
 | `@tesouro/embedded-components-react/core`         | Framework-agnostic token utilities (`createWidgetTokenManager`).                     |
 | `@tesouro/embedded-components-react/monite-sdk`   | Monite SDK surface for Monite-backed widgets.                                        |
@@ -61,7 +61,8 @@ boundary.
 
 `@tesouro/embedded-components-react/experimental` (and the per-module
 `@tesouro/embedded-components-react/experimental/<Module>`) is a staging area for
-work in progress. It is **outside this package's semver contract**:
+work in progress. It is **currently empty** — nothing ships on it today — and it
+is **outside this package's semver contract**:
 
 - Anything exported there can change shape or be **removed outright in any
   release, including a patch**. There is no deprecation window.
@@ -190,6 +191,21 @@ Every widget below also accepts the shared auth/scope props from
 from a parent provider or take it directly. Only each widget’s own props are
 listed here.
 
+### WidgetSuite
+
+A whole banking page in one component: a section menu over the widgets behind it, served by a single widget-init call. Unlike a widget — a content area you drop onto a page you own — a suite owns the page it is placed on, exists once per page, and decides which widgets appear on it.
+
+#### Props
+
+| Prop               | Type                              | Default                         | Description                                                                                                                                                                                                                                |
+| ------------------ | --------------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `sections`         | `readonly WidgetSuiteSectionId[]` | `WIDGET_SUITE_DEFAULT_SECTIONS` | Which sections the suite offers, in menu order. A listed section is still hidden when the token does not earn it.                                                                                                                          |
+| `section`          | `WidgetSuiteSectionId`            | —                               | Which section is showing. Supplying it puts the menu in controlled mode for the lifetime of the mount, so pair it with `onSectionChange`.                                                                                                  |
+| `defaultSection`   | `WidgetSuiteSectionId`            | first of `sections`             | Which section the suite opens on. Read once per mount, and ignored when `section` is supplied.                                                                                                                                             |
+| `onSectionChange`  | `(section) => void`               | `undefined`                     | Called when a person moves the suite. Never fired on mount, and never for the entitlement fallback, so a URL mirroring it cannot erase a deep link.                                                                                        |
+| `labels`           | `WidgetSuiteLabelOverrides`       | `WIDGET_SUITE_LABELS_EN`        | Every string on the page, in one tree: a group for the shell, the menu names, the section heading, the disclosure states, and one per section carrying that section's widget copy. Override any leaf and its siblings keep their defaults. |
+| `showSectionTitle` | `boolean`                         | `true`                          | Shows a heading above each section, named as its menu item is. Set `false` when your page already heads the suite.                                                                                                                         |
+
 ### AcceptDisclosuresWidget
 
 A self-contained widget for reviewing and accepting required banking disclosures. Fetches the caller's disclosure document set (title/url pairs, in presentation order) from `GET /identity/v1/disclosures` and renders an inline bordered card with those links, an agreement checkbox, and an Accept action. The host supplies no document URLs — the document set, its titles, and its order are entirely backend configuration for the bank partner's program. The provider attribution and agreement copy come from the widget init tenant identity.