@wix/patterns 1.468.0 → 1.469.0

package/dist/docs/TabsFilter.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description
@@ -28,25 +30,25 @@ import { TabsFilter } from '@wix/patterns';
 
 This example uses the `<TabsFilter>` `data` prop to include filter tabs in the table.
 
-Example code: read `dist/docs/TabsFilter/basic-tabs.tsx`
+Example code: read `dist/examples/TabsFilter/basic-tabs.tsx`
 
 ### Tabs with a basic counter
 
 This example uses the `<TabsFilter>` `counterBadge` prop to include a counter badge in the table's filter tabs.
 
-Example code: read `dist/docs/TabsFilter/tabs-with-a-basic-counter.tsx`
+Example code: read `dist/examples/TabsFilter/tabs-with-a-basic-counter.tsx`
 
 ### Tabs with a counter badge
 
 This example uses the `<TabsFilter>` `counterBadge` prop to include a counter badge in the table's filter tabs. The badge's `skin` and the `disabled` prop both take the total, so a tab can stay neutral and be greyed out while its counter is `0`.
 
-Example code: read `dist/docs/TabsFilter/tabs-with-a-counter-badge.tsx`
+Example code: read `dist/examples/TabsFilter/tabs-with-a-counter-badge.tsx`
 
 ### Disabled tabs
 
 This example uses the `<TabsFilter>` `disabled` prop to make tabs with no items non-interactive.
 
-Example code: read `dist/docs/TabsFilter/disabled-tabs.tsx`
+Example code: read `dist/examples/TabsFilter/disabled-tabs.tsx`
 
 ## API
 

package/dist/docs/Tags.md

@@ -4,6 +4,10 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-cairo-dummyservice-v1-dummy-entity/types`, `@wix/ambassador-contacts-v4-contact/http`, `@wix/ambassador-contacts-v4-contact/types`, `@wix/ambassador-v1-entity/http`, `@wix/ambassador-v1-entity/types`, `@wix/yoshi-flow-bm`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Overview
 
 ### Introduction
@@ -121,7 +125,7 @@ import { CollectionPage } from '@wix/patterns/page';
 
 WixPatterns tags provide a default column, filtering, and bulk action for assigning tags.
 
-Example code: read `dist/docs/Tags/basic.tsx`
+Example code: read `dist/examples/Tags/basic.tsx`
 
 ---
 
@@ -129,7 +133,7 @@ Example code: read `dist/docs/Tags/basic.tsx`
 
 Position the "Tags" column differently in your table.
 
-Example code: read `dist/docs/Tags/customized-tags-column-position.tsx`
+Example code: read `dist/examples/Tags/customized-tags-column-position.tsx`
 
 ---
 
@@ -137,7 +141,7 @@ Example code: read `dist/docs/Tags/customized-tags-column-position.tsx`
 
 Config the Tags column props. In this example the column the defaultHidden is false
 
-Example code: read `dist/docs/Tags/custom-config-for-tags-column.tsx`
+Example code: read `dist/examples/Tags/custom-config-for-tags-column.tsx`
 
 ---
 
@@ -145,7 +149,7 @@ Example code: read `dist/docs/Tags/custom-config-for-tags-column.tsx`
 
 Locate the Tags filter in a different position on your filters side panel or toolbar.
 
-Example code: read `dist/docs/Tags/customized-filter-position.tsx`
+Example code: read `dist/examples/Tags/customized-filter-position.tsx`
 
 ---
 
@@ -153,7 +157,7 @@ Example code: read `dist/docs/Tags/customized-filter-position.tsx`
 
 This example shows a `TableFolders` component with tags. Note that you can only assign tags to table items and not to folders.
 
-Example code: read `dist/docs/Tags/on-table-with-folders.tsx`
+Example code: read `dist/examples/Tags/on-table-with-folders.tsx`
 
 ## API
 

package/dist/docs/TagsWidget.md

@@ -2,6 +2,10 @@
 
 **Category:** Features/Enrich/Tags
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-cairo-dummyservice-v1-dummy-entity/types`, `@wix/ambassador-v1-entity/http`, `@wix/ambassador-v1-entity/types`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Overview
 
 ### Introduction

package/dist/docs/ToolbarFilters.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## 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. 
@@ -39,35 +41,35 @@ import { CollectionToolbarFilters } from '@wix/patterns';
 
 A table with a toolbar containing 2 filters, and no title. Filters are displayed on the left side of the toolbar unless there's existing left-side content, such as a title.
 
-Example code: read `dist/docs/ToolbarFilters/2-filters-without-a-title.tsx`
+Example code: read `dist/examples/ToolbarFilters/2-filters-without-a-title.tsx`
 
 ### 2 filters with a title
 
 A table with a toolbar containing 2 filters and a title. Filters are displayed on the left side of the toolbar unless there's existing left-side content, such as a title.
 
