@wix/patterns 1.478.0 → 1.480.0

package/dist/docs/Collection and Entity Template.md

@@ -0,0 +1,59 @@
+# Collection and Entity Template
+
+**Category:** Templates
+
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
+## Related components
+
+`withDashboard`, `WixPatternsProvider`, `PatternsReactRouter`, `PatternsReactRoute`, `CollectionPage`, `useTableCollection`, `Table`, `CollectionSearch`, `CollectionToolbarFilters`, `MultiSelectCheckboxFilter`, `stringsArrayFilter`, `CollectionEmptyState`, `CollectionNoResultsState`, `CollectionErrorState`, `PrimaryActions`, `usePatternsNavigate`, `EntityPage`, `useEntityPage`, `useEntityPageContext`
+
+Each name resolves in `dist/docs/index.json` — as a key, or as one of an entry's `symbols` aliases.
+
+## Template files
+
+Copy all of them into one directory: they import one another by relative path.
+
+- `dist/templates/collection-entity/ItemEntityPage.tsx`
+- `dist/templates/collection-entity/ItemsApp.tsx`
+- `dist/templates/collection-entity/ItemsCollectionPage.tsx`
+- `dist/templates/collection-entity/items-api.ts`
+- `dist/templates/collection-entity/page.tsx`
+
+## Overview
+
+A complete dashboard page for a list of records that the user can create and edit: a collection page with search, a filter and every placeholder state, an entity page that serves both the create and the edit route, and the router between them. Use it when you fetch the rows yourself, from an SDK or an API; for a CMS collection use the CMS Collection and Entity Template instead. Copy the whole directory, rename the items and the item to your own feature and entity, and replace the bodies in the api file.
+
+## Files
+
+| File | What it is |
+| --- | --- |
+| page.tsx | The entry file. It hands the dashboard's page location to the router. |
+| ItemsApp.tsx | The provider, the router and the three routes. |
+| ItemsCollectionPage.tsx | The table: search, a status filter, the empty, no-results and error states, and a row that opens the record. |
+| ItemEntityPage.tsx | Create and edit in one component, with one form field. |
+| items-api.ts | The data functions the pages call. The in-memory list is only there so the template runs. |
+
+## What to change, and what to keep
+
+Change the names, the columns, the filters, the form fields and the api file. One column per field the page is meant to show, and one filter per way the user needs to narrow the list.
+
+Keep the wiring. Each of these compiles and builds without complaint when it is wrong, and fails only in the browser:
+
+- **The page location in the entry file.** The router reads it from what the entry passes down, and nothing supplies it otherwise in a Wix CLI app.
+- **The provider as a parent of the router.** A provider placed beside what reads it throws at runtime.
+- **Every filter and the search term reaching the fetch.** A filter that is declared and rendered but never read still shows its options and narrows nothing. The same is true of search, which the table turns on by default.
+- **The cursor.** Return it on every page, and leave it undefined on the last one. An empty string reads as another page, and the table keeps asking.
+- **The error state.** Without it a failed query shows loading skeletons forever.
+- **The row opening a route.** Every record opens a page of its own, never a side panel. Passing the row along with the path lets the entity page show its title before its own fetch lands.
+- **The new-entity check as a function.** A successful create moves the route from the new path to the record's own while the page stays mounted, so a value computed once goes stale.
+
+**The entity page parameters are a picked list.** A parameter that is not in it is a compile error, not an ignored option. If one of the template's parameters does not compile, upgrade `@wix/patterns` rather than deleting the line: without the new-entity check a create page behaves as an edit page.
+
+**A total is opt-in.** The collection hook takes a separate fetch for the total count. Leave it out unless the page shows a figure the user asked for: when present, it replaces the count of loaded rows, so one that resolves to nothing reports zero beside a full table.
+
+## Adding a settings area
+
+A page that also needs app-wide settings takes the settings page from the Settings Page Template and registers it as one more route, of type other, at its own path. The route type has no dedicated settings value.
+
+

package/dist/docs/Collection and Read-Only Detail Template.md

