@wix/patterns 1.461.0 → 1.463.0

package/dist/docs/ToolbarFilters.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Filter/Components
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 The Toolbar Filters feature allows you to manipulate data from a collection by applying specific criteria, conditions, or filters. For example, you can use the Toolbar Filter to filter data displayed in a table. You can define any filter item as the default. 
@@ -97,12 +99,7 @@ Example code: read `dist/docs/ToolbarFilters/mini-toolbar-with-filters.tsx`
 
 ### Props
 
-Read `dist/dts-bundle/components/CollectionToolbarFilters.d.ts` for `ToolbarFilters`'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/components/CollectionToolbarFilters.d.ts` for `ToolbarFilters`'s props.
 
 ## BI
 

package/dist/docs/ToolbarSecondaryActions.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Actions/SecondaryActions
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Description

package/dist/docs/ToolbarTitle.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Display/Toolbar
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Description

package/dist/docs/Views.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Display/Views
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Description

package/dist/docs/WidgetsFormProvider.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Providers
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Overview
@@ -65,10 +67,5 @@ export const MyEntityPage = () => {
 
 ### Props
 
-Read `dist/dts-bundle/components/WidgetsFormProvider.d.ts` for `WidgetsFormProvider`'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/components/WidgetsFormProvider.d.ts` for `WidgetsFormProvider`'s props.
 

package/dist/docs/WixPatternsBMProvider.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Providers
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Overview
@@ -31,10 +33,5 @@ export default () => {
 
 ### Props
 
-Read `dist/dts-bundle/components/WixPatternsBMProvider.d.ts` for `WixPatternsBMProvider`'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/components/WixPatternsBMProvider.d.ts` for `WixPatternsBMProvider`'s props.
 

package/dist/docs/WixPatternsBaseProvider.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Providers
 
+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 @@
 `WixPatternsBaseProvider` is the minimal provider for Wix Patterns. It supplies the core container context without platform-specific integrations. Use this when building standalone applications or testing outside of Business Manager or Essentials.
 
 ```tsx
-import { WixPatternsBaseProvider } from '@wix/patterns';
+import { WixPatternsBaseProvider } from '@wix/patterns/essentials';
 ```
 
 ### Example
@@ -81,10 +83,5 @@ function App() {
 
 ### Props
 
-Read `dist/dts-bundle/components/WixPatternsBaseProvider.d.ts` for `WixPatternsBaseProvider`'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/components/WixPatternsBaseProvider.d.ts` for `WixPatternsBaseProvider`'s props.
 

package/dist/docs/WixPatternsEssentialsProvider.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Providers
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Overview
@@ -43,10 +45,5 @@ export default () => {
 
 ### Props
 
-Read `dist/dts-bundle/components/WixPatternsEssentialsProvider.d.ts` for `WixPatternsEssentialsProvider`'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/components/WixPatternsEssentialsProvider.d.ts` for `WixPatternsEssentialsProvider`'s props.
 

package/dist/docs/WixPatternsGizaProvider.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Providers
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Overview
@@ -37,10 +39,5 @@ export default () => {
 
 ### Props
 
-Read `dist/dts-bundle/components/WixPatternsGizaProvider.d.ts` for `WixPatternsGizaProvider`'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/components/WixPatternsGizaProvider.d.ts` for `WixPatternsGizaProvider`'s props.
 

package/dist/docs/WixPatternsProvider.md

@@ -2,6 +2,8 @@
 
 **Category:** Base Components/Providers
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## API
 
 ### Overview
@@ -75,9 +77,9 @@ The component `withDashboard()` returns takes a `location` prop. Under Yoshi BM
 flow the host passes it. In a **Wix CLI app** nothing passes props to the
 dashboard page component, so read it from the dashboard SDK yourself:
 
-```jsx
+```tsx
 import { useEffect, useState } from 'react';
-import { dashboard } from '@wix/dashboard';
+import { dashboard, type PageLocation } from '@wix/dashboard';
 import { WixDesignSystemProvider } from '@wix/design-system';
 import { withDashboard } from '@wix/patterns';
 import { WixPatternsProvider } from '@wix/patterns/provider';
@@ -91,7 +93,7 @@ const App = withDashboard(() => (
 ));
 
 export default function Page() {
-  const [location, setLocation] = useState();
+  const [location, setLocation] = useState<PageLocation>();
 
   useEffect(() => {
     const subscription = dashboard.observeState((_pageParams, environment) => {
@@ -112,10 +114,5 @@ export default function Page() {
 
 ### Props
 
-Read `dist/dts-bundle/components/WixPatternsProvider.d.ts` for `WixPatternsProvider`'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/components/WixPatternsProvider.d.ts` for `WixPatternsProvider`'s props.
 

package/dist/docs/Working with Cache.md

@@ -48,17 +48,17 @@ Consider having a BM page with a Wix Patterns table:
 
 ###### _src/pages/contacts-list-page/index.tsx_
 
-```jsx
+```tsx
 import React from 'react';
 import { queryContacts } from '@wix/ambassador-contacts-v4-contact/http';
-import { useCollection } from '@wix/patterns';
+import { OffsetQuery, useCollection } from '@wix/patterns';
 import { useHttpClient } from '@wix/yoshi-flow-bm';
 
 export default () => {
   const httpClient = useHttpClient();
   const collection = useCollection({
     queryName: 'wix.contacts.v4.contact',
-    fetchData: (query) => {
+    fetchData: (query: OffsetQuery) => {
       const { limit, offset, search, filters } = query;
       return httpClient.request(queryContacts(/* ... */)).then((res) => {
         /* ... */

package/dist/docs/arrayFilter.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
 
 ### Description
@@ -211,10 +213,5 @@ function customArrayFilter() {
 
 ### Props
 
-Read `dist/dts-bundle/functions/arrayFilter.d.ts` for `arrayFilter`'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/arrayFilter.d.ts` for `arrayFilter`'s props.
 

package/dist/docs/customFilter.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
@@ -160,10 +162,5 @@ function customFilterExample() {
 
 ### Props
 
-Read `dist/dts-bundle/functions/customFilter.d.ts` for `customFilter`'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/customFilter.d.ts` for `customFilter`'s props.
 

package/dist/docs/dateRangeFilter.Factories.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
@@ -39,10 +41,5 @@ function dateRangeFilterExample() {
 
 ### Props
 
-Read `dist/dts-bundle/functions/dateRangeFilter.d.ts` for `dateRangeFilter`'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/dateRangeFilter.d.ts` for `dateRangeFilter`'s props.
 

package/dist/docs/deleteSecondaryAction.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Actions/Action Cell
 
+Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
+
 ## Design
 
 ### Demo
@@ -106,10 +108,5 @@ function DeleteSecondaryAction() {
 
 ### Props
 
-Read `dist/dts-bundle/functions/deleteSecondaryAction.d.ts` for `deleteSecondaryAction`'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/deleteSecondaryAction.d.ts` for `deleteSecondaryAction`'s props.
 

package/dist/docs/idNameArrayFilter.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
@@ -146,7 +148,9 @@ The response from the `/fake-entity` endpoint includes the `id` and `name` of th
 
 ```tsx
 import React from 'react';
+import { useHttpClient } from '@wix/yoshi-flow-bm';
 import {
+  OffsetQuery,
   idNameArrayFilter,
   MultiSelectCollectionFilter,
   useFilterCollection,
@@ -156,14 +160,14 @@ import { Cell, Layout } from '@wix/design-system';
 function defaultFields() {
   const [filter] = React.useState(() => idNameArrayFilter());
 
-  const fakeEntityHttpClient = useFakeEntityHttpClient();
+  const fakeEntityHttpClient = useHttpClient();
 
   const collection = useFilterCollection(filter, {
     queryName: 'fakeEntity-filter',
-    fetchData: (query) => {
+    fetchData: (query: OffsetQuery) => {
       const { limit, offset } = query;
       return fakeEntityHttpClient
-        .request({
+        .request<{ items: { id: string; name: string }[]; total: number }>({
           url: '/api/fake-entity',
           params: { limit, offset },
         })
@@ -191,10 +195,5 @@ function defaultFields() {
 
 ### Props
 
-Read `dist/dts-bundle/functions/idNameArrayFilter.d.ts` for `idNameArrayFilter`'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/idNameArrayFilter.d.ts` for `idNameArrayFilter`'s props.