@wix/patterns 1.461.0 → 1.463.0

package/dist/docs/operatorFilter.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Filter/Factories
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Usage
@@ -42,6 +44,8 @@ import React from 'react';
 import { CollectionPage } from '@wix/patterns/page';
 import {
   operatorFilter,
+  OffsetQuery,
+  OperatorFilterState,
   FilterOperator,
   OperatorFilterPicker,
   transformOperatorFilterToWQL,
@@ -84,7 +88,12 @@ function operatorFilterWithTableExample() {
     filters: {
       name: nameFilter,
     },
-    fetchData: async ({ limit, offset, search, filters }) => {
+    fetchData: async ({
+      limit,
+      offset,
+      search,
+      filters,
+    }: OffsetQuery<{ name: OperatorFilterState<string> }>) => {
       const nameFilters = filters.name
         ? transformOperatorFilterToWQL('name', filters.name)
         : [];
@@ -101,7 +110,9 @@ function operatorFilterWithTableExample() {
             cursorPaging: { limit, offset },
           },
         }),
-      )) as { data: { contacts: Contact[]; pagingMetadata: { total: number } } };
+      )) as {
+        data: { contacts: Contact[]; pagingMetadata: { total: number } };
+      };
 
       return {
         items: response?.data?.contacts || [],
@@ -145,7 +156,9 @@ function operatorFilterWithTableExample() {
                   title: 'Created',
                   render: (contact) =>
                     contact.createdDate
-                      ? new window.Date(contact.createdDate).toLocaleDateString()
+                      ? new window.Date(
+                          contact.createdDate,
+                        ).toLocaleDateString()
                       : '',
                 },
               ]}
@@ -168,10 +181,5 @@ export default operatorFilterWithTableExample;
 
 ### Props
 
-Read `dist/dts-bundle/functions/operatorFilter.d.ts` for `operatorFilter`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/functions/operatorFilter.d.ts` for `operatorFilter`'s props.
 

package/dist/docs/stringFilter.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Filter/Factories
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Usage
@@ -197,10 +199,5 @@ function ContactsTable() {
 
 ### Props
 
-Read `dist/dts-bundle/functions/stringFilter.d.ts` for `stringFilter`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/functions/stringFilter.d.ts` for `stringFilter`'s props.
 

