@wix/patterns 1.467.0 → 1.469.0

package/dist/docs/CollectionPage.Header.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description
@@ -20,19 +22,19 @@ import { CollectionPage } from '@wix/patterns/page';
 
 Rendering a header with title, subtitle, total, primary action, and more actions. To learn how to create a more actions menu, see [`MoreActions`](./?path=/story/features-actions-more-actions--more-actions).
 
-Example code: read `dist/docs/CollectionPage.Header/full.tsx`
+Example code: read `dist/examples/CollectionPage.Header/full.tsx`
 
 ### Without Total
 
 Hiding the total number of entities in the header of a collection page, with `hideTotal` config.
 
-Example code: read `dist/docs/CollectionPage.Header/without-total.tsx`
+Example code: read `dist/examples/CollectionPage.Header/without-total.tsx`
 
 ### With Badges
 
 Rendering one or more [`Badge`](https://www.docs.wixdesignsystem.com/?path=/story/components-indicators--badge) badges at the end of the title row, after the total, with `badges`. Set the skin and text of each; their size is always `small`. Badges are not rendered while the header is collapsed into its minimized state.
 
-Example code: read `dist/docs/CollectionPage.Header/with-badges.tsx`
+Example code: read `dist/examples/CollectionPage.Header/with-badges.tsx`
 
 ## API
 

package/dist/docs/CollectionPage.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description

package/dist/docs/CollectionPremiumEmptyState.md

@@ -4,6 +4,10 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-contacts-v4-contact/types`, `@wix/yoshi-flow-bm`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Design
 
 ### Description

package/dist/docs/CollectionSearch.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description
@@ -59,25 +61,25 @@ import { CollectionSearch } from '@wix/patterns';
 
 The search input will bw shown be default
 
-Example code: read `dist/docs/CollectionSearch/default.tsx`
+Example code: read `dist/examples/CollectionSearch/default.tsx`
 
 ### Max length
 
 An option to limit the amout of characaters
 
-Example code: read `dist/docs/CollectionSearch/max-length.tsx`
+Example code: read `dist/examples/CollectionSearch/max-length.tsx`
 
 ### Placeholder
 
 An option to define the placeholder text.
 
-Example code: read `dist/docs/CollectionSearch/placeholder.tsx`
+Example code: read `dist/examples/CollectionSearch/placeholder.tsx`
 
 ### Search highlighting
 
 Gets highlighted search results in the table. Learn how to [enable it](./?path=/story/features-display--highlighted-search-results).
 
-Example code: read `dist/docs/CollectionSearch/search-highlighting.tsx`
+Example code: read `dist/examples/CollectionSearch/search-highlighting.tsx`
 
 ## API
 

package/dist/docs/Component Tests.md

@@ -2,6 +2,10 @@
 
 **Category:** Guides/Component Tests
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/yoshi-flow-bm/testkit`, `@wix/yoshi-flow-bm/testkit/http-client`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Design
 
 ### Overview

package/dist/docs/Composition and Providers.md

@@ -0,0 +1,135 @@
+# Composition and Providers
+
+**Category:** Guides
+
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+## Related components
+
+`WixPatternsProvider`, `WixPatternsBMProvider`, `WixPatternsGizaProvider`, `WixPatternsEssentialsProvider`, `WixPatternsBaseProvider`, `CollectionPage`, `EntityPage`, `SettingsPage`, `Table`, `Grid`, `TableGridSwitch`, `TableFolders`, `GridFolders`, `TableState`, `GridState`, `TableGridSwitchState`, `TableFoldersState`, `GridFoldersState`, `useTableCollection`, `useGridCollection`, `useTableGridSwitchCollection`, `useTableFolders`, `useGridFolders`, `PatternsReactRouter`, `PatternsReactRoute`, `usePatternsNavigate`, `withDashboard`
+
+Each name resolves in `dist/docs/index.json` — as a key, or as one of an entry's `symbols` aliases.
+
+## Overview
+
+Every patterns page is four nested layers. Getting the nesting wrong is the most common
+way a page that looks right throws at runtime.
+
+```
+Provider                  <- WixPatternsProvider, or one of the flow-specific providers
+  +-- Page                <- CollectionPage, EntityPage, or SettingsPage
+       +-- Collection     <- Table, Grid, TableGridSwitch, TableFolders, GridFolders
+            +-- Features  <- filters, actions, sorting, drag-and-drop
+```
+
+## The collection triad
+
+Every collection type is the same three pieces — a component, a state type, and the hook
+that builds the state:
+
+| Component | State type | Hook |
+| --- | --- | --- |
+| `Table` | `TableState` | `useTableCollection` |
+| `Grid` | `GridState` | `useGridCollection` |
+| `TableGridSwitch` | `TableGridSwitchState` | `useTableGridSwitchCollection` |
+| `TableFolders` | `TableFoldersState` | `useTableFolders` |
+| `GridFolders` | `GridFoldersState` | `useGridFolders` |
+
+Call the hook, pass the result to the component's `state` prop, and put the component
+inside a page. `useCreateCollection` is not part of this table and does not create items —
+it returns a function that initialises collection state.
+
+## Choosing a provider
+
+There is one provider per host environment, and each has its own entry point. Pick by where
+the app runs, not by preference.
+
+| Provider | Entry point | The host it serves |
+| --- | --- | --- |
+| `WixPatternsProvider` | `@wix/patterns/provider` | The Wix dashboard. Requires the `@wix/dashboard` peer dependency. |
+| `WixPatternsBMProvider` | `@wix/patterns/bm` | Yoshi BM Flow over Business Manager. |
+| `WixPatternsGizaProvider` | `@wix/patterns/giza` | Yoshi BM Flow over Giza. |
+| `WixPatternsEssentialsProvider` | `@wix/patterns/essentials` | Yoshi Fullstack. |
+| `WixPatternsBaseProvider` | `@wix/patterns/essentials` | Neither Giza nor Essentials — you inject i18n, sentry and the rest yourself. |
+
+**No provider detects its environment for you**, and none of them is a drop-in for another:
+each entry point exports exactly the one provider named above — except `essentials`, which
+carries two — so reaching for the wrong subpath is an import error rather than a silent
+fallback. The project's own flow decides which row applies; each provider's doc carries its
+import line verbatim.
+
+## The provider must be a parent, not a sibling
+
+Collection hooks read the provider's context, so the provider has to be **above** them in
+the tree — in a different component, not the same one.
+
+This throws at runtime, and the JSX looks correct, which is what makes it hard to see:
+
+
+```tsx
+function ShiftsApp() {
+  // `useTableCollection` runs before `WixPatternsProvider` exists above it
+  const state = useTableCollection({ /* … */ });
+  return (
+    <WixPatternsProvider>
+      <Table state={state} columns={columns} />
+    </WixPatternsProvider>
+  );
+}
+```
+
+Split the provider and the page into separate components:
+
+```tsx
+// ShiftsApp.tsx
+import { WixPatternsProvider } from '@wix/patterns/provider';
+
+interface Shift {
+  id: string;
+  name: string;
+}
+
+function ShiftsRoot() {
+  return (
+    <WixPatternsProvider>
+      <ShiftsCollectionPage />
+    </WixPatternsProvider>
+  );
+}
+
+// ShiftsCollectionPage.tsx
+import { Table, useTableCollection, OffsetQuery } from '@wix/patterns';
+import { CollectionPage } from '@wix/patterns/page';
+
+function ShiftsCollectionPage() {
+  // the provider's context exists above this component
+  const state = useTableCollection<Shift>({
+    queryName: 'shifts',
+    itemKey: (item) => item.id,
+    itemName: (item) => item.name,
+    fetchData: async (query: OffsetQuery) => ({ items: [] as Shift[], total: 0 }),
+    filters: {},
+  });
+
+  return (
+    <CollectionPage>
+      <Table state={state} columns={[{ title: 'Name', render: (item) => item.name }]} />
+    </CollectionPage>
+  );
+}
+```
+
+Keep the provider — and the router, if there is one — in the app's root component, and give
+each page its own file.
+
+## More than one page
+
+Use the library's own router rather than adding a second one: `PatternsReactRouter`,
+`PatternsReactRoute` and `usePatternsNavigate`. The router reads the page location out of
+the dashboard context that `withDashboard` renders, so it needs that wrapper above it with a
+`location` prop and throws at render time without one. `PatternsReactRouter`'s
+**Requirements** section has the setup.
+
+

package/dist/docs/ComputedQuery.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/CustomColumns.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description
@@ -18,7 +20,7 @@ import { CustomColumns } from '@wix/patterns';
 
 A basic table with the custom columns feature.
 
-Example code: read `dist/docs/CustomColumns/basic.tsx`
+Example code: read `dist/examples/CustomColumns/basic.tsx`
 
 ---
 
@@ -30,7 +32,7 @@ Customize a column to be hidden by default.
 
  **Note:** By default, new columns added to an existing table are visible to users. Set `defaultHidden` to `true` to hide them.
 
-Example code: read `dist/docs/CustomColumns/hide-specific-columns-by-default.tsx`
+Example code: read `dist/examples/CustomColumns/hide-specific-columns-by-default.tsx`
 
 ---
 
@@ -38,7 +40,7 @@ Example code: read `dist/docs/CustomColumns/hide-specific-columns-by-default.tsx
 
 Locking columns restricts users from editing the specified columns and disables the hide and show functionality (checkbox).
 
-Example code: read `dist/docs/CustomColumns/lock-columns.tsx`
+Example code: read `dist/examples/CustomColumns/lock-columns.tsx`
 
 ---
 
@@ -46,7 +48,7 @@ Example code: read `dist/docs/CustomColumns/lock-columns.tsx`
 
 Excluding columns restricts users from editing the specified columns and hides them from the custom column selection panel.
 
-Example code: read `dist/docs/CustomColumns/exclude-columns.tsx`
+Example code: read `dist/examples/CustomColumns/exclude-columns.tsx`
 
 ---
 
@@ -54,7 +56,7 @@ Example code: read `dist/docs/CustomColumns/exclude-columns.tsx`
 
 Add a tooltip next to the column's name. The tooltip allows you to add more information about the column.
 
-Example code: read `dist/docs/CustomColumns/add-a-tooltip.tsx`
+Example code: read `dist/examples/CustomColumns/add-a-tooltip.tsx`
 
 ---
 
@@ -64,7 +66,7 @@ Drag and drop columns in the side panel to reorder the columns.
 
  When adding new columns to an existing table component, the custom column order is preserved, and new columns are appended to the right of the existing columns. However, if the columns are still in their original order, the updated table overrides it.
 
-Example code: read `dist/docs/CustomColumns/reorder-columns.tsx`
+Example code: read `dist/examples/CustomColumns/reorder-columns.tsx`
 
 ---
 
@@ -74,7 +76,7 @@ To freeze columns and prevent users from reordering them, use the `reorderDisabl
  
 >**Note**: You can only freeze columns in a table starting from the first column, and in consecutive order.
 
-Example code: read `dist/docs/CustomColumns/freeze-column-reorder.tsx`
+Example code: read `dist/examples/CustomColumns/freeze-column-reorder.tsx`
 
 ---
 
@@ -82,7 +84,7 @@ Example code: read `dist/docs/CustomColumns/freeze-column-reorder.tsx`
 
 To achieve greater optimization, consider utilizing the `refreshOnColumnsChange` flag with `true` value and retrieving the `columns` array from the query object. This approach enables you to retrieve the necessary fields from your backend.
 
-Example code: read `dist/docs/CustomColumns/load-only-selected-columns.tsx`
+Example code: read `dist/examples/CustomColumns/load-only-selected-columns.tsx`
 
 ---
 
@@ -90,7 +92,7 @@ Example code: read `dist/docs/CustomColumns/load-only-selected-columns.tsx`
 
 Retrieve the visible columns from the custom columns feature.
 
-Example code: read `dist/docs/CustomColumns/get-visible-columns.tsx`
+Example code: read `dist/examples/CustomColumns/get-visible-columns.tsx`
 
 ## API
 

package/dist/docs/CustomFieldType.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description
@@ -33,25 +35,25 @@ import { defineFieldType } from '@wix/patterns';
 
 What you get: a read-only table where the custom Progress field renders as a progress bar (the `table` slot) and a Progress filter in the toolbar (the `filter` slot — check a bucket and the backend applies the raw filter value). Manage fields can add functionality and visibility on top: the field's actions and show/hide controls appear in the manage-fields and customize-columns panels.
 
-Example code: read `dist/docs/CustomFieldType/table-cell-and-filter.tsx`
+Example code: read `dist/examples/CustomFieldType/table-cell-and-filter.tsx`
 
 ### Editable cell
 
 What you get: the same field type in an editable spreadsheet — the `editableTable` slot renders progress bars in view mode and a number input in edit mode. Try it: double-click a Progress cell (or focus it and type a digit) to edit — Enter or Tab commits, Escape cancels, values clamp to 0–100 on commit (`normalizeOnCommit`), and copy/paste round-trips through `serialize`/`deserialize`. Right-click a Progress cell: Cut is always disabled with the type's tooltip, while Clear is disabled only when the value is 100. The Progress column's header menu also has "This is action only for progress bar" (the separate `actions` slot). Filtering is opted out with `{ filterable: false }`, so the toolbar shows no Progress filter.
 
-Example code: read `dist/docs/CustomFieldType/editable-cell.tsx`
+Example code: read `dist/examples/CustomFieldType/editable-cell.tsx`
 
 ### Add-field modal
 
 What you get: a custom type users can create fields of. The `fieldModal` slot opts the Progress type into the add-field modal — click the "+" header button, pick "Progress" in the type picker (it shows the definition's label, icons, subtitle, and group), name it, and confirm. The new field arrives at the source's `fieldActions.addField` as `{ type: 'CUSTOM', customType: 'docs.progress' }` and its column appears immediately, rendered by the type's `editableTable` slot. Requires `schemaPermissions.createField` and `fieldActions.addField` on the source. Note the picker offers only what the source declares (`fieldModal.types`) plus creatable custom types, and persistence belongs to the source's `FieldActions` — this demo stores fields in memory, so they reset on refresh; a source backed by a real service persists them (see the API tab).
 
-Example code: read `dist/docs/CustomFieldType/add-field-modal.tsx`
+Example code: read `dist/examples/CustomFieldType/add-field-modal.tsx`
 
 ### Entity-page form
 
 What you get: the custom type in the entity-page form. The `form` slot's component renders only the Progress input — it receives `value`/`onChange` props, and the entity page owns the form wiring (registration on the form, validation from the definition's `value.validate`) and the field UI (label, required marker, error message). Without a `form` slot, an entity page rendering the field throws in development (production skips it). Try it: change the progress, save from the header, and the value round-trips through the source's backend.
 
-Example code: read `dist/docs/CustomFieldType/entity-page-form.tsx`
+Example code: read `dist/examples/CustomFieldType/entity-page-form.tsx`
 
 ## API
 
@@ -89,7 +91,7 @@ The backend owns the translation: `find({ filters })` receives the raw filter va
 
 #### `table` — the read-only table cell and column layout
 
-- `CellComponent(props: { value: V })` — renders the cell.
+- `CellComponent(props: TableCellProps<V>)` — renders the cell. Props: `value`, `columnId`, `row`. `row` is the item the cell belongs to, so a cell can act on it and not only display it.
 - `width: string` — required; custom types get no built-in layout default.
 - `align?: 'start' | 'center' | 'end'` — default `'start'`.
 

package/dist/docs/CustomFieldsViewWidget.md

@@ -2,6 +2,10 @@
 
 **Category:** Features/Enrich/Data Extension/Components
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-cairo-dummyservice-v1-dummy-entity/types`, `@wix/ambassador-v1-entity/types`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Overview
 
 ### Introduction

package/dist/docs/CustomFieldsWidget.md

@@ -4,6 +4,10 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-cairo-dummyservice-v1-dummy-entity/http`, `@wix/ambassador-cairo-dummyservice-v1-dummy-entity/types`, `@wix/ambassador-v1-entity/http`, `@wix/ambassador-v1-entity/types`, `@wix/yoshi-flow-bm`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Overview
 
 ### Introduction
@@ -107,7 +111,7 @@ export const MyPageProvider = ({ children }) => {
 
 This example demonstrates the component with all existing field types including initial values.
 
-Example code: read `dist/docs/CustomFieldsWidget/basic.tsx`
+Example code: read `dist/examples/CustomFieldsWidget/basic.tsx`
 
 ---
 
@@ -115,7 +119,7 @@ Example code: read `dist/docs/CustomFieldsWidget/basic.tsx`
 
 This example demonstrates the component in a responsive layout.
 
-Example code: read `dist/docs/CustomFieldsWidget/responsive.tsx`
+Example code: read `dist/examples/CustomFieldsWidget/responsive.tsx`
 
 ---
 
@@ -123,7 +127,7 @@ Example code: read `dist/docs/CustomFieldsWidget/responsive.tsx`
 
 This example demonstrates the component in an empty state.
 
-Example code: read `dist/docs/CustomFieldsWidget/empty-state.tsx`
+Example code: read `dist/examples/CustomFieldsWidget/empty-state.tsx`
 
 ---
 
@@ -131,7 +135,7 @@ Example code: read `dist/docs/CustomFieldsWidget/empty-state.tsx`
 
 This example shows the component in an inline layout - without card.
 
-Example code: read `dist/docs/CustomFieldsWidget/inline-theme.tsx`
+Example code: read `dist/examples/CustomFieldsWidget/inline-theme.tsx`
 
 ---
 
@@ -139,7 +143,7 @@ Example code: read `dist/docs/CustomFieldsWidget/inline-theme.tsx`
 
 This example shows how to control the state, and use custom loading and error UIs
 
-Example code: read `dist/docs/CustomFieldsWidget/controllable-state.tsx`
+Example code: read `dist/examples/CustomFieldsWidget/controllable-state.tsx`
 
 ---
 
@@ -147,7 +151,7 @@ Example code: read `dist/docs/CustomFieldsWidget/controllable-state.tsx`
 
 This example demonstrates how to use the component without an entity page. Use the hook useCustomFields with your fqdn and get the change in `onChange` callback.
 
-Example code: read `dist/docs/CustomFieldsWidget/without-entity-page.tsx`
+Example code: read `dist/examples/CustomFieldsWidget/without-entity-page.tsx`
 
 ---
 
@@ -155,7 +159,7 @@ Example code: read `dist/docs/CustomFieldsWidget/without-entity-page.tsx`
 
 In case the field was created with read and write permissions for users, it will be rendered here
 
-Example code: read `dist/docs/CustomFieldsWidget/with-tpa-fields.tsx`
+Example code: read `dist/examples/CustomFieldsWidget/with-tpa-fields.tsx`
 
 ## API
 

package/dist/docs/DateRangeFilter.Components.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Overview

package/dist/docs/Display Extended Fields.md

@@ -2,6 +2,10 @@
 
 **Category:** Features/Enrich/Data Extension
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-contacts-v4-contact/http`, `@wix/ambassador-contacts-v4-contact/types`, `@wix/ambassador-contacts-v5-contact/http`, `@wix/ambassador-contacts-v5-contact/types`, `@wix/ambassador-v1-entity/types`, `@wix/yoshi-flow-bm`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Guide
 
 This guide explains how to display extended fields in your table.

package/dist/docs/Enable Filters for Extended Fields.md

@@ -2,6 +2,10 @@
 
 **Category:** Features/Enrich/Data Extension
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-contacts-v5-contact/http`, `@wix/ambassador-contacts-v5-contact/types`, `@wix/yoshi-flow-bm`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Guide
 
 This article explains how to enable filters on your extended fields.

package/dist/docs/EntityPage.AdditionalContent.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Entity Page
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/EntityPage.Card.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Entity Page
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Examples
 
 ### Basic

package/dist/docs/EntityPage.Content.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Entity Page
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/EntityPage.Header.md

@@ -2,6 +2,10 @@
 
 **Category:** Base Components/Pages/Entity Page
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-cairo-dummyservice-v1-dummy-entity/types`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Examples
 
 ### Basic

package/dist/docs/EntityPage.MainContent.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Entity Page
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/EntityPage.Slots.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Entity Page
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Examples
 
 ### Basic