@wix/patterns 1.462.0 → 1.464.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
@@ -179,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,162 @@ 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:
+
+```
+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.
+
+
+### Create route
+
+"Add new" is an entity page too, not a modal — and it is not the edit call with the
+id left out. Four things differ, three of them silently.
+
+**Register it as its own route, typed `createEntity`.** One component can serve both
+entity routes; the route is what tells them apart.
+
+
+```tsx
+<PatternsReactRoute type="collection"   path="/shifts"          element={<ShiftsCollectionPage />} />
+<PatternsReactRoute type="createEntity" path="/shifts/new"      element={<ShiftEntityPage />} />
+<PatternsReactRoute type="editEntity"   path="/shifts/:shiftId" element={<ShiftEntityPage />} />
+```
+
+**Navigate there without an `entity`.**
+[`navigateToEntityPage`](./?path=%2Fstory%2Fbase-components-pages-router-hooks-usepatternsnavigate--usepatternsnavigate)
+takes the argument so the header can render its title before the fetch resolves; on a
+create route there is no record to give it, so omit it and the title renders when your
+own `fetch` does. A placeholder record is the common workaround and is not needed — and
+is worse than nothing, because until `fetch` resolves that placeholder *is*
+`state.entity`.
+
+**`fetch` is required, and `{ entity: undefined }` is the create answer.** Its type is
+`() => Promise<{ entity: T | undefined }>`; the `undefined` is that case, not a loading
+state. There is nothing to load, so resolve straight away rather than reaching for a
+`fetch`-less variant, which does not exist.
+
+**Set `isNewEntity`.** It is the only param that tells the page which route it is on.
+Omitted, the page infers from data — an entity is loaded, so this must be an edit — and
+a create page that seeds local defaults through `fetch` is then announced to the
+collection as an *update*. The collection changes a row it does not have instead of
+adding one: the new record never appears in the list, and the only trace is a
+`Fetched page info for updated entity not found` console error.
+
+A page that only ever creates passes `isNewEntity: true` and a `fetch` that resolves
+empty. More often one component serves both routes, and the presence of the route param
+answers all four at once:
+
+```tsx
+import React from 'react';
+import { useParams } from 'react-router-dom';
+import { EntityPage, useEntityPage } from '@wix/patterns';
+import { useForm } from '@wix/patterns/form';
+
+interface Shift {
+  id?: string;
+  name?: string;
+}
+
+interface ShiftFormFields {
+  name?: string;
+}
 
-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.
+const api = {
+  getShift: (id: string): Promise<Shift> =>
+    Promise.resolve({ id, name: 'Morning' }),
+  createShift: (values: Partial<Shift>): Promise<Shift> =>
+    Promise.resolve({ id: 'generated-id', ...values }),
+  updateShift: (id: string, values: Partial<Shift>): Promise<Shift> =>
+    Promise.resolve({ id, ...values }),
+  deleteShift: (_id: string): Promise<void> => Promise.resolve(),
+};
+
+// One component behind both entity routes — `/shifts/new` (`type="createEntity"`)
+// and `/shifts/:shiftId` (`type="editEntity"`). Which route it is on is the
+// presence of the param, and that one answer feeds four separate params.
+function ShiftEntityPage() {
+  const { shiftId } = useParams<{ shiftId?: string }>();
+  const isNewEntity = !shiftId;
+
+  const form = useForm<ShiftFormFields>({ defaultValues: { name: '' } });
+
+  const state = useEntityPage<Shift, ShiftFormFields>({
+    parentPath: '/shifts',
+    form,
+    // Decides how the save is announced to the collection — created vs
+    // updated. Omitted, the announcement follows whether an entity was
+    // loaded, so a create page that seeds defaults through `fetch` is
+    // announced as an update.
+    isNewEntity,
+    // `fetch` is required on both routes. `{ entity: undefined }` is the
+    // create case built into its return type, not a loading state.
+    fetch: () =>
+      shiftId
+        ? api.getShift(shiftId).then((entity) => ({ entity }))
+        : Promise.resolve({ entity: undefined }),
+    // `updatedEntity` is the key name for an insert too.
+    onSave: async ({ widgetsFormData }) => {
+      const values = { ...form.getValues(), ...widgetsFormData };
+      const updatedEntity = shiftId
+        ? await api.updateShift(shiftId, values)
+        : await api.createShift(values);
+      return { updatedEntity };
+    },
+    saveSuccessToast: isNewEntity ? 'Shift added' : 'Shift updated',
+    // A record that does not exist yet has nothing to delete.
+    ...(isNewEntity
+      ? {}
+      : {
+          deleteAction: {
+            onDelete: (shift: Shift) => api.deleteShift(shift.id!),
+          },
+        }),
+  });
+
+  return (
+    <EntityPage state={state}>
+      <EntityPage.Header
+        title={{ text: isNewEntity ? 'Add Shift' : state.entity?.name ?? '' }}
+      />
+      <EntityPage.Content>
+        <EntityPage.MainContent>...</EntityPage.MainContent>
+      </EntityPage.Content>
+    </EntityPage>
+  );
+}
+
+export default ShiftEntityPage;
+```
+
+The header title is the same conditional the params are: `isNewEntity ? 'Add Shift' :
+state.entity?.name`.
+
+One consequence of how the hook is built: `useEntityPage` reads its params once, in a
+`useState` initializer, so a boolean `isNewEntity` is fixed at mount. That is what you
+want when each route mounts its own page. Pass the getter form —
+`isNewEntity?: boolean | (() => boolean)` — to read a live source when a single mounted
+page survives the route change instead.
+
+
+### 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/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,18 +2,21 @@
 
 **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
 
 The `usePatternsNavigate` hook provides functions to navigate between pages in a Patterns React application.
 
-
 ### Usage
+
 This hook returns an object with two functions that you can use:
 
 ```ts