-Example code: read `dist/docs/ToolbarFilters/2-filters-with-a-title.tsx`
+Example code: read `dist/examples/ToolbarFilters/2-filters-with-a-title.tsx`
 
 ### Custom label for tags
 
 Sets a custom label for the filtered tags using toolbarTagProps.
 
-Example code: read `dist/docs/ToolbarFilters/custom-label-for-tags.tsx`
+Example code: read `dist/examples/ToolbarFilters/custom-label-for-tags.tsx`
 
 ### More than 2 filters
 
 If there are more than 2 filters, the filters are displayed in a side panel.
 
-Example code: read `dist/docs/ToolbarFilters/more-than-2-filters.tsx`
+Example code: read `dist/examples/ToolbarFilters/more-than-2-filters.tsx`
 
 ### Apply changes
 
 This example adds an apply filters button. If you want to get a reference to the filter that is about to be applied, use [getPendingFilter](./?path=%2Fstory%2Fcommon-state--toolbarcollectionstate).
 
-Example code: read `dist/docs/ToolbarFilters/apply-changes.tsx`
+Example code: read `dist/examples/ToolbarFilters/apply-changes.tsx`
 
 ### Postpone collection filter initial fetch
 
-Example code: read `dist/docs/ToolbarFilters/postpone-collection-filter-initial-fetch.tsx`
+Example code: read `dist/examples/ToolbarFilters/postpone-collection-filter-initial-fetch.tsx`
 
 ### Customize filter display tags
 
@@ -77,23 +79,23 @@ Customize the text of the tags displayed when a user selects a filter item.
  
  Default: Filter item name
 
-Example code: read `dist/docs/ToolbarFilters/customize-filter-display-tags.tsx`
+Example code: read `dist/examples/ToolbarFilters/customize-filter-display-tags.tsx`
 
 ### Add filter presets for future dates.
 
-Example code: read `dist/docs/ToolbarFilters/add-filter-presets-for-future-dates.tsx`
+Example code: read `dist/examples/ToolbarFilters/add-filter-presets-for-future-dates.tsx`
 
 ### Mini toolbar
 
 To create a mini toolbar, set the `width` prop of the `<Box>` component to a minimum of `228px`.
 
-Example code: read `dist/docs/ToolbarFilters/mini-toolbar.tsx`
+Example code: read `dist/examples/ToolbarFilters/mini-toolbar.tsx`
 
 ### Mini toolbar with filters
 
 To create a mini toolbar, set the `width` prop of the `<Box>` component to a minimum of `228px`. To add filters, set the Table component's `filters` prop.
 
-Example code: read `dist/docs/ToolbarFilters/mini-toolbar-with-filters.tsx`
+Example code: read `dist/examples/ToolbarFilters/mini-toolbar-with-filters.tsx`
 
 ## API
 

package/dist/docs/ToolbarSecondaryActions.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description
@@ -19,25 +21,25 @@ import { ToolbarSecondaryActions } from '@wix/patterns';
 
 Display multiple secondary action buttons in the toolbar.
 
-Example code: read `dist/docs/ToolbarSecondaryActions/multiple-secondary-action-buttons.tsx`
+Example code: read `dist/examples/ToolbarSecondaryActions/multiple-secondary-action-buttons.tsx`
 
 ### Multiple actions with dropdown menus
 
 Display multiple secondary action buttons, each with a dropdown menu that shows additional actions when clicked.
 
-Example code: read `dist/docs/ToolbarSecondaryActions/multiple-actions-with-dropdown-menus.tsx`
+Example code: read `dist/examples/ToolbarSecondaryActions/multiple-actions-with-dropdown-menus.tsx`
 
 ### Mixed buttons and dropdown menus
 
 Display a combination of single action buttons and buttons with dropdown menus in the same toolbar.
 
-Example code: read `dist/docs/ToolbarSecondaryActions/mixed-buttons-and-dropdown-menus.tsx`
+Example code: read `dist/examples/ToolbarSecondaryActions/mixed-buttons-and-dropdown-menus.tsx`
 
 ### Grouped actions with dividers
 
 Group actions in a dropdown menu by providing `subItems` as nested arrays. Each array creates a group, and dividers appear between groups.
 
-Example code: read `dist/docs/ToolbarSecondaryActions/grouped-actions-with-dividers.tsx`
+Example code: read `dist/examples/ToolbarSecondaryActions/grouped-actions-with-dividers.tsx`
 
 ## API
 

package/dist/docs/ToolbarTitle.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description
@@ -15,7 +17,7 @@ The card title located on the left hand side of the toolbar to provide visitors
 
 This example uses the `<ToolbarTitle>` `title` prop to display a title in the toolbar.
 
-Example code: read `dist/docs/ToolbarTitle/title.tsx`
+Example code: read `dist/examples/ToolbarTitle/title.tsx`
 
 ---
 