package/dist/docs/stringsArrayFilter.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Filter/Factories
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Usage
@@ -103,10 +105,5 @@ function statusFilter() {
 
 ### Props
 
-Read `dist/dts-bundle/functions/stringsArrayFilter.d.ts` for `stringsArrayFilter`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/functions/stringsArrayFilter.d.ts` for `stringsArrayFilter`'s props.
 

package/dist/docs/useCreateCollection.md

@@ -2,6 +2,8 @@
 
 **Category:** Common/Hooks
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Overview
@@ -10,10 +12,5 @@ React hook that that retuns a function that initializes a collection state. Simi
 
 ### Props
 
-Read `dist/dts-bundle/hooks/useCreateCollection.d.ts` for `useCreateCollection`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/useCreateCollection.d.ts` for `useCreateCollection`'s props.
 

package/dist/docs/useEntity.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Entity Page/Hooks/useEntity
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Overview
@@ -69,10 +71,5 @@ Returns [`EntityPageState`](./?path=/story/base-components-pages-entity-page-sta
 
 ### Props
 
-| Prop | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `panels` | `SidePanelsState \| null` | Yes | - | The page's side-panel host, the way a table's lives on its toolbar. Attached by the first feature that needs one, through `SidePanelsState.setOnPage` — so a page with no panels neither builds nor bundles the side-panel code. Everything on the page shares this host, which is what keeps one panel open at a time. |
-| `customColumnsState` | `CustomColumnsEntityPageState \| null` | Yes | - | The fields card's "Manage fields" state, set by the card that owns it — the panel is rendered by the host with no props and reads it from here, as a table's panel reads `toolbar.customColumnsState`. |
-| `fieldsContainer` | `PatternsFieldsAppContainer \| undefined` | Yes | - | The container the page's field renderers are built with — the one the schema carries, so a table on the same schema shares it. Initialized in `init()` below, next to the schema load the fields also wait on; the schema-entry EntityPage puts it in React context. |
-| `holdSave` | `() => () => void` | Yes | - | Blocks `handleSubmit` until the returned release is called (idempotent). For features whose form fields are not mounted yet — react-hook-form only validates mounted controls, so a save in that window would skip their required-field validation. |
+Read `dist/dts-bundle/hooks/useEntity.d.ts` for `useEntity`'s props.
 

package/dist/docs/useEntityPage.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Entity Page/Hooks/useEntityPage
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Overview
@@ -68,12 +70,31 @@ export default EditShift;
 
 [EntityPageState](./?path=/story/base-components-pages-entity-page-state--entitypagestate)
 
-### Props
+### Typing the call
+
+The signature takes two generics — the entity type **and** the form-values type:
+
+
+```tsx
+useEntityPage<T, V extends FieldValues = FieldValues>(props: UseEntityPageParams<T, V>)
+```
+
+`V` is not inferred from the `form` argument. It falls back to `FieldValues`, so passing a
+typed `useForm<ShiftFormFields>()` while naming only the entity fails to assign:
 
-Read `dist/dts-bundle/hooks/useEntityPage.d.ts` for `useEntityPage`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
+```
+Type 'UseFormReturn<ShiftFormFields, any, ShiftFormFields>' is not assignable to
+type 'UseFormReturn<FieldValues, any, FieldValues>'
+```
+
+Naming a single generic works only when the form is untyped.
+
+The tempting fix is `useEntityPage<any, ShiftFormFields>`, which resolves the error by giving
+up the entity type: `state.entity` becomes `any`, and every field access below it stops being
+checked. Name both.
+
+
+### Props
 
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/useEntityPage.d.ts` for `useEntityPage`'s props.
 

package/dist/docs/useEntityPageContext.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Entity Page/Hooks/useEntityPageContext
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Overview
@@ -9,7 +11,7 @@
 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.
 
 ```tsx
-import { useEntityPageContext } from '@wix/patterns/page';
+import { useEntityPageContext } from '@wix/patterns';
 ```
 
 ### Example
@@ -38,3 +40,7 @@ export default ShiftCardContent;
 
 [EntityPageState](./?path=/story/base-components-pages-entity-page-state--entitypagestate)
 
+### Props
+
+Read `dist/dts-bundle/hooks/useEntityPageContext.d.ts` for `useEntityPageContext`'s props.
+

package/dist/docs/useFilterCollection.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Filter/Hooks
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Overview
@@ -147,10 +149,5 @@ function ContactsFilterCollection() {
 
 ### Props
 
-Read `dist/dts-bundle/hooks/useFilterCollection.d.ts` for `useFilterCollection`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/useFilterCollection.d.ts` for `useFilterCollection`'s props.
 

package/dist/docs/useGridCollection.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Collections/Grid/useGridCollection
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Description
@@ -14,6 +16,7 @@ import { useGridCollection } from '@wix/patterns';
 
 ### Example
 
+
 ```jsx
 import { useGridCollection, Grid } from '@wix/patterns';
 import { contacts } from '@wix/crm';
@@ -42,10 +45,5 @@ return (
 
 ### Props
 
-Read `dist/dts-bundle/hooks/useGridCollection.d.ts` for `useGridCollection`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/useGridCollection.d.ts` for `useGridCollection`'s props.
 

package/dist/docs/useGridFolders.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Collections/GridFolders/useGridFolders
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Description
@@ -18,10 +20,5 @@ import { useGridFolders } from '@wix/patterns';
 
 ### Props
 
-Read `dist/dts-bundle/hooks/useGridFolders.d.ts` for `useGridFolders`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/useGridFolders.d.ts` for `useGridFolders`'s props.
 

package/dist/docs/useNestedTable.md

@@ -29,6 +29,7 @@ import {
   useCreateCollection,
   Filter,
   stringsArrayFilter,
+  OffsetQuery,
 } from '@wix/patterns';
 import { CollectionPage } from '@wix/patterns/page';
 import { useHttpClient } from '@wix/yoshi-flow-bm';
@@ -56,7 +57,7 @@ function SingleEntityNestedTable() {
           filters: {
             parentId: stringsArrayFilter(),
           },
-          fetchData: (query) => {
+          fetchData: (query: OffsetQuery<ContactFilters>) => {
             const { limit, offset, search, filters } = query;
             return httpClient
               .request(

package/dist/docs/useOptimisticActions.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Actions/Updates
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Description
@@ -128,10 +130,5 @@ Example code: read `dist/docs/useOptimisticActions/custom-error-handling.tsx`
 
 ### Props
 
-Read `dist/dts-bundle/hooks/useOptimisticActions.d.ts` for `useOptimisticActions`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/useOptimisticActions.d.ts` for `useOptimisticActions`'s props.
 

package/dist/docs/usePatternsNavigate.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Pages/Router/Hooks/usePatternsNavigate
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Description
@@ -65,10 +67,5 @@ import { usePatternsNavigate } from '@wix/patterns/router';
 
 ### Props
 
-Read `dist/dts-bundle/hooks/usePatternsNavigate.d.ts` for `usePatternsNavigate`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/usePatternsNavigate.d.ts` for `usePatternsNavigate`'s props.
 

package/dist/docs/usePickerModal.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Collections/Picker/Hooks
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Description
@@ -131,10 +133,5 @@ function PickerModalSingleSelectExample() {
 
 ### Props
 
-Read `dist/dts-bundle/hooks/usePickerModal.d.ts` for `usePickerModal`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/usePickerModal.d.ts` for `usePickerModal`'s props.
 

package/dist/docs/useSettingsPageContext.md

@@ -9,7 +9,7 @@
 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.
 
 ```tsx
-import { useSettingsPageContext } from '@wix/patterns/page';
+import { useSettingsPageContext } from '@wix/patterns';
 ```
 
 ### Example

package/dist/docs/useStaticListFilterCollection.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Filter/Hooks
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Overview
@@ -187,10 +189,5 @@ function UseStaticListFilterCollectionExample() {
 
 ### Props
 
-Read `dist/dts-bundle/hooks/useStaticListFilterCollection.d.ts` for `useStaticListFilterCollection`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/useStaticListFilterCollection.d.ts` for `useStaticListFilterCollection`'s props.
 

package/dist/docs/useTableCollection.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Collections/Table/useTableCollection
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Description
@@ -14,6 +16,7 @@ import { useTableCollection } from '@wix/patterns';
 
 ### Example
 
+
 ```jsx
 import { useTableCollection, Table } from '@wix/patterns';
 import { contacts } from '@wix/crm';
@@ -42,10 +45,5 @@ return (
 
 ### Props
 
-Read `dist/dts-bundle/hooks/useTableCollection.d.ts` for `useTableCollection`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/useTableCollection.d.ts` for `useTableCollection`'s props.
 

package/dist/docs/useTableFolders.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Collections/TableFolders/useTableFolders
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Description
@@ -18,10 +20,5 @@ import { useTableFolders } from '@wix/patterns';
 
 ### Props
 
-Read `dist/dts-bundle/hooks/useTableFolders.d.ts` for `useTableFolders`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/useTableFolders.d.ts` for `useTableFolders`'s props.
 

package/dist/docs/useTableGridSwitchCollection.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Collections/TableGridSwitch/useTableGridSwitchCollection
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Description
@@ -14,6 +16,7 @@ import { useTableGridSwitchCollection } from '@wix/patterns';
 
 ### Example
 
+
 ```jsx
 import { Contact } from '@wix/ambassador-contacts-v4-contact/types';
 import { useTableGridSwitchCollection, TableGridSwitch } from '@wix/patterns';
@@ -42,10 +45,5 @@ return (
 
 ### Props
 
-Read `dist/dts-bundle/hooks/useTableGridSwitchCollection.d.ts` for `useTableGridSwitchCollection`'s full prop list, with types and
-descriptions. They are not repeated here, so the bundle is the single source of truth.
-
-A one-line stub in that file is an answer, not a truncation: an empty body with a
-"Produced by" note means you get the value from that hook or factory rather than
-constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
+Read `dist/dts-bundle/hooks/useTableGridSwitchCollection.d.ts` for `useTableGridSwitchCollection`'s props.