@@ -0,0 +1,47 @@
+# Collection and Read-Only Detail Template
+
+**Category:** Templates
+
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
+## Related components
+
+`withDashboard`, `WixPatternsProvider`, `PatternsReactRouter`, `PatternsReactRoute`, `CollectionPage`, `useTableCollection`, `Table`, `CollectionSearch`, `CollectionToolbarFilters`, `MultiSelectCheckboxFilter`, `stringsArrayFilter`, `CollectionEmptyState`, `CollectionNoResultsState`, `CollectionErrorState`, `usePatternsNavigate`
+
+Each name resolves in `dist/docs/index.json` — as a key, or as one of an entry's `symbols` aliases.
+
+## Template files
+
+Copy all of them into one directory: they import one another by relative path.
+
+- `dist/templates/collection-detail/ItemDetailPage.tsx`
+- `dist/templates/collection-detail/ItemsApp.tsx`
+- `dist/templates/collection-detail/ItemsCollectionPage.tsx`
+- `dist/templates/collection-detail/items-api.ts`
+- `dist/templates/collection-detail/page.tsx`
+
+## Overview
+
+A complete dashboard page for a list of records the user reads but does not edit: a collection page with search, a filter and every placeholder state, a read-only detail page for one record, and the router between them. Use it when there is nothing to create and nothing to save. Copy the whole directory, rename the items and the item to your own feature and entity, and replace the bodies in the api file.
+
+## Files
+
+| File | What it is |
+| --- | --- |
+| page.tsx | The entry file. It hands the dashboard's page location to the router. |
+| ItemsApp.tsx | The provider, the router and the two routes. |
+| ItemsCollectionPage.tsx | The table: search, a status filter, the empty, no-results and error states, and a row that opens the record. |
+| ItemDetailPage.tsx | One record, read-only, with the way back in its header. |
+| items-api.ts | The data functions the pages call. The in-memory list is only there so the template runs. |
+
+## Why the detail page is not an EntityPage
+
+An entity page has no read-only mode. Its fetch and save are both required, and its actions bar can rename the save button but not remove it, so a display-only record would ship buttons that save a form nobody was offered. The detail page is therefore a plain design-system page, the same shape the library uses for its own read-only views.
+
+It is still registered as an edit-entity route. That type is what wires the way back to the collection, and if the page later grows an edit form it becomes the Collection and Entity Template's entity page with the route and the row click unchanged.
+
+## What to keep
+
+Everything the Collection and Entity Template lists under keeping the wiring applies here too: the page location in the entry file, the provider as a parent of the router, every filter and the search term reaching the fetch, the cursor, the error state, and a row that opens a route rather than a side panel.
+
+

package/dist/docs/CollectionEmptyState.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-Displays an empty state for a table when no items exist in the collection. Pass through the `emptyState` prop of a [`Grid`](./?path=/story/base-components-collections-grid-grid--grid), [`Table`](./?path=/story/base-components-collections-table-table--table), or other collection component.
+Displays an empty state for a table when no items exist in the collection. Pass through the `emptyState` prop of a [`Grid`](Grid.md), [`Table`](Table.md), or other collection component.
 
 
 ```tsx

package/dist/docs/CollectionErrorState.md

@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-The `CollectionErrorState` component displays an error state for a collection when a data fetch fails. Pass this component to the `errorState` prop of a collection component, such as a [Grid](./?path=/story/base-components-collections-grid-grid--grid) or a [Table](./?path=/story/base-components-collections-table-table--table). 
+The `CollectionErrorState` component displays an error state for a collection when a data fetch fails. Pass this component to the `errorState` prop of a collection component, such as a [Grid](Grid.md) or a [Table](Table.md). 
 
 
 ```tsx

package/dist/docs/CollectionNoResultsState.md

@@ -12,7 +12,7 @@ Some of that scaffolding is environment-scoped and is **not** needed to use this
 
 ### Description
 
-Displays an empty state when a filter or search has no results. Pass through the `noResultsState` prop of a [`Grid`](./?path=/story/base-components-collections-grid-grid--grid), [`Table`](./?path=/story/base-components-collections-table-table--table), or other collection component.
+Displays an empty state when a filter or search has no results. Pass through the `noResultsState` prop of a [`Grid`](Grid.md), [`Table`](Table.md), or other collection component.
 
 
 

package/dist/docs/CollectionOptimisticActions.md

@@ -16,7 +16,7 @@ The CollectionOptimisticActions class provides a set of utilities for managing o
 
 You can learn about collection approches for [Updates](./?path=/story/features-actions-updates--updates)
 
-To manage a collection using CollectionOptimisticActions use the hook [useOptimisticActions](./?path=/story/features-actions-updates--useoptimisticactions)
+To manage a collection using CollectionOptimisticActions use the hook [useOptimisticActions](useOptimisticActions.md)
 
 #### Error Handling
 Offers hooks for handling errors, retrying actions, and updating UI based on the success or failure of optimistic actions.
@@ -42,7 +42,7 @@ The simulation is done by the `predicate` & `orderBy` parameters.
 WixPatterns includes default implementations for these parameters, which are designed based on assumptions about the typical behavior of servers.
 Therefore, it's crucial to ensure consistency between client-side and server-side filtering, either by using the default implementations or by explicitly implementing the `predicate` & `orderBy` functions.
 
-> When not using [Sortable Columns](./?path=/story/features-sort-sortable-columns-sortable-columns--sortable-columns) it's necessary to specify the `orderBy` parameter; otherwise, WixPatterns will not merge the updated items when they should be visible under a new filtering criteria. 
+> When not using [Sortable Columns](<Sortable Columns.md>) it's necessary to specify the `orderBy` parameter; otherwise, WixPatterns will not merge the updated items when they should be visible under a new filtering criteria. 
 ***The default implementations are not guaranteed to be compatible with all servers.***
 ***Hence, ensure consistency in filtering behavior across both client and server sides by explicitly implementing the `predicate` and `orderBy` functions when necessary.***
 

package/dist/docs/CollectionPage.Content.md