@@ -23,23 +25,23 @@ Example code: read `dist/docs/ToolbarTitle/title.tsx`
 
 This example uses the `<ToolbarTitle>` `title` and `subtitle` props to display a title, subtitle, and a redirect link in the toolbar.
 
-Example code: read `dist/docs/ToolbarTitle/title-subtitle-and-learn-more.tsx`
+Example code: read `dist/examples/ToolbarTitle/title-subtitle-and-learn-more.tsx`
 
 ---
 
 ### Title and count
 
-This example uses the `<ToolbarTitle>` `title` and `showCount` props to display a title and a count in the toolbar.
+This example uses the `<ToolbarTitle>` `title` and `showTotal` props to display a title and a count in the toolbar.
 
-Example code: read `dist/docs/ToolbarTitle/title-and-count.tsx`
+Example code: read `dist/examples/ToolbarTitle/title-and-count.tsx`
 
 ---
 
 ### Title, count, and the collection's item limit
 
-This example uses the `<ToolbarTitle>` `title`, `showCount`, and `itemsLimit` props to display a title, a count, and the maximum number of items a visitor can add to the collection in the toolbar.
+This example uses the `<ToolbarTitle>` `title`, `showTotal`, and `itemsLimit` props to display a title, a count, and the maximum number of items a visitor can add to the collection in the toolbar.
 
-Example code: read `dist/docs/ToolbarTitle/title-count-and-the-collection-s-item-limit.tsx`
+Example code: read `dist/examples/ToolbarTitle/title-count-and-the-collection-s-item-limit.tsx`
 
 ## API
 

package/dist/docs/Views.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description
@@ -32,25 +34,25 @@ import { Views } from '@wix/patterns';
 
 This example uses the `<Views>` `allItemsViewProps` prop to hide the default "All Items" view from the list of views. "All Items" view will be the default view, and then visitors can apply filters, custom columns, or sorting before saving the current view.
 
-Example code: read `dist/docs/Views/basic-view.tsx`
+Example code: read `dist/examples/Views/basic-view.tsx`
 
 ### Basic View that can be chosen
 
 This example uses the `<Views>` `allItemsViewProps` prop to name the default view that appears in the views dropdown.
 
-Example code: read `dist/docs/Views/basic-view-that-can-be-chosen.tsx`
+Example code: read `dist/examples/Views/basic-view-that-can-be-chosen.tsx`
 
 ### View with selected columns
 
 This example uses the `selectedColumns` property in the view object in the `<Views>` `presets` prop to define which columns should be displayed in the table in this view.
 
-Example code: read `dist/docs/Views/view-with-selected-columns.tsx`
+Example code: read `dist/examples/Views/view-with-selected-columns.tsx`
 
 ### Views separated by category in the dropdown
 
 This example defines views in different sections in the `<Views>` `presets` prop.
 
-Example code: read `dist/docs/Views/views-separated-by-category-in-the-dropdown.tsx`
+Example code: read `dist/examples/Views/views-separated-by-category-in-the-dropdown.tsx`
 
 ## API
 

package/dist/docs/WidgetsFormProvider.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/WixPatternsBMProvider.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/WixPatternsBaseProvider.md

@@ -4,6 +4,10 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/fe-essentials/data-capsule`, `@wix/fe-essentials/error-monitor`, `@wix/fe-essentials/http-client`, `@wix/fe-essentials/i18n`, `@wix/fe-essentials/react`, `@wix/fe-essentials/sentry`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## API
 
 ### Overview

package/dist/docs/WixPatternsEssentialsProvider.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/WixPatternsGizaProvider.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/WixPatternsProvider.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/Working with Cache.md

@@ -2,6 +2,10 @@
 
 **Category:** Guides
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/ambassador-contacts-v4-contact/http`, `@wix/yoshi-flow-bm`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ##  
 
 Wix Patterns uses cache to optimize the request time, more specifically it uses the "in-memory" cache strategy which means that the cache persists only during the browser session. Once the browser tab is closed all cache is cleared.

package/dist/docs/arrayFilter.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Description

package/dist/docs/bulkActionModal.md

@@ -2,6 +2,8 @@
 
 **Category:** Features/Actions/Bulk Actions
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## API
 
 ### Overview

package/dist/docs/customFilter.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Usage

package/dist/docs/dateRangeFilter.Factories.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Usage

package/dist/docs/deleteSecondaryAction.md

@@ -4,6 +4,8 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
 ## Design
 
 ### Demo

package/dist/docs/idNameArrayFilter.md

@@ -4,6 +4,10 @@
 
 Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
 
+Examples below are illustrative: each one demonstrates this page's API, and everything around it — data source, layout, http client — is only scaffolding to make that runnable.
+
+Some of that scaffolding is environment-scoped and is **not** needed to use this component: `@wix/yoshi-flow-bm`. Those resolve only against a Wix build environment (a Yoshi flow's runtime, a generated service client, an internal sibling package) — substitute your own data source and http client rather than installing them.
+
 ## Design
 
 ### Usage