@wix/patterns 1.458.0 → 1.460.0

package/dist/docs/WixPatternsEssentialsProvider.md

@@ -41,3 +41,12 @@ 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.
+

package/dist/docs/WixPatternsGizaProvider.md

@@ -35,3 +35,12 @@ 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.
+

package/dist/docs/WixPatternsProvider.md

@@ -110,3 +110,12 @@ 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.
+

package/dist/docs/arrayFilter.md

@@ -211,16 +211,10 @@ function customArrayFilter() {
 
 ### Props
 
-| Prop | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `defaultValue` | `T[]` | No | - | The value to set the value to, when clearing the filter (Optional) |
-| `parse` | `(value: string \| Record<string, unknown> \| null \| undefined) => T \| null` | Yes | - | Convert a unknown object to a T.<br> If the function returns null, the item will be skipped when we try to deserializate it from an array. @param value |
-| `simplify` | `((value: T) => Partial<T>)` | No | - | Return a simplified form of an item for serialization. @param value |
-| `matches` | `((item: T, value: T[]) => boolean)` | No | - | Indicates whether an item matches the current value of the filter |
-| `equals` | `((item1: T, item2: T) => boolean)` | No | - | A function which accepts 2 items and returns true if they are equal |
-| `persistent` | `boolean` | No | - | Marks the filter as a "context" or "scope" filter. This makes the filter not be visible in the sub-toolbar tag list, not saved in views, not counted as "X filters applied". |
-| `initialValue` | `T[]` | No | - | The value to initialize the filter with (Optional) |
-| `itemKey` | `(item: T) => string` | Yes | - | A callback function that accepts an item and returns a unique ID of it. typically `item.id`. |
-| `itemName` | `(item: T) => string` | Yes | - | A callback function that accepts an item and returns the item name which is used in many messages through cairo |
-| `isCustomField` | `boolean` | No | - | If the filter is a custom field |
+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.
 

package/dist/docs/customFilter.md

@@ -160,23 +160,10 @@ function customFilterExample() {
 
 ### Props
 
-| Prop | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `defaultValue` | `T` | Yes | - | The value to set the value to, when clearing the filter. |
-| `isEmpty` | `(value: T) => boolean` | Yes | - | Indicates whether nothing is selected.<br> For example, when implementing a range filter, when both minimum and maximum inputs are empty |
-| `size` | `((value: T) => number)` | No | `A function that 0 when `isEmpty` returns true, and 1 otherwise.` | Indicates the number of effective filters.<br> For example, when implementing a range filter, 1 when only minimum/maximum are entered, 2 - when both entered. |
-| `toQueryString` | `((value: T) => string)` | No | - | Convert the filter value to a string, to be stored in a URL. |
-| `fromQueryString` | `((str: string) => T)` | No | - | Convert the a string value to the filter value, to be retrieved from a URL. |
-| `decode` | `(value: unknown) => T` | Yes | - | Convert a unknown object to a T.<br> If the function returns null, the item will be skipped when we try to deserializate it from an array. @param value |
-| `encode` | `(value: T) => unknown` | Yes | - | Return a simplified form of an item for serialization. @param value |
-| `toArray` | `(value: T) => FilterItem<T>[]` | Yes | - | Flatten the correct selection to an array, to be shown in the table sub-toolbar in a tag list. Usually this will return an array with a single item, but it gives control when we want to show more than a 1 tag in the tag list. |
-| `remove` | `((item: FilterItem<T>[], value: T) => T)` | No | `A function that returns `defaultValue`.` | Remove a tag from the tag list. |
-| `hasDiff` | `((data: T) => boolean)` | No | - | Indicates whether current filter value is different than `data` |
-| `matches` | `((item: FilterItem<T>, value: T) => boolean)` | No | - | Indicates whether an item matches the current value of the filter |
-| `equals` | `((item1: FilterItem<T>, item2: FilterItem<T>) => boolean)` | No | - | A function which accepts 2 items and returns true if they are equal |
-| `persistent` | `boolean` | No | - | Marks the filter as a "context" or "scope" filter. This makes the filter not be visible in the sub-toolbar tag list, not saved in views, not counted as "X filters applied". |
-| `initialValue` | `T` | No | - | The value to initialize the filter with (Optional) |
-| `itemKey` | `(item: FilterItem<T>) => string` | Yes | - | A callback function that accepts an item and returns a unique ID of it. typically `item.id`. |
-| `itemName` | `(item: FilterItem<T>) => string` | Yes | - | A callback function that accepts an item and returns the item name which is used in many messages through cairo |
-| `isCustomField` | `boolean` | No | - | If the filter is a custom field |
+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.
 

package/dist/docs/dateRangeFilter.Factories.md

@@ -39,17 +39,10 @@ function dateRangeFilterExample() {
 
 ### Props
 
-| Prop | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `parse` | `((value: unknown) => Date \| null)` | No | - | Convert an unknown object to a T. @param value |
-| `simplify` | `((value: Date) => Partial<Date>)` | No | - | Return a simplified form of an item for serialization. @param value |
-| `matches` | `((item: RangeItem<Date>, value: RangeItem<Date>) => boolean)` | No | - | Indicates whether an item matches the current value of the filter |
-| `isEmptyPreset` | `((preset?: string) => boolean)` | No | - | Indicates whether a preset does not exist or is empty |
-| `parsePreset` | `((preset?: string) => RangeItem<Date>)` | No | - | Converts a preset string to a RangeItem @param preset |
-| `persistent` | `boolean` | No | - | Marks the filter as a "context" or "scope" filter. This makes the filter not be visible in the sub-toolbar tag list, not saved in views, not counted as "X filters applied". |
-| `initialValue` | `RangeItem<Date>` | No | - | The value to initialize the filter with (Optional) |
-| `itemKey` | `((item: RangeItem<Date>) => string)` | No | - | A callback function that accepts an item and returns a unique ID of it. typically `item.id`. |
-| `itemName` | `((item: RangeItem<Date>) => string)` | No | - | A callback function that accepts an item and returns the item name which is used in many messages through cairo |
-| `equals` | `((item1: RangeItem<Date>, item2: RangeItem<Date>) => boolean)` | No | - | A function which accepts 2 items and returns true if they are equal |
-| `isCustomField` | `boolean` | No | - | If the filter is a custom field |
+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.
 

package/dist/docs/deleteSecondaryAction.md

@@ -106,17 +106,10 @@ function DeleteSecondaryAction() {
 
 ### Props
 
-| Prop | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `optimisticActions` | `CollectionOptimisticActions<T, F>` | Yes | - | Actions for performing optimistic updates on the collection. These updates are applied immediately for better user experience while waiting for the server response. |
-| `actionCellAPI` | `ActionCellAPI<T, F>` | Yes | - | API for interacting with the action cell. This API provides methods for manipulating and accessing the action cell's state. |
-| `submit` | `(items: T[]) => Promise<R>` | Yes | - | Function to submit the deletion operation. @param items - The items to delete. |
-| `showUndoToast` | `boolean` | No | `false` | Determines whether to display an undo toast before calling the server action. |
-| `showUndoSuccessToast` | `boolean` | No | `false` | Determines whether to display a toast after clicking on undo. |
-| `onUndo` | `(() => void)` | No | - | Callback function triggered when the user clicks on the undo button. |
-| `errorToast` | `((err: unknown, params: { retry: () => void; }) => string \| ToastConfig)` | No | - | Function to generate error toast to show in case the server fails to perform the action. |
-| `onError` | `((err: unknown) => void)` | No | - | Callback function triggered when an error occurs. |
-| `onTryAgain` | `(() => void \| Promise<void>)` | No | - | Callback function to retry the action. @deprecated Use the prop `errorToast={(err, {retry}) => { action:{onClick: () {retry();} }}}` instead. |
-| `successToast` | `string \| ToastConfig` | No | - | Toast message or configuration to show on successful action. |
-| `updateServerAfter` | `EventuallyUpdated` | No | `submit` | Indicates when the server is eventually updated. Possible values: - submit: Server updates immediately after the submission promise resolves. - number: Server updates after a specified timeout (in milliseconds). - Promise: Server updates after a forwarded promise resolves. |
+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.
 

package/dist/docs/idNameArrayFilter.md

@@ -191,16 +191,10 @@ function defaultFields() {
 
 ### Props
 
-| Prop | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `defaultValue` | `T[]` | No | - | The value to set the value to, when clearing the filter (Optional) |
-| `parse` | `(value: string \| Record<string, unknown> \| null \| undefined) => T \| null` | Yes | - | Convert a unknown object to a T.<br> If the function returns null, the item will be skipped when we try to deserializate it from an array. @param value |
-| `simplify` | `((value: T) => Partial<T>)` | No | - | Return a simplified form of an item for serialization. @param value |
-| `matches` | `((item: T, value: T[]) => boolean)` | No | - | Indicates whether an item matches the current value of the filter |
-| `equals` | `((item1: T, item2: T) => boolean)` | No | - | A function which accepts 2 items and returns true if they are equal |
-| `persistent` | `boolean` | No | - | Marks the filter as a "context" or "scope" filter. This makes the filter not be visible in the sub-toolbar tag list, not saved in views, not counted as "X filters applied". |
-| `initialValue` | `T[]` | No | - | The value to initialize the filter with (Optional) |
-| `itemKey` | `(item: T) => string` | Yes | - | A callback function that accepts an item and returns a unique ID of it. typically `item.id`. |
-| `itemName` | `(item: T) => string` | Yes | - | A callback function that accepts an item and returns the item name which is used in many messages through cairo |
-| `isCustomField` | `boolean` | No | - | If the filter is a custom field |
+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.