@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-This component acts as a container for collection components like [Table](./?path=/story/base-components-collections-table-table--table) and [Grid](./?path=/story/base-components-collections-grid-grid--grid), which should be sent as children.
+This component acts as a container for collection components like [Table](Table.md) and [Grid](Grid.md), which should be sent as children.
 
 
 ```tsx

package/dist/docs/CollectionPage.Header.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-This component renders a [Page.Header](https://www.docs.wixdesignsystem.com/?path=/story/components-layout-page--page-header) component inside a [CollectionPage](./?path=/story/base-components-pages-collection-page--collectionpage).
+This component renders a [Page.Header](https://www.docs.wixdesignsystem.com/?path=/story/components-layout-page--page-header) component inside a [CollectionPage](CollectionPage.md).
 
 Pass badges through `title.badges`. Each badge supports `text`, `skin`, `prefixIcon`, `suffixIcon`, and an optional `tooltip` string. Tooltips appear on hover or keyboard focus; press Tab to focus a badge with a tooltip. Badges without tooltips do not add a tab stop. All badges use the small size and are hidden in the minimized header.
 
@@ -22,7 +22,7 @@ import { CollectionPage } from '@wix/patterns/page';
 
 ### Full
 
-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).
+Rendering a header with title, subtitle, total, primary action, and more actions. To learn how to create a more actions menu, see [`MoreActions`](<More Actions.md>).
 
 Example code: read `dist/examples/CollectionPage.Header/full.tsx`
 
@@ -45,9 +45,9 @@ Example code: read `dist/examples/CollectionPage.Header/with-badges.tsx`
 | Prop | Type | Required | Default | Description |
 |------|------|----------|---------|-------------|
 | `breadcrumbs` | `BreadcrumbsElement` | No | - | A [`Breadcrumbs`](https://www.docs.wixdesignsystem.com/?path=/story/components-navigation--breadcrumbs) element to be rendered on the header. |
-| `title` | `{ text: string; hideTotal?: boolean \| undefined; badges?: CollectionPageHeaderBadge[] \| undefined; }` | Yes | - | `text`: The title text. \ `hideTotal`: Determines whether to hide the number of total entities on the title of the page. \ `badges`: Badges rendered at the end of the title row, after the total. Their size is always `small`. Each badge accepts `text`, `skin`, `prefixIcon`, `suffixIcon`, and an optional `tooltip` shown on hover or keyboard focus. \ The minimized header shows the title text on its own, so badges are not rendered while it is collapsed. |
+| `title` | `{ text: string; hideTotal?: boolean \| undefined; badges?: CollectionPageHeaderBadge[] \| undefined; }` | Yes | - | `text`: The title text. \ `hideTotal`: Determines whether to hide the number of total entities on the title of the page. \ `badges`: Badges rendered at the end of the title row, after the total. Their size is `small` (`medium` on mobile). Each badge accepts `text`, `skin`, `prefixIcon`, `suffixIcon`, and an optional `tooltip` shown on hover or keyboard focus. \ The minimized header shows the title text on its own, so badges are not rendered while it is collapsed. |
 | `subtitle` | `PageSubTitleProps` | No | - | The page subtitle text. |
-| `primaryAction` | `PrimaryActionsElement` | No | - | A [`PrimaryActions`](./?path=/story/features-actions-primary-actions--primary-actions) component to be rendered on the header. A primary button w/o PopoverMenu component to be rendered in the header. |
-| `secondaryActions` | `SecondaryActionsElement` | No | - | A [`SecondaryActions`](./?path=/story/features-actions-secondary-actions--secondary-actions) component to be rendered on the header. A Secondary button w/o PopoverMenu component to be rendered on the header |
-| `moreActions` | `MoreActionsElement` | No | - | A [`MoreActions`](./?path=/story/features-actions-more-actions--more-actions) component to be rendered on the header. |
+| `primaryAction` | `PrimaryActionsElement` | No | - | A [`PrimaryActions`](PrimaryActions.md) component to be rendered on the header. A primary button w/o PopoverMenu component to be rendered in the header. |
+| `secondaryActions` | `SecondaryActionsElement` | No | - | A [`SecondaryActions`](SecondaryActions.md) component to be rendered on the header. A Secondary button w/o PopoverMenu component to be rendered on the header |
+| `moreActions` | `MoreActionsElement` | No | - | A [`MoreActions`](<More Actions.md>) component to be rendered on the header. |
 

package/dist/docs/CollectionPage.md

@@ -11,10 +11,10 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 ### Description
 
 CollectionPage wraps [](https://www.docs.wixdesignsystem.com/?path=/story/components-layout-page--page) from `@wix/design-system`. \
-It provides scrolling context for collection components, such as [](./?path=/story/components-collection--table).
+It provides scrolling context for collection components, such as [](Table.md).
 Also, it displays total items count in the page header.
 
-It accepts two types of children: [CollectionPage.Header](./?path=/story/base-components-pages-collection-page--collectionpage-header) and [CollectionPage.Content](./?path=/story/base-components-pages-collection-page--collectionpage-content).
+It accepts two types of children: [CollectionPage.Header](CollectionPage.Header.md) and [CollectionPage.Content](CollectionPage.Content.md).
 
 
 

package/dist/docs/CollectionPremiumEmptyState.md

@@ -12,7 +12,7 @@ Some of that scaffolding is environment-scoped and is **not** needed to use this
 
 ### Description
 
-Displays an empty state encouraging users to upgrade to a premiuim plan. Pass through the `emptyState` prop of a [`Grid`](./?path=/story/base-components-collections-grid-grid--grid), [`Table`](./?path=/story/base-components-collections-table-table--table), or other collection component.
+Displays an empty state encouraging users to upgrade to a premiuim plan. Pass through the `emptyState` prop of a [`Grid`](Grid.md), [`Table`](Table.md), or other collection component.
 
 
 ```tsx

