@wix/patterns 1.478.0 → 1.479.0

package/dist/docs/createNestedTableLevel.md

@@ -6,7 +6,7 @@
 
 ### Overview
 
-A helper function that creates a [`NestedTableLevel`](./?path=/story/base-components-collections-nestedtable--nestedtablelevel) descriptor without specifying `depth` (depth is assigned automatically based on array position). Pass the result to the `levels` array in [`useNestedTable`](./?path=/story/base-components-collections-nestedtable-usenestedtable--usenestedtable).
+A helper function that creates a [`NestedTableLevel`](NestedTableLevel.md) descriptor without specifying `depth` (depth is assigned automatically based on array position). Pass the result to the `levels` array in [`useNestedTable`](useNestedTable.md).
 
 ### Props
 
@@ -19,6 +19,6 @@ A helper function that creates a [`NestedTableLevel`](./?path=/story/base-compon
 | `breadcrumbs` | `((item: T) => { id: string; name: string; }[] \| null)` | No | - | A function that accepts the item of the current level and returns an array of breadcrumbs to be displayed in the toolbar. Each breadcrumb is an object with `id` and `name` properties. `fetchData` will be called with `query.fields` that contains the value `breadcrumbs` to signal that the breadcrumbs should be fetched. |
 | `expandable` | `((item: T) => boolean)` | No | - | A function that accepts the item of the current level and returns a boolean value that indicates whether the item can be expanded. By default, all items are expandable. |
 | `parentKey` | `(item: T) => string \| null \| undefined` | Yes | - | A function that accepts the item of the current level and returns the key of the parent item, for example: `(item) => item.parentId`. |
-| `createCollection` | `(params?: NestedOptimisticActionsState<T, F> \| undefined) => { collection: CollectionState<T, F>; parentFilter?: Filter<...> \| undefined; }` | Yes | - | A function that creates a collection for the current level (using [useCreateCollection](./?path=/story/common-hooks--usecreatecollection) hook), and returns the collection state and a reference to a filter object within this collection that filters the collection by the parent key. => { collection: [CollectionState](./?path=/story/common-state--collectionstate); parentFilter?: [Filter<string[]>](./?path=/story/features-filter-factories--stringsarrayfilter); } |
-| `optimisticActionsPredicate` | `((query: ComputedQuery<F>) => (item: T) => boolean)` | No | - | A [predicate](./?path=/story/features-actions-updates--useoptimisticactions) function to pass to the internal [OptimisticActions](/?path=/story/features-actions-updates--collectionoptimisticactions) created by NestedTable |
+| `createCollection` | `(params?: NestedOptimisticActionsState<T, F> \| undefined) => { collection: CollectionState<T, F>; parentFilter?: Filter<...> \| undefined; }` | Yes | - | A function that creates a collection for the current level (using [useCreateCollection](useCreateCollection.md) hook), and returns the collection state and a reference to a filter object within this collection that filters the collection by the parent key. => { collection: [CollectionState](CollectionState.md); parentFilter?: [Filter<string[]>](stringsArrayFilter.md); } |
+| `optimisticActionsPredicate` | `((query: ComputedQuery<F>) => (item: T) => boolean)` | No | - | A [predicate](useOptimisticActions.md) function to pass to the internal [OptimisticActions](/?path=/story/features-actions-updates--collectionoptimisticactions) created by NestedTable |
 

package/dist/docs/createNestedTableSingleEntityLevels.md

@@ -8,7 +8,7 @@
 
 A helper function to create multiple nested table levels out of the same configurations for a single entity type.
 
-It's the same as [createNestedTableLevel](./?path=/story/base-components-collections-nestedtable--createnestedtablelevel) for cases where all levels are of the same entity type.
+It's the same as [createNestedTableLevel](createNestedTableLevel.md) for cases where all levels are of the same entity type.
 
 
 ### Props

package/dist/docs/customFilter.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Usage
 
-A generic filter factory to be passed to [useCollection](./?path=/story/common-hooks--usecollection) `filters` property. This factory, allows creating custom filters that are not provided by Wix Patterns.
+A generic filter factory to be passed to [useCollection](useCollection.md) `filters` property. This factory, allows creating custom filters that are not provided by Wix Patterns.
 
 To create a custom filter, we must implement 2 different parts:
 
@@ -36,7 +36,7 @@ import { customFilter } from '@wix/patterns';
 
 ### Custom date filter component
 
-An example of creating a custom date filter component, though in practice it is recommended to use the pre-built [DateRangeFilter](./?path=/story/features-filter-components--daterangefilter) component instead.
+An example of creating a custom date filter component, though in practice it is recommended to use the pre-built [DateRangeFilter](DateRangeFilter.Components.md) component instead.
 
 ```tsx
 import { Avatar, DatePicker } from '@wix/design-system';

package/dist/docs/dateRangeFilter.Factories.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Usage
 
-The filter is used together with [DateRangeFilter](./?path=/story/features-filter-components--daterangefilter) component. Check the component examples section to see all possibilities for this filter.
+The filter is used together with [DateRangeFilter](DateRangeFilter.Components.md) component. Check the component examples section to see all possibilities for this filter.
 
 **Do:**
 

package/dist/docs/index.json

@@ -604,6 +604,17 @@
     "category": "Guides",
     "summary": "**Next.js** is replacing the Yoshi fullstack flow. It's not yet officially supported by the infra team, however early adopters can try it out using the WIX Next.js template."
   },
+  "Page Templates": {
+    "file": "Page Templates.md",
+    "category": "Guides",
+    "summary": "Start a dashboard page from one of the page templates rather than from an empty file. Each is a complete, working page that this package compiles against its own release, shipped as a directory under `dist/templates/` and listed on its docs-index entry as `templateFiles`.",
+    "relatedTemplates": [
+      "Collection and Entity Template",
+      "Collection and Read-Only Detail Template",
+      "Settings Page Template",
+      "CMS Collection and Entity Template"
+    ]
+  },
   "Reading the Doc Indices": {
     "file": "Reading the Doc Indices.md",
     "category": "Guides",
@@ -1223,6 +1234,115 @@
     "summary": "The `TagsWidget` component enhances the entity page by displaying the tags that are associated with the entity. It also enables to add new tags to the entity, and remove existing tags from it.",
     "importPath": "@wix/patterns"
   },
+  "CMS Collection and Entity Template": {
+    "file": "CMS Collection and Entity Template.md",
+    "category": "Templates",
+    "summary": "A complete dashboard page over a CMS collection, driven by its schema: a collection page whose columns, search and item names come from the collection's fields, an entity page whose form renders every field with the right control, and the router between them. Use it whenever the rows are a CMS collection, whether your app ships it or the site already has it.",
+    "relatedComponents": [
+      "withDashboard",
+      "WixPatternsProvider",
+      "PatternsReactRouter",
+      "PatternsReactRoute",
+      "CollectionPage",
+      "useSchemaSource",
+      "Table",
+      "useTableCollection",
+      "CollectionEmptyState",
+      "CollectionNoResultsState",
+      "CollectionErrorState",
+      "PrimaryActions",
+      "usePatternsNavigate",
+      "EntityPage",
+      "useEntityPage",
+      "useEntity"
+    ],
+    "templateFiles": [
+      "cms-collection-entity/ItemEntityPage.tsx",
+      "cms-collection-entity/ItemsApp.tsx",
+      "cms-collection-entity/ItemsCollectionPage.tsx",
+      "cms-collection-entity/collection.ts",
+      "cms-collection-entity/page.tsx"
+    ]
+  },
+  "Collection and Read-Only Detail Template": {
+    "file": "Collection and Read-Only Detail Template.md",
+    "category": "Templates",
+    "summary": "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.",
+    "relatedComponents": [
+      "withDashboard",
+      "WixPatternsProvider",
+      "PatternsReactRouter",
+      "PatternsReactRoute",
+      "CollectionPage",
+      "useTableCollection",
+      "Table",
+      "CollectionSearch",
+      "CollectionToolbarFilters",
+      "MultiSelectCheckboxFilter",
+      "stringsArrayFilter",
+      "CollectionEmptyState",
+      "CollectionNoResultsState",
+      "CollectionErrorState",
+      "usePatternsNavigate"
+    ],
+    "templateFiles": [
+      "collection-detail/ItemDetailPage.tsx",
+      "collection-detail/ItemsApp.tsx",
+      "collection-detail/ItemsCollectionPage.tsx",
+      "collection-detail/items-api.ts",
+      "collection-detail/page.tsx"
+    ]
+  },
+  "Collection and Entity Template": {
+    "file": "Collection and Entity Template.md",
+    "category": "Templates",
+    "summary": "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.",
+    "relatedComponents": [
+      "withDashboard",
+      "WixPatternsProvider",
+      "PatternsReactRouter",
+      "PatternsReactRoute",
+      "CollectionPage",
+      "useTableCollection",
+      "Table",
+      "CollectionSearch",
+      "CollectionToolbarFilters",
+      "MultiSelectCheckboxFilter",
+      "stringsArrayFilter",
+      "CollectionEmptyState",
+      "CollectionNoResultsState",
+      "CollectionErrorState",
+      "PrimaryActions",
+      "usePatternsNavigate",
+      "EntityPage",
+      "useEntityPage",
+      "useEntityPageContext"
+    ],
+    "templateFiles": [
+      "collection-entity/ItemEntityPage.tsx",
+      "collection-entity/ItemsApp.tsx",
+      "collection-entity/ItemsCollectionPage.tsx",
+      "collection-entity/items-api.ts",
+      "collection-entity/page.tsx"
+    ]
+  },
+  "Settings Page Template": {
+    "file": "Settings Page Template.md",
+    "category": "Templates",
+    "summary": "A complete dashboard page for app-wide settings with no list: the entry file, a settings page with one card of form fields, and the functions that load and store the settings. Use it when the page configures the app rather than listing records. Copy the whole directory, replace the fields with your own, and replace the bodies in the api file.",
+    "relatedComponents": [
+      "withDashboard",
+      "WixPatternsProvider",
+      "SettingsPage",
+      "useSettingsPage",
+      "useSettingsPageContext"
+    ],
+    "templateFiles": [
+      "settings-page/SettingsPageView.tsx",
+      "settings-page/page.tsx",
+      "settings-page/settings-api.ts"
+    ]
+  },
   "ToolbarCollectionState": {
     "file": "ToolbarCollectionState.md",
     "category": "Common/State",

package/dist/docs/useAmbassadorCollection.md

@@ -11,7 +11,7 @@ Some of that scaffolding is environment-scoped and is **not** needed to use this
 ### Overview
 
 A React hook that initializes a collection state using an Ambassador SDK package.
-The ambassador package should implement the [`crud.ts` module](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-design-patterns#platformization-guidelines_api-design-patterns_auto-crud-sdk-generation-experimental). This is a higher-level alternative to [`useCollection`](./?path=/story/common-hooks--usecollection) that auto-generates `fetchData`, `queryName`, and `itemKey` from the Ambassador SDK.
+The ambassador package should implement the [`crud.ts` module](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-design-patterns#platformization-guidelines_api-design-patterns_auto-crud-sdk-generation-experimental). This is a higher-level alternative to [`useCollection`](useCollection.md) that auto-generates `fetchData`, `queryName`, and `itemKey` from the Ambassador SDK.
 
 ```tsx
 import { useAmbassadorCollection } from '@wix/patterns';
@@ -96,7 +96,7 @@ function UseAmbassador() {
 
 ### Returns
 
-[CollectionState](./?path=/story/common-state--collectionstate)
+[CollectionState](CollectionState.md)
 
 ### Props
 

package/dist/docs/useCollection.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Overview
 
-The base React hook for creating a [`CollectionState`](./?path=/story/common-state--collectionstate). All other collection hooks (`useTableCollection`, `useGridCollection`, etc.) build on top of `useCollection`.
+The base React hook for creating a [`CollectionState`](CollectionState.md). All other collection hooks (`useTableCollection`, `useGridCollection`, etc.) build on top of `useCollection`.
 
 Use this hook directly when you need a collection state that is not tied to a specific component, or when building custom collection components.
 
@@ -55,7 +55,7 @@ export default ItemCount;
 
 ### Returns
 
-[CollectionState](./?path=/story/common-state--collectionstate)
+[CollectionState](CollectionState.md)
 
 ### Props
 

package/dist/docs/useCreateCollection.md

@@ -8,7 +8,7 @@ Paths written as `dist/…` below are relative to the `@wix/patterns` package ro
 
 ### Overview
 
-React hook that that retuns a function that initializes a collection state. Similiar to [useCollection](./?path=/story/common-hooks--usecollection), but it returns a function that initializes a collection state instead of the collection state itself.
+React hook that that retuns a function that initializes a collection state. Similiar to [useCollection](useCollection.md), but it returns a function that initializes a collection state instead of the collection state itself.
 
 ### Props
 

package/dist/docs/useCreateNestedOptimisticActions.md

@@ -6,16 +6,16 @@
 
 ### Overview
 
-A React hook that returns a function to create [OptimisticActions](./?path=/story/features-actions-updates--collectionoptimisticactions) instance for a nested table collection created in the `levels.createCollection` prop of [useNestedTable](./?path=/story/base-components-collections-nestedtable--usenestedtable).
+A React hook that returns a function to create [OptimisticActions](CollectionOptimisticActions.md) instance for a nested table collection created in the `levels.createCollection` prop of [useNestedTable](useNestedTable.md).
 
-For additional information and how to use it, see [Node API usage example](./?path=/story/base-components-collections-nestedtable--nestedtable#Node_API_usage)
+For additional information and how to use it, see [Node API usage example](NestedTable.md)
 
 
 ### Props
 
 | Prop | Type | Required | Default | Description |
 |------|------|----------|---------|-------------|
-| `collection` | `CollectionState<T, F>` | Yes | - | @required The collection that is created by [NestedTableLevel.createCollection](./?path=/story/base-components-collections-nestedtable--nestedtablelevel). |
-| `state` | `unknown` | Yes | - | The state object that passed to the [NestedTableLevel.createCollection](./?path=/story/base-components-collections-nestedtable--nestedtablelevel) - this must be passed here. |
-| `params` | `CollectionOptimisticActionsBaseParams<T, F>` | No | - | Additional [OptimisticActions](./?path=/story/features-actions-updates--useoptimisticactions) configuration. |
+| `collection` | `CollectionState<T, F>` | Yes | - | @required The collection that is created by [NestedTableLevel.createCollection](NestedTableLevel.md). |
+| `state` | `unknown` | Yes | - | The state object that passed to the [NestedTableLevel.createCollection](NestedTableLevel.md) - this must be passed here. |
+| `params` | `CollectionOptimisticActionsBaseParams<T, F>` | No | - | Additional [OptimisticActions](useOptimisticActions.md) configuration. |
 

package/dist/docs/useEntity.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Overview
 
-A React hook that subscribes to the entity from [`EntityPageState`](./?path=/story/base-components-pages-entity-page-state--entitypagestate) and returns it reactively. Use this when you need to access the entity outside of `Card.Content`, such as in the page header (title, subtitle, breadcrumbs, etc.).
+A React hook that subscribes to the entity from [`EntityPageState`](EntityPageState.md) and returns it reactively. Use this when you need to access the entity outside of `Card.Content`, such as in the page header (title, subtitle, breadcrumbs, etc.).
 
 **Important:** During the first render the entity will be `undefined` while data is being fetched. Do not rely on the initial value — always handle the `undefined` case.
 
@@ -69,7 +69,7 @@ export default ShiftPage;
 
 ### Returns
 
-Returns [`EntityPageState`](./?path=/story/base-components-pages-entity-page-state--entitypagestate)`.entity` — the current entity value (`T | undefined`).
+Returns [`EntityPageState`](EntityPageState.md)`.entity` — the current entity value (`T | undefined`).
 
 ### Props
 

package/dist/docs/useEntityPage.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Overview
 
-A React hook that creates the state for an [`EntityPage`](./?path=/story/base-components-pages-entity-page--entitypage). Configure entity fetching, save flow, form integration, toasts, and navigation. The returned [`EntityPageState`](./?path=/story/base-components-pages-entity-page-state--entitypagestate) is passed to `<EntityPage state={state}>`.
+A React hook that creates the state for an [`EntityPage`](EntityPage.md). Configure entity fetching, save flow, form integration, toasts, and navigation. The returned [`EntityPageState`](EntityPageState.md) is passed to `<EntityPage state={state}>`.
 
 ```tsx
 import { useEntityPage } from '@wix/patterns';
@@ -72,7 +72,7 @@ export default EditShift;
 
 ### Returns
 
-[EntityPageState](./?path=/story/base-components-pages-entity-page-state--entitypagestate)
+[EntityPageState](EntityPageState.md)
 
 ### Typing the call
 
@@ -249,7 +249,7 @@ definite yes, so nothing here is for you to wire.
    otherwise. There is no navigate call for you to make on success.
 3. **It hands the saved entity to that parent** in router state, under `_createdEntity` or
    `_updatedEntity`. Which one is `isNewEntity`'s doing, falling back to whether `fetch`
-   loaded an entity — the [Create route](./?path=/story/base-components-pages-entity-page-hooks-useentitypage--useentitypage)
+   loaded an entity — the [Create route](useEntityPage.md)
    section covers why that matters. `transformEntityToCollectionItem` shapes what is handed
    over, and defaults to passing the entity through; give it a function when the collection's
    row type is not the entity type.

package/dist/docs/useEntityPageContext.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Overview
 
-A React hook that retrieves [`EntityPageState`](./?path=/story/base-components-pages-entity-page-state--entitypagestate) from React context. Use it in any child component rendered within [`EntityPage`](./?path=/story/base-components-pages-entity-page--entitypage) to access the page state without prop-drilling.
+A React hook that retrieves [`EntityPageState`](EntityPageState.md) from React context. Use it in any child component rendered within [`EntityPage`](EntityPage.md) to access the page state without prop-drilling.
 
 ```tsx
 import { useEntityPageContext } from '@wix/patterns';
@@ -40,7 +40,7 @@ export default ShiftCardContent;
 
 ### Returns
 
-[EntityPageState](./?path=/story/base-components-pages-entity-page-state--entitypagestate)
+[EntityPageState](EntityPageState.md)
 
 ### Props
 

package/dist/docs/useGridCollection.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-`useGridCollection` is a React hook designed to facilitate the management of the [`Grid`](./?path=/story/base-components-collections-grid-grid--grid) component.It returns a [`GridState`](./?path=/story/base-components-collections-grid-gridstate--gridstate) to pass to the `state` prop of the `Grid` component.
+`useGridCollection` is a React hook designed to facilitate the management of the [`Grid`](Grid.md) component.It returns a [`GridState`](GridState.md) to pass to the `state` prop of the `Grid` component.
 
 ```tsx
 import { useGridCollection } from '@wix/patterns';
@@ -43,7 +43,7 @@ return (
 
 ### Returns
 
-[GridState](./?path=/story/base-components-collections-grid-gridstate--gridstate)
+[GridState](GridState.md)
 
 ### Props
 

package/dist/docs/useGridFolders.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-`useGridFolders` is a React hook designed to facilitate the management of the [`GridFolders`](./?path=/story/base-components-collections-gridfolders-gridfolders--gridfolders) component.It returns a [`GridFoldersState`](./?path=/story/base-components-collections-gridfolders-gridfoldersstate--gridfoldersstate) to pass to the `state` prop of the `GridFolders` component.
+`useGridFolders` is a React hook designed to facilitate the management of the [`GridFolders`](GridFolders.md) component.It returns a [`GridFoldersState`](GridFoldersState.md) to pass to the `state` prop of the `GridFolders` component.
 
 ```tsx
 import { useGridFolders } from '@wix/patterns';
@@ -18,7 +18,7 @@ import { useGridFolders } from '@wix/patterns';
 
 ### Returns
 
-[GridFoldersState](./?path=/story/base-components-collections-gridfolders-gridfoldersstate--gridfoldersstate)
+[GridFoldersState](GridFoldersState.md)
 
 ### Props
 

package/dist/docs/useNestedTable.md

@@ -10,9 +10,9 @@ Some of that scaffolding is environment-scoped and is **not** needed to use this
 
 ### Description
 
-`useNestedTable` is a React hook that creates the state for a [`NestedTable`](./?path=/story/base-components-collections-nestedtable--nestedtable) component — a table that displays hierarchical data with expand/collapse, flat and nested view modes, and multi-level optimistic actions.
+`useNestedTable` is a React hook that creates the state for a [`NestedTable`](NestedTable.md) component — a table that displays hierarchical data with expand/collapse, flat and nested view modes, and multi-level optimistic actions.
 
-You define the hierarchy through `levels`, where each level describes how to fetch its items, how they relate to their parent, and how to render columns. The hook returns a [`NestedTableState`](./?path=/story/base-components-collections-nestedtable--nestedtablestate) to pass to `<NestedTable state={state} />`.
+You define the hierarchy through `levels`, where each level describes how to fetch its items, how they relate to their parent, and how to render columns. The hook returns a [`NestedTableState`](NestedTableState.md) to pass to `<NestedTable state={state} />`.
 
 ```tsx
 import { useNestedTable } from '@wix/patterns';
@@ -111,7 +111,7 @@ function SingleEntityNestedTable() {
 
 ### Returns
 
-[NestedTableState](./?path=/story/base-components-collections-nestedtable--nestedtablestate)
+[NestedTableState](NestedTableState.md)
 
 ### Props
 
@@ -120,7 +120,7 @@ function SingleEntityNestedTable() {
 | `fetchAllLimit` | `number` | No | `1000` | If the total items in the server are less or equal to this threshold, all items will be fetched and rendered at once, in expanded state (referred to as "Eager" mode). |
 | `fetchAllThreshold` | `number` | No | - | @deprecated Use `fetchAllLimit` instead. |
 | `expandAllThreshold` | `number` | No | ``fetchAllThreshold`` | In "Eager" mode, items will be in expanded state. This threshold allows to use collapsed state if the total items in the server are greater than this threshold. |
-| `columns` | `NestedTableColumn<C>[]` | Yes | - | Columns to be rendered in the nested table. Same as [TableColumn](./?path=/story/common-types--tablecolumn) - just without rendering logic of cells (`render` prop will be defined for each level individually in the `levels` prop). |
+| `columns` | `NestedTableColumn<C>[]` | Yes | - | Columns to be rendered in the nested table. Same as [TableColumn](TableColumn.md) - just without rendering logic of cells (`render` prop will be defined for each level individually in the `levels` prop). |
 | `mainColumn` | `{ title?: string; width?: string \| number; } \| undefined` | No | `'' - `width`: The width of the column. Can be a number (in pixels) or a string (percentage). '326px'` | Main column of the nested table. An object with the following properties: - `title`: The title of the column. |
-| `levels` | `Omit<NestedTableLevelDescriptor<C, any, any>, "depth">[]` | Yes | - | Configuration of the nested table levels. Use one of the helper function to create the levels configuration: - [createNestedTableLevel](./?path=/story/base-components-collections-nestedtable--createnestedtablelevel) - for cases where each level if of a different entity type. - [createNestedTableSingleEntityLevels](./?path=/story/base-components-collections-nestedtable--createnestedtablesingleentitylevels) - for cases where all levels are of the same entity type. |
+| `levels` | `Omit<NestedTableLevelDescriptor<C, any, any>, "depth">[]` | Yes | - | Configuration of the nested table levels. Use one of the helper function to create the levels configuration: - [createNestedTableLevel](createNestedTableLevel.md) - for cases where each level if of a different entity type. - [createNestedTableSingleEntityLevels](createNestedTableSingleEntityLevels.md) - for cases where all levels are of the same entity type. |
 

package/dist/docs/useOptimisticActions.md

@@ -19,10 +19,10 @@ The hook receives two parameters:
 
 - **params** - Optional parameters to configure the behavior of the optimistic actions.
 
-The hook returns an instance of [CollectionOptimisticActions](./?path=/story/features-actions-updates--collectionoptimisticactions), which encapsulates the optimistic actions for the provided collection.
+The hook returns an instance of [CollectionOptimisticActions](CollectionOptimisticActions.md), which encapsulates the optimistic actions for the provided collection.
 
 ### Returns
-[CollectionOptimisticActions](./?path=/story/features-actions-updates--collectionoptimisticactions)
+[CollectionOptimisticActions](CollectionOptimisticActions.md)
 
 ### Usage
 The following example uses the `useOptimisticActions` hook to initialize optimistic actions for the `state.collection`. It also passed optional parameters to configure the behavior of optimistic actions, such as custom predicate logic for filtering items.

package/dist/docs/usePatternsNavigate.md

@@ -83,7 +83,7 @@ until then the placeholder *is* the page's `state.entity`.
 
 The create page itself needs three more things — the `createEntity` route, a
 `fetch` that resolves empty, and `isNewEntity`. See
-[Create route](./?path=/story/base-components-pages-entity-page-hooks-useentitypage--useentitypage)
+[Create route](useEntityPage.md)
 on `useEntityPage`, which has the worked component for a page serving both the
 create and the edit route.
 

package/dist/docs/usePickerContent.md

@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-`usePickerContent` is a React hook that creates the collection state for the content displayed inside a [`PickerModal`](./?path=/story/base-components-picker--pickermodal). It extends the collection config (like `filters`, `itemName`) and adds picker-specific options such as `modalState`, `events`, and `initialSelect`.
+`usePickerContent` is a React hook that creates the collection state for the content displayed inside a [`PickerModal`](PickerModal.md). It extends the collection config (like `filters`, `itemName`) and adds picker-specific options such as `modalState`, `events`, and `initialSelect`.
 
 Define a `PickerContentComponent` that calls `usePickerContent` with the `modalState` received via props, then pass it to `usePickerModal` as `pickerContentComponent`.
 
@@ -74,7 +74,7 @@ The same config object, enriched with internal collection state. Pass it to `<Pi
 | `persistQueryToUrl` | `boolean` | No | `false` | Persist the selected filters, search & sort in the query parameters of the URL.<br/> For improved readability, sort & columns are formatted in CSV-like formatting, i.e "?sort=name+desc,price+asc". Do not use commas and/or spaces for your columns IDs.<br> Note: The filters from the selected view will be persist, but the actual view will not be selected |
 | `refreshOnColumnsChange` | `boolean` | No | `false` | Whether the collection refreshes when different columns are selected. <br> <br> Selected columns are passed in `fetchData(query.columns)`. |
 | `selectionConsistencyMode` | `"clear" \| "preserve"` | No | `preserve` | Preserve or clear selection after applying a new search or filter. |
-| `events` | `(CollectionEvents<F> & PickerEvents<T, F>)` | No | - | Optional callbacks for various events of the collection state lifecycle - `onInitialPageFetched` - when the first page of items is ready - `onSearch` - when fetching new items as a result new search - `onSearchResults` - when the result of a search is ready - `onNewPageStart` - when starting to load the next page of items - `onNewPageAdded` - when the result of the next page is ready - `onError` - When `fetchData` throws an error. Return `true` from this function if the error was reported and shouldn't be reported again internally. Optional callbacks for various events of the picker content lifecycle Extends [CollectionEvents](./?path=/story/common-hooks--usecollection) `onReady` - when picker content is ready `onInitialFetchError` - when there's an error loading the picker. When the callback returns a promise, the initial loader will keep showing until the promise is resolved (useful for cases of redirect to login for example). `onItemSelectClick` - when clicking on an item checkbox / radio button |
+| `events` | `(CollectionEvents<F> & PickerEvents<T, F>)` | No | - | Optional callbacks for various events of the collection state lifecycle - `onInitialPageFetched` - when the first page of items is ready - `onSearch` - when fetching new items as a result new search - `onSearchResults` - when the result of a search is ready - `onNewPageStart` - when starting to load the next page of items - `onNewPageAdded` - when the result of the next page is ready - `onError` - When `fetchData` throws an error. Return `true` from this function if the error was reported and shouldn't be reported again internally. Optional callbacks for various events of the picker content lifecycle Extends [CollectionEvents](useCollection.md) `onReady` - when picker content is ready `onInitialFetchError` - when there's an error loading the picker. When the callback returns a promise, the initial loader will keep showing until the promise is resolved (useful for cases of redirect to login for example). `onItemSelectClick` - when clicking on an item checkbox / radio button |
 | `modalState` | `PickerModalState<T, F>` | Yes | - | The modal state object passed from `<PickerModal />` |
 | `initialSelect` | `true \| ((item: T, index: number) => boolean) \| PickerSelection<T>` | No | - | Sets initial selection to the picker. Either:<br> - `boolean` - Sets the first item as selected. - `function` - A predicate for items to be selected in the picker. - `object` (Older API, new API below) - `selectedValues` - Specific selection - `isSelectAll` - All selected - `uncheckedValues` - Optional unchecked items - `partiallySelectedIds` - Items that should have 3rd indeterminate status - `object` (New API) - `values` - Initial selected values. Using this prop it's possible to specify the initial status of each pre-selected value. - `defaultStatus` - Forces this status on all items and all future items that will be loaded to the picker when scrolling. |
 

package/dist/docs/usePickerModal.md

@@ -12,7 +12,7 @@ Some of that scaffolding is environment-scoped and is **not** needed to use this
 
 ### Description
 
-`usePickerModal` is a React hook that creates the state for a [`PickerModal`](./?path=/story/base-components-picker--pickermodal). It accepts picker configuration (query name, fetch data, filters, pagination, selection callback) and a lazy-loaded `pickerContentComponent`. Import from the entry point that matches your environment.
+`usePickerModal` is a React hook that creates the state for a [`PickerModal`](PickerModal.md). It accepts picker configuration (query name, fetch data, filters, pagination, selection callback) and a lazy-loaded `pickerContentComponent`. Import from the entry point that matches your environment.
 
 ```tsx
 import { usePickerModal } from '@wix/patterns/bm';

package/dist/docs/usePickerStandalone.md

@@ -10,7 +10,7 @@ Some of that scaffolding is environment-scoped and is **not** needed to use this
 
 ### Description
 
-`usePickerStandalone` is a React hook that creates the state for a [`PickerStandalone`](./?path=/story/base-components-picker--pickerstandalone) component — a full-page picker for selecting an item and navigating to a destination URL. It extends [`useCollection`](./?path=/story/common-hooks--usecollection) with picker-specific options like `defaultDestinationUrl` and `initialSelect`.
+`usePickerStandalone` is a React hook that creates the state for a [`PickerStandalone`](PickerStandalone.md) component — a full-page picker for selecting an item and navigating to a destination URL. It extends [`useCollection`](useCollection.md) with picker-specific options like `defaultDestinationUrl` and `initialSelect`.
 
 ```tsx
 import { usePickerStandalone } from '@wix/patterns';
@@ -18,7 +18,7 @@ import { usePickerStandalone } from '@wix/patterns';
 
 ### Extends
 
-[`useCollection`](./?path=/story/common-hooks--usecollection)
+[`useCollection`](useCollection.md)
 
 ---
 

package/dist/docs/useSettingsPage.md

@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Overview
 
-A React hook that creates the state for a [`SettingsPage`](./?path=/story/base-components-pages-settings-page--settingspage). Configure settings fetching, save/cancel flow, form integration, and toasts. The returned [`SettingsPageState`](./?path=/story/base-components-pages-settings-page-state--settingspagestate) is passed to `<SettingsPage state={state}>`.
+A React hook that creates the state for a [`SettingsPage`](SettingsPage.md). Configure settings fetching, save/cancel flow, form integration, and toasts. The returned [`SettingsPageState`](SettingsPageState.md) is passed to `<SettingsPage state={state}>`.
 
 ```tsx
 import { useSettingsPage } from '@wix/patterns';
@@ -63,7 +63,7 @@ export default AppSettings;
 
 ### Returns
 
-[SettingsPageState](./?path=/story/base-components-pages-settings-page-state--settingspagestate)
+[SettingsPageState](SettingsPageState.md)
 
 ### Props
 

package/dist/docs/useSettingsPageContext.md

@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Overview
 
-A React hook that retrieves [`SettingsPageState`](./?path=/story/base-components-pages-settings-page-state--settingspagestate) from React context. Use it in any child component rendered within [`SettingsPage`](./?path=/story/base-components-pages-settings-page--settingspage) to access the page state without prop-drilling.
+A React hook that retrieves [`SettingsPageState`](SettingsPageState.md) from React context. Use it in any child component rendered within [`SettingsPage`](SettingsPage.md) to access the page state without prop-drilling.
 
 ```tsx
 import { useSettingsPageContext } from '@wix/patterns';
@@ -37,5 +37,5 @@ export default ThemeSummary;
 
 ### Returns
 
-[SettingsPageState](./?path=/story/base-components-pages-settings-page-state--settingspagestate)
+[SettingsPageState](SettingsPageState.md)
 

package/dist/docs/useStaticListFilterCollection.md

@@ -10,8 +10,8 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Overview
 
-`useStaticListFilterCollection` is a hook that connects a filter ([ArrayFilter](./?path=/story/features-filter-factories--arrayfilter), usually), to a [CollectionState](./?path=/story/common-state--collectionstate) created from a static list of items.
-It also providers search functionality (search term, will be matched against the [itemName](./?path=/story/features-filter-factories--arrayfilter&tab=API) function configured on the `filter` object).
+`useStaticListFilterCollection` is a hook that connects a filter ([ArrayFilter](arrayFilter.md), usually), to a [CollectionState](CollectionState.md) created from a static list of items.
+It also providers search functionality (search term, will be matched against the [itemName](arrayFilter.md) function configured on the `filter` object).
 
 
 

package/dist/docs/useTableCollection.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-`useTableCollection` is a React hook designed to facilitate the management of the [`Table`](./?path=/story/base-components-collections-table-table--table) component.It returns a [`TableState`](./?path=/story/base-components-collections-table-tablestate--tablestate) to pass to the `state` prop of the `Table` component.
+`useTableCollection` is a React hook designed to facilitate the management of the [`Table`](Table.md) component.It returns a [`TableState`](TableState.md) to pass to the `state` prop of the `Table` component.
 
 ```tsx
 import { useTableCollection } from '@wix/patterns';

package/dist/docs/useTableFolders.md

@@ -10,7 +10,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-`useTableFolders` is a React hook designed to facilitate the management of the [`TableFolders`](./?path=/story/base-components-collections-tablefolders-tablefolders--tablefolders) component.It returns a [`TableFoldersState`](./?path=/story/base-components-collections-tablefolders-tablefoldersstate--tablefoldersstate) to pass to the `state` prop of the `TableFolders` component.
+`useTableFolders` is a React hook designed to facilitate the management of the [`TableFolders`](TableFolders.md) component.It returns a [`TableFoldersState`](TableFoldersState.md) to pass to the `state` prop of the `TableFolders` component.
 
 ```tsx
 import { useTableFolders } from '@wix/patterns';
@@ -18,7 +18,7 @@ import { useTableFolders } from '@wix/patterns';
 
 ### Returns
 
-[TableFoldersState](./?path=/story/base-components-collections-tablefolders-tablefoldersstate--tablefoldersstate)
+[TableFoldersState](TableFoldersState.md)
 
 ### Props
 

package/dist/docs/useTableGridSwitchCollection.md

@@ -12,7 +12,7 @@ Some of that scaffolding is environment-scoped and is **not** needed to use this
 
 ### Description
 
-`useTableGridSwitchCollection` is a React hook designed to facilitate the management of the [`TableGridSwitch`](./?path=/story/base-components-collections-tablegridswitch-tablegridswitch--tablegridswitch) component.It returns a [`TableGridSwitchState`](./?path=/story/base-components-collections-tablegridswitch-tablegridswitchstate--tablegridswitchstate) to pass to the `state` prop of the `TableGridSwitch` component.
+`useTableGridSwitchCollection` is a React hook designed to facilitate the management of the [`TableGridSwitch`](TableGridSwitch.md) component.It returns a [`TableGridSwitchState`](TableGridSwitchState.md) to pass to the `state` prop of the `TableGridSwitch` component.
 
 ```tsx
 import { useTableGridSwitchCollection } from '@wix/patterns';
@@ -45,7 +45,7 @@ return (
 
 ### Returns
 
-[TableGridSwitchState](./?path=/story/base-components-collections-tablegridswitch-tablegridswitch--tablegridswitchstate)
+[TableGridSwitchState](TableGridSwitchState.md)
 
 ### Props
 

package/dist/docs/useTableGridSwitchFolders.md

@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
 
 ### Description
 
-`useTableGridSwitchFolders` is a React hook designed to facilitate the management of the [`TableGridSwitchFolders`](./?path=/story/base-components-collections-tablegridswitchfolders-tablegridswitchfolders--tablegridswitchfolders) component. It returns a [`TableGridSwitchFoldersState`](./?path=/story/base-components-collections-tablegridswitchfolders-tablegridswitchfoldersstate--tablegridswitchfoldersstate) to pass to the `state` prop of `TableGridSwitchFolders`.
+`useTableGridSwitchFolders` is a React hook designed to facilitate the management of the [`TableGridSwitchFolders`](TableGridSwitchFolders.md) component. It returns a [`TableGridSwitchFoldersState`](TableGridSwitchFoldersState.md) to pass to the `state` prop of `TableGridSwitchFolders`.
 
 ```tsx
 import { useTableGridSwitchFolders } from '@wix/patterns';
@@ -16,12 +16,12 @@ import { useTableGridSwitchFolders } from '@wix/patterns';
 
 ### Returns
 
-[TableGridSwitchFoldersState](./?path=/story/base-components-collections-tablegridswitchfolders-tablegridswitchfoldersstate--tablegridswitchfoldersstate)
+[TableGridSwitchFoldersState](TableGridSwitchFoldersState.md)
 
 ### Props
 
 | Prop | Type | Required | Default | Description |
 |------|------|----------|---------|-------------|
-| `items` | `CollectionState<T1, F1>` | Yes | - | A [collection state](./?path=/story/common-hooks--usecollection) that fetches items |
-| `folders` | `CollectionState<T2, F2>` | Yes | - | A [collection state](./?path=/story/common-hooks--usecollection) that fetches folders |
+| `items` | `CollectionState<T1, F1>` | Yes | - | A [collection state](useCollection.md) that fetches items |
+| `folders` | `CollectionState<T2, F2>` | Yes | - | A [collection state](useCollection.md) that fetches folders |