-const { navigateToCollectionPage, navigateToEntityPage } = usePatternsNavigate();
+const { navigateToCollectionPage, navigateToEntityPage } =
+  usePatternsNavigate();
 ```
 
 The `navigateToCollectionPage` function is used to navigate to a collection page. \
@@ -21,18 +24,18 @@ A good usecase for it, is to navigate to a collection page on a breadcrumb click
 It takes the path of the collection page as an argument:
 
 ```ts
-  <Breadcrumbs
-    activeId="current"
-    items={[
-      { id: 'root', value: 'Dummy Entity Collection' },
-      { id: 'current', value: 'Entity Page' },
-    ]}
-    onClick={(e) => {
-      if (e.id === 'root') {
-        navigateToCollectionPage({ path: '/entities' });
-      }
-    }}
-  />
+<Breadcrumbs
+  activeId="current"
+  items={[
+    { id: 'root', value: 'Dummy Entity Collection' },
+    { id: 'current', value: 'Entity Page' },
+  ]}
+  onClick={(e) => {
+    if (e.id === 'root') {
+      navigateToCollectionPage({ path: '/entities' });
+    }
+  }}
+/>
 ```
 
 The `navigateToEntityPage` function is used to navigate to an entity page. \
@@ -56,6 +59,27 @@ It takes the path of the entity page, and the entity as arguments:
    }}
 ```
 
+### Navigating to a create page
+
+`entity` is optional, because a create page has no record to pass yet. Omit it:
+
+```ts
+<PrimaryActions
+  label="Add shift"
+  onClick={() => navigateToEntityPage({ path: '/shifts/new' })}
+/>
+```
+
+Passing a placeholder object instead is a common workaround and is not needed —
+the header simply renders without a title until your own `fetch` resolves, and
+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)
+on `useEntityPage`, which has the worked component for a page serving both the
+create and the edit route.
+
 
 ```tsx
 import { usePatternsNavigate } from '@wix/patterns/router';
@@ -65,10 +89,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.
 

package/dist/dts-bundle/components/Grid.d.ts

@@ -53,6 +53,9 @@ interface Filter<T = any> {
 type FiltersMap = {
     [key: string]: Filter<any> | undefined;
 };
+type OptionalFiltersMap = {
+    [key: string]: undefined;
+};
 
 /**
  * `ComputedQuery` — cut here because it has its own bundle.
@@ -444,9 +447,9 @@ interface GridBaseProps<T, F extends FiltersMap> extends Omit<ToolbarCollectionB
     };
     layoutType?: LayoutType;
 }
-type GridBasePropsWithoutPreset<T, F extends FiltersMap> = Omit<GridBaseProps<T, F>, 'preset' | 'renderItem'>;
-type GridProps<T, F extends FiltersMap> = GridPresetProps<T, GridBasePropsWithoutPreset<T, F>>;
-declare function Grid<T, F extends FiltersMap = FiltersMap>(props: GridProps<T, F>): React__default.JSX.Element;
+type GridBasePropsWithoutPreset<T, F extends FiltersMap = OptionalFiltersMap> = Omit<GridBaseProps<T, F>, 'preset' | 'renderItem'>;
+type GridProps<T, F extends FiltersMap = OptionalFiltersMap> = GridPresetProps<T, GridBasePropsWithoutPreset<T, F>>;
+declare function Grid<T, F extends FiltersMap = OptionalFiltersMap>(props: GridProps<T, F>): React__default.JSX.Element;
 
 export { Grid };
 export type { GridBasePropsWithoutPreset, GridProps };