package/dist/docs/CollectionSearch.md

@@ -12,13 +12,13 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 `CollectionSearch` adds a search input to the collection toolbar, allowing users to filter items by free-text search. When a user types in the search box, the search term is passed to your `fetchData` function via `query.search`, enabling server-side filtering.
 
-The search input integrates automatically with [`CollectionPage`](./?path=/story/base-components-pages-collection-page--collectionpage) and any collection component (Table, Grid, etc.) through the toolbar.
+The search input integrates automatically with [`CollectionPage`](CollectionPage.md) and any collection component (Table, Grid, etc.) through the toolbar.
 
 #### Features
 
 - **Character limit** — Use the `maxLength` prop to limit how many characters users can type.
 - **Custom placeholder** — Set a `placeholder` prop to guide users on what to search for.
-- **Search highlighting** — Combine with [`HighlightedSearch`](./?path=/story/features-display--highlighted-search-results) to visually highlight matching text in results.
+- **Search highlighting** — Combine with [`HighlightedSearch`](<Highlighted Search.md>) to visually highlight matching text in results.
 - **Debounced input** — Search queries are debounced to avoid excessive API calls while typing.
 
 #### Usage
@@ -49,8 +49,8 @@ fetchData: async (query: OffsetQuery) => {
 
 #### Related
 
-- [`HighlightedSearch`](./?path=/story/features-display--highlighted-search-results) — Highlight matching text in search results
-- [`CollectionToolbarFilters`](./?path=/story/features-filter-components--collectiontoolbarfilters) — Add filter dropdowns alongside search
+- [`HighlightedSearch`](<Highlighted Search.md>) — Highlight matching text in search results
+- [`CollectionToolbarFilters`](ToolbarFilters.md) — Add filter dropdowns alongside search
 
 
 ```tsx
@@ -77,7 +77,7 @@ 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).
+Gets highlighted search results in the table. Learn how to [enable it](<Highlighted Search.md>).
 
 Example code: read `dist/examples/CollectionSearch/search-highlighting.tsx`
 

package/dist/docs/CollectionState.md

@@ -6,7 +6,7 @@
 
 ### Overview
 
-`CollectionState` is the core state object for all collection components. It manages server data fetching, pagination, filtering, sorting, search, and bulk selection. Created by hooks like [`useTableCollection`](./?path=/story/base-components-collections-table-usetablecollection--usetablecollection) or [`useGridCollection`](./?path=/story/common-hooks--usegridcollection).
+`CollectionState` is the core state object for all collection components. It manages server data fetching, pagination, filtering, sorting, search, and bulk selection. Created by hooks like [`useTableCollection`](useTableCollection.md) or [`useGridCollection`](useGridCollection.md).
 
 Key methods: `invalidate()`, `refreshCurrentPage()`, `clearResultAndMoveToStart()`, `retryErrorState()`.
 
@@ -19,9 +19,9 @@ Key methods: `invalidate()`, `refreshCurrentPage()`, `clearResultAndMoveToStart(
 | `refreshCurrentPage` | `(params?: { noInvalidate?: boolean \| undefined; } \| undefined) => Promise<void>` | Yes | - | Invalidates cache and refreshes current page, without showing a loading indication.<br> Optional parameters:<br> - `noInvalidate` - Refreshes current page without invalidating cache. |
 | `clearResultAndMoveToStart` | `(params?: { force?: boolean \| undefined; filters?: { [P in keyof F]?: string[] \| null \| undefined; } \| undefined; } \| undefined) => Promise<void>` | Yes | - | Clears all data from the collection and goes back to the first page and refreshes the first page data, while showing a loading indication.<br> Optional parameters:<br> - `force` - Invalidates the cache and resets react-query observer. - `filters` - Clears only a specific part of the cache, for example: `invalidate({ filters: { status: ['active'] } })` |
 | `retryErrorState` | `() => void` | Yes | - | Triggers retry when collection fails to load |
-| `bulkSelect` | `BulkSelectState<T>` | Yes | - | [BulkSelectState](./?path=/story/common-state--bulkselectstate) |
+| `bulkSelect` | `BulkSelectState<T>` | Yes | - | [BulkSelectState](BulkSelectState.md) |
 | `searchInputRef` | `{ focus: () => void; } \| null` | No | - | Reference to the search input element to allow programmatic focus |
-| `originQuery` | `ComputedQueryFull<F>` | Yes | - | [ComputedQuery](./?path=/story/common-types--computedquery) instance. Holds all the relevant variables to query the server API with. |
+| `originQuery` | `ComputedQueryFull<F>` | Yes | - | [ComputedQuery](ComputedQuery.md) instance. Holds all the relevant variables to query the server API with. |
 | `status` | `QueryResultStatus<DataResultKeyed<T>, unknown>` | Yes | - | Status of the query. Contains boolean flags of `isIdle`, `isError`, `isLoading`, `isFetching`, `isSuccess`. The difference between `isLoading` and `isFetching` is that `isLoading` is true during the initial query, `isFetching` is true during the next queries. |
 | `total` | `number` | Yes | - | The total number of items, as was returned from the last query. |
 | `keyedItems` | `KeyedItem<T>[]` | Yes | - | All the keyed items of the collection |

package/dist/docs/CollectionToolbar.md

@@ -8,11 +8,11 @@
 
 `CollectionToolbar` is the internal toolbar component rendered by `Table`, `Grid`, and other collection components. It displays the title, search input, filters, custom columns, sort, export button, primary/secondary actions, more actions, and view switcher.
 
-You do not render this component directly — instead, configure the toolbar through props on the collection component (e.g. `<Table title={...} search={...} filters={...} />`). The toolbar reads its state from [`ToolbarCollectionState`](./?path=/story/common-state--toolbarcollectionstate).
+You do not render this component directly — instead, configure the toolbar through props on the collection component (e.g. `<Table title={...} search={...} filters={...} />`). The toolbar reads its state from [`ToolbarCollectionState`](ToolbarCollectionState.md).
 
 ## Testkit
 
 ### Description
 
-The table toolbar rendering in WixPatterns relies on this internal component. To explore the available methods, please refer to the [ToolbarCollectionState](./?path=/story/common-state--toolbarcollectionstate) documentation.
+The table toolbar rendering in WixPatterns relies on this internal component. To explore the available methods, please refer to the [ToolbarCollectionState](ToolbarCollectionState.md) documentation.
 

package/dist/docs/Component Tests.md

@@ -16,7 +16,7 @@ Some of that scaffolding is environment-scoped and is **not** needed to use this
 
 ##### WixPatternsProvider / WixPatternsBMProvider
 
-> This is relevant only when testing a component which **is not already** wrapped with either [`WixPatternsProvider`](./?path=/story/base-components-providers--wixpatternsprovider) or [`WixPatternsBMProvider`](./?path=/story/base-components-providers--wixpatternsbmprovider).
+> This is relevant only when testing a component which **is not already** wrapped with either [`WixPatternsProvider`](WixPatternsProvider.md) or [`WixPatternsBMProvider`](WixPatternsBMProvider.md).
 
 If your use case requires testing such component, before rendering it, wrap with one of the providers:
 
@@ -83,7 +83,7 @@ export class TableTestDriver {
 
   /**
    * Here we use a utility which acts as a collection API server, and we integrate it with `HttpClientMocks` below
-   * See full API for `InMemoryBackend` - ./?path=/story/testing-utils--inmemorybackend
+   * See full API for `InMemoryBackend` - ./?path=/story/guides--inmemorybackend
    */
   backend = new InMemoryBackend<{ id: string; name: string }>({
     createOne: (index) => ({

package/dist/docs/ComputedQuery.md

@@ -16,7 +16,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 The argument passed to the `fetchData()` function.
 
-The `fetchData()` function is responsible for fetching data collections and is defined within collection hooks like [`useTableCollection()`](./?path=/story/base-components-collections-table-usetablecollection--usetablecollection) and [`useGridCollection()`](./?path=/story/base-components-collections-grid-usegridcollection--usegridcollection).
+The `fetchData()` function is responsible for fetching data collections and is defined within collection hooks like [`useTableCollection()`](useTableCollection.md) and [`useGridCollection()`](useGridCollection.md).
 
 `ComputedQuery` ensures that queries align with the expected input of the server. It supports both `offset` and `cursor` pagination modes, which can be set by adjusting the `paginationMode` property in the relevant hook.
 

package/dist/docs/CustomColumns.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-Allows users to control the display behavior of [`Table`](./?path=/story/base-components-collections-table-table--table) columns. For more information, see [Custom Columns Overview](./?path=/story/features-display-custom-columns--overview).
+Allows users to control the display behavior of [`Table`](Table.md) columns. For more information, see [Custom Columns Overview](./?path=/story/features-display-custom-columns--overview).
 
 ```tsx
 import { CustomColumns } from '@wix/patterns';
@@ -133,6 +133,6 @@ Event   |   Description   |
 
 ### Usage
 
-All `<CustomColumns />` testkit APIs are exposed directly from the `<Table />` [testkit](./?path=/story/base-components-collections-table-table--table&tab=Testkit).
+All `<CustomColumns />` testkit APIs are exposed directly from the `<Table />` [testkit](Table.md).
 
 

package/dist/docs/CustomFieldsViewWidget.md

@@ -19,7 +19,7 @@ The `CustomFieldsViewWidget` component enhances the entity page by displaying bo
 
 ### Getting Started
 
-1. Wrap your app with one of the Wix Patterns providers: [WixPatternsProvider](./?path=/story/base-components-providers--wixpatternsprovider).
+1. Wrap your app with one of the Wix Patterns providers: [WixPatternsProvider](WixPatternsProvider.md).
 
 2. Add `CustomFieldsViewWidget` to one of your child components and pass the `extendedFields` prop to it from the `entity` object and `fqdn`.
 

package/dist/docs/CustomFieldsWidget.md

@@ -21,7 +21,7 @@ The `CustomFieldsWidget` component enhances the entity page by displaying user-d
 
 ### Getting Started
 
-1. Wrap your page with [WidgetsFormProvider](./?path=/story/base-components-providers--widgetsformprovider).
+1. Wrap your page with [WidgetsFormProvider](WidgetsFormProvider.md).
 
 ```diff
 + import { WidgetsFormProvider } from '@wix/patterns/page';
@@ -66,7 +66,7 @@ export const MyPageProvider = ({ children }) => {
   }
 ```
 
-3. Use the [useWidgetsFormContext](./?path=/story/common-hooks--usewidgetsformcontext) hook to get the `state` object and use it to validate the `CustomFieldsWidget` data.
+3. Use the [useWidgetsFormContext](useWidgetsFormContext.md) hook to get the `state` object and use it to validate the `CustomFieldsWidget` data.
 
 ```diff
   import { MyEntity } from '@wix/ambassador-v1-entity/types';
@@ -165,7 +165,7 @@ Example code: read `dist/examples/CustomFieldsWidget/with-tpa-fields.tsx`
 
 ### Manually wrapping with WidgetsFormProvider
 
-To gain more control over the app structure, the app needs to be wrapped manually with the [WidgetsFormProvider](./?path=/story/base-components-providers--widgetsformprovider) component. This is useful when you want to use the [useWidgetsFormContext](./?path=/story/common-hooks--usewidgetsformcontext) hook in a component that is not a direct child of the `Page` component.
+To gain more control over the app structure, the app needs to be wrapped manually with the [WidgetsFormProvider](WidgetsFormProvider.md) component. This is useful when you want to use the [useWidgetsFormContext](useWidgetsFormContext.md) hook in a component that is not a direct child of the `Page` component.
 
 > Note: `useWidgetsFormContext` must still be used inside a direct child of the `WixPatternsBMProvider` component.
 

package/dist/docs/Data Extension Overview.md

@@ -27,9 +27,9 @@ Enhance your Patterns components so that your users can:
 
 ### Get started
 
-* [Display Your Fields](./?path=/story/features-enrich-data-extension--display-extended-fields)
-* [Enable Filters](./?path=/story/features-enrich-data-extension--enable-filters-for-extended-fields)
-* [Allow Your Users to Add Extended Fields](./?path=/story/features-enrich-data-extension--allow-users-to-add-extended-fields)
+* [Display Your Fields](<Display Extended Fields.md>)
+* [Enable Filters](<Enable Filters for Extended Fields.md>)
+* [Allow Your Users to Add Extended Fields](<Allow Users to Add Extended Fields.md>)
 
 ### Examples
 
@@ -40,7 +40,7 @@ For detailed code samples, check out the **Examples** tab.
 
 ### I integrated with CustomFieldsWidget and I need a way to get the data from the form. How can I do that?
 
-If you need a way to retrieve data from the form, you can use the `validate` and `isDirty` methods that are part of the [FormPageState](./?path=/story/common-state--formpagestate). These methods allow you to validate the form data and determine if any changes have been made respectively. To access them, you can retrieve the `state` directly from [useWidgetsFormContext](./?path=/story/common-hooks--usewidgetsformcontext) hook. Take a look at the [CustomFieldsWidget](./?path=/story/features-enrich-data-extension-components--customfieldswidget) for a complete example.
+If you need a way to retrieve data from the form, you can use the `validate` and `isDirty` methods that are part of the [FormPageState](FormPageState.md). These methods allow you to validate the form data and determine if any changes have been made respectively. To access them, you can retrieve the `state` directly from [useWidgetsFormContext](useWidgetsFormContext.md) hook. Take a look at the [CustomFieldsWidget](CustomFieldsWidget.md) for a complete example.
 
 ### Is there a restriction on the amount of data that can be stored in the custom fields? If so, what is it?
 
@@ -48,7 +48,7 @@ Yes, there is a limit to the data you can store in the custom fields. You can st
 
 ### Can I open the custom field modal from my code? If so, how?
 
-Absolutely! You have the ability to open the modal directly from your code. To do so, simply call the `openCustomFieldModal` method, which is available through the [ToolbarCollectionState](./?path=/story/common-state--toolbarcollectionstate). To access it, call `state.toolbar.openCustomFieldModal()` where state represents the result of invoking either [useTableCollection](./?path=/story/base-components-collections-table-usetablecollection--usetablecollection) or [useGridCollection](./?path=/story/base-components-collections-grid-usegridcollection--usegridcollection).
+Absolutely! You have the ability to open the modal directly from your code. To do so, simply call the `openCustomFieldModal` method, which is available through the [ToolbarCollectionState](ToolbarCollectionState.md). To access it, call `state.toolbar.openCustomFieldModal()` where state represents the result of invoking either [useTableCollection](useTableCollection.md) or [useGridCollection](useGridCollection.md).
 
 ### If a TPA creates custom fields, will those fields be visible?
 

package/dist/docs/DataResultRaw.md

@@ -12,7 +12,7 @@ The return type of the `fetchData` function passed to collection hooks. Contains
 
 ### Description
 
-You must return a `DataResultRaw` object from `fetchData()` in collection hooks, such as [`useTableCollection()`](./?path=/story/base-components-collections-table-usetablecollection--usetablecollection) and [`useGridCollection()`](./?path=/story/base-components-collections-grid-usegridcollection--usegridcollection).
+You must return a `DataResultRaw` object from `fetchData()` in collection hooks, such as [`useTableCollection()`](useTableCollection.md) and [`useGridCollection()`](useGridCollection.md).
 
 
 ### Props

package/dist/docs/Display Extended Fields.md

@@ -58,7 +58,7 @@ This step simply enabled the Data Extension features in your table. After the ne
 
 To add, show, reorder, and hide extended fields:
 
-1. Add the [Custom Columns feature](./?path=/story/features-display-custom-columns--customcolumns).
+1. Add the [Custom Columns feature](CustomColumns.md).
 
     ```diff
     <Table
@@ -105,9 +105,9 @@ To add an extra view of extended fields in the entity page:
 
 ### See also
 
-* [Data Extension Overview](./?path=/story/features-enrich-data-extension--data-extension-overview)
-* [Enable Filters for Extended Fields](./?path=/story/features-enrich-data-extension--enable-filters-for-extended-fields)
-* [Allow Users to Add Extended Fields](./?path=/story/features-enrich-data-extension--allow-users-to-add-extended-fields)
+* [Data Extension Overview](<Data Extension Overview.md>)
+* [Enable Filters for Extended Fields](<Enable Filters for Extended Fields.md>)
+* [Allow Users to Add Extended Fields](<Allow Users to Add Extended Fields.md>)
 
 
 ## Examples

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

@@ -27,7 +27,7 @@ Make sure that you have:
 
 * A Patterns [`Table`](./?path=%2Fstory%2Fbase-components-collections-table-table--table) component.
 * A server configured to [support data extensions](https://dev.wix.com/docs/rnd-general/articles/open-platform/data-extensions/data-extensions-101#backend).
-* Followed the [steps to display extended fields](./?path=/story/features-enrich-data-extension--display-extended-fields).
+* Followed the [steps to display extended fields](<Display Extended Fields.md>).
 
 ### Step 1 | Expose a Nile/Search endpoint
 
@@ -138,8 +138,8 @@ In your table component:
 
 ### See also
 
-* [Data Extension Overview](./?path=/story/features-enrich-data-extension--data-extension-overview)
-* [Allow Users to Add Extended Fields](./?path=/story/features-enrich-data-extension--allow-users-to-add-extended-fields)
+* [Data Extension Overview](<Data Extension Overview.md>)
+* [Allow Users to Add Extended Fields](<Allow Users to Add Extended Fields.md>)
 
 
 ## Examples

package/dist/docs/EntityPage.AdditionalContent.md

@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Overview
 
-A slot component for the side panel of an [`EntityPage`](./?path=/story/base-components-pages-entity-page--entitypage). Place it inside `<EntityPage.Content>` alongside `<EntityPage.MainContent>`. Supports an optional `sticky` prop to keep the content fixed while scrolling.
+A slot component for the side panel of an [`EntityPage`](EntityPage.md). Place it inside `<EntityPage.Content>` alongside `<EntityPage.MainContent>`. Supports an optional `sticky` prop to keep the content fixed while scrolling.
 
 ```tsx
 import { EntityPage } from '@wix/patterns';
@@ -16,7 +16,7 @@ import { EntityPage } from '@wix/patterns';
 
 ### Usage
 
-This component acts as a container for [EntityPage.Card](./?path=/story/base-components-pages-entity-page--entitypage-card) child components and is displayed on the right side of the Page layout. For examples of how this component is used, please refer to the [EntityPage](./?path=/story/base-components-pages-entity-page--entitypage) examples.
+This component acts as a container for [EntityPage.Card](EntityPage.Card.md) child components and is displayed on the right side of the Page layout. For examples of how this component is used, please refer to the [EntityPage](EntityPage.md) examples.
 
 ### Props
 

package/dist/docs/EntityPage.Card.md

@@ -206,7 +206,7 @@ function States() {
 
 ### Overview
 
-A card container used inside [`EntityPage.MainContent`](./?path=/story/base-components-pages-entity-page--entitypage-maincontent) or [`EntityPage.AdditionalContent`](./?path=/story/base-components-pages-entity-page--entitypage-additionalcontent). It wraps form fields and content sections with a card layout, and supports loading/error/success states for async content.
+A card container used inside [`EntityPage.MainContent`](EntityPage.MainContent.md) or [`EntityPage.AdditionalContent`](EntityPage.AdditionalContent.md). It wraps form fields and content sections with a card layout, and supports loading/error/success states for async content.
 
 ```tsx
 import { EntityPage } from '@wix/patterns';

package/dist/docs/EntityPage.Content.md

@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Overview
 
-A layout slot for the body of an [`EntityPage`](./?path=/story/base-components-pages-entity-page--entitypage). Wraps `<EntityPage.MainContent>` and optionally `<EntityPage.AdditionalContent>` to create the two-column layout.
+A layout slot for the body of an [`EntityPage`](EntityPage.md). Wraps `<EntityPage.MainContent>` and optionally `<EntityPage.AdditionalContent>` to create the two-column layout.
 
 ```tsx
 import { EntityPage } from '@wix/patterns';
@@ -16,7 +16,7 @@ import { EntityPage } from '@wix/patterns';
 
 ### Usage
 
-This component acts as a container for [EntityPage.MainContent](./?path=/story/base-components-pages-entity-page--entitypage-maincontent) and [EntityPage.AdditionalContent](./?path=/story/base-components-pages-entity-page--entitypage-additionalcontent) components. For examples of how this component is used, please refer to the [EntityPage](./?path=/story/base-components-pages-entity-page--entitypage&tab=Examples) examples.
+This component acts as a container for [EntityPage.MainContent](EntityPage.MainContent.md) and [EntityPage.AdditionalContent](EntityPage.AdditionalContent.md) components. For examples of how this component is used, please refer to the [EntityPage](EntityPage.md) examples.
 
 ### Props
 

package/dist/docs/EntityPage.Header.md

@@ -78,7 +78,7 @@ function Basic() {
 
 ### More Actions
 
-This example displays a header with more actions CTA. To learn how to create a more actions menu, see [`MoreActions`](./?path=/story/features-actions-more-actions--more-actions).
+This example displays a header with more actions CTA. To learn how to create a more actions menu, see [`MoreActions`](<More Actions.md>).
 
 ```tsx
 import React from 'react';
@@ -236,7 +236,7 @@ function Badges() {
 
 ### Overview
 
-The header component for an [`EntityPage`](./?path=/story/base-components-pages-entity-page--entitypage). Renders the page title, optional subtitle, breadcrumbs, badges, and a more-actions menu. Place it as a direct child of `<EntityPage>`.
+The header component for an [`EntityPage`](EntityPage.md). Renders the page title, optional subtitle, breadcrumbs, badges, and a more-actions menu. Place it as a direct child of `<EntityPage>`.
 
 ```tsx
 import { EntityPage } from '@wix/patterns';

package/dist/docs/EntityPage.MainContent.md

@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Overview
 
-A slot component for the main content area of an [`EntityPage`](./?path=/story/base-components-pages-entity-page--entitypage). Place it inside `<EntityPage.Content>`. This is where you render the primary form fields and cards.
+A slot component for the main content area of an [`EntityPage`](EntityPage.md). Place it inside `<EntityPage.Content>`. This is where you render the primary form fields and cards.
 
 ```tsx
 import { EntityPage } from '@wix/patterns';
@@ -16,7 +16,7 @@ import { EntityPage } from '@wix/patterns';
 
 ### Usage
 
-This component acts as a container for [EntityPage.Card](./?path=/story/base-components-pages-entity-page--entitypage-card) child components and is displayed on the left side of the Page layout. For examples of how this component is used, please refer to the [EntityPage](./?path=/story/base-components-pages-entity-page--entitypage&tab=Examples) examples.
+This component acts as a container for [EntityPage.Card](EntityPage.Card.md) child components and is displayed on the left side of the Page layout. For examples of how this component is used, please refer to the [EntityPage](EntityPage.md) examples.
 
 ### Props
 

package/dist/docs/EntityPage.Slots.md

@@ -62,7 +62,7 @@ function Basic() {
 
 ### Overview
 
-A slot container for rendering TPA plugin widgets inside an [`EntityPage`](./?path=/story/base-components-pages-entity-page--entitypage). Pass a `containerId` from your Dev Center app to render third-party plugins in the entity page layout. Learn more about [Slots and Plugins](./?path=/story/features-enrich-slots-and-plugins--slots-and-plugins).
+A slot container for rendering TPA plugin widgets inside an [`EntityPage`](EntityPage.md). Pass a `containerId` from your Dev Center app to render third-party plugins in the entity page layout. Learn more about [Slots and Plugins](./?path=/story/features-enrich-slots-and-plugins--slots-and-plugins).
 
 ```tsx
 import { EntityPage } from '@wix/patterns';