@wix/patterns 1.468.0 → 1.470.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (877) hide show
  1. package/dist/cjs/components/ActionCell/ActionCell.js.map +1 -1
  2. package/dist/cjs/components/CardContainer/CardContainer.st.css.js +2 -2
  3. package/dist/cjs/components/CardContainer/CardContainer.st.css.js.map +1 -1
  4. package/dist/cjs/components/CmsFieldManagement/CmsFieldForm.st.css.js +3 -3
  5. package/dist/cjs/components/CmsFieldManagement/CmsFieldForm.st.css.js.map +1 -1
  6. package/dist/cjs/components/CmsFieldManagement/CmsFieldModal.st.css.js +3 -3
  7. package/dist/cjs/components/CmsFieldManagement/CmsFieldModal.st.css.js.map +1 -1
  8. package/dist/cjs/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js +3 -3
  9. package/dist/cjs/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js.map +1 -1
  10. package/dist/cjs/components/Collapse/Collapse.st.css.js +3 -3
  11. package/dist/cjs/components/Collapse/Collapse.st.css.js.map +1 -1
  12. package/dist/cjs/components/CollectionPageNew/CollectionPage.st.css.js +2 -2
  13. package/dist/cjs/components/CollectionPageNew/CollectionPage.st.css.js.map +1 -1
  14. package/dist/cjs/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js +3 -3
  15. package/dist/cjs/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js.map +1 -1
  16. package/dist/cjs/components/CollectionTable/CollectionTable.st.css.js +2 -2
  17. package/dist/cjs/components/CollectionTable/CollectionTable.st.css.js.map +1 -1
  18. package/dist/cjs/components/CollectionTable/CollectionTable.uni.driver.js +5 -1
  19. package/dist/cjs/components/CollectionTable/CollectionTable.uni.driver.js.map +1 -1
  20. package/dist/cjs/components/CollectionTable/CollectionTableWSRTable.st.css.js +2 -2
  21. package/dist/cjs/components/CollectionTable/CollectionTableWSRTable.st.css.js.map +1 -1
  22. package/dist/cjs/components/CollectionToolbar/CollectionToolbar.st.css.js +5 -5
  23. package/dist/cjs/components/CollectionToolbar/CollectionToolbar.st.css.js.map +1 -1
  24. package/dist/cjs/components/CollectionToolbar/SearchOrCustomFilter.st.css.js +4 -4
  25. package/dist/cjs/components/CollectionToolbar/SearchOrCustomFilter.st.css.js.map +1 -1
  26. package/dist/cjs/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js +2 -2
  27. package/dist/cjs/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js.map +1 -1
  28. package/dist/cjs/components/CollectionViewsDropdown/ViewsDropdown.st.css.js +2 -2
  29. package/dist/cjs/components/CollectionViewsDropdown/ViewsDropdown.st.css.js.map +1 -1
  30. package/dist/cjs/components/CustomFieldFilters/CheckboxCustomFieldFilter.js +4 -3
  31. package/dist/cjs/components/CustomFieldFilters/CheckboxCustomFieldFilter.js.map +1 -1
  32. package/dist/cjs/components/CustomFieldFilters/checkboxFilterOptions.js +14 -0
  33. package/dist/cjs/components/CustomFieldFilters/checkboxFilterOptions.js.map +1 -0
  34. package/dist/cjs/components/CustomFieldsTransforms/transformCustomCheckboxToWQL.js +4 -3
  35. package/dist/cjs/components/CustomFieldsTransforms/transformCustomCheckboxToWQL.js.map +1 -1
  36. package/dist/cjs/components/DragHandle/DragHandle.st.css.js +2 -2
  37. package/dist/cjs/components/DragHandle/DragHandle.st.css.js.map +1 -1
  38. package/dist/cjs/components/EditableTable/EditableCell.st.css.js +3 -3
  39. package/dist/cjs/components/EditableTable/EditableCell.st.css.js.map +1 -1
  40. package/dist/cjs/components/EditableTable/EditableTable.js +16 -11
  41. package/dist/cjs/components/EditableTable/EditableTable.js.map +1 -1
  42. package/dist/cjs/components/EditableTable/EditableTable.uni.driver.js +4 -0
  43. package/dist/cjs/components/EditableTable/EditableTable.uni.driver.js.map +1 -1
  44. package/dist/cjs/components/EditableTable/HeaderActionsPopover.st.css.js +2 -2
  45. package/dist/cjs/components/EditableTable/HeaderActionsPopover.st.css.js.map +1 -1
  46. package/dist/cjs/components/EditableTable/cellTypes/CellViewLayout.st.css.js +2 -2
  47. package/dist/cjs/components/EditableTable/cellTypes/CellViewLayout.st.css.js.map +1 -1
  48. package/dist/cjs/components/EditableTable/cellTypes/address/Edit.st.css.js +3 -3
  49. package/dist/cjs/components/EditableTable/cellTypes/address/Edit.st.css.js.map +1 -1
  50. package/dist/cjs/components/EditableTable/cellTypes/array/Edit.st.css.js +3 -3
  51. package/dist/cjs/components/EditableTable/cellTypes/array/Edit.st.css.js.map +1 -1
  52. package/dist/cjs/components/EditableTable/cellTypes/boolean/Edit.st.css.js +3 -3
  53. package/dist/cjs/components/EditableTable/cellTypes/boolean/Edit.st.css.js.map +1 -1
  54. package/dist/cjs/components/EditableTable/cellTypes/boolean/View.st.css.js +3 -3
  55. package/dist/cjs/components/EditableTable/cellTypes/boolean/View.st.css.js.map +1 -1
  56. package/dist/cjs/components/EditableTable/cellTypes/color/Edit.st.css.js +2 -2
  57. package/dist/cjs/components/EditableTable/cellTypes/color/Edit.st.css.js.map +1 -1
  58. package/dist/cjs/components/EditableTable/cellTypes/date/Edit.st.css.js +3 -3
  59. package/dist/cjs/components/EditableTable/cellTypes/date/Edit.st.css.js.map +1 -1
  60. package/dist/cjs/components/EditableTable/cellTypes/date/View.st.css.js +2 -2
  61. package/dist/cjs/components/EditableTable/cellTypes/date/View.st.css.js.map +1 -1
  62. package/dist/cjs/components/EditableTable/cellTypes/datetime/Edit.st.css.js +8 -8
  63. package/dist/cjs/components/EditableTable/cellTypes/datetime/Edit.st.css.js.map +1 -1
  64. package/dist/cjs/components/EditableTable/cellTypes/datetime/View.st.css.js +7 -7
  65. package/dist/cjs/components/EditableTable/cellTypes/datetime/View.st.css.js.map +1 -1
  66. package/dist/cjs/components/EditableTable/cellTypes/email/Edit.st.css.js +3 -3
  67. package/dist/cjs/components/EditableTable/cellTypes/email/Edit.st.css.js.map +1 -1
  68. package/dist/cjs/components/EditableTable/cellTypes/email/View.st.css.js +2 -2
  69. package/dist/cjs/components/EditableTable/cellTypes/email/View.st.css.js.map +1 -1
  70. package/dist/cjs/components/EditableTable/cellTypes/number/Edit.st.css.js +3 -3
  71. package/dist/cjs/components/EditableTable/cellTypes/number/Edit.st.css.js.map +1 -1
  72. package/dist/cjs/components/EditableTable/cellTypes/number/View.st.css.js +3 -3
  73. package/dist/cjs/components/EditableTable/cellTypes/number/View.st.css.js.map +1 -1
  74. package/dist/cjs/components/EditableTable/cellTypes/object/Edit.st.css.js +3 -3
  75. package/dist/cjs/components/EditableTable/cellTypes/object/Edit.st.css.js.map +1 -1
  76. package/dist/cjs/components/EditableTable/cellTypes/object/View.st.css.js +2 -2
  77. package/dist/cjs/components/EditableTable/cellTypes/object/View.st.css.js.map +1 -1
  78. package/dist/cjs/components/EditableTable/cellTypes/select/Edit.st.css.js +3 -3
  79. package/dist/cjs/components/EditableTable/cellTypes/select/Edit.st.css.js.map +1 -1
  80. package/dist/cjs/components/EditableTable/cellTypes/text/Edit.st.css.js +4 -4
  81. package/dist/cjs/components/EditableTable/cellTypes/text/Edit.st.css.js.map +1 -1
  82. package/dist/cjs/components/EditableTable/cellTypes/text/View.st.css.js +2 -2
  83. package/dist/cjs/components/EditableTable/cellTypes/text/View.st.css.js.map +1 -1
  84. package/dist/cjs/components/EditableTable/cellTypes/time/Edit.st.css.js +4 -4
  85. package/dist/cjs/components/EditableTable/cellTypes/time/Edit.st.css.js.map +1 -1
  86. package/dist/cjs/components/EditableTable/cellTypes/url/Edit.st.css.js +3 -3
  87. package/dist/cjs/components/EditableTable/cellTypes/url/Edit.st.css.js.map +1 -1
  88. package/dist/cjs/components/EditableTable/cellTypes/url/View.st.css.js +5 -5
  89. package/dist/cjs/components/EditableTable/cellTypes/url/View.st.css.js.map +1 -1
  90. package/dist/cjs/components/EmptyState/EmptyStateBase.st.css.js +2 -2
  91. package/dist/cjs/components/EmptyState/EmptyStateBase.st.css.js.map +1 -1
  92. package/dist/cjs/components/EntityPage/EntityPagePlain.st.css.js +2 -2
  93. package/dist/cjs/components/EntityPage/EntityPagePlain.st.css.js.map +1 -1
  94. package/dist/cjs/components/EntityPageFields/EntityPageField.js +78 -8
  95. package/dist/cjs/components/EntityPageFields/EntityPageField.js.map +1 -1
  96. package/dist/cjs/components/EntityPageFields/EntityPageFields.js +5 -4
  97. package/dist/cjs/components/EntityPageFields/EntityPageFields.js.map +1 -1
  98. package/dist/cjs/components/EntityPageFields/EntityPageReferenceField.js +10 -31
  99. package/dist/cjs/components/EntityPageFields/EntityPageReferenceField.js.map +1 -1
  100. package/dist/cjs/components/EntityPageFields/EntityPageReferenceValue.js +71 -0
  101. package/dist/cjs/components/EntityPageFields/EntityPageReferenceValue.js.map +1 -0
  102. package/dist/cjs/components/EntityPageFields/useReferencedSchema.js +42 -0
  103. package/dist/cjs/components/EntityPageFields/useReferencedSchema.js.map +1 -0
  104. package/dist/cjs/components/Fade/Fade.st.css.js +2 -2
  105. package/dist/cjs/components/Fade/Fade.st.css.js.map +1 -1
  106. package/dist/cjs/components/Heading/Heading.st.css.js +2 -2
  107. package/dist/cjs/components/Heading/Heading.st.css.js.map +1 -1
  108. package/dist/cjs/components/ImportButton/ImportStepUpload.st.css.js +3 -3
  109. package/dist/cjs/components/ImportButton/ImportStepUpload.st.css.js.map +1 -1
  110. package/dist/cjs/components/InputOverflow/InputOverflow.st.css.js +2 -2
  111. package/dist/cjs/components/InputOverflow/InputOverflow.st.css.js.map +1 -1
  112. package/dist/cjs/components/LoadingRow/LoadingRow.st.css.js +3 -3
  113. package/dist/cjs/components/LoadingRow/LoadingRow.st.css.js.map +1 -1
  114. package/dist/cjs/components/MaxHeightText/MaxHeightText.st.css.js +2 -2
  115. package/dist/cjs/components/MaxHeightText/MaxHeightText.st.css.js.map +1 -1
  116. package/dist/cjs/components/MaxLines/MaxLines.st.css.js +2 -2
  117. package/dist/cjs/components/MaxLines/MaxLines.st.css.js.map +1 -1
  118. package/dist/cjs/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js +5 -5
  119. package/dist/cjs/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js.map +1 -1
  120. package/dist/cjs/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js +2 -2
  121. package/dist/cjs/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js.map +1 -1
  122. package/dist/cjs/components/NestedTable/NestedTableRow.st.css.js +5 -5
  123. package/dist/cjs/components/NestedTable/NestedTableRow.st.css.js.map +1 -1
  124. package/dist/cjs/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js +2 -2
  125. package/dist/cjs/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js.map +1 -1
  126. package/dist/cjs/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js +2 -2
  127. package/dist/cjs/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js.map +1 -1
  128. package/dist/cjs/components/PickerContent/PickerContent.st.css.js +2 -2
  129. package/dist/cjs/components/PickerContent/PickerContent.st.css.js.map +1 -1
  130. package/dist/cjs/components/PickerContent/PickerContentAdditionalStep.st.css.js +4 -4
  131. package/dist/cjs/components/PickerContent/PickerContentAdditionalStep.st.css.js.map +1 -1
  132. package/dist/cjs/components/PickerTableListItem/PickerTableListItem.st.css.js +2 -2
  133. package/dist/cjs/components/PickerTableListItem/PickerTableListItem.st.css.js.map +1 -1
  134. package/dist/cjs/components/ScrollableContent/ScrollableContent.st.css.js +2 -2
  135. package/dist/cjs/components/ScrollableContent/ScrollableContent.st.css.js.map +1 -1
  136. package/dist/cjs/components/SetupWidget/SetupWidget.st.css.js +10 -10
  137. package/dist/cjs/components/SetupWidget/SetupWidget.st.css.js.map +1 -1
  138. package/dist/cjs/components/SkeletonCard/SkeletonCard.st.css.js +3 -3
  139. package/dist/cjs/components/SkeletonCard/SkeletonCard.st.css.js.map +1 -1
  140. package/dist/cjs/components/SlidingModal/SlidingModal.st.css.js +2 -2
  141. package/dist/cjs/components/SlidingModal/SlidingModal.st.css.js.map +1 -1
  142. package/dist/cjs/components/Table/AddFieldColumnHeader.st.css.js +6 -6
  143. package/dist/cjs/components/Table/AddFieldColumnHeader.st.css.js.map +1 -1
  144. package/dist/cjs/components/TabsFilter/TabsFilter.st.css.js +3 -3
  145. package/dist/cjs/components/TabsFilter/TabsFilter.st.css.js.map +1 -1
  146. package/dist/cjs/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js +2 -2
  147. package/dist/cjs/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js.map +1 -1
  148. package/dist/cjs/components/ToolbarItem/ToolbarItem.st.css.js +2 -2
  149. package/dist/cjs/components/ToolbarItem/ToolbarItem.st.css.js.map +1 -1
  150. package/dist/cjs/components/ToolbarItemBox/ToolbarItemBox.st.css.js +2 -2
  151. package/dist/cjs/components/ToolbarItemBox/ToolbarItemBox.st.css.js.map +1 -1
  152. package/dist/cjs/components/common.st.css.js +4 -4
  153. package/dist/cjs/components/common.st.css.js.map +1 -1
  154. package/dist/cjs/schema/EntityPageFieldsCard.js +8 -8
  155. package/dist/cjs/schema/EntityPageFieldsCard.js.map +1 -1
  156. package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css.js +2 -2
  157. package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css.js.map +1 -1
  158. package/dist/cjs/state/CustomColumnsEntityPageState.js +3 -4
  159. package/dist/cjs/state/CustomColumnsEntityPageState.js.map +1 -1
  160. package/dist/cjs/state/EntityPage/resolveEntityPageFields.js +15 -9
  161. package/dist/cjs/state/EntityPage/resolveEntityPageFields.js.map +1 -1
  162. package/dist/cjs/state/EntityPageFieldsCardState.js +5 -10
  163. package/dist/cjs/state/EntityPageFieldsCardState.js.map +1 -1
  164. package/dist/cjs/state/FormPage/FormPageHeader.st.css.js +2 -2
  165. package/dist/cjs/state/FormPage/FormPageHeader.st.css.js.map +1 -1
  166. package/dist/cjs/state/buildEditableFieldColumns.js +6 -0
  167. package/dist/cjs/state/buildEditableFieldColumns.js.map +1 -1
  168. package/dist/cjs/state/buildFieldColumns.js +4 -1
  169. package/dist/cjs/state/buildFieldColumns.js.map +1 -1
  170. package/dist/cjs/styles.global.css +2 -2
  171. package/dist/cjs/version.js +1 -1
  172. package/dist/cjs/version.js.map +1 -1
  173. package/dist/docs/AI Assistant.md +2 -0
  174. package/dist/docs/ActionCellProps.md +2 -0
  175. package/dist/docs/Allow Users to Add Extended Fields.md +4 -0
  176. package/dist/docs/AutoCompleteFilter.md +4 -0
  177. package/dist/docs/Collection Toolkit.md +116 -0
  178. package/dist/docs/Collection to Entity Flow.md +145 -0
  179. package/dist/docs/CollectionEmptyState.md +5 -3
  180. package/dist/docs/CollectionErrorState.md +2 -0
  181. package/dist/docs/CollectionNoResultsState.md +4 -0
  182. package/dist/docs/CollectionOptimisticActions.md +12 -8
  183. package/dist/docs/CollectionPage.Content.md +2 -0
  184. package/dist/docs/CollectionPage.Header.md +5 -3
  185. package/dist/docs/CollectionPage.md +2 -0
  186. package/dist/docs/CollectionPremiumEmptyState.md +4 -0
  187. package/dist/docs/CollectionSearch.md +6 -4
  188. package/dist/docs/Component Tests.md +4 -0
  189. package/dist/docs/Composition and Providers.md +135 -0
  190. package/dist/docs/ComputedQuery.md +2 -0
  191. package/dist/docs/CustomColumns.md +11 -9
  192. package/dist/docs/CustomFieldType.md +6 -4
  193. package/dist/docs/CustomFieldsViewWidget.md +4 -0
  194. package/dist/docs/CustomFieldsWidget.md +11 -7
  195. package/dist/docs/DateRangeFilter.Components.md +2 -0
  196. package/dist/docs/Display Extended Fields.md +4 -0
  197. package/dist/docs/Enable Filters for Extended Fields.md +4 -0
  198. package/dist/docs/EntityPage.AdditionalContent.md +2 -0
  199. package/dist/docs/EntityPage.Card.md +2 -0
  200. package/dist/docs/EntityPage.Content.md +2 -0
  201. package/dist/docs/EntityPage.Header.md +4 -0
  202. package/dist/docs/EntityPage.MainContent.md +2 -0
  203. package/dist/docs/EntityPage.Slots.md +2 -0
  204. package/dist/docs/EntityPage.md +13 -11
  205. package/dist/docs/EntityPageState.md +2 -0
  206. package/dist/docs/Explore Apps.md +2 -0
  207. package/dist/docs/ExportTo.md +8 -4
  208. package/dist/docs/Filter Overview.md +3 -1
  209. package/dist/docs/Grid Sections.md +2 -0
  210. package/dist/docs/Grid.md +8 -6
  211. package/dist/docs/GridDragAndDrop.md +2 -0
  212. package/dist/docs/GridFolders.md +4 -0
  213. package/dist/docs/GridFoldersSection.md +2 -0
  214. package/dist/docs/Highlighted Search.md +2 -0
  215. package/dist/docs/ImportButton.md +11 -7
  216. package/dist/docs/InMemoryBackend.md +2 -0
  217. package/dist/docs/Indeterminate.md +6 -2
  218. package/dist/docs/Internal Scroll.md +4 -2
  219. package/dist/docs/More Actions.md +11 -9
  220. package/dist/docs/MultiAutoInlineCheckboxFilter.md +2 -0
  221. package/dist/docs/MultiBulkActionToolbar.md +8 -6
  222. package/dist/docs/MultiInlineCheckboxFilter.md +2 -0
  223. package/dist/docs/MultiLevelSorting.md +5 -3
  224. package/dist/docs/MultiSelectCheckboxFilter.md +4 -0
  225. package/dist/docs/MultiSelectCollectionFilter.md +4 -0
  226. package/dist/docs/NestedTable.md +10 -6
  227. package/dist/docs/NumberRangeFilter.md +2 -0
  228. package/dist/docs/OperatorFilterPicker.md +2 -0
  229. package/dist/docs/PageWrapper.md +2 -0
  230. package/dist/docs/PatternsReactRoute.md +2 -0
  231. package/dist/docs/PatternsReactRouter.md +2 -0
  232. package/dist/docs/PickerContent.md +2 -0
  233. package/dist/docs/PickerModal.md +9 -5
  234. package/dist/docs/PickerStandalone.md +8 -4
  235. package/dist/docs/PrimaryActionButton.md +2 -0
  236. package/dist/docs/PrimaryActions.md +2 -0
  237. package/dist/docs/PrimaryPageButton.md +2 -0
  238. package/dist/docs/RadioGroupFilter.md +2 -0
  239. package/dist/docs/Reading the Doc Indices.md +186 -0
  240. package/dist/docs/RequestId.md +2 -0
  241. package/dist/docs/SecondaryActions.md +2 -0
  242. package/dist/docs/SettingsPage.AdditionalContent.md +2 -0
  243. package/dist/docs/SettingsPage.Card.md +2 -0
  244. package/dist/docs/SettingsPage.Content.md +2 -0
  245. package/dist/docs/SettingsPage.Header.md +4 -0
  246. package/dist/docs/SettingsPage.MainContent.md +2 -0
  247. package/dist/docs/SettingsPage.md +9 -7
  248. package/dist/docs/SettingsPageState.md +2 -0
  249. package/dist/docs/SingleSelectFilter.md +9 -5
  250. package/dist/docs/Sled Tests.md +4 -0
  251. package/dist/docs/Sortable Columns.md +4 -2
  252. package/dist/docs/Suggestions.md +6 -4
  253. package/dist/docs/SummaryBar.md +7 -5
  254. package/dist/docs/Table Sections.md +6 -4
  255. package/dist/docs/Table.md +16 -12
  256. package/dist/docs/TableDragAndDrop.md +8 -4
  257. package/dist/docs/TableFolders.md +7 -3
  258. package/dist/docs/TableGridSwitch.md +4 -2
  259. package/dist/docs/TableGridSwitchDragAndDrop.md +2 -0
  260. package/dist/docs/TableGridSwitchFolders.md +7 -3
  261. package/dist/docs/TableTopNotification.md +6 -2
  262. package/dist/docs/TabsFilter.md +6 -4
  263. package/dist/docs/Tags.md +9 -5
  264. package/dist/docs/TagsWidget.md +4 -0
  265. package/dist/docs/ToolbarFilters.md +12 -10
  266. package/dist/docs/ToolbarSecondaryActions.md +6 -4
  267. package/dist/docs/ToolbarTitle.md +8 -6
  268. package/dist/docs/Views.md +6 -4
  269. package/dist/docs/WidgetsFormProvider.md +2 -0
  270. package/dist/docs/WixPatternsBMProvider.md +2 -0
  271. package/dist/docs/WixPatternsBaseProvider.md +4 -0
  272. package/dist/docs/WixPatternsEssentialsProvider.md +2 -0
  273. package/dist/docs/WixPatternsGizaProvider.md +2 -0
  274. package/dist/docs/WixPatternsProvider.md +2 -0
  275. package/dist/docs/Working with Cache.md +4 -0
  276. package/dist/docs/arrayFilter.md +2 -0
  277. package/dist/docs/bulkActionModal.md +2 -0
  278. package/dist/docs/customFilter.md +2 -0
  279. package/dist/docs/dateRangeFilter.Factories.md +2 -0
  280. package/dist/docs/deleteSecondaryAction.md +2 -0
  281. package/dist/docs/idNameArrayFilter.md +4 -0
  282. package/dist/docs/index.json +668 -149
  283. package/dist/docs/operatorFilter.md +2 -0
  284. package/dist/docs/stringFilter.md +2 -0
  285. package/dist/docs/stringsArrayFilter.md +2 -0
  286. package/dist/docs/useAmbassadorCollection.md +4 -0
  287. package/dist/docs/useCollection.md +5 -19
  288. package/dist/docs/useEntity.md +2 -0
  289. package/dist/docs/useEntityPage.md +40 -0
  290. package/dist/docs/useEntityPageContext.md +2 -0
  291. package/dist/docs/useFilterCollection.md +2 -0
  292. package/dist/docs/useGridCollection.md +2 -0
  293. package/dist/docs/useGridFolders.md +2 -0
  294. package/dist/docs/useItemsSelectionFilter.md +2 -0
  295. package/dist/docs/useNestedTable.md +4 -0
  296. package/dist/docs/useOptimisticActions.md +11 -7
  297. package/dist/docs/usePatternsNavigate.md +3 -1
  298. package/dist/docs/usePickerContent.md +2 -0
  299. package/dist/docs/usePickerModal.md +4 -0
  300. package/dist/docs/usePickerStandalone.md +4 -0
  301. package/dist/docs/useSelector.md +2 -0
  302. package/dist/docs/useSettingsPage.md +2 -0
  303. package/dist/docs/useSettingsPageContext.md +2 -0
  304. package/dist/docs/useStaticListFilterCollection.md +2 -0
  305. package/dist/docs/useTableCollection.md +2 -0
  306. package/dist/docs/useTableFolders.md +2 -0
  307. package/dist/docs/useTableGridSwitchCollection.md +4 -0
  308. package/dist/docs/useTableGridSwitchFolders.md +2 -0
  309. package/dist/docs/useWidgetsFormContext.md +2 -0
  310. package/dist/docs/withDashboard.md +2 -0
  311. package/dist/dts-bundle/components/AutoCompleteFilter.d.ts +2 -2
  312. package/dist/dts-bundle/components/CollectionOptimisticActions.d.ts +2 -2
  313. package/dist/dts-bundle/components/CollectionPage.d.ts +2 -2
  314. package/dist/dts-bundle/components/CollectionSearch.d.ts +1 -1
  315. package/dist/dts-bundle/components/CollectionToolbarFilters.d.ts +1 -1
  316. package/dist/dts-bundle/components/Controller.d.ts +48 -0
  317. package/dist/dts-bundle/components/DateRangeFilter.d.ts +2 -2
  318. package/dist/dts-bundle/components/EntityPage.d.ts +2 -2
  319. package/dist/dts-bundle/components/ExportButton.d.ts +2 -2
  320. package/dist/dts-bundle/components/Grid.d.ts +6 -6
  321. package/dist/dts-bundle/components/GridFolders.d.ts +5 -5
  322. package/dist/dts-bundle/components/MoreActions.d.ts +1 -1
  323. package/dist/dts-bundle/components/MultiAutoInlineCheckboxFilter.d.ts +1 -1
  324. package/dist/dts-bundle/components/MultiBulkActionToolbar.d.ts +1 -1
  325. package/dist/dts-bundle/components/MultiInlineCheckboxFilter.d.ts +1 -1
  326. package/dist/dts-bundle/components/MultiSelectCheckboxFilter.d.ts +2 -2
  327. package/dist/dts-bundle/components/MultiSelectCollectionFilter.d.ts +2 -2
  328. package/dist/dts-bundle/components/NumberRangeFilter.d.ts +2 -2
  329. package/dist/dts-bundle/components/OperatorFilterPicker.d.ts +1 -1
  330. package/dist/dts-bundle/components/PickerModal.d.ts +1 -1
  331. package/dist/dts-bundle/components/PrimaryActions.d.ts +1 -1
  332. package/dist/dts-bundle/components/RadioGroupFilter.d.ts +1 -1
  333. package/dist/dts-bundle/components/SecondaryActions.d.ts +1 -1
  334. package/dist/dts-bundle/components/SettingsPage.d.ts +1 -1
  335. package/dist/dts-bundle/components/SingleSelectFilter.d.ts +2 -2
  336. package/dist/dts-bundle/components/Table.d.ts +3 -3
  337. package/dist/dts-bundle/components/TableFolders.d.ts +6 -6
  338. package/dist/dts-bundle/components/TableGridSwitch.d.ts +9 -9
  339. package/dist/dts-bundle/components/TabsFilter.d.ts +2 -2
  340. package/dist/dts-bundle/exports/core.d.ts +1 -0
  341. package/dist/dts-bundle/exports/form.d.ts +2 -0
  342. package/dist/dts-bundle/exports/index.d.ts +1 -0
  343. package/dist/dts-bundle/exports/schema.d.ts +2 -0
  344. package/dist/dts-bundle/functions/dateRangeFilter.d.ts +1 -1
  345. package/dist/dts-bundle/functions/deleteSecondaryAction.d.ts +2 -2
  346. package/dist/dts-bundle/hooks/useCollection.d.ts +331 -0
  347. package/dist/dts-bundle/hooks/useCreateCollection.d.ts +5 -5
  348. package/dist/dts-bundle/hooks/useEntity.d.ts +1 -1
  349. package/dist/dts-bundle/hooks/useEntityPage.d.ts +9 -731
  350. package/dist/dts-bundle/hooks/useEntityPageContext.d.ts +1 -1
  351. package/dist/dts-bundle/hooks/useExportConfig.d.ts +2 -2
  352. package/dist/dts-bundle/hooks/useFilterCollection.d.ts +5 -5
  353. package/dist/dts-bundle/hooks/useGridCollection.d.ts +6 -6
  354. package/dist/dts-bundle/hooks/useGridFolders.d.ts +2 -2
  355. package/dist/dts-bundle/hooks/useOptimisticActions.d.ts +3 -3
  356. package/dist/dts-bundle/hooks/usePickerModal.d.ts +8 -5
  357. package/dist/dts-bundle/hooks/useStaticListFilterCollection.d.ts +1 -1
  358. package/dist/dts-bundle/hooks/useTableCollection.d.ts +6 -6
  359. package/dist/dts-bundle/hooks/useTableFolders.d.ts +2 -2
  360. package/dist/dts-bundle/hooks/useTableGridSwitchCollection.d.ts +6 -6
  361. package/dist/dts-bundle/index.json +643 -150
  362. package/dist/dts-bundle/index.txt +112 -0
  363. package/dist/dts-bundle/types/ActionCell.d.ts +2 -2
  364. package/dist/dts-bundle/types/ActionCellProps.d.ts +3 -2
  365. package/dist/dts-bundle/types/BulkActionModalRenderPropParams.d.ts +2 -2
  366. package/dist/dts-bundle/types/CollectionTableBaseProps.d.ts +10 -10
  367. package/dist/dts-bundle/types/CollectionViewsDropdownBaseProps.d.ts +1 -1
  368. package/dist/dts-bundle/types/Column.d.ts +1 -1
  369. package/dist/dts-bundle/types/ComputedQuery.d.ts +1 -1
  370. package/dist/dts-bundle/types/CursorQuery.d.ts +4 -4
  371. package/dist/dts-bundle/types/EntityPageState.d.ts +12 -481
  372. package/dist/dts-bundle/types/EntityPageStateParams.d.ts +7 -729
  373. package/dist/dts-bundle/types/FilterProps.d.ts +1 -1
  374. package/dist/dts-bundle/types/GridFoldersState.d.ts +1 -1
  375. package/dist/dts-bundle/types/GridState.d.ts +1 -1
  376. package/dist/dts-bundle/types/OffsetQuery.d.ts +4 -4
  377. package/dist/dts-bundle/types/OnSaveParams.d.ts +7 -729
  378. package/dist/dts-bundle/types/SchemaSource.d.ts +799 -0
  379. package/dist/dts-bundle/types/TableColumn.d.ts +1 -1
  380. package/dist/dts-bundle/types/TableFoldersState.d.ts +2 -2
  381. package/dist/dts-bundle/types/TableGridSwitchState.d.ts +3 -3
  382. package/dist/dts-bundle/types/TableState.d.ts +2 -2
  383. package/dist/dts-bundle/types/TagsProps.d.ts +4 -4
  384. package/dist/dts-bundle/types/ToolbarBaseProps.d.ts +4 -4
  385. package/dist/dts-bundle/types/ToolbarCollectionBaseProps.d.ts +10 -10
  386. package/dist/dts-bundle/types/ToolbarTitleProps.d.ts +1 -1
  387. package/dist/dts-bundle/types/UseEntityPageParams.d.ts +8 -730
  388. package/dist/dts-bundle/types/UseFormReturn.d.ts +713 -0
  389. package/dist/esm/components/CardContainer/CardContainer.st.css.js +2 -2
  390. package/dist/esm/components/CardContainer/CardContainer.st.css.js.map +1 -1
  391. package/dist/esm/components/CmsFieldManagement/CmsFieldForm.st.css.js +2 -2
  392. package/dist/esm/components/CmsFieldManagement/CmsFieldForm.st.css.js.map +1 -1
  393. package/dist/esm/components/CmsFieldManagement/CmsFieldModal.st.css.js +2 -2
  394. package/dist/esm/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js +2 -2
  395. package/dist/esm/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js.map +1 -1
  396. package/dist/esm/components/Collapse/Collapse.st.css.js +2 -2
  397. package/dist/esm/components/Collapse/Collapse.st.css.js.map +1 -1
  398. package/dist/esm/components/CollectionPageNew/CollectionPage.st.css.js +2 -2
  399. package/dist/esm/components/CollectionPageNew/CollectionPage.st.css.js.map +1 -1
  400. package/dist/esm/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js +2 -2
  401. package/dist/esm/components/CollectionTable/CollectionTable.st.css.js +2 -2
  402. package/dist/esm/components/CollectionTable/CollectionTable.uni.driver.js +8 -1
  403. package/dist/esm/components/CollectionTable/CollectionTable.uni.driver.js.map +1 -1
  404. package/dist/esm/components/CollectionTable/CollectionTableWSRTable.st.css.js +2 -2
  405. package/dist/esm/components/CollectionToolbar/CollectionToolbar.st.css.js +2 -2
  406. package/dist/esm/components/CollectionToolbar/SearchOrCustomFilter.st.css.js +2 -2
  407. package/dist/esm/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js +2 -2
  408. package/dist/esm/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js.map +1 -1
  409. package/dist/esm/components/CollectionViewsDropdown/ViewsDropdown.st.css.js +2 -2
  410. package/dist/esm/components/CustomFieldFilters/CheckboxCustomFieldFilter.js +3 -2
  411. package/dist/esm/components/CustomFieldFilters/CheckboxCustomFieldFilter.js.map +1 -1
  412. package/dist/esm/components/CustomFieldFilters/checkboxFilterOptions.js +10 -0
  413. package/dist/esm/components/CustomFieldFilters/checkboxFilterOptions.js.map +1 -0
  414. package/dist/esm/components/CustomFieldsTransforms/transformCustomCheckboxToWQL.js +6 -3
  415. package/dist/esm/components/CustomFieldsTransforms/transformCustomCheckboxToWQL.js.map +1 -1
  416. package/dist/esm/components/DragHandle/DragHandle.st.css.js +2 -2
  417. package/dist/esm/components/EditableTable/EditableCell.st.css.js +2 -2
  418. package/dist/esm/components/EditableTable/EditableCell.st.css.js.map +1 -1
  419. package/dist/esm/components/EditableTable/EditableTable.js +10 -3
  420. package/dist/esm/components/EditableTable/EditableTable.js.map +1 -1
  421. package/dist/esm/components/EditableTable/EditableTable.uni.driver.js +5 -1
  422. package/dist/esm/components/EditableTable/EditableTable.uni.driver.js.map +1 -1
  423. package/dist/esm/components/EditableTable/HeaderActionsPopover.st.css.js +2 -2
  424. package/dist/esm/components/EditableTable/cellTypes/CellViewLayout.st.css.js +2 -2
  425. package/dist/esm/components/EditableTable/cellTypes/CellViewLayout.st.css.js.map +1 -1
  426. package/dist/esm/components/EditableTable/cellTypes/address/Edit.st.css.js +2 -2
  427. package/dist/esm/components/EditableTable/cellTypes/address/Edit.st.css.js.map +1 -1
  428. package/dist/esm/components/EditableTable/cellTypes/array/Edit.st.css.js +2 -2
  429. package/dist/esm/components/EditableTable/cellTypes/boolean/Edit.st.css.js +2 -2
  430. package/dist/esm/components/EditableTable/cellTypes/boolean/View.st.css.js +2 -2
  431. package/dist/esm/components/EditableTable/cellTypes/color/Edit.st.css.js +2 -2
  432. package/dist/esm/components/EditableTable/cellTypes/date/Edit.st.css.js +2 -2
  433. package/dist/esm/components/EditableTable/cellTypes/date/View.st.css.js +2 -2
  434. package/dist/esm/components/EditableTable/cellTypes/date/View.st.css.js.map +1 -1
  435. package/dist/esm/components/EditableTable/cellTypes/datetime/Edit.st.css.js +2 -2
  436. package/dist/esm/components/EditableTable/cellTypes/datetime/View.st.css.js +2 -2
  437. package/dist/esm/components/EditableTable/cellTypes/email/Edit.st.css.js +2 -2
  438. package/dist/esm/components/EditableTable/cellTypes/email/Edit.st.css.js.map +1 -1
  439. package/dist/esm/components/EditableTable/cellTypes/email/View.st.css.js +2 -2
  440. package/dist/esm/components/EditableTable/cellTypes/email/View.st.css.js.map +1 -1
  441. package/dist/esm/components/EditableTable/cellTypes/number/Edit.st.css.js +2 -2
  442. package/dist/esm/components/EditableTable/cellTypes/number/View.st.css.js +2 -2
  443. package/dist/esm/components/EditableTable/cellTypes/number/View.st.css.js.map +1 -1
  444. package/dist/esm/components/EditableTable/cellTypes/object/Edit.st.css.js +2 -2
  445. package/dist/esm/components/EditableTable/cellTypes/object/Edit.st.css.js.map +1 -1
  446. package/dist/esm/components/EditableTable/cellTypes/object/View.st.css.js +2 -2
  447. package/dist/esm/components/EditableTable/cellTypes/select/Edit.st.css.js +2 -2
  448. package/dist/esm/components/EditableTable/cellTypes/text/Edit.st.css.js +2 -2
  449. package/dist/esm/components/EditableTable/cellTypes/text/Edit.st.css.js.map +1 -1
  450. package/dist/esm/components/EditableTable/cellTypes/text/View.st.css.js +2 -2
  451. package/dist/esm/components/EditableTable/cellTypes/text/View.st.css.js.map +1 -1
  452. package/dist/esm/components/EditableTable/cellTypes/time/Edit.st.css.js +2 -2
  453. package/dist/esm/components/EditableTable/cellTypes/url/Edit.st.css.js +2 -2
  454. package/dist/esm/components/EditableTable/cellTypes/url/View.st.css.js +2 -2
  455. package/dist/esm/components/EmptyState/EmptyStateBase.st.css.js +2 -2
  456. package/dist/esm/components/EntityPage/EntityPagePlain.st.css.js +2 -2
  457. package/dist/esm/components/EntityPage/EntityPagePlain.st.css.js.map +1 -1
  458. package/dist/esm/components/EntityPageFields/EntityPageField.js +13 -3
  459. package/dist/esm/components/EntityPageFields/EntityPageField.js.map +1 -1
  460. package/dist/esm/components/EntityPageFields/EntityPageFields.js +3 -3
  461. package/dist/esm/components/EntityPageFields/EntityPageFields.js.map +1 -1
  462. package/dist/esm/components/EntityPageFields/EntityPageReferenceField.js +4 -25
  463. package/dist/esm/components/EntityPageFields/EntityPageReferenceField.js.map +1 -1
  464. package/dist/esm/components/EntityPageFields/EntityPageReferenceValue.js +37 -0
  465. package/dist/esm/components/EntityPageFields/EntityPageReferenceValue.js.map +1 -0
  466. package/dist/esm/components/EntityPageFields/useReferencedSchema.js +30 -0
  467. package/dist/esm/components/EntityPageFields/useReferencedSchema.js.map +1 -0
  468. package/dist/esm/components/Fade/Fade.st.css.js +2 -2
  469. package/dist/esm/components/Fade/Fade.st.css.js.map +1 -1
  470. package/dist/esm/components/Heading/Heading.st.css.js +2 -2
  471. package/dist/esm/components/ImportButton/ImportStepUpload.st.css.js +2 -2
  472. package/dist/esm/components/InputOverflow/InputOverflow.st.css.js +2 -2
  473. package/dist/esm/components/InputOverflow/InputOverflow.st.css.js.map +1 -1
  474. package/dist/esm/components/LoadingRow/LoadingRow.st.css.js +3 -3
  475. package/dist/esm/components/MaxHeightText/MaxHeightText.st.css.js +2 -2
  476. package/dist/esm/components/MaxLines/MaxLines.st.css.js +2 -2
  477. package/dist/esm/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js +2 -2
  478. package/dist/esm/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js.map +1 -1
  479. package/dist/esm/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js +2 -2
  480. package/dist/esm/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js.map +1 -1
  481. package/dist/esm/components/NestedTable/NestedTableRow.st.css.js +2 -2
  482. package/dist/esm/components/NestedTable/NestedTableRow.st.css.js.map +1 -1
  483. package/dist/esm/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js +2 -2
  484. package/dist/esm/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js.map +1 -1
  485. package/dist/esm/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js +2 -2
  486. package/dist/esm/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js.map +1 -1
  487. package/dist/esm/components/PickerContent/PickerContent.st.css.js +2 -2
  488. package/dist/esm/components/PickerContent/PickerContent.st.css.js.map +1 -1
  489. package/dist/esm/components/PickerContent/PickerContentAdditionalStep.st.css.js +2 -2
  490. package/dist/esm/components/PickerContent/PickerContentAdditionalStep.st.css.js.map +1 -1
  491. package/dist/esm/components/PickerTableListItem/PickerTableListItem.st.css.js +2 -2
  492. package/dist/esm/components/ScrollableContent/ScrollableContent.st.css.js +2 -2
  493. package/dist/esm/components/ScrollableContent/ScrollableContent.st.css.js.map +1 -1
  494. package/dist/esm/components/SetupWidget/SetupWidget.st.css.js +2 -2
  495. package/dist/esm/components/SkeletonCard/SkeletonCard.st.css.js +2 -2
  496. package/dist/esm/components/SlidingModal/SlidingModal.st.css.js +2 -2
  497. package/dist/esm/components/SlidingModal/SlidingModal.st.css.js.map +1 -1
  498. package/dist/esm/components/Table/AddFieldColumnHeader.st.css.js +2 -2
  499. package/dist/esm/components/TabsFilter/TabsFilter.st.css.js +2 -2
  500. package/dist/esm/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js +2 -2
  501. package/dist/esm/components/ToolbarItem/ToolbarItem.st.css.js +2 -2
  502. package/dist/esm/components/ToolbarItem/ToolbarItem.st.css.js.map +1 -1
  503. package/dist/esm/components/ToolbarItemBox/ToolbarItemBox.st.css.js +2 -2
  504. package/dist/esm/components/common.st.css.js +2 -2
  505. package/dist/esm/schema/EntityPageFieldsCard.js.map +1 -1
  506. package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css.js +2 -2
  507. package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css.js.map +1 -1
  508. package/dist/esm/state/CustomColumnsEntityPageState.js +2 -3
  509. package/dist/esm/state/CustomColumnsEntityPageState.js.map +1 -1
  510. package/dist/esm/state/EntityPage/resolveEntityPageFields.js +12 -9
  511. package/dist/esm/state/EntityPage/resolveEntityPageFields.js.map +1 -1
  512. package/dist/esm/state/EntityPageFieldsCardState.js +4 -6
  513. package/dist/esm/state/EntityPageFieldsCardState.js.map +1 -1
  514. package/dist/esm/state/FormPage/FormPageHeader.st.css.js +2 -2
  515. package/dist/esm/state/buildEditableFieldColumns.js +6 -0
  516. package/dist/esm/state/buildEditableFieldColumns.js.map +1 -1
  517. package/dist/esm/state/buildFieldColumns.js +3 -0
  518. package/dist/esm/state/buildFieldColumns.js.map +1 -1
  519. package/dist/esm/styles.global.css +2 -2
  520. package/dist/esm/version.js +1 -1
  521. package/dist/{docs → examples}/CollectionEmptyState/2-ctas.tsx +6 -0
  522. package/dist/{docs → examples}/CollectionEmptyState/demo.tsx +6 -0
  523. package/dist/{docs → examples}/CollectionEmptyState/passive-empty-state.tsx +6 -0
  524. package/dist/{docs → examples}/CollectionOptimisticActions/create-many.tsx +6 -0
  525. package/dist/{docs → examples}/CollectionOptimisticActions/create-one.tsx +6 -0
  526. package/dist/{docs → examples}/CollectionOptimisticActions/delete-all.tsx +14 -0
  527. package/dist/{docs → examples}/CollectionOptimisticActions/delete-many.tsx +6 -0
  528. package/dist/{docs → examples}/CollectionOptimisticActions/delete-one.tsx +6 -0
  529. package/dist/{docs → examples}/CollectionOptimisticActions/update-all.tsx +14 -0
  530. package/dist/{docs → examples}/CollectionOptimisticActions/update-many.tsx +6 -0
  531. package/dist/{docs → examples}/CollectionOptimisticActions/update-one.tsx +6 -0
  532. package/dist/{docs → examples}/CollectionPage.Header/full.tsx +6 -0
  533. package/dist/{docs → examples}/CollectionPage.Header/with-badges.tsx +6 -0
  534. package/dist/{docs → examples}/CollectionPage.Header/without-total.tsx +6 -0
  535. package/dist/{docs → examples}/CollectionSearch/default.tsx +6 -0
  536. package/dist/{docs → examples}/CollectionSearch/max-length.tsx +6 -0
  537. package/dist/{docs → examples}/CollectionSearch/placeholder.tsx +6 -0
  538. package/dist/{docs → examples}/CollectionSearch/search-highlighting.tsx +6 -0
  539. package/dist/{docs → examples}/CustomColumns/add-a-tooltip.tsx +6 -0
  540. package/dist/{docs → examples}/CustomColumns/basic.tsx +6 -0
  541. package/dist/{docs → examples}/CustomColumns/exclude-columns.tsx +6 -0
  542. package/dist/{docs → examples}/CustomColumns/freeze-column-reorder.tsx +6 -0
  543. package/dist/{docs → examples}/CustomColumns/get-visible-columns.tsx +6 -0
  544. package/dist/{docs → examples}/CustomColumns/hide-specific-columns-by-default.tsx +6 -0
  545. package/dist/{docs → examples}/CustomColumns/load-only-selected-columns.tsx +6 -0
  546. package/dist/{docs → examples}/CustomColumns/lock-columns.tsx +6 -0
  547. package/dist/{docs → examples}/CustomColumns/reorder-columns.tsx +6 -0
  548. package/dist/{docs → examples}/CustomFieldType/add-field-modal.tsx +6 -0
  549. package/dist/{docs → examples}/CustomFieldType/editable-cell.tsx +6 -0
  550. package/dist/{docs → examples}/CustomFieldType/entity-page-form.tsx +6 -0
  551. package/dist/{docs → examples}/CustomFieldType/table-cell-and-filter.tsx +6 -0
  552. package/dist/{docs → examples}/CustomFieldsWidget/basic.tsx +12 -0
  553. package/dist/{docs → examples}/CustomFieldsWidget/controllable-state.tsx +12 -0
  554. package/dist/{docs → examples}/CustomFieldsWidget/empty-state.tsx +6 -0
  555. package/dist/{docs → examples}/CustomFieldsWidget/inline-theme.tsx +12 -0
  556. package/dist/{docs → examples}/CustomFieldsWidget/responsive.tsx +12 -0
  557. package/dist/{docs → examples}/CustomFieldsWidget/with-tpa-fields.tsx +12 -0
  558. package/dist/{docs → examples}/CustomFieldsWidget/without-entity-page.tsx +12 -0
  559. package/dist/{docs → examples}/EntityPage/2-columns.tsx +6 -0
  560. package/dist/{docs → examples}/EntityPage/basic.tsx +6 -0
  561. package/dist/{docs → examples}/EntityPage/delete-action.tsx +6 -0
  562. package/dist/{docs → examples}/EntityPage/delete-error-handling.tsx +6 -0
  563. package/dist/{docs → examples}/EntityPage/demo.tsx +6 -0
  564. package/dist/{docs → examples}/EntityPage/error-on-fetch.tsx +6 -0
  565. package/dist/{docs → examples}/EntityPage/error-on-save.tsx +6 -0
  566. package/dist/{docs → examples}/EntityPage/input-initialization-with-controller.tsx +6 -0
  567. package/dist/{docs → examples}/EntityPage/input-initialization-with-usecontroller.tsx +6 -0
  568. package/dist/{docs → examples}/EntityPage/loading.tsx +6 -0
  569. package/dist/{docs → examples}/EntityPage/overriding-save-button-text.tsx +6 -0
  570. package/dist/{docs → examples}/ExportTo/cta-is-out-of-the-table.tsx +14 -0
  571. package/dist/{docs → examples}/ExportTo/export-all-table.tsx +14 -0
  572. package/dist/{docs → examples}/ExportTo/export-filtered-table.tsx +14 -0
  573. package/dist/{docs → examples}/ExportTo/export-table-with-selection-bulk-selection.tsx +14 -0
  574. package/dist/{docs → examples}/Filter Overview/interactive-example.tsx +6 -0
  575. package/dist/{docs → examples}/Grid/card-with-a-cta-that-opens-a-modal.tsx +6 -0
  576. package/dist/{docs → examples}/Grid/card-with-a-cta-that-opens-a-popup.tsx +6 -0
  577. package/dist/{docs → examples}/Grid/demo.tsx +6 -0
  578. package/dist/{docs → examples}/Grid/grid-sections.tsx +6 -0
  579. package/dist/{docs → examples}/Grid/grid-with-a-reduced-width.tsx +6 -0
  580. package/dist/{docs → examples}/Grid/use-the-preset-prop.tsx +6 -0
  581. package/dist/{docs → examples}/ImportButton/backup-error-handling.tsx +14 -0
  582. package/dist/{docs → examples}/ImportButton/cms-import.tsx +12 -0
  583. package/dist/{docs → examples}/ImportButton/create-new-field.tsx +12 -0
  584. package/dist/{docs → examples}/ImportButton/platformized-import-fields-inline.tsx +14 -0
  585. package/dist/{docs → examples}/ImportButton/platformized-import-from-a-source.tsx +6 -0
  586. package/dist/{docs → examples}/ImportButton/required-fields.tsx +14 -0
  587. package/dist/{docs → examples}/ImportButton/update-or-skip-by-id.tsx +12 -0
  588. package/dist/{docs → examples}/Indeterminate/all-indeterminate.tsx +14 -0
  589. package/dist/{docs → examples}/Indeterminate/items-indeterminate-status.tsx +14 -0
  590. package/dist/{docs → examples}/Internal Scroll/full-width-section.tsx +6 -0
  591. package/dist/{docs → examples}/Internal Scroll/narrow-side-section.tsx +6 -0
  592. package/dist/{docs → examples}/More Actions/collection-page-2.tsx +6 -0
  593. package/dist/{docs → examples}/More Actions/collection-page.tsx +6 -0
  594. package/dist/{docs → examples}/More Actions/explore-related-apps.tsx +6 -0
  595. package/dist/{docs → examples}/More Actions/featured-more-actions-custom-position.tsx +6 -0
  596. package/dist/{docs → examples}/More Actions/featured-more-actions-opt-out.tsx +6 -0
  597. package/dist/{docs → examples}/More Actions/featured-more-actions.tsx +6 -0
  598. package/dist/{docs → examples}/More Actions/integrate-with-extension.tsx +6 -0
  599. package/dist/{docs → examples}/More Actions/more-actions-in-the-toolbar.tsx +6 -0
  600. package/dist/{docs → examples}/More Actions/more-actions-with-a-divider.tsx +6 -0
  601. package/dist/{docs → examples}/MultiBulkActionToolbar/basic-secondary-action.tsx +6 -0
  602. package/dist/{docs → examples}/MultiBulkActionToolbar/bulk-action.tsx +6 -0
  603. package/dist/{docs → examples}/MultiBulkActionToolbar/extend-menu-items.tsx +6 -0
  604. package/dist/{docs → examples}/MultiBulkActionToolbar/maximum-selection.tsx +6 -0
  605. package/dist/{docs → examples}/MultiBulkActionToolbar/popover-menu.tsx +6 -0
  606. package/dist/{docs → examples}/MultiBulkActionToolbar/primary-secondary-actions-with-a-divider.tsx +6 -0
  607. package/dist/{docs → examples}/MultiLevelSorting/basic-multi-level-sorting.tsx +6 -0
  608. package/dist/{docs → examples}/MultiLevelSorting/multi-level-sorting-with-custom-sort-order.tsx +6 -0
  609. package/dist/{docs → examples}/MultiLevelSorting/multi-level-sorting-with-defined-sort-directions.tsx +6 -0
  610. package/dist/{docs → examples}/NestedTable/drag-and-drop.tsx +14 -0
  611. package/dist/{docs → examples}/NestedTable/filters.tsx +6 -0
  612. package/dist/{docs → examples}/NestedTable/flat-mode-search.tsx +14 -0
  613. package/dist/{docs → examples}/NestedTable/node-api-usage.tsx +14 -0
  614. package/dist/{docs → examples}/NestedTable/single-entity.tsx +14 -0
  615. package/dist/{docs → examples}/NestedTable/various-entities.tsx +14 -0
  616. package/dist/{docs → examples}/PickerModal/multi-select.tsx +14 -0
  617. package/dist/{docs → examples}/PickerModal/pre-selected-item.tsx +14 -0
  618. package/dist/{docs → examples}/PickerModal/search-override.tsx +14 -0
  619. package/dist/{docs → examples}/PickerModal/single-selection.tsx +14 -0
  620. package/dist/{docs → examples}/PickerModal/with-filter-dropdown.tsx +14 -0
  621. package/dist/{docs → examples}/PickerStandalone/basic.tsx +13 -0
  622. package/dist/{docs → examples}/PickerStandalone/createnew.tsx +13 -0
  623. package/dist/{docs → examples}/PickerStandalone/custom-empty-state.tsx +12 -0
  624. package/dist/{docs → examples}/PickerStandalone/custom-items.tsx +13 -0
  625. package/dist/{docs → examples}/SettingsPage/2-columns.tsx +6 -0
  626. package/dist/{docs → examples}/SettingsPage/basic.tsx +6 -0
  627. package/dist/{docs → examples}/SettingsPage/error-on-fetch.tsx +6 -0
  628. package/dist/{docs → examples}/SettingsPage/error-on-save.tsx +6 -0
  629. package/dist/{docs → examples}/SettingsPage/input-initialization-with-controller.tsx +6 -0
  630. package/dist/{docs → examples}/SettingsPage/input-initialization-with-usecontroller.tsx +6 -0
  631. package/dist/{docs → examples}/SettingsPage/loading.tsx +6 -0
  632. package/dist/{docs → examples}/SingleSelectFilter/custom-render-items.tsx +12 -0
  633. package/dist/{docs → examples}/SingleSelectFilter/empty-state.tsx +6 -0
  634. package/dist/{docs → examples}/SingleSelectFilter/sections.tsx +12 -0
  635. package/dist/{docs → examples}/SingleSelectFilter/server-data.tsx +12 -0
  636. package/dist/{docs → examples}/SingleSelectFilter/static-data.tsx +6 -0
  637. package/dist/{docs → examples}/Sortable Columns/basic-sortable-column.tsx +6 -0
  638. package/dist/{docs → examples}/Sortable Columns/custom-sort-order.tsx +6 -0
  639. package/dist/{docs → examples}/Suggestions/carousel-customization.tsx +6 -0
  640. package/dist/{docs → examples}/Suggestions/carousel-vs-container-layout.tsx +6 -0
  641. package/dist/{docs → examples}/Suggestions/custom-card-rendering.tsx +6 -0
  642. package/dist/{docs → examples}/Suggestions/with-transform-function.tsx +6 -0
  643. package/dist/{docs → examples}/SummaryBar/error.tsx +6 -0
  644. package/dist/{docs → examples}/SummaryBar/loading-with-error.tsx +6 -0
  645. package/dist/{docs → examples}/SummaryBar/loading-with-success.tsx +6 -0
  646. package/dist/{docs → examples}/SummaryBar/loading.tsx +6 -0
  647. package/dist/{docs → examples}/SummaryBar/success.tsx +6 -0
  648. package/dist/{docs → examples}/Table/basic-table.tsx +6 -0
  649. package/dist/{docs → examples}/Table/cursor-pagination.tsx +12 -0
  650. package/dist/{docs → examples}/Table/fetch-total-async.tsx +12 -0
  651. package/dist/{docs → examples}/Table/filters.tsx +6 -0
  652. package/dist/{docs → examples}/Table/header.tsx +6 -0
  653. package/dist/{docs → examples}/Table/horizontal-scroll.tsx +6 -0
  654. package/dist/{docs → examples}/Table/table-disabled-rows.tsx +6 -0
  655. package/dist/{docs → examples}/Table/using-ambassador.tsx +12 -0
  656. package/dist/{docs → examples}/Table/using-with-external-data-source.tsx +6 -0
  657. package/dist/{docs → examples}/Table/virtual.tsx +6 -0
  658. package/dist/{docs → examples}/Table Sections/demo.tsx +6 -0
  659. package/dist/{docs → examples}/Table Sections/with-badge.tsx +6 -0
  660. package/dist/{docs → examples}/Table Sections/with-collapse.tsx +6 -0
  661. package/dist/{docs → examples}/Table Sections/with-summary.tsx +6 -0
  662. package/dist/{docs → examples}/TableDragAndDrop/save-order-mode.tsx +6 -0
  663. package/dist/{docs → examples}/TableDragAndDrop/specific-filters.tsx +6 -0
  664. package/dist/{docs → examples}/TableDragAndDrop/specific-tabs.tsx +12 -0
  665. package/dist/{docs → examples}/TableDragAndDrop/table.tsx +6 -0
  666. package/dist/{docs → examples}/TableFolders/demo.tsx +14 -0
  667. package/dist/{docs → examples}/TableFolders/table-folders.tsx +14 -0
  668. package/dist/{docs → examples}/TableFolders/with-tags.tsx +15 -0
  669. package/dist/{docs → examples}/TableGridSwitch/basic-table-grid-switch.tsx +6 -0
  670. package/dist/{docs → examples}/TableGridSwitch/custom-columns.tsx +6 -0
  671. package/dist/{docs → examples}/TableGridSwitchFolders/demo.tsx +14 -0
  672. package/dist/{docs → examples}/TableGridSwitchFolders/tablegridswitchfolders.tsx +14 -0
  673. package/dist/{docs → examples}/TableGridSwitchFolders/with-tags.tsx +15 -0
  674. package/dist/{docs → examples}/TableTopNotification/base.tsx +14 -0
  675. package/dist/{docs → examples}/TableTopNotification/nested-table.tsx +14 -0
  676. package/dist/{docs → examples}/TabsFilter/basic-tabs.tsx +6 -0
  677. package/dist/{docs → examples}/TabsFilter/disabled-tabs.tsx +6 -0
  678. package/dist/{docs → examples}/TabsFilter/tabs-with-a-basic-counter.tsx +6 -0
  679. package/dist/{docs → examples}/TabsFilter/tabs-with-a-counter-badge.tsx +6 -0
  680. package/dist/{docs → examples}/Tags/basic.tsx +12 -0
  681. package/dist/{docs → examples}/Tags/custom-config-for-tags-column.tsx +12 -0
  682. package/dist/{docs → examples}/Tags/customized-filter-position.tsx +12 -0
  683. package/dist/{docs → examples}/Tags/customized-tags-column-position.tsx +12 -0
  684. package/dist/{docs → examples}/Tags/on-table-with-folders.tsx +15 -0
  685. package/dist/{docs → examples}/ToolbarFilters/2-filters-with-a-title.tsx +6 -0
  686. package/dist/{docs → examples}/ToolbarFilters/2-filters-without-a-title.tsx +6 -0
  687. package/dist/{docs → examples}/ToolbarFilters/add-filter-presets-for-future-dates.tsx +6 -0
  688. package/dist/{docs → examples}/ToolbarFilters/apply-changes.tsx +6 -0
  689. package/dist/{docs → examples}/ToolbarFilters/custom-label-for-tags.tsx +6 -0
  690. package/dist/{docs → examples}/ToolbarFilters/customize-filter-display-tags.tsx +6 -0
  691. package/dist/{docs → examples}/ToolbarFilters/mini-toolbar-with-filters.tsx +6 -0
  692. package/dist/{docs → examples}/ToolbarFilters/mini-toolbar.tsx +6 -0
  693. package/dist/{docs → examples}/ToolbarFilters/more-than-2-filters.tsx +6 -0
  694. package/dist/{docs → examples}/ToolbarFilters/postpone-collection-filter-initial-fetch.tsx +6 -0
  695. package/dist/{docs → examples}/ToolbarSecondaryActions/grouped-actions-with-dividers.tsx +6 -0
  696. package/dist/{docs → examples}/ToolbarSecondaryActions/mixed-buttons-and-dropdown-menus.tsx +6 -0
  697. package/dist/{docs → examples}/ToolbarSecondaryActions/multiple-actions-with-dropdown-menus.tsx +6 -0
  698. package/dist/{docs → examples}/ToolbarSecondaryActions/multiple-secondary-action-buttons.tsx +6 -0
  699. package/dist/{docs → examples}/ToolbarTitle/title-and-count.tsx +6 -0
  700. package/dist/{docs → examples}/ToolbarTitle/title-count-and-the-collection-s-item-limit.tsx +6 -0
  701. package/dist/{docs → examples}/ToolbarTitle/title-subtitle-and-learn-more.tsx +6 -0
  702. package/dist/{docs → examples}/ToolbarTitle/title.tsx +6 -0
  703. package/dist/{docs → examples}/Views/basic-view-that-can-be-chosen.tsx +6 -0
  704. package/dist/{docs → examples}/Views/basic-view.tsx +6 -0
  705. package/dist/{docs → examples}/Views/view-with-selected-columns.tsx +6 -0
  706. package/dist/{docs → examples}/Views/views-separated-by-category-in-the-dropdown.tsx +6 -0
  707. package/dist/{docs → examples}/useOptimisticActions/custom-error-handling.tsx +6 -0
  708. package/dist/{docs → examples}/useOptimisticActions/default-behaviour.tsx +6 -0
  709. package/dist/{docs → examples}/useOptimisticActions/error-handling-and-retries.tsx +6 -0
  710. package/dist/{docs → examples}/useOptimisticActions/items-orders.tsx +6 -0
  711. package/dist/{docs → examples}/useOptimisticActions/revision-handling.tsx +6 -0
  712. package/dist/{docs → examples}/useOptimisticActions/success-toast-with-undo.tsx +6 -0
  713. package/dist/{docs → examples}/useOptimisticActions/update-with-query.tsx +14 -0
  714. package/dist/types/components/ActionCell/ActionCell.d.ts +1 -0
  715. package/dist/types/components/ActionCell/ActionCell.d.ts.map +1 -1
  716. package/dist/types/components/CardContainer/CardContainer.st.css.d.ts.map +1 -1
  717. package/dist/types/components/CmsFieldManagement/CmsFieldForm.st.css.d.ts.map +1 -1
  718. package/dist/types/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.d.ts.map +1 -1
  719. package/dist/types/components/Collapse/Collapse.st.css.d.ts.map +1 -1
  720. package/dist/types/components/CollectionPageNew/CollectionPage.st.css.d.ts.map +1 -1
  721. package/dist/types/components/CollectionTable/CollectionTable.uni.driver.d.ts +20 -4
  722. package/dist/types/components/CollectionTable/CollectionTable.uni.driver.d.ts.map +1 -1
  723. package/dist/types/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.d.ts.map +1 -1
  724. package/dist/types/components/CustomFieldFilters/CheckboxCustomFieldFilter.d.ts.map +1 -1
  725. package/dist/types/components/CustomFieldFilters/checkboxFilterOptions.d.ts +10 -0
  726. package/dist/types/components/CustomFieldFilters/checkboxFilterOptions.d.ts.map +1 -0
  727. package/dist/types/components/CustomFieldsTransforms/transformCustomCheckboxToWQL.d.ts.map +1 -1
  728. package/dist/types/components/EditableTable/EditableCell.st.css.d.ts.map +1 -1
  729. package/dist/types/components/EditableTable/EditableTable.d.ts.map +1 -1
  730. package/dist/types/components/EditableTable/EditableTable.uni.driver.d.ts +83 -48
  731. package/dist/types/components/EditableTable/EditableTable.uni.driver.d.ts.map +1 -1
  732. package/dist/types/components/EditableTable/cellTypes/CellViewLayout.st.css.d.ts.map +1 -1
  733. package/dist/types/components/EditableTable/cellTypes/address/Edit.st.css.d.ts.map +1 -1
  734. package/dist/types/components/EditableTable/cellTypes/date/View.st.css.d.ts.map +1 -1
  735. package/dist/types/components/EditableTable/cellTypes/email/Edit.st.css.d.ts.map +1 -1
  736. package/dist/types/components/EditableTable/cellTypes/email/View.st.css.d.ts.map +1 -1
  737. package/dist/types/components/EditableTable/cellTypes/number/View.st.css.d.ts.map +1 -1
  738. package/dist/types/components/EditableTable/cellTypes/object/Edit.st.css.d.ts.map +1 -1
  739. package/dist/types/components/EditableTable/cellTypes/text/Edit.st.css.d.ts.map +1 -1
  740. package/dist/types/components/EditableTable/cellTypes/text/View.st.css.d.ts.map +1 -1
  741. package/dist/types/components/EntityPage/EntityPagePlain.st.css.d.ts.map +1 -1
  742. package/dist/types/components/EntityPageFields/EntityPageField.d.ts +3 -1
  743. package/dist/types/components/EntityPageFields/EntityPageField.d.ts.map +1 -1
  744. package/dist/types/components/EntityPageFields/EntityPageFields.d.ts.map +1 -1
  745. package/dist/types/components/EntityPageFields/EntityPageReferenceField.d.ts.map +1 -1
  746. package/dist/types/components/EntityPageFields/EntityPageReferenceValue.d.ts +11 -0
  747. package/dist/types/components/EntityPageFields/EntityPageReferenceValue.d.ts.map +1 -0
  748. package/dist/types/components/EntityPageFields/useReferencedSchema.d.ts +8 -0
  749. package/dist/types/components/EntityPageFields/useReferencedSchema.d.ts.map +1 -0
  750. package/dist/types/components/Fade/Fade.st.css.d.ts.map +1 -1
  751. package/dist/types/components/InputOverflow/InputOverflow.st.css.d.ts.map +1 -1
  752. package/dist/types/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.d.ts.map +1 -1
  753. package/dist/types/components/NestedTable/NestedTable.uni.driver.d.ts +1 -0
  754. package/dist/types/components/NestedTable/NestedTable.uni.driver.d.ts.map +1 -1
  755. package/dist/types/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.d.ts.map +1 -1
  756. package/dist/types/components/NestedTable/NestedTableRow.st.css.d.ts.map +1 -1
  757. package/dist/types/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.d.ts.map +1 -1
  758. package/dist/types/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.d.ts.map +1 -1
  759. package/dist/types/components/PickerContent/PickerContent.st.css.d.ts.map +1 -1
  760. package/dist/types/components/PickerContent/PickerContentAdditionalStep.st.css.d.ts.map +1 -1
  761. package/dist/types/components/ScrollableContent/ScrollableContent.st.css.d.ts.map +1 -1
  762. package/dist/types/components/SlidingModal/SlidingModal.st.css.d.ts.map +1 -1
  763. package/dist/types/components/Table/Table.uni.driver.d.ts +1 -0
  764. package/dist/types/components/Table/Table.uni.driver.d.ts.map +1 -1
  765. package/dist/types/components/TableFolders/TableFolders.uni.driver.d.ts +1 -0
  766. package/dist/types/components/TableFolders/TableFolders.uni.driver.d.ts.map +1 -1
  767. package/dist/types/components/TableGridSwitch/TableGridSwitch.uni.driver.d.ts +1 -0
  768. package/dist/types/components/TableGridSwitch/TableGridSwitch.uni.driver.d.ts.map +1 -1
  769. package/dist/types/components/ToolbarItem/ToolbarItem.st.css.d.ts.map +1 -1
  770. package/dist/types/schema/EntityPageFieldsCard.d.ts +2 -1
  771. package/dist/types/schema/EntityPageFieldsCard.d.ts.map +1 -1
  772. package/dist/types/state/CollectionPage/CollectionPageHeader.st.css.d.ts.map +1 -1
  773. package/dist/types/state/CustomColumnsEntityPageState.d.ts +1 -1
  774. package/dist/types/state/CustomColumnsEntityPageState.d.ts.map +1 -1
  775. package/dist/types/state/EntityPage/resolveEntityPageFields.d.ts +4 -4
  776. package/dist/types/state/EntityPage/resolveEntityPageFields.d.ts.map +1 -1
  777. package/dist/types/state/EntityPageFieldsCardState.d.ts +1 -3
  778. package/dist/types/state/EntityPageFieldsCardState.d.ts.map +1 -1
  779. package/dist/types/state/buildEditableFieldColumns.d.ts.map +1 -1
  780. package/dist/types/state/buildFieldColumns.d.ts.map +1 -1
  781. package/dist/types/testkit/enzyme.d.ts +4 -0
  782. package/dist/types/testkit/enzyme.d.ts.map +1 -1
  783. package/dist/types/testkit/jsdom.d.ts +6 -0
  784. package/dist/types/testkit/jsdom.d.ts.map +1 -1
  785. package/dist/types/testkit/playwright.d.ts +6 -0
  786. package/dist/types/testkit/playwright.d.ts.map +1 -1
  787. package/dist/types/testkit/puppeteer.d.ts +6 -0
  788. package/dist/types/testkit/puppeteer.d.ts.map +1 -1
  789. package/dist/types/version.d.ts +1 -1
  790. package/package.json +8 -7
  791. package/src/components/ActionCell/ActionCell.ts +1 -0
  792. package/src/components/CardContainer/CardContainer.st.css.ts +2 -2
  793. package/src/components/CmsFieldManagement/CmsFieldForm.st.css.ts +2 -2
  794. package/src/components/CmsFieldManagement/CmsFieldModal.st.css.ts +2 -2
  795. package/src/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.ts +2 -2
  796. package/src/components/Collapse/Collapse.st.css.ts +2 -2
  797. package/src/components/CollectionPageNew/CollectionPage.st.css.ts +2 -2
  798. package/src/components/CollectionSectionHeader/CollectionSectionHeader.st.css.ts +2 -2
  799. package/src/components/CollectionTable/CollectionTable.st.css.ts +2 -2
  800. package/src/components/CollectionTable/CollectionTable.uni.driver.ts +13 -0
  801. package/src/components/CollectionTable/CollectionTableWSRTable.st.css.ts +2 -2
  802. package/src/components/CollectionToolbar/CollectionToolbar.st.css.ts +2 -2
  803. package/src/components/CollectionToolbar/SearchOrCustomFilter.st.css.ts +2 -2
  804. package/src/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.ts +2 -2
  805. package/src/components/CollectionViewsDropdown/ViewsDropdown.st.css.ts +2 -2
  806. package/src/components/CustomFieldFilters/CheckboxCustomFieldFilter.tsx +3 -2
  807. package/src/components/CustomFieldFilters/checkboxFilterOptions.ts +9 -0
  808. package/src/components/CustomFieldsTransforms/transformCustomCheckboxToWQL.tsx +6 -3
  809. package/src/components/DragHandle/DragHandle.st.css.ts +2 -2
  810. package/src/components/EditableTable/EditableCell.st.css.ts +2 -2
  811. package/src/components/EditableTable/EditableTable.tsx +13 -3
  812. package/src/components/EditableTable/EditableTable.uni.driver.ts +15 -1
  813. package/src/components/EditableTable/HeaderActionsPopover.st.css.ts +2 -2
  814. package/src/components/EditableTable/cellTypes/CellViewLayout.st.css.ts +2 -2
  815. package/src/components/EditableTable/cellTypes/address/Edit.st.css.ts +2 -2
  816. package/src/components/EditableTable/cellTypes/array/Edit.st.css.ts +2 -2
  817. package/src/components/EditableTable/cellTypes/boolean/Edit.st.css.ts +2 -2
  818. package/src/components/EditableTable/cellTypes/boolean/View.st.css.ts +2 -2
  819. package/src/components/EditableTable/cellTypes/color/Edit.st.css.ts +2 -2
  820. package/src/components/EditableTable/cellTypes/date/Edit.st.css.ts +2 -2
  821. package/src/components/EditableTable/cellTypes/date/View.st.css.ts +2 -2
  822. package/src/components/EditableTable/cellTypes/datetime/Edit.st.css.ts +2 -2
  823. package/src/components/EditableTable/cellTypes/datetime/View.st.css.ts +2 -2
  824. package/src/components/EditableTable/cellTypes/email/Edit.st.css.ts +2 -2
  825. package/src/components/EditableTable/cellTypes/email/View.st.css.ts +2 -2
  826. package/src/components/EditableTable/cellTypes/number/Edit.st.css.ts +2 -2
  827. package/src/components/EditableTable/cellTypes/number/View.st.css.ts +2 -2
  828. package/src/components/EditableTable/cellTypes/object/Edit.st.css.ts +2 -2
  829. package/src/components/EditableTable/cellTypes/object/View.st.css.ts +2 -2
  830. package/src/components/EditableTable/cellTypes/select/Edit.st.css.ts +2 -2
  831. package/src/components/EditableTable/cellTypes/text/Edit.st.css.ts +2 -2
  832. package/src/components/EditableTable/cellTypes/text/View.st.css.ts +2 -2
  833. package/src/components/EditableTable/cellTypes/time/Edit.st.css.ts +2 -2
  834. package/src/components/EditableTable/cellTypes/url/Edit.st.css.ts +2 -2
  835. package/src/components/EditableTable/cellTypes/url/View.st.css.ts +2 -2
  836. package/src/components/EmptyState/EmptyStateBase.st.css.ts +2 -2
  837. package/src/components/EntityPage/EntityPagePlain.st.css.ts +2 -2
  838. package/src/components/EntityPageFields/EntityPageField.tsx +47 -2
  839. package/src/components/EntityPageFields/EntityPageFields.tsx +6 -6
  840. package/src/components/EntityPageFields/EntityPageReferenceField.tsx +5 -39
  841. package/src/components/EntityPageFields/EntityPageReferenceValue.tsx +64 -0
  842. package/src/components/EntityPageFields/useReferencedSchema.ts +42 -0
  843. package/src/components/Fade/Fade.st.css.ts +2 -2
  844. package/src/components/Heading/Heading.st.css.ts +2 -2
  845. package/src/components/ImportButton/ImportStepUpload.st.css.ts +2 -2
  846. package/src/components/InputOverflow/InputOverflow.st.css.ts +2 -2
  847. package/src/components/LoadingRow/LoadingRow.st.css.ts +3 -3
  848. package/src/components/MaxHeightText/MaxHeightText.st.css.ts +2 -2
  849. package/src/components/MaxLines/MaxLines.st.css.ts +2 -2
  850. package/src/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.ts +2 -2
  851. package/src/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.ts +2 -2
  852. package/src/components/NestedTable/NestedTableRow.st.css.ts +2 -2
  853. package/src/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.ts +2 -2
  854. package/src/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.ts +2 -2
  855. package/src/components/PickerContent/PickerContent.st.css.ts +2 -2
  856. package/src/components/PickerContent/PickerContentAdditionalStep.st.css.ts +2 -2
  857. package/src/components/PickerTableListItem/PickerTableListItem.st.css.ts +2 -2
  858. package/src/components/ScrollableContent/ScrollableContent.st.css.ts +2 -2
  859. package/src/components/SetupWidget/SetupWidget.st.css.ts +2 -2
  860. package/src/components/SkeletonCard/SkeletonCard.st.css.ts +2 -2
  861. package/src/components/SlidingModal/SlidingModal.st.css.ts +2 -2
  862. package/src/components/Table/AddFieldColumnHeader.st.css.ts +2 -2
  863. package/src/components/TabsFilter/TabsFilter.st.css.ts +2 -2
  864. package/src/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.ts +2 -2
  865. package/src/components/ToolbarItem/ToolbarItem.st.css.ts +2 -2
  866. package/src/components/ToolbarItemBox/ToolbarItemBox.st.css.ts +2 -2
  867. package/src/components/common.st.css.ts +2 -2
  868. package/src/schema/EntityPageFieldsCard.tsx +2 -1
  869. package/src/state/CollectionPage/CollectionPageHeader.st.css.ts +2 -2
  870. package/src/state/CustomColumnsEntityPageState.ts +7 -4
  871. package/src/state/EntityPage/resolveEntityPageFields.ts +22 -11
  872. package/src/state/EntityPageFieldsCardState.ts +11 -12
  873. package/src/state/FormPage/FormPageHeader.st.css.ts +2 -2
  874. package/src/state/buildEditableFieldColumns.ts +6 -0
  875. package/src/state/buildFieldColumns.tsx +3 -0
  876. package/src/styles.global.css +2 -2
  877. package/src/version.ts +1 -1
@@ -1,24 +1,35 @@
1
1
  {
2
- "ActionSubItem": {
3
- "file": "ActionSubItem.md",
4
- "category": "Common/Types"
5
- },
6
2
  "AI Assistant": {
7
3
  "file": "AI Assistant.md",
8
4
  "category": "Integrations/AI Assistant",
5
+ "summary": "Wix Patterns allows you to integrate your AI Assistant with a collection and use it to add items to that collection. Items are added smoothly with a dedicated animation.",
6
+ "importPath": "@wix/patterns",
9
7
  "symbols": [
10
8
  "createAiAssistant"
11
9
  ]
12
10
  },
11
+ "ActionSubItem": {
12
+ "file": "ActionSubItem.md",
13
+ "category": "Common/Types",
14
+ "summary": "Pass `ActionSubItem` to PrimaryActions, SecondaryActions , or in MultiBulkActionToolbar."
15
+ },
13
16
  "AutoCompleteFilter": {
14
17
  "file": "AutoCompleteFilter.md",
15
18
  "category": "Features/Filter/Components",
16
- "bundle": "components/AutoCompleteFilter.d.ts"
19
+ "summary": "AutoCompleteProps",
20
+ "importPath": "@wix/patterns",
21
+ "bundle": "components/AutoCompleteFilter.d.ts",
22
+ "propsTotal": 122,
23
+ "propsTypeName": "Omit"
17
24
  },
18
25
  "CollectionEmptyState": {
19
26
  "file": "CollectionEmptyState.md",
20
27
  "category": "Features/Display/Empty States",
28
+ "summary": "Displays an empty state for a table when no items exist in the collection. Pass through the `emptyState` prop of a `Grid`, `Table`, or other collection component.",
29
+ "importPath": "@wix/patterns",
21
30
  "bundle": "components/CollectionEmptyState.d.ts",
31
+ "propsTotal": 12,
32
+ "propsTypeName": "CollectionEmptyStateProps",
22
33
  "examples": [
23
34
  "CollectionEmptyState/demo.tsx",
24
35
  "CollectionEmptyState/2-ctas.tsx",
@@ -27,17 +38,26 @@
27
38
  },
28
39
  "CollectionErrorState": {
29
40
  "file": "CollectionErrorState.md",
30
- "category": "Common/State"
41
+ "category": "Common/State",
42
+ "summary": "The `CollectionErrorState` component displays an error state for a collection when a data fetch fails. Pass this component to the `errorState` prop of a collection component, such as a Grid or a Table.",
43
+ "importPath": "@wix/patterns"
31
44
  },
32
45
  "CollectionNoResultsState": {
33
46
  "file": "CollectionNoResultsState.md",
34
47
  "category": "Features/Display/Empty States",
35
- "bundle": "components/CollectionNoResultsState.d.ts"
48
+ "summary": "Displays an empty state when a filter or search has no results. Pass through the `noResultsState` prop of a `Grid`, `Table`, or other collection component.",
49
+ "importPath": "@wix/patterns",
50
+ "bundle": "components/CollectionNoResultsState.d.ts",
51
+ "propsTotal": 9,
52
+ "propsTypeName": "Omit"
36
53
  },
37
54
  "CollectionOptimisticActions": {
38
55
  "file": "CollectionOptimisticActions.md",
39
56
  "category": "Features/Actions/Updates",
57
+ "summary": "The CollectionOptimisticActions class provides a set of utilities for managing optimistic actions on a collection of data. It allows performing various actions such as adding, updating, and deleting items from a collection while assuming that these actions will succeed, even before confirming with the server.",
40
58
  "bundle": "components/CollectionOptimisticActions.d.ts",
59
+ "propsTotal": 8,
60
+ "propsTypeName": "CollectionOptimisticActions",
41
61
  "examples": [
42
62
  "CollectionOptimisticActions/create-one.tsx",
43
63
  "CollectionOptimisticActions/create-many.tsx",
@@ -52,15 +72,17 @@
52
72
  "CollectionPage": {
53
73
  "file": "CollectionPage.md",
54
74
  "category": "Base Components/Pages/Collection Page",
55
- "bundle": "components/CollectionPage.d.ts"
56
- },
57
- "CollectionPage.Content": {
58
- "file": "CollectionPage.Content.md",
59
- "category": "Base Components/Pages/Collection Page"
75
+ "summary": "CollectionPage wraps <Page/> from `@wix/design-system`. It provides scrolling context for collection components, such as <Table/>. Also, it displays total items count in the page header.",
76
+ "importPath": "@wix/patterns/page",
77
+ "bundle": "components/CollectionPage.d.ts",
78
+ "propsTotal": 13,
79
+ "propsTypeName": "CollectionPageProps"
60
80
  },
61
81
  "CollectionPage.Header": {
62
82
  "file": "CollectionPage.Header.md",
63
83
  "category": "Base Components/Pages/Collection Page",
84
+ "summary": "This component renders a Page.Header component inside a CollectionPage.",
85
+ "importPath": "@wix/patterns/page",
64
86
  "symbols": [
65
87
  "CollectionPageHeader"
66
88
  ],
@@ -70,15 +92,29 @@
70
92
  "CollectionPage.Header/with-badges.tsx"
71
93
  ]
72
94
  },
95
+ "CollectionPage.Content": {
96
+ "file": "CollectionPage.Content.md",
97
+ "category": "Base Components/Pages/Collection Page",
98
+ "summary": "This component acts as a container for collection components like Table and Grid, which should be sent as children.",
99
+ "importPath": "@wix/patterns/page"
100
+ },
73
101
  "CollectionPremiumEmptyState": {
74
102
  "file": "CollectionPremiumEmptyState.md",
75
103
  "category": "Features/Display/Empty States",
76
- "bundle": "components/CollectionPremiumEmptyState.d.ts"
104
+ "summary": "Displays an empty state encouraging users to upgrade to a premiuim plan. Pass through the `emptyState` prop of a `Grid`, `Table`, or other collection component.",
105
+ "importPath": "@wix/patterns",
106
+ "bundle": "components/CollectionPremiumEmptyState.d.ts",
107
+ "propsTotal": 12,
108
+ "propsTypeName": "CollectionPremiumEmptyStateProps"
77
109
  },
78
110
  "CollectionSearch": {
79
111
  "file": "CollectionSearch.md",
80
112
  "category": "Features/Filter/Components",
113
+ "summary": "`CollectionSearch` adds a search input to the collection toolbar, allowing users to filter items by free-text search. When a user types in the search box, the search term is passed to your `fetchData` function via `query.search`, enabling server-side filtering.",
114
+ "importPath": "@wix/patterns",
81
115
  "bundle": "components/CollectionSearch.d.ts",
116
+ "propsTotal": 2,
117
+ "propsTypeName": "CollectionSearchProps",
82
118
  "examples": [
83
119
  "CollectionSearch/default.tsx",
84
120
  "CollectionSearch/max-length.tsx",
@@ -88,15 +124,19 @@
88
124
  },
89
125
  "CollectionSubToolbar": {
90
126
  "file": "CollectionSubToolbar.md",
91
- "category": "Common/Components"
127
+ "category": "Common/Components",
128
+ "summary": "The sub-toolbar is rendered below the main collection toolbar. It displays applied filter tags so users can see and remove active filters at a glance. This component is used internally by `Table`, `Grid`, and other collection components — you do not need to render it directly. To control its behavior, configure filters on the collection state."
92
129
  },
93
130
  "CollectionToolbar": {
94
131
  "file": "CollectionToolbar.md",
95
- "category": "Common/Components"
132
+ "category": "Common/Components",
133
+ "summary": "`CollectionToolbar` is the internal toolbar component rendered by `Table`, `Grid`, and other collection components. It displays the title, search input, filters, custom columns, sort, export button, primary/secondary actions, more actions, and view switcher. You do not render this component directly — instead, configure the toolbar through props on the collection component (e.g."
96
134
  },
97
135
  "ToolbarFilters": {
98
136
  "file": "ToolbarFilters.md",
99
137
  "category": "Features/Filter/Components",
138
+ "summary": "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.",
139
+ "importPath": "@wix/patterns",
100
140
  "bundle": "components/CollectionToolbarFilters.d.ts",
101
141
  "symbols": [
102
142
  "CollectionToolbarFilters"
@@ -117,6 +157,7 @@
117
157
  "CustomFieldType": {
118
158
  "file": "CustomFieldType.md",
119
159
  "category": "Features/Enrich/Custom Field Types",
160
+ "summary": "A **custom field type** is a consumer-defined field that plugs into every schema-driven surface. Define it once with `defineFieldType<V>()` and register it on the schema source via `fieldTypes` — the page wires nothing per surface. Each surface resolves its own slot from the definition:",
120
161
  "examples": [
121
162
  "CustomFieldType/table-cell-and-filter.tsx",
122
163
  "CustomFieldType/editable-cell.tsx",
@@ -124,13 +165,34 @@
124
165
  "CustomFieldType/entity-page-form.tsx"
125
166
  ]
126
167
  },
168
+ "CustomColumns": {
169
+ "file": "CustomColumns.md",
170
+ "category": "Features/Display/Custom Columns",
171
+ "summary": "Allows users to control the display behavior of `Table` columns. For more information, see Custom Columns Overview.",
172
+ "importPath": "@wix/patterns",
173
+ "examples": [
174
+ "CustomColumns/basic.tsx",
175
+ "CustomColumns/hide-specific-columns-by-default.tsx",
176
+ "CustomColumns/lock-columns.tsx",
177
+ "CustomColumns/exclude-columns.tsx",
178
+ "CustomColumns/add-a-tooltip.tsx",
179
+ "CustomColumns/reorder-columns.tsx",
180
+ "CustomColumns/freeze-column-reorder.tsx",
181
+ "CustomColumns/load-only-selected-columns.tsx",
182
+ "CustomColumns/get-visible-columns.tsx"
183
+ ]
184
+ },
127
185
  "CustomFieldsViewWidget": {
128
186
  "file": "CustomFieldsViewWidget.md",
129
- "category": "Features/Enrich/Data Extension/Components"
187
+ "category": "Features/Enrich/Data Extension/Components",
188
+ "summary": "The `CustomFieldsViewWidget` component enhances the entity page by displaying both user-defined custom fields and custom fields that are defined by apps that are installed on the site.",
189
+ "importPath": "@wix/patterns"
130
190
  },
131
191
  "CustomFieldsWidget": {
132
192
  "file": "CustomFieldsWidget.md",
133
193
  "category": "Features/Enrich/Data Extension/Components",
194
+ "summary": "The `CustomFieldsWidget` component enhances the entity page by displaying user-defined custom fields. It not only shows existing custom fields but also acts as a form, enabling users to fill in data for those fields and submit it. Additionally, the widget provides functionality to manage existing fields and add new ones.",
195
+ "importPath": "@wix/patterns",
134
196
  "examples": [
135
197
  "CustomFieldsWidget/basic.tsx",
136
198
  "CustomFieldsWidget/responsive.tsx",
@@ -141,30 +203,23 @@
141
203
  "CustomFieldsWidget/with-tpa-fields.tsx"
142
204
  ]
143
205
  },
144
- "CustomColumns": {
145
- "file": "CustomColumns.md",
146
- "category": "Features/Display/Custom Columns",
147
- "examples": [
148
- "CustomColumns/basic.tsx",
149
- "CustomColumns/hide-specific-columns-by-default.tsx",
150
- "CustomColumns/lock-columns.tsx",
151
- "CustomColumns/exclude-columns.tsx",
152
- "CustomColumns/add-a-tooltip.tsx",
153
- "CustomColumns/reorder-columns.tsx",
154
- "CustomColumns/freeze-column-reorder.tsx",
155
- "CustomColumns/load-only-selected-columns.tsx",
156
- "CustomColumns/get-visible-columns.tsx"
157
- ]
158
- },
159
206
  "DateRangeFilter": {
160
207
  "file": "DateRangeFilter.Components.md",
161
208
  "category": "Features/Filter/Components",
162
- "bundle": "components/DateRangeFilter.d.ts"
209
+ "summary": "Use `DateRangeFilter` for rendering a date range.",
210
+ "importPath": "@wix/patterns",
211
+ "bundle": "components/DateRangeFilter.d.ts",
212
+ "propsTotal": 69,
213
+ "propsTypeName": "DateRangeFilterProps"
163
214
  },
164
215
  "EntityPage": {
165
216
  "file": "EntityPage.md",
166
217
  "category": "Base Components/Pages/Entity Page",
218
+ "summary": "The `EntityPage` component serves as a container that encapsulates the logic and layout structure for rendering an entity page. It provides a structured and organized way to display and manage information related to a specific entity.",
219
+ "importPath": "@wix/patterns",
167
220
  "bundle": "components/EntityPage.d.ts",
221
+ "propsTotal": 15,
222
+ "propsTypeName": "EntityPageProps",
168
223
  "examples": [
169
224
  "EntityPage/demo.tsx",
170
225
  "EntityPage/basic.tsx",
@@ -181,32 +236,48 @@
181
236
  },
182
237
  "EntityPage.AdditionalContent": {
183
238
  "file": "EntityPage.AdditionalContent.md",
184
- "category": "Base Components/Pages/Entity Page"
239
+ "category": "Base Components/Pages/Entity Page",
240
+ "summary": "A slot component for the side panel of an `EntityPage`. Place it inside `<EntityPage.Content>` alongside `<EntityPage.MainContent>`. Supports an optional `sticky` prop to keep the content fixed while scrolling.",
241
+ "importPath": "@wix/patterns"
185
242
  },
186
243
  "EntityPage.Card": {
187
244
  "file": "EntityPage.Card.md",
188
- "category": "Base Components/Pages/Entity Page"
245
+ "category": "Base Components/Pages/Entity Page",
246
+ "summary": "A card container used inside `EntityPage.MainContent` or `EntityPage.AdditionalContent`. It wraps form fields and content sections with a card layout, and supports loading/error/success states for async content.",
247
+ "importPath": "@wix/patterns"
248
+ },
249
+ "EntityPage.MainContent": {
250
+ "file": "EntityPage.MainContent.md",
251
+ "category": "Base Components/Pages/Entity Page",
252
+ "summary": "A slot component for the main content area of an `EntityPage`. Place it inside `<EntityPage.Content>`. This is where you render the primary form fields and cards.",
253
+ "importPath": "@wix/patterns"
189
254
  },
190
255
  "EntityPage.Content": {
191
256
  "file": "EntityPage.Content.md",
192
- "category": "Base Components/Pages/Entity Page"
257
+ "category": "Base Components/Pages/Entity Page",
258
+ "summary": "A layout slot for the body of an `EntityPage`. Wraps `<EntityPage.MainContent>` and optionally `<EntityPage.AdditionalContent>` to create the two-column layout.",
259
+ "importPath": "@wix/patterns"
193
260
  },
194
261
  "EntityPage.Header": {
195
262
  "file": "EntityPage.Header.md",
196
- "category": "Base Components/Pages/Entity Page"
197
- },
198
- "EntityPage.MainContent": {
199
- "file": "EntityPage.MainContent.md",
200
- "category": "Base Components/Pages/Entity Page"
263
+ "category": "Base Components/Pages/Entity Page",
264
+ "summary": "The header component for an `EntityPage`. Renders the page title, optional subtitle, breadcrumbs, badges, and a more-actions menu. Place it as a direct child of `<EntityPage>`.",
265
+ "importPath": "@wix/patterns"
201
266
  },
202
267
  "EntityPage.Slots": {
203
268
  "file": "EntityPage.Slots.md",
204
- "category": "Base Components/Pages/Entity Page"
269
+ "category": "Base Components/Pages/Entity Page",
270
+ "summary": "A slot container for rendering TPA plugin widgets inside an `EntityPage`. Pass a `containerId` from your Dev Center app to render third-party plugins in the entity page layout. Learn more about Slots and Plugins.",
271
+ "importPath": "@wix/patterns"
205
272
  },
206
273
  "Grid": {
207
274
  "file": "Grid.md",
208
275
  "category": "Base Components/Collections/Grid/Grid",
276
+ "summary": "The `Grid` component displays cards in rows and columns as an alternative to tables. It is responsive, adjusting the number of cards per row based on the viewport width, and includes built-in virtualization for efficient rendering of many items without impacting performance.",
277
+ "importPath": "@wix/patterns",
209
278
  "bundle": "components/Grid.d.ts",
279
+ "propsTotal": 39,
280
+ "propsTypeName": "GridProps",
210
281
  "examples": [
211
282
  "Grid/demo.tsx",
212
283
  "Grid/card-with-a-cta-that-opens-a-modal.tsx",
@@ -219,27 +290,37 @@
219
290
  "GridFolders": {
220
291
  "file": "GridFolders.md",
221
292
  "category": "Base Components/Collections/GridFolders/GridFolders",
222
- "bundle": "components/GridFolders.d.ts"
293
+ "summary": "The `GridFolders` component presents folders and their respective content in a visually organized grid view, where each part is neatly divided into its own dedicated section. The `useGridFolders()` hook manages the state and behavior of the grid component based on the provided collections.",
294
+ "importPath": "@wix/patterns",
295
+ "bundle": "components/GridFolders.d.ts",
296
+ "propsTotal": 43,
297
+ "propsTypeName": "GridFoldersBaseProps"
223
298
  },
224
299
  "GridFoldersSection": {
225
300
  "file": "GridFoldersSection.md",
226
- "category": "Base Components/Collections/GridFolders/GridFoldersSection"
301
+ "category": "Base Components/Collections/GridFolders/GridFoldersSection",
302
+ "summary": "`GridFoldersSection` renders a section within a `GridFolders` layout — either the folders section or the items section. Each section can include an optional `header` (e.g. a section title) and accepts `children` for the grid content. This component is typically used in conjunction with `GridFolders` and `useGridCollection`."
227
303
  },
228
304
  "Grid Sections": {
229
305
  "file": "Grid Sections.md",
230
- "category": "Features/Display/Grid Sections"
306
+ "category": "Features/Display/Grid Sections",
307
+ "summary": "Group `Grid` data into sections."
231
308
  },
232
309
  "GridSectionsProp": {
233
310
  "file": "GridSectionsProp.md",
234
- "category": "Common/Types"
311
+ "category": "Common/Types",
312
+ "summary": "Configuration object for the `sections` prop on `Grid`. Enables grouping grid items into sections with headers. Provide a `GridSections` component, a `groupBy` function that extracts the grouping key from each item, and an optional `renderSection` callback for custom section headers."
235
313
  },
236
314
  "Highlighted Search": {
237
315
  "file": "Highlighted Search.md",
238
- "category": "Features/Display/Highlighted Search"
316
+ "category": "Features/Display/Highlighted Search",
317
+ "summary": "The searchable prop on table columns allows you to specify whether a column's content is included in search operations. When a search is performed, matching text within searchable columns is automatically highlighted in the UI."
239
318
  },
240
319
  "ImportButton": {
241
320
  "file": "ImportButton.md",
242
321
  "category": "Features/Import",
322
+ "summary": "The `ImportButton` is the platformized solution for importing a CSV file into a collection.",
323
+ "importPath": "@wix/patterns",
243
324
  "examples": [
244
325
  "ImportButton/cms-import.tsx",
245
326
  "ImportButton/platformized-import-fields-inline.tsx",
@@ -253,6 +334,7 @@
253
334
  "Internal Scroll": {
254
335
  "file": "Internal Scroll.md",
255
336
  "category": "Features/Display/Internal Scroll",
337
+ "summary": "The \"internalScroll\" prop enables internal scrolling within the component itself, by wrapping it inside a limited height container.",
256
338
  "examples": [
257
339
  "Internal Scroll/full-width-section.tsx",
258
340
  "Internal Scroll/narrow-side-section.tsx"
@@ -260,11 +342,13 @@
260
342
  },
261
343
  "Explore Apps": {
262
344
  "file": "Explore Apps.md",
263
- "category": "Integrations/ExploreApps"
345
+ "category": "Integrations/ExploreApps",
346
+ "summary": "Enable users to explore third-party apps that may provide additional business solutions for them. This is an integration with App Market’s solution, allowing users to explore and install apps while staying within context."
264
347
  },
265
348
  "More Actions": {
266
349
  "file": "More Actions.md",
267
350
  "category": "Features/Actions/ More Actions",
351
+ "summary": "Displays a menu of more actions on a page component.",
268
352
  "examples": [
269
353
  "More Actions/collection-page.tsx",
270
354
  "More Actions/collection-page-2.tsx",
@@ -280,26 +364,44 @@
280
364
  "MultiAutoInlineCheckboxFilter": {
281
365
  "file": "MultiAutoInlineCheckboxFilter.md",
282
366
  "category": "Features/Filter/Components",
283
- "bundle": "components/MultiAutoInlineCheckboxFilter.d.ts"
367
+ "summary": "`MultiAutoInlineCheckboxFilter` is based on MultiInlineCheckboxFilter and MultiSelectCheckboxFilter.",
368
+ "importPath": "@wix/patterns",
369
+ "bundle": "components/MultiAutoInlineCheckboxFilter.d.ts",
370
+ "propsTotal": 50,
371
+ "propsTypeName": "MultiAutoInlineCheckboxFilterProps"
284
372
  },
285
373
  "MultiInlineCheckboxFilter": {
286
374
  "file": "MultiInlineCheckboxFilter.md",
287
375
  "category": "Features/Filter/Components",
288
- "bundle": "components/MultiInlineCheckboxFilter.d.ts"
376
+ "summary": "Use `MultiInlineCheckboxFilter` for rendering an inline list of known number of items, with checkboxes.",
377
+ "importPath": "@wix/patterns",
378
+ "bundle": "components/MultiInlineCheckboxFilter.d.ts",
379
+ "propsTotal": 49,
380
+ "propsTypeName": "MultiInlineCheckboxFilterProps"
289
381
  },
290
382
  "MultiSelectCheckboxFilter": {
291
383
  "file": "MultiSelectCheckboxFilter.md",
292
384
  "category": "Features/Filter/Components",
293
- "bundle": "components/MultiSelectCheckboxFilter.d.ts"
385
+ "summary": "Use `MultiSelectCheckboxFilter` for rendering a list of items in a dropdown, with checkboxes.",
386
+ "importPath": "@wix/patterns",
387
+ "bundle": "components/MultiSelectCheckboxFilter.d.ts",
388
+ "propsTotal": 127,
389
+ "propsTypeName": "MultiSelectCheckboxFilterProps"
294
390
  },
295
391
  "MultiSelectCollectionFilter": {
296
392
  "file": "MultiSelectCollectionFilter.md",
297
393
  "category": "Features/Filter/Components",
298
- "bundle": "components/MultiSelectCollectionFilter.d.ts"
394
+ "summary": "`MultiSelectCollectionFilter` is based on MultiSelect.",
395
+ "importPath": "@wix/patterns",
396
+ "bundle": "components/MultiSelectCollectionFilter.d.ts",
397
+ "propsTotal": 132,
398
+ "propsTypeName": "MultiSelectCollectionFilterProps"
299
399
  },
300
400
  "NestedTable": {
301
401
  "file": "NestedTable.md",
302
402
  "category": "Base Components/Collections/NestedTable",
403
+ "summary": "The Nested Table component handles hierarchical data with multiple levels of nesting, allowing users to easily navigate through parent-child relationships. It is ideal for displaying information that requires multiple levels of nesting, such as a file system or a product catalog.",
404
+ "importPath": "@wix/patterns",
303
405
  "examples": [
304
406
  "NestedTable/single-entity.tsx",
305
407
  "NestedTable/various-entities.tsx",
@@ -312,25 +414,41 @@
312
414
  "NumberRangeFilter": {
313
415
  "file": "NumberRangeFilter.md",
314
416
  "category": "Features/Filter/Components",
315
- "bundle": "components/NumberRangeFilter.d.ts"
417
+ "summary": "# NumberRangeFilter Component",
418
+ "importPath": "@wix/patterns",
419
+ "bundle": "components/NumberRangeFilter.d.ts",
420
+ "propsTotal": 11,
421
+ "propsTypeName": "NumberRangeFilterProps"
316
422
  },
317
423
  "OperatorFilterPicker": {
318
424
  "file": "OperatorFilterPicker.md",
319
425
  "category": "Features/Filter/Components",
320
- "bundle": "components/OperatorFilterPicker.d.ts"
426
+ "summary": "The `OperatorFilterPicker` component provides a UI for users to select a filter operator and input a value. It renders a dropdown for operator selection and an input field for the filter value.",
427
+ "importPath": "@wix/patterns",
428
+ "bundle": "components/OperatorFilterPicker.d.ts",
429
+ "propsTotal": 11,
430
+ "propsTypeName": "OperatorPickerProps"
321
431
  },
322
432
  "PageWrapper": {
323
433
  "file": "PageWrapper.md",
324
- "category": "Base Components/Pages/Custom/PageWrapper"
434
+ "category": "Base Components/Pages/Custom/PageWrapper",
435
+ "summary": "`PageWrapper` is designed to wrap `<Page/>` from `@wix/design-system`.",
436
+ "importPath": "@wix/patterns"
325
437
  },
326
438
  "PickerContent": {
327
439
  "file": "PickerContent.md",
328
- "category": "Base Components/Collections/Picker"
440
+ "category": "Base Components/Collections/Picker",
441
+ "summary": "`PickerContent` displays the content of a picker (list of selectable items). It is used inside `PickerModal` and `PickerStandalone`. Configure it via the `usePickerContent` hook.",
442
+ "importPath": "@wix/patterns"
329
443
  },
330
444
  "PickerModal": {
331
445
  "file": "PickerModal.md",
332
446
  "category": "Base Components/Collections/Picker",
447
+ "summary": "`PickerModal` allows rendering a modal that (dynamically) renders a SelectorList powered by Wix Patterns collection state.",
448
+ "importPath": "@wix/patterns",
333
449
  "bundle": "components/PickerModal.d.ts",
450
+ "propsTotal": 36,
451
+ "propsTypeName": "PickerModalProps",
334
452
  "examples": [
335
453
  "PickerModal/multi-select.tsx",
336
454
  "PickerModal/single-selection.tsx",
@@ -350,6 +468,8 @@
350
468
  "PickerStandalone": {
351
469
  "file": "PickerStandalone.md",
352
470
  "category": "Base Components/Collections/Picker",
471
+ "summary": "`PickerStandalone` allows rendering a Standalone TableListItem, powered by Wix Patterns `CollectionState`. This is a component to render an item picker that adds dynamic support for:",
472
+ "importPath": "@wix/patterns",
353
473
  "examples": [
354
474
  "PickerStandalone/basic.tsx",
355
475
  "PickerStandalone/custom-empty-state.tsx",
@@ -360,53 +480,86 @@
360
480
  "PrimaryActionButton": {
361
481
  "file": "PrimaryActionButton.md",
362
482
  "category": "Features/Actions/PrimaryActions",
363
- "bundle": "components/PrimaryActionButton.d.ts"
483
+ "summary": "The `PrimaryActionButton` component displays a primary action button in the table toolbar. Use this component when you want to add a primary action button to a table.",
484
+ "importPath": "@wix/patterns",
485
+ "bundle": "components/PrimaryActionButton.d.ts",
486
+ "propsTotal": 11
364
487
  },
365
488
  "PrimaryActions": {
366
489
  "file": "PrimaryActions.md",
367
490
  "category": "Features/Actions/PrimaryActions",
368
- "bundle": "components/PrimaryActions.d.ts"
491
+ "summary": "The `PrimaryActions` component displays a primary action button in a collection page header. Each action can be a single button or a button with a dropdown menu that shows additional actions.",
492
+ "importPath": "@wix/patterns",
493
+ "bundle": "components/PrimaryActions.d.ts",
494
+ "propsTotal": 12,
495
+ "propsTypeName": "ActionSubitem"
369
496
  },
370
497
  "PrimaryPageButton": {
371
498
  "file": "PrimaryPageButton.md",
372
499
  "category": "Features/Actions/PrimaryPageButton",
500
+ "summary": "A primary button that should be use on CollectionPage.Header component. It has the same API as the Button component, excluding the `size` and `skin` props, and with a `text` prop that is replacing the `children` prop.",
501
+ "importPath": "@wix/patterns",
373
502
  "bundle": "components/PrimaryPageButton.d.ts",
503
+ "propsTotal": 13,
504
+ "propsTypeName": "PrimaryPageButtonProps",
374
505
  "status": "deprecated",
375
506
  "statusMessage": "Use `PrimaryActions` component instead."
376
507
  },
377
508
  "RadioGroupFilter": {
378
509
  "file": "RadioGroupFilter.md",
379
510
  "category": "Features/Filter/Components",
380
- "bundle": "components/RadioGroupFilter.d.ts"
511
+ "summary": "`RadioGroupFilter` is based on `RadioGroup` component of `@wix/design-system`. Use `RadioGroupFilter` for rendering a filter that shows a list of items and allow users to choose a single item from the list. Render it by providing ArrayFilter to the filter prop and a list of options via the data props.",
512
+ "importPath": "@wix/patterns",
513
+ "bundle": "components/RadioGroupFilter.d.ts",
514
+ "propsTotal": 13,
515
+ "propsTypeName": "RadioGroupFilterProps"
381
516
  },
382
517
  "RequestId": {
383
518
  "file": "RequestId.md",
384
- "category": "Features/Display/Errors/RequestId"
519
+ "category": "Features/Display/Errors/RequestId",
520
+ "summary": "Use this component to help customer care and users communicate and investigate bugs faster Expose requestID on every error that is based on a server request.",
521
+ "importPath": "@wix/patterns/components"
385
522
  },
386
523
  "PatternsReactRoute": {
387
524
  "file": "PatternsReactRoute.md",
388
525
  "category": "Base Components/Pages/Router",
389
- "bundle": "components/PatternsReactRoute.d.ts"
526
+ "summary": "The `PatternsReactRoute` component defines a route for a Patterns element.",
527
+ "importPath": "@wix/patterns/router",
528
+ "bundle": "components/PatternsReactRoute.d.ts",
529
+ "propsTotal": 1,
530
+ "propsTypeName": "PatternsReactProps"
390
531
  },
391
532
  "PatternsReactRouter": {
392
533
  "file": "PatternsReactRouter.md",
393
534
  "category": "Base Components/Pages/Router",
535
+ "summary": "The `PatternsReactRouter` component wraps `PatternsReactRoute` components and defines the base path for those routes.",
536
+ "importPath": "@wix/patterns/router",
394
537
  "bundle": "components/PatternsReactRouter.d.ts"
395
538
  },
396
539
  "usePatternsNavigate": {
397
540
  "file": "usePatternsNavigate.md",
398
541
  "category": "Base Components/Pages/Router/Hooks/usePatternsNavigate",
542
+ "summary": "The `usePatternsNavigate` hook provides functions to navigate between pages in a Patterns React application.",
543
+ "importPath": "@wix/patterns/router",
399
544
  "bundle": "hooks/usePatternsNavigate.d.ts"
400
545
  },
401
546
  "SecondaryActions": {
402
547
  "file": "SecondaryActions.md",
403
548
  "category": "Features/Actions/SecondaryActions",
404
- "bundle": "components/SecondaryActions.d.ts"
549
+ "summary": "The `SecondaryActions` component displays a secondary action button in a collection page header. Each action can be a single button or a button with a dropdown menu that shows additional actions.",
550
+ "importPath": "@wix/patterns",
551
+ "bundle": "components/SecondaryActions.d.ts",
552
+ "propsTotal": 12,
553
+ "propsTypeName": "ActionSubitem"
405
554
  },
406
555
  "SettingsPage": {
407
556
  "file": "SettingsPage.md",
408
557
  "category": "Base Components/Pages/Settings Page",
558
+ "summary": "The `SettingsPage` component serves as a container that encapsulates the logic and layout structure for rendering an settings page. It provides a structured and organized way to display and manage information related to a specific settings.",
559
+ "importPath": "@wix/patterns",
409
560
  "bundle": "components/SettingsPage.d.ts",
561
+ "propsTotal": 14,
562
+ "propsTypeName": "SettingsPageProps",
410
563
  "examples": [
411
564
  "SettingsPage/basic.tsx",
412
565
  "SettingsPage/2-columns.tsx",
@@ -419,28 +572,42 @@
419
572
  },
420
573
  "SettingsPage.AdditionalContent": {
421
574
  "file": "SettingsPage.AdditionalContent.md",
422
- "category": "Base Components/Pages/Settings Page"
575
+ "category": "Base Components/Pages/Settings Page",
576
+ "summary": "A slot component for the side panel of a `SettingsPage`. Place it inside `<SettingsPage.Content>` alongside `<SettingsPage.MainContent>`. Supports an optional `sticky` prop to keep the content fixed while scrolling.",
577
+ "importPath": "@wix/patterns"
423
578
  },
424
579
  "SettingsPage.Card": {
425
580
  "file": "SettingsPage.Card.md",
426
- "category": "Base Components/Pages/Settings Page"
581
+ "category": "Base Components/Pages/Settings Page",
582
+ "summary": "A card container used inside `SettingsPage.MainContent` or `SettingsPage.AdditionalContent`. It wraps form fields and content sections with a card layout, and supports loading/error/success states for async content.",
583
+ "importPath": "@wix/patterns"
427
584
  },
428
585
  "SettingsPage.Content": {
429
586
  "file": "SettingsPage.Content.md",
430
- "category": "Base Components/Pages/Settings Page"
587
+ "category": "Base Components/Pages/Settings Page",
588
+ "summary": "A layout slot for the body of a `SettingsPage`. Wraps `<SettingsPage.MainContent>` and optionally `<SettingsPage.AdditionalContent>` to create the two-column layout.",
589
+ "importPath": "@wix/patterns"
431
590
  },
432
591
  "SettingsPage.Header": {
433
592
  "file": "SettingsPage.Header.md",
434
- "category": "Base Components/Pages/Settings Page"
593
+ "category": "Base Components/Pages/Settings Page",
594
+ "summary": "The header component for a `SettingsPage`. Renders the page title, optional subtitle, and a more-actions menu. Place it as a direct child of `<SettingsPage>`.",
595
+ "importPath": "@wix/patterns"
435
596
  },
436
597
  "SettingsPage.MainContent": {
437
598
  "file": "SettingsPage.MainContent.md",
438
- "category": "Base Components/Pages/Settings Page"
599
+ "category": "Base Components/Pages/Settings Page",
600
+ "summary": "A slot component for the main content area of a `SettingsPage`. Place it inside `<SettingsPage.Content>`. This is where you render the primary form fields and cards.",
601
+ "importPath": "@wix/patterns"
439
602
  },
440
603
  "SingleSelectFilter": {
441
604
  "file": "SingleSelectFilter.md",
442
605
  "category": "Features/Filter/Components",
606
+ "summary": "Renders a Dropdown filter that shows a list of items fetched from a server.",
607
+ "importPath": "@wix/patterns",
443
608
  "bundle": "components/SingleSelectFilter.d.ts",
609
+ "propsTotal": 121,
610
+ "propsTypeName": "SingleSelectFilterProps",
444
611
  "examples": [
445
612
  "SingleSelectFilter/server-data.tsx",
446
613
  "SingleSelectFilter/static-data.tsx",
@@ -452,6 +619,7 @@
452
619
  "Sortable Columns": {
453
620
  "file": "Sortable Columns.md",
454
621
  "category": "Features/Sort/Sortable Columns/Sortable Columns",
622
+ "summary": "The sortable columns feature allows users to sort a table by clicking on a column header, sorting the table based on the values in that column.",
455
623
  "examples": [
456
624
  "Sortable Columns/basic-sortable-column.tsx",
457
625
  "Sortable Columns/custom-sort-order.tsx"
@@ -460,6 +628,8 @@
460
628
  "Suggestions": {
461
629
  "file": "Suggestions.md",
462
630
  "category": "Features/Display/Suggestions",
631
+ "summary": "Displays marketing offers from the Wix Dealer service. For more information, see Suggestions Overview.",
632
+ "importPath": "@wix/patterns",
463
633
  "examples": [
464
634
  "Suggestions/with-transform-function.tsx",
465
635
  "Suggestions/custom-card-rendering.tsx",
@@ -470,7 +640,11 @@
470
640
  "SummaryBar": {
471
641
  "file": "SummaryBar.md",
472
642
  "category": "Features/Display/Toolbar",
643
+ "summary": "Displays summary information.",
644
+ "importPath": "@wix/patterns",
473
645
  "bundle": "components/SummaryBar.d.ts",
646
+ "propsTotal": 3,
647
+ "propsTypeName": "SummaryBarProps",
474
648
  "examples": [
475
649
  "SummaryBar/success.tsx",
476
650
  "SummaryBar/loading.tsx",
@@ -482,7 +656,11 @@
482
656
  "Table": {
483
657
  "file": "Table.md",
484
658
  "category": "Base Components/Collections/Table/Table",
659
+ "summary": "The `Table` component displays data in rows and columns, allowing you to organize information in an easy-to-scan format. This component extends the standard Wix Design System `Table` to offer additional advanced features like infinite scroll, search, and filters.",
660
+ "importPath": "@wix/patterns",
485
661
  "bundle": "components/Table.d.ts",
662
+ "propsTotal": 63,
663
+ "propsTypeName": "TableProps",
486
664
  "examples": [
487
665
  "Table/basic-table.tsx",
488
666
  "Table/horizontal-scroll.tsx",
@@ -499,7 +677,11 @@
499
677
  "TableFolders": {
500
678
  "file": "TableFolders.md",
501
679
  "category": "Base Components/Collections/TableFolders/TableFolders",
680
+ "summary": "The `TableFolders` component displays a table-like view of folders and items.",
681
+ "importPath": "@wix/patterns",
502
682
  "bundle": "components/TableFolders.d.ts",
683
+ "propsTotal": 57,
684
+ "propsTypeName": "TableFoldersProps",
503
685
  "examples": [
504
686
  "TableFolders/demo.tsx",
505
687
  "TableFolders/table-folders.tsx",
@@ -509,7 +691,11 @@
509
691
  "TableGridSwitch": {
510
692
  "file": "TableGridSwitch.md",
511
693
  "category": "Base Components/Collections/TableGridSwitch/TableGridSwitch",
694
+ "summary": "The `TableGridSwitch` component provides a pair of icons in the toolbar for toggling between `Grid` and `Table` views. The icon order is fixed: `Table` view is on the left, and `Grid` view is on the right.",
695
+ "importPath": "@wix/patterns",
512
696
  "bundle": "components/TableGridSwitch.d.ts",
697
+ "propsTotal": 64,
698
+ "propsTypeName": "TableGridSwitchBaseProps",
513
699
  "examples": [
514
700
  "TableGridSwitch/basic-table-grid-switch.tsx",
515
701
  "TableGridSwitch/custom-columns.tsx"
@@ -518,6 +704,8 @@
518
704
  "TableGridSwitchFolders": {
519
705
  "file": "TableGridSwitchFolders.md",
520
706
  "category": "Base Components/Collections/TableGridSwitchFolders/TableGridSwitchFolders",
707
+ "summary": "The `TableGridSwitchFolders` component obtains the state of two collections initialized by the `useCollection()` hook: `collection` and `foldersCollection`. These collections are responsible for fetching and managing data related to items and folders. The component also accepts specific parameters to define how each item in the collections should be rendered within the table grid.",
708
+ "importPath": "@wix/patterns",
521
709
  "examples": [
522
710
  "TableGridSwitchFolders/demo.tsx",
523
711
  "TableGridSwitchFolders/tablegridswitchfolders.tsx",
@@ -527,6 +715,7 @@
527
715
  "Table Sections": {
528
716
  "file": "Table Sections.md",
529
717
  "category": "Features/Display/Table Sections",
718
+ "summary": "Group `Table` data into sections.",
530
719
  "examples": [
531
720
  "Table Sections/demo.tsx",
532
721
  "Table Sections/with-badge.tsx",
@@ -536,12 +725,17 @@
536
725
  },
537
726
  "TableSectionsProp": {
538
727
  "file": "TableSectionsProp.md",
539
- "category": "Common/Types"
728
+ "category": "Common/Types",
729
+ "summary": "Configuration object for the `sections` prop on `Table`. Enables grouping table rows into collapsible sections with headers. Provide a `TableSections` component, a `groupBy` function, a `renderSection` callback, and optional `collapsible` and `events` properties."
540
730
  },
541
731
  "TableTopNotification": {
542
732
  "file": "TableTopNotification.md",
543
733
  "category": "Features/Display/TableTopNotification",
734
+ "summary": "`TableTopNotification` allows showing a message that appears between the table header and the table rows.",
735
+ "importPath": "@wix/patterns",
544
736
  "bundle": "components/TableTopNotification.d.ts",
737
+ "propsTotal": 19,
738
+ "propsTypeName": "TableTopNotificationProps",
545
739
  "examples": [
546
740
  "TableTopNotification/base.tsx",
547
741
  "TableTopNotification/nested-table.tsx"
@@ -550,7 +744,11 @@
550
744
  "TabsFilter": {
551
745
  "file": "TabsFilter.md",
552
746
  "category": "Features/Filter/Components",
747
+ "summary": "Filter component that always renders in the toolbar.",
748
+ "importPath": "@wix/patterns",
553
749
  "bundle": "components/TabsFilter.d.ts",
750
+ "propsTotal": 7,
751
+ "propsTypeName": "TabsFilterProps",
554
752
  "examples": [
555
753
  "TabsFilter/basic-tabs.tsx",
556
754
  "TabsFilter/tabs-with-a-basic-counter.tsx",
@@ -561,6 +759,8 @@
561
759
  "Tags": {
562
760
  "file": "Tags.md",
563
761
  "category": "Features/Enrich/Tags",
762
+ "summary": "Tags allow users a flexible way to categorize and manage their data.",
763
+ "importPath": "@wix/patterns",
564
764
  "examples": [
565
765
  "Tags/basic.tsx",
566
766
  "Tags/customized-tags-column-position.tsx",
@@ -571,11 +771,15 @@
571
771
  },
572
772
  "TagsWidget": {
573
773
  "file": "TagsWidget.md",
574
- "category": "Features/Enrich/Tags"
774
+ "category": "Features/Enrich/Tags",
775
+ "summary": "The `TagsWidget` component enhances the entity page by displaying the tags that are associated with the entity. It also enables to add new tags to the entity, and remove existing tags from it.",
776
+ "importPath": "@wix/patterns"
575
777
  },
576
778
  "ToolbarSecondaryActions": {
577
779
  "file": "ToolbarSecondaryActions.md",
578
780
  "category": "Features/Actions/SecondaryActions",
781
+ "summary": "The `ToolbarSecondaryActions` component displays multiple secondary action buttons in a collection toolbar. Each action can be a single button or a button with a dropdown menu that shows additional actions.",
782
+ "importPath": "@wix/patterns",
579
783
  "examples": [
580
784
  "ToolbarSecondaryActions/multiple-secondary-action-buttons.tsx",
581
785
  "ToolbarSecondaryActions/multiple-actions-with-dropdown-menus.tsx",
@@ -586,6 +790,8 @@
586
790
  "ToolbarTitle": {
587
791
  "file": "ToolbarTitle.md",
588
792
  "category": "Features/Display/Toolbar",
793
+ "summary": "The card title located on the left hand side of the toolbar to provide visitors with information about the collection.",
794
+ "importPath": "@wix/patterns",
589
795
  "examples": [
590
796
  "ToolbarTitle/title.tsx",
591
797
  "ToolbarTitle/title-subtitle-and-learn-more.tsx",
@@ -596,6 +802,8 @@
596
802
  "Views": {
597
803
  "file": "Views.md",
598
804
  "category": "Features/Display/Views",
805
+ "summary": "Collections of table states. A table state includes the filters, column sorts, and custom columns that are applied to the table.",
806
+ "importPath": "@wix/patterns",
599
807
  "examples": [
600
808
  "Views/basic-view.tsx",
601
809
  "Views/basic-view-that-can-be-chosen.tsx",
@@ -606,65 +814,98 @@
606
814
  "WidgetsFormProvider": {
607
815
  "file": "WidgetsFormProvider.md",
608
816
  "category": "Base Components/Providers",
817
+ "summary": "`WidgetsFormProvider` wraps form content in Entity/Settings pages to provide widget-level form context. It enables custom form widgets (like `CustomFieldsWidget`) to register with the page form and participate in validation and submission. Place it inside `<EntityPage.Card>` or `<SettingsPage.Card>` content.",
818
+ "importPath": "@wix/patterns/page",
609
819
  "bundle": "components/WidgetsFormProvider.d.ts"
610
820
  },
611
821
  "WixPatternsBMProvider": {
612
822
  "file": "WixPatternsBMProvider.md",
613
823
  "category": "Base Components/Providers",
824
+ "summary": "`WixPatternsBMProvider` is the top-level provider for Wix Patterns applications running inside Wix Business Manager. It wraps your app with the necessary context (BI, fedops, translations, HTTP client, etc.). Use this as the outermost provider in your BM module entry point.",
825
+ "importPath": "@wix/patterns/bm",
614
826
  "bundle": "components/WixPatternsBMProvider.d.ts"
615
827
  },
616
828
  "WixPatternsBaseProvider": {
617
829
  "file": "WixPatternsBaseProvider.md",
618
830
  "category": "Base Components/Providers",
619
- "bundle": "components/WixPatternsBaseProvider.d.ts"
831
+ "summary": "`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.",
832
+ "importPath": "@wix/patterns/essentials",
833
+ "bundle": "components/WixPatternsBaseProvider.d.ts",
834
+ "propsTotal": 1,
835
+ "propsTypeName": "WixPatternsBaseProviderProps"
620
836
  },
621
837
  "WixPatternsEssentialsProvider": {
622
838
  "file": "WixPatternsEssentialsProvider.md",
623
839
  "category": "Base Components/Providers",
840
+ "summary": "`WixPatternsEssentialsProvider` is the provider for Wix Patterns applications running with Wix Essentials (the modern SDK). It wraps your app with container context derived from the Essentials SDK modules.",
841
+ "importPath": "@wix/patterns/essentials",
624
842
  "bundle": "components/WixPatternsEssentialsProvider.d.ts"
625
843
  },
626
844
  "WixPatternsGizaProvider": {
627
845
  "file": "WixPatternsGizaProvider.md",
628
846
  "category": "Base Components/Providers",
847
+ "summary": "`WixPatternsGizaProvider` is the provider for Wix Patterns applications running in the Giza (Editor) environment. It supplies the container context for editor-based applications.",
848
+ "importPath": "@wix/patterns/giza",
629
849
  "bundle": "components/WixPatternsGizaProvider.d.ts"
630
850
  },
631
851
  "WixPatternsProvider": {
632
852
  "file": "WixPatternsProvider.md",
633
853
  "category": "Base Components/Providers",
854
+ "summary": "`WixPatternsProvider` is the recommended top-level provider for most Wix Patterns applications. It auto-detects the environment (BM, Essentials, Giza) and supplies the appropriate context. Wrap your entire app with this provider.",
855
+ "importPath": "@wix/patterns/provider",
634
856
  "bundle": "components/WixPatternsProvider.d.ts"
635
857
  },
636
858
  "bulkActionModal": {
637
859
  "file": "bulkActionModal.md",
638
- "category": "Features/Actions/Bulk Actions"
860
+ "category": "Features/Actions/Bulk Actions",
861
+ "summary": "`bulkActionModal` is a render-prop passed to collection components (`Table`, `Grid`, `TableFolders`, etc.) that opens a custom modal when a bulk action is triggered from the `MultiBulkActionToolbar`. The render function receives: - `selectedValues` — the items selected via the checkbox column - `uncheckedValues` — the items that were unchecked (relevant when \"Select All\" is active) - `isSelectAll`…"
639
862
  },
640
863
  "deleteSecondaryAction": {
641
864
  "file": "deleteSecondaryAction.md",
642
865
  "category": "Features/Actions/Action Cell",
643
- "bundle": "functions/deleteSecondaryAction.d.ts"
866
+ "importPath": "@wix/patterns",
867
+ "bundle": "functions/deleteSecondaryAction.d.ts",
868
+ "propsTotal": 11,
869
+ "propsTypeName": "DeleteSecondaryActionProps"
644
870
  },
645
871
  "useEntity": {
646
872
  "file": "useEntity.md",
647
873
  "category": "Base Components/Pages/Entity Page/Hooks/useEntity",
648
- "bundle": "hooks/useEntity.d.ts"
874
+ "summary": "A React hook that subscribes to the entity from `EntityPageState` and returns it reactively. Use this when you need to access the entity outside of `Card.Content`, such as in the page header (title, subtitle, breadcrumbs, etc.). **Important:** During the first render the entity will be `undefined` while data is being fetched. Do not rely on the initial value — always handle the `undefined` case.",
875
+ "importPath": "@wix/patterns",
876
+ "bundle": "hooks/useEntity.d.ts",
877
+ "propsTotal": 4,
878
+ "propsTypeName": "EntityPageState"
649
879
  },
650
880
  "useEntityPage": {
651
881
  "file": "useEntityPage.md",
652
882
  "category": "Base Components/Pages/Entity Page/Hooks/useEntityPage",
653
- "bundle": "hooks/useEntityPage.d.ts"
883
+ "summary": "A React hook that creates the state for an `EntityPage`. Configure entity fetching, save flow, form integration, toasts, and navigation. The returned `EntityPageState` is passed to `<EntityPage state={state}>`.",
884
+ "importPath": "@wix/patterns",
885
+ "bundle": "hooks/useEntityPage.d.ts",
886
+ "propsTotal": 11,
887
+ "propsTypeName": "UseEntityPageParams"
654
888
  },
655
889
  "useEntityPageContext": {
656
890
  "file": "useEntityPageContext.md",
657
891
  "category": "Base Components/Pages/Entity Page/Hooks/useEntityPageContext",
892
+ "summary": "A React hook that retrieves `EntityPageState` from React context. Use it in any child component rendered within `EntityPage` to access the page state without prop-drilling.",
893
+ "importPath": "@wix/patterns",
658
894
  "bundle": "hooks/useEntityPageContext.d.ts"
659
895
  },
660
896
  "useItemsSelectionFilter": {
661
897
  "file": "useItemsSelectionFilter.md",
662
- "category": "Common/hooks"
898
+ "category": "Common/hooks",
899
+ "summary": "The `useItemsSelectionFilter` hook creates a filter that fetches and displays items from a specific provider.",
900
+ "importPath": "@wix/patterns"
663
901
  },
664
902
  "useOptimisticActions": {
665
903
  "file": "useOptimisticActions.md",
666
904
  "category": "Features/Actions/Updates",
905
+ "summary": "The `useOptimisticActions` is a hook used to manage optimistic actions for a collection. It provides functionality to perform optimistic CRUD operations on a collection of items, such as creating, updating, and deleting items, while awaiting confirmation from the server.",
906
+ "importPath": "@wix/patterns",
667
907
  "bundle": "hooks/useOptimisticActions.d.ts",
908
+ "propsTotal": 7,
668
909
  "examples": [
669
910
  "useOptimisticActions/default-behaviour.tsx",
670
911
  "useOptimisticActions/success-toast-with-undo.tsx",
@@ -678,41 +919,61 @@
678
919
  "usePickerModal": {
679
920
  "file": "usePickerModal.md",
680
921
  "category": "Base Components/Collections/Picker/Hooks",
681
- "bundle": "hooks/usePickerModal.d.ts"
922
+ "summary": "`usePickerModal` is a React hook that creates the state for a `PickerModal`. It accepts picker configuration (query name, fetch data, filters, pagination, selection callback) and a lazy-loaded `pickerContentComponent`. Import from the entry point that matches your environment.",
923
+ "importPath": "@wix/patterns/bm",
924
+ "bundle": "hooks/usePickerModal.d.ts",
925
+ "propsTotal": 14,
926
+ "propsTypeName": "UsePickerModalParamsBase"
682
927
  },
683
928
  "usePickerStandalone": {
684
929
  "file": "usePickerStandalone.md",
685
- "category": "Base Components/Collections/Picker/Hooks"
930
+ "category": "Base Components/Collections/Picker/Hooks",
931
+ "summary": "`usePickerStandalone` is a React hook that creates the state for a `PickerStandalone` component — a full-page picker for selecting an item and navigating to a destination URL. It extends `useCollection` with picker-specific options like `defaultDestinationUrl` and `initialSelect`.",
932
+ "importPath": "@wix/patterns"
686
933
  },
687
934
  "useSelector": {
688
935
  "file": "useSelector.md",
689
- "category": "Common/Hooks"
936
+ "category": "Common/Hooks",
937
+ "summary": "`useSelector` is a custom hook designed for React applications that doesn't use MobX for state management. Its primary purpose is to simplify the process of getting updated values from the MobX state within functional components.",
938
+ "importPath": "@wix/patterns"
690
939
  },
691
940
  "useSettingsPage": {
692
941
  "file": "useSettingsPage.md",
693
- "category": "Base Components/Pages/Settings Page/Hooks/useSettingsPage"
942
+ "category": "Base Components/Pages/Settings Page/Hooks/useSettingsPage",
943
+ "summary": "A React hook that creates the state for a `SettingsPage`. Configure settings fetching, save/cancel flow, form integration, and toasts. The returned `SettingsPageState` is passed to `<SettingsPage state={state}>`.",
944
+ "importPath": "@wix/patterns"
694
945
  },
695
946
  "useSettingsPageContext": {
696
947
  "file": "useSettingsPageContext.md",
697
- "category": "Base Components/Pages/Settings Page/Hooks/useSettingsPageContext"
948
+ "category": "Base Components/Pages/Settings Page/Hooks/useSettingsPageContext",
949
+ "summary": "A React hook that retrieves `SettingsPageState` from React context. Use it in any child component rendered within `SettingsPage` to access the page state without prop-drilling.",
950
+ "importPath": "@wix/patterns"
698
951
  },
699
952
  "ActionCellProps": {
700
953
  "file": "ActionCellProps.md",
701
954
  "category": "Features/Actions/Action Cell",
702
- "bundle": "types/ActionCellProps.d.ts"
955
+ "summary": "TableActionCellProps",
956
+ "bundle": "types/ActionCellProps.d.ts",
957
+ "propsTotal": 15,
958
+ "propsTypeName": "ActionCellProps"
703
959
  },
704
960
  "BulkActionModalRenderProp": {
705
961
  "file": "BulkActionModalRenderProp.md",
706
962
  "category": "Common/Types",
707
- "bundle": "types/BulkActionModalRenderPropParams.d.ts"
963
+ "summary": "A render-prop type for the `bulkActionModal` prop on collection components (`Table`, `Grid`, etc.). The render function receives selection state (`selectedValues`, `uncheckedValues`, `allSelected`), a `query` object, and modal controls (`openModal`, `closeModal`). Return a React element for the modal content.",
964
+ "bundle": "types/BulkActionModalRenderPropParams.d.ts",
965
+ "propsTotal": 7,
966
+ "propsTypeName": "BulkActionModalRenderPropParams"
708
967
  },
709
968
  "BulkSelectState": {
710
969
  "file": "BulkSelectState.md",
711
- "category": "Common/State"
970
+ "category": "Common/State",
971
+ "summary": "`BulkSelectState` manages the selection state for bulk actions in collection components. It tracks which items are selected, supports \"Select All\", and provides `allSelected`, `selectedValues`, and `uncheckedValues` properties. Created internally by `CollectionState` — you typically access it via `state.collection.bulkSelect`."
712
972
  },
713
973
  "Category": {
714
974
  "file": "Category.md",
715
- "category": "Common/Types"
975
+ "category": "Common/Types",
976
+ "summary": "Defines a category in the `Views` dropdown. A category groups related views and appears as a section header. Each category has a unique `id`, a display `name`, and an array of `View` objects."
716
977
  },
717
978
  "CollectionSection": {
718
979
  "file": "CollectionSection.md",
@@ -720,52 +981,75 @@
720
981
  },
721
982
  "CollectionState": {
722
983
  "file": "CollectionState.md",
723
- "category": "Common/State"
984
+ "category": "Common/State",
985
+ "summary": "`CollectionState` is the core state object for all collection components. It manages server data fetching, pagination, filtering, sorting, search, and bulk selection. Created by hooks like `useTableCollection` or `useGridCollection`. Key methods: `invalidate()`, `refreshCurrentPage()`, `clearResultAndMoveToStart()`, `retryErrorState()`."
724
986
  },
725
987
  "ComputedQuery": {
726
988
  "file": "ComputedQuery.md",
727
989
  "category": "Common/Types",
728
- "bundle": "types/ComputedQuery.d.ts"
990
+ "summary": "`ComputedQuery` represents the current paging, sorting, and filtering state passed to `fetchData`. It includes `offset` (or `cursor`), `limit`, `sort`, and `filter` values derived from the active filters. Use it in bulk operations like `updateAll` or `deleteAll` to apply the same filters server-side.",
991
+ "bundle": "types/ComputedQuery.d.ts",
992
+ "propsTotal": 13,
993
+ "propsTypeName": "ComputedQuery"
729
994
  },
730
995
  "CtaBaseProps": {
731
996
  "file": "CtaBaseProps.md",
732
- "category": "Common/Types"
997
+ "category": "Common/Types",
998
+ "summary": "Base props for call-to-action buttons used in section headers, toolbar actions, and other action triggers. Defines the common `id`, `onClick`, `label`, and `prefixIcon` properties."
733
999
  },
734
1000
  "customFilter": {
735
1001
  "file": "customFilter.md",
736
1002
  "category": "Features/Filter/Factories",
737
- "bundle": "functions/customFilter.d.ts"
1003
+ "summary": "A generic filter factory to be passed to useCollection `filters` property. This factory, allows creating custom filters that are not provided by Wix Patterns.",
1004
+ "importPath": "@wix/patterns",
1005
+ "bundle": "functions/customFilter.d.ts",
1006
+ "propsTotal": 17,
1007
+ "propsTypeName": "CustomFilterStateParams"
738
1008
  },
739
1009
  "Data Extension Overview": {
740
1010
  "file": "Data Extension Overview.md",
741
- "category": "Features/Enrich/Data Extension"
1011
+ "category": "Features/Enrich/Data Extension",
1012
+ "summary": "Patterns Data Extension feature builds on the open platform Data Extensions capability."
742
1013
  },
743
1014
  "Display Extended Fields": {
744
1015
  "file": "Display Extended Fields.md",
745
- "category": "Features/Enrich/Data Extension"
1016
+ "category": "Features/Enrich/Data Extension",
1017
+ "summary": "This guide explains how to display extended fields in your table."
746
1018
  },
747
1019
  "Enable Filters for Extended Fields": {
748
1020
  "file": "Enable Filters for Extended Fields.md",
749
- "category": "Features/Enrich/Data Extension"
1021
+ "category": "Features/Enrich/Data Extension",
1022
+ "summary": "This article explains how to enable filters on your extended fields."
750
1023
  },
751
1024
  "Allow Users to Add Extended Fields": {
752
1025
  "file": "Allow Users to Add Extended Fields.md",
753
- "category": "Features/Enrich/Data Extension"
1026
+ "category": "Features/Enrich/Data Extension",
1027
+ "summary": "This guide shows you how to let users add and manage extended fields."
754
1028
  },
755
1029
  "DataResultRaw": {
756
1030
  "file": "DataResultRaw.md",
757
1031
  "category": "Common/Types",
758
- "bundle": "types/DataResultRaw.d.ts"
1032
+ "summary": "The return type of the `fetchData` function passed to collection hooks. Contains the `items` array, optional `total` count (after filters), `available` count (before filters), `cursor` for cursor-based pagination, and `hasNext` flag.",
1033
+ "bundle": "types/DataResultRaw.d.ts",
1034
+ "propsTotal": 5,
1035
+ "propsTypeName": "DataResultRaw"
759
1036
  },
760
1037
  "EntityPageState": {
761
1038
  "file": "EntityPageState.md",
762
1039
  "category": "Base Components/Pages/Entity Page/State",
763
- "bundle": "types/EntityPageState.d.ts"
1040
+ "summary": "`EntityPageState` is the state object that drives an `EntityPage`. It is created by the `useEntityPage` hook and manages: - **Entity fetching** — loads the entity from the server via `fetch` - **Form state** — integrates with `react-hook-form` for editing - **Save / cancel flow** — calls `onSave` with form values and handles success/error toasts - **Dirty-form protection** — warns on `beforeunload…",
1041
+ "bundle": "types/EntityPageState.d.ts",
1042
+ "propsTotal": 4,
1043
+ "propsTypeName": "EntityPageState"
764
1044
  },
765
1045
  "ExportTo": {
766
1046
  "file": "ExportTo.md",
767
1047
  "category": "Features/Export",
1048
+ "summary": "The ExportTo is a platformised solution for exporting lists of data.",
1049
+ "importPath": "@wix/patterns",
768
1050
  "bundle": "components/ExportButton.d.ts",
1051
+ "propsTotal": 12,
1052
+ "propsTypeName": "ExportButtonProps",
769
1053
  "symbols": [
770
1054
  "ExportButton"
771
1055
  ],
@@ -779,35 +1063,54 @@
779
1063
  "FilterProps": {
780
1064
  "file": "FilterProps.md",
781
1065
  "category": "Features/Filter/Props",
782
- "bundle": "types/FilterProps.d.ts"
1066
+ "summary": "The base filter component interface used by all filter types in Wix Patterns. Each filter defines how it renders in the toolbar, its value type, and how it maps to query parameters. See specific filter implementations like `SingleSelectFilter`, `MultiSelectCheckboxFilter`, and `DateRangeFilter`.",
1067
+ "bundle": "types/FilterProps.d.ts",
1068
+ "propsTotal": 11,
1069
+ "propsTypeName": "FilterProps"
783
1070
  },
784
1071
  "FormPageState": {
785
1072
  "file": "FormPageState.md",
786
- "category": "Common/State"
1073
+ "category": "Common/State",
1074
+ "summary": "`FormPageState` manages form state for page components (`EntityPage`, `SettingsPage`). It wraps a `react-hook-form` `UseFormReturn` instance and adds initialization/submission task tracking and optional widgets form state. You typically do not create this directly — it is managed internally by `EntityPageState` or `SettingsPageState`."
787
1075
  },
788
1076
  "GridDragAndDrop": {
789
1077
  "file": "GridDragAndDrop.md",
790
- "category": "Features/Sort/Drag and Drop"
1078
+ "category": "Features/Sort/Drag and Drop",
1079
+ "summary": "Enables drag and drop functionality on a `Grid` component.",
1080
+ "importPath": "@wix/patterns"
791
1081
  },
792
1082
  "GridFoldersState": {
793
1083
  "file": "GridFoldersState.md",
794
1084
  "category": "Base Components/Collections/GridFolders/GridFoldersState",
795
- "bundle": "types/GridFoldersState.d.ts"
1085
+ "summary": "`GridFoldersState` manages the state for a `GridFolders` component, which displays both folders and items in a grid layout. It holds separate `CollectionState` instances for folders and items, plus a shared toolbar. Created by `useGridCollection` with a folders configuration.",
1086
+ "bundle": "types/GridFoldersState.d.ts",
1087
+ "propsTotal": 1,
1088
+ "propsTypeName": "GridFoldersStatePublicAPI"
796
1089
  },
797
1090
  "GridState": {
798
1091
  "file": "GridState.md",
799
1092
  "category": "Base Components/Collections/Grid/GridState",
800
- "bundle": "types/GridState.d.ts"
1093
+ "summary": "`GridState` manages the state for a `Grid` component. It wraps a `CollectionState` for data, a `ToolbarCollectionState` for the toolbar, and tracks grid-specific UI state like size presets and sections. Created by `useGridCollection`.",
1094
+ "bundle": "types/GridState.d.ts",
1095
+ "propsTotal": 3,
1096
+ "propsTypeName": "GridStatePublicAPI"
801
1097
  },
802
1098
  "MoreActionsItem": {
803
1099
  "file": "MoreActionsItem.md",
804
1100
  "category": "Common/Types",
805
- "bundle": "types/MoreActionsItem.d.ts"
1101
+ "summary": "Defines an action item in the `MoreActions` dropdown menu. Each item has a `text` label, an `onClick` handler, and optional properties like `prefixIcon`, `skin` (`dark` or `destructive`), `disabled`, `subtitle`, and `dataHook`.",
1102
+ "bundle": "types/MoreActionsItem.d.ts",
1103
+ "propsTotal": 10,
1104
+ "propsTypeName": "MoreActionsItem"
806
1105
  },
807
1106
  "MultiBulkActionToolbar": {
808
1107
  "file": "MultiBulkActionToolbar.md",
809
1108
  "category": "Features/Actions/Bulk Actions",
1109
+ "summary": "Provides the ability to perform multiple operations on multiple items.",
1110
+ "importPath": "@wix/patterns",
810
1111
  "bundle": "components/MultiBulkActionToolbar.d.ts",
1112
+ "propsTotal": 5,
1113
+ "propsTypeName": "MultiBulkActionToolbarProps",
811
1114
  "examples": [
812
1115
  "MultiBulkActionToolbar/bulk-action.tsx",
813
1116
  "MultiBulkActionToolbar/popover-menu.tsx",
@@ -820,7 +1123,11 @@
820
1123
  "MultiLevelSorting": {
821
1124
  "file": "MultiLevelSorting.md",
822
1125
  "category": "Features/Sort/Sortable Columns/MultiLevelSorting",
1126
+ "summary": "Allows visitors to apply sorting to multiple columns (in hierarchical order).",
1127
+ "importPath": "@wix/patterns",
823
1128
  "bundle": "types/MultiLevelSorting.d.ts",
1129
+ "propsTotal": 4,
1130
+ "propsTypeName": "IMultiLevelSortingProps",
824
1131
  "examples": [
825
1132
  "MultiLevelSorting/basic-multi-level-sorting.tsx",
826
1133
  "MultiLevelSorting/multi-level-sorting-with-defined-sort-directions.tsx",
@@ -829,37 +1136,51 @@
829
1136
  },
830
1137
  "NestedTableLevel": {
831
1138
  "file": "NestedTableLevel.md",
832
- "category": "Base Components/Collections/NestedTable"
1139
+ "category": "Base Components/Collections/NestedTable",
1140
+ "summary": "Describes a single level in a `NestedTable` hierarchy. Each level defines how its items are fetched (`createCollection`), how they relate to parents (`parentKey`), and how they render (`columns`, `renderMainColumn`, `actionCell`). Supports expandability, breadcrumbs, drag-and-drop, and row highlighting."
833
1141
  },
834
1142
  "NestedTableNodeState": {
835
1143
  "file": "NestedTableNodeState.md",
836
- "category": "Base Components/Collections/NestedTable"
1144
+ "category": "Base Components/Collections/NestedTable",
1145
+ "summary": "`NestedTableNodeState` represents a single node in a `NestedTable` tree. Each node has a `depth`, `expanded` state, `children` collection, `optimisticActions`, and access to its parent via `getParent()`. Use `getData()` to access the item and `toggleExpand()` to expand/collapse."
837
1146
  },
838
1147
  "NestedTableOptimisticActions": {
839
1148
  "file": "NestedTableOptimisticActions.md",
840
- "category": "Base Components/Collections/NestedTable"
1149
+ "category": "Base Components/Collections/NestedTable",
1150
+ "summary": "Extends the standard optimistic actions API with nested-table-specific operations. Provides `updateMany`, `updateOne`, `deleteMany`, and `deleteOne` methods that accept a `propagate` parameter to cascade changes to child nodes. Access via `nodeState.optimisticActions`."
841
1151
  },
842
1152
  "NestedTableState": {
843
1153
  "file": "NestedTableState.md",
844
- "category": "Base Components/Collections/NestedTable"
1154
+ "category": "Base Components/Collections/NestedTable",
1155
+ "summary": "`NestedTableState` manages the state for a `NestedTable` component. It handles multi-level hierarchical data with expand/collapse, flat and nested view modes, toolbar, and optimistic actions. Created by `useNestedTable`."
845
1156
  },
846
1157
  "operatorFilter": {
847
1158
  "file": "operatorFilter.md",
848
1159
  "category": "Features/Filter/Factories",
849
- "bundle": "functions/operatorFilter.d.ts"
1160
+ "summary": "The `operatorFilter` factory creates a filter that combines an operator selection with a value input. It is ideal for advanced filtering scenarios where users need to specify how they want to filter data.",
1161
+ "importPath": "@wix/patterns",
1162
+ "bundle": "functions/operatorFilter.d.ts",
1163
+ "propsTotal": 11,
1164
+ "propsTypeName": "OperatorFilterStateParams"
850
1165
  },
851
1166
  "SettingsPageState": {
852
1167
  "file": "SettingsPageState.md",
853
- "category": "Base Components/Pages/Settings Page/State"
1168
+ "category": "Base Components/Pages/Settings Page/State",
1169
+ "summary": "`SettingsPageState` is the state object that drives a `SettingsPage`. It is created by the `useSettingsPage` hook and manages: - **Settings fetching** — loads the current settings from the server via `fetch` - **Form state** — integrates with `react-hook-form` for editing - **Save / cancel flow** — calls `onSave` and `onCancel` with success/error toasts - **Dirty-form protection** — warns on `befo…"
854
1170
  },
855
1171
  "TableColumn": {
856
1172
  "file": "TableColumn.md",
857
1173
  "category": "Common/Types",
858
- "bundle": "types/TableColumn.d.ts"
1174
+ "summary": "Defines a column in a `Table` component. Extends the Wix Design System table column with Patterns-specific features: `sortable` / `defaultSortOrder`, `searchable`, `hideable` (for `CustomColumns`), and `mobile` layout configuration.",
1175
+ "bundle": "types/TableColumn.d.ts",
1176
+ "propsTotal": 19,
1177
+ "propsTypeName": "Column"
859
1178
  },
860
1179
  "TableDragAndDrop": {
861
1180
  "file": "TableDragAndDrop.md",
862
1181
  "category": "Features/Sort/Drag and Drop",
1182
+ "summary": "Enables drag and drop functionality on a `Table` component.",
1183
+ "importPath": "@wix/patterns",
863
1184
  "examples": [
864
1185
  "TableDragAndDrop/table.tsx",
865
1186
  "TableDragAndDrop/specific-tabs.tsx",
@@ -870,169 +1191,367 @@
870
1191
  "TableFoldersState": {
871
1192
  "file": "TableFoldersState.md",
872
1193
  "category": "Base Components/Collections/TableFolders/TableFoldersState",
873
- "bundle": "types/TableFoldersState.d.ts"
1194
+ "summary": "`TableFoldersState` manages the state for a `TableFolders` component, which displays folders and items in a table layout. Holds separate `CollectionState` instances for folders and items, plus a shared `TableState` and toolbar. Created by `useTableCollection` with a folders configuration.",
1195
+ "bundle": "types/TableFoldersState.d.ts",
1196
+ "propsTotal": 3,
1197
+ "propsTypeName": "TableFoldersStatePublicAPI"
874
1198
  },
875
1199
  "TableGridSwitchDragAndDrop": {
876
1200
  "file": "TableGridSwitchDragAndDrop.md",
877
- "category": "Features/Sort/Drag and Drop"
1201
+ "category": "Features/Sort/Drag and Drop",
1202
+ "summary": "Enables drag and drop functionality on a `TableGridSwitch` component.",
1203
+ "importPath": "@wix/patterns"
878
1204
  },
879
1205
  "TableGridSwitchFoldersState": {
880
1206
  "file": "TableGridSwitchFoldersState.md",
881
- "category": "Base Components/Collections/TableGridSwitchFolders/TableGridSwitchFoldersState"
1207
+ "category": "Base Components/Collections/TableGridSwitchFolders/TableGridSwitchFoldersState",
1208
+ "summary": "`TableGridSwitchFoldersState` manages the state for a `TableGridSwitchFolders` component — a collection that supports switching between table and grid views while also displaying folders. Holds a `GridFoldersState`, a `TableFoldersState`, and a `viewTypeState` for toggling layouts."
882
1209
  },
883
1210
  "TableGridSwitchState": {
884
1211
  "file": "TableGridSwitchState.md",
885
1212
  "category": "Base Components/Collections/TableGridSwitch/TableGridSwitchState",
886
- "bundle": "types/TableGridSwitchState.d.ts"
1213
+ "summary": "`TableGridSwitchState` manages the state for a `TableGridSwitch` component, which lets users switch between table and grid views. Wraps a `GridState` and a `TableState` with a shared `viewTypeState`. Created by `useTableGridSwitchCollection`.",
1214
+ "bundle": "types/TableGridSwitchState.d.ts",
1215
+ "propsTotal": 4,
1216
+ "propsTypeName": "_TableGridSwitchState"
887
1217
  },
888
1218
  "TableState": {
889
1219
  "file": "TableState.md",
890
1220
  "category": "Base Components/Collections/Table/TableState",
891
- "bundle": "types/TableState.d.ts"
1221
+ "summary": "`TableState` manages the state for a `Table` component. It wraps a `CollectionState` for data, a `ToolbarCollectionState` for the toolbar, tracks visible columns and sorting, and supports virtual scrolling and drag-and-drop. Created by `useTableCollection`.",
1222
+ "bundle": "types/TableState.d.ts",
1223
+ "propsTotal": 5,
1224
+ "propsTypeName": "TableStatePublicAPI"
892
1225
  },
893
1226
  "ToolbarCollectionState": {
894
1227
  "file": "ToolbarCollectionState.md",
895
- "category": "Common/State"
1228
+ "category": "Common/State",
1229
+ "summary": "`ToolbarCollectionState` manages the toolbar state for collection components. It handles filter panel visibility, custom columns selection, data capsule persistence, fedops reporting, and responsive layout calculations. You typically do not create this directly — it is managed internally by `TableState`, `GridState`, and similar component states."
896
1230
  },
897
1231
  "View": {
898
1232
  "file": "View.md",
899
- "category": "Common/Types"
1233
+ "category": "Common/Types",
1234
+ "summary": "Defines a saved view in the `Views` dropdown. A view captures a snapshot of filters, visible columns, column order, sort directions, and layout type (table or grid). Use `isDefaultView` to set the initial view when the collection loads."
900
1235
  },
901
1236
  "arrayFilter": {
902
1237
  "file": "arrayFilter.md",
903
1238
  "category": "Features/Filter/Factories",
904
- "bundle": "functions/arrayFilter.d.ts"
1239
+ "summary": "A generic filter factory that can be used with the `filters` property of the `useCollection` hook, for selecting one or multiple values from a fixed or dynamic list of items.",
1240
+ "importPath": "@wix/patterns",
1241
+ "bundle": "functions/arrayFilter.d.ts",
1242
+ "propsTotal": 10,
1243
+ "propsTypeName": "ArrayFilterStateParams"
905
1244
  },
906
1245
  "createNestedTableLevel": {
907
1246
  "file": "createNestedTableLevel.md",
908
- "category": "Base Components/Collections/NestedTable"
1247
+ "category": "Base Components/Collections/NestedTable",
1248
+ "summary": "A helper function that creates a `NestedTableLevel` descriptor without specifying `depth` (depth is assigned automatically based on array position). Pass the result to the `levels` array in `useNestedTable`."
909
1249
  },
910
1250
  "createNestedTableSingleEntityLevels": {
911
1251
  "file": "createNestedTableSingleEntityLevels.md",
912
- "category": "Base Components/Collections/NestedTable"
1252
+ "category": "Base Components/Collections/NestedTable",
1253
+ "summary": "A helper function to create multiple nested table levels out of the same configurations for a single entity type."
913
1254
  },
914
1255
  "dateRangeFilter": {
915
1256
  "file": "dateRangeFilter.Factories.md",
916
1257
  "category": "Features/Filter/Factories",
917
- "bundle": "functions/dateRangeFilter.d.ts"
918
- },
919
- "idNameArrayFilter": {
920
- "file": "idNameArrayFilter.md",
921
- "category": "Features/Filter/Factories",
922
- "bundle": "functions/idNameArrayFilter.d.ts"
1258
+ "summary": "The filter is used together with DateRangeFilter component. Check the component examples section to see all possibilities for this filter.",
1259
+ "importPath": "@wix/patterns",
1260
+ "bundle": "functions/dateRangeFilter.d.ts",
1261
+ "propsTotal": 11,
1262
+ "propsTypeName": "Partial"
923
1263
  },
924
1264
  "stringFilter": {
925
1265
  "file": "stringFilter.md",
926
1266
  "category": "Features/Filter/Factories",
927
- "bundle": "functions/stringFilter.d.ts"
1267
+ "summary": "This filter was primarily designed to be used in conjunction with the search functionality within the WixPatterns collection. It is not typically necessary to use this filter instead of the other available filters.",
1268
+ "importPath": "@wix/patterns",
1269
+ "bundle": "functions/stringFilter.d.ts",
1270
+ "propsTotal": 2,
1271
+ "propsTypeName": "Partial"
1272
+ },
1273
+ "idNameArrayFilter": {
1274
+ "file": "idNameArrayFilter.md",
1275
+ "category": "Features/Filter/Factories",
1276
+ "summary": "This filter is often used for complex objects and types that do not have official support in Wix Patterns.",
1277
+ "importPath": "@wix/patterns",
1278
+ "bundle": "functions/idNameArrayFilter.d.ts",
1279
+ "propsTotal": 10,
1280
+ "propsTypeName": "ArrayFilterStateParams"
928
1281
  },
929
1282
  "stringsArrayFilter": {
930
1283
  "file": "stringsArrayFilter.md",
931
1284
  "category": "Features/Filter/Factories",
932
- "bundle": "functions/stringsArrayFilter.d.ts"
1285
+ "summary": "The filter is used to manage an array of strings. The string value can be a simple string that is displayed to the user, an enum value that is translated using `itemName` prop, or even an array of IDs that is not used with UI component but rather as an internal filter for querying data.",
1286
+ "importPath": "@wix/patterns",
1287
+ "bundle": "functions/stringsArrayFilter.d.ts",
1288
+ "propsTotal": 10,
1289
+ "propsTypeName": "ArrayFilterStateParams"
933
1290
  },
934
1291
  "useAmbassadorCollection": {
935
1292
  "file": "useAmbassadorCollection.md",
936
- "category": "Common/Hooks"
1293
+ "category": "Common/Hooks",
1294
+ "summary": "A React hook that initializes a collection state using an Ambassador SDK package. The ambassador package should implement the `crud.ts` module. This is a higher-level alternative to `useCollection` that auto-generates `fetchData`, `queryName`, and `itemKey` from the Ambassador SDK.",
1295
+ "importPath": "@wix/patterns"
937
1296
  },
938
1297
  "useCollection": {
939
1298
  "file": "useCollection.md",
940
- "category": "Common/Hooks"
1299
+ "category": "Common/Hooks",
1300
+ "summary": "The base React hook for creating a `CollectionState`. All other collection hooks (`useTableCollection`, `useGridCollection`, etc.) build on top of `useCollection`. Use this hook directly when you need a collection state that is not tied to a specific component, or when building custom collection components.",
1301
+ "importPath": "@wix/patterns",
1302
+ "bundle": "hooks/useCollection.d.ts",
1303
+ "propsTotal": 17,
1304
+ "propsTypeName": "CollectionConfig"
941
1305
  },
942
1306
  "useCreateCollection": {
943
1307
  "file": "useCreateCollection.md",
944
1308
  "category": "Common/Hooks",
945
- "bundle": "hooks/useCreateCollection.d.ts"
1309
+ "summary": "React hook that that retuns a function that initializes a collection state. Similiar to useCollection, but it returns a function that initializes a collection state instead of the collection state itself.",
1310
+ "bundle": "hooks/useCreateCollection.d.ts",
1311
+ "propsTotal": 17,
1312
+ "propsTypeName": "CollectionConfig"
946
1313
  },
947
1314
  "useCreateNestedOptimisticActions": {
948
1315
  "file": "useCreateNestedOptimisticActions.md",
949
- "category": "Base Components/Collections/NestedTable"
1316
+ "category": "Base Components/Collections/NestedTable",
1317
+ "summary": "A React hook that returns a function to create OptimisticActions instance for a nested table collection created in the `levels.createCollection` prop of useNestedTable."
950
1318
  },
951
1319
  "useFilterCollection": {
952
1320
  "file": "useFilterCollection.md",
953
1321
  "category": "Features/Filter/Hooks",
954
- "bundle": "hooks/useFilterCollection.d.ts"
1322
+ "summary": "React hook that connects a filter to a collection state.",
1323
+ "importPath": "@wix/patterns",
1324
+ "bundle": "hooks/useFilterCollection.d.ts",
1325
+ "propsTotal": 11,
1326
+ "propsTypeName": "FilterCollectionConfig"
955
1327
  },
956
1328
  "useGridCollection": {
957
1329
  "file": "useGridCollection.md",
958
1330
  "category": "Base Components/Collections/Grid/useGridCollection",
959
- "bundle": "hooks/useGridCollection.d.ts"
1331
+ "summary": "`useGridCollection` is a React hook designed to facilitate the management of the `Grid` component.It returns a `GridState` to pass to the `state` prop of the `Grid` component.",
1332
+ "importPath": "@wix/patterns",
1333
+ "bundle": "hooks/useGridCollection.d.ts",
1334
+ "propsTotal": 17,
1335
+ "propsTypeName": "CollectionConfig"
960
1336
  },
961
1337
  "useGridFolders": {
962
1338
  "file": "useGridFolders.md",
963
1339
  "category": "Base Components/Collections/GridFolders/useGridFolders",
964
- "bundle": "hooks/useGridFolders.d.ts"
1340
+ "summary": "`useGridFolders` is a React hook designed to facilitate the management of the `GridFolders` component.It returns a `GridFoldersState` to pass to the `state` prop of the `GridFolders` component.",
1341
+ "importPath": "@wix/patterns",
1342
+ "bundle": "hooks/useGridFolders.d.ts",
1343
+ "propsTotal": 2,
1344
+ "propsTypeName": "GridFoldersConfig"
965
1345
  },
966
1346
  "useNestedTable": {
967
1347
  "file": "useNestedTable.md",
968
- "category": "Base Components/Collections/NestedTable"
1348
+ "category": "Base Components/Collections/NestedTable",
1349
+ "summary": "`useNestedTable` is a React hook that creates the state for a `NestedTable` component — a table that displays hierarchical data with expand/collapse, flat and nested view modes, and multi-level optimistic actions. You define the hierarchy through `levels`, where each level describes how to fetch its items, how they relate to their parent, and how to render columns.",
1350
+ "importPath": "@wix/patterns"
969
1351
  },
970
1352
  "usePickerContent": {
971
1353
  "file": "usePickerContent.md",
972
- "category": "Base Components/Collections/Picker/Hooks"
973
- },
974
- "useTableCollection": {
975
- "file": "useTableCollection.md",
976
- "category": "Base Components/Collections/Table/useTableCollection",
977
- "bundle": "hooks/useTableCollection.d.ts"
1354
+ "category": "Base Components/Collections/Picker/Hooks",
1355
+ "summary": "`usePickerContent` is a React hook that creates the collection state for the content displayed inside a `PickerModal`. It extends the collection config (like `filters`, `itemName`) and adds picker-specific options such as `modalState`, `events`, and `initialSelect`.",
1356
+ "importPath": "@wix/patterns"
978
1357
  },
979
1358
  "useStaticListFilterCollection": {
980
1359
  "file": "useStaticListFilterCollection.md",
981
1360
  "category": "Features/Filter/Hooks",
982
- "bundle": "hooks/useStaticListFilterCollection.d.ts"
1361
+ "summary": "`useStaticListFilterCollection` is a hook that connects a filter (ArrayFilter, usually), to a CollectionState created from a static list of items. It also providers search functionality (search term, will be matched against the itemName function configured on the `filter` object).",
1362
+ "importPath": "@wix/patterns",
1363
+ "bundle": "hooks/useStaticListFilterCollection.d.ts",
1364
+ "propsTotal": 2,
1365
+ "propsTypeName": "UseStaticListFilterCollectionProps"
1366
+ },
1367
+ "useTableCollection": {
1368
+ "file": "useTableCollection.md",
1369
+ "category": "Base Components/Collections/Table/useTableCollection",
1370
+ "summary": "`useTableCollection` is a React hook designed to facilitate the management of the `Table` component.It returns a `TableState` to pass to the `state` prop of the `Table` component.",
1371
+ "importPath": "@wix/patterns",
1372
+ "bundle": "hooks/useTableCollection.d.ts",
1373
+ "propsTotal": 17,
1374
+ "propsTypeName": "CollectionConfig"
983
1375
  },
984
1376
  "useTableFolders": {
985
1377
  "file": "useTableFolders.md",
986
1378
  "category": "Base Components/Collections/TableFolders/useTableFolders",
987
- "bundle": "hooks/useTableFolders.d.ts"
1379
+ "summary": "`useTableFolders` is a React hook designed to facilitate the management of the `TableFolders` component.It returns a `TableFoldersState` to pass to the `state` prop of the `TableFolders` component.",
1380
+ "importPath": "@wix/patterns",
1381
+ "bundle": "hooks/useTableFolders.d.ts",
1382
+ "propsTotal": 2,
1383
+ "propsTypeName": "TableFoldersConfig"
988
1384
  },
989
1385
  "useTableGridSwitchCollection": {
990
1386
  "file": "useTableGridSwitchCollection.md",
991
1387
  "category": "Base Components/Collections/TableGridSwitch/useTableGridSwitchCollection",
992
- "bundle": "hooks/useTableGridSwitchCollection.d.ts"
1388
+ "summary": "`useTableGridSwitchCollection` is a React hook designed to facilitate the management of the `TableGridSwitch` component.It returns a `TableGridSwitchState` to pass to the `state` prop of the `TableGridSwitch` component.",
1389
+ "importPath": "@wix/patterns",
1390
+ "bundle": "hooks/useTableGridSwitchCollection.d.ts",
1391
+ "propsTotal": 17,
1392
+ "propsTypeName": "CollectionConfig"
993
1393
  },
994
1394
  "useTableGridSwitchFolders": {
995
1395
  "file": "useTableGridSwitchFolders.md",
996
- "category": "Base Components/Collections/TableGridSwitchFolders/useTableGridSwitchFolders"
1396
+ "category": "Base Components/Collections/TableGridSwitchFolders/useTableGridSwitchFolders",
1397
+ "summary": "`useTableGridSwitchFolders` is a React hook designed to facilitate the management of the `TableGridSwitchFolders` component. It returns a `TableGridSwitchFoldersState` to pass to the `state` prop of `TableGridSwitchFolders`.",
1398
+ "importPath": "@wix/patterns"
997
1399
  },
998
1400
  "useWidgetsFormContext": {
999
1401
  "file": "useWidgetsFormContext.md",
1000
- "category": "Common/Hooks"
1402
+ "category": "Common/Hooks",
1403
+ "summary": "The `useWidgetsFormContext` hook is used to get access to the page's state, when the page is wrapped with WidgetsFormProvider"
1001
1404
  },
1002
1405
  "withDashboard": {
1003
1406
  "file": "withDashboard.md",
1004
1407
  "category": "Base Components/Pages/Router",
1408
+ "summary": "`withDashboard` is the higher-order component that renders bex-core's dashboard context around a page. Patterns components read the current page location out of that context, so wrapping the page is not optional for any of them that route.",
1409
+ "importPath": "@wix/patterns",
1005
1410
  "bundle": "functions/withDashboard.d.ts"
1006
1411
  },
1007
1412
  "InMemoryBackend": {
1008
1413
  "file": "InMemoryBackend.md",
1009
- "category": "Guides"
1414
+ "category": "Guides",
1415
+ "summary": "A mocking utility which acts as a collection server API.",
1416
+ "importPath": "@wix/patterns/testkit/backend"
1010
1417
  },
1011
1418
  "Tags Overview": {
1012
1419
  "file": "Tags Overview.md",
1013
- "category": "Features/Enrich/Tags"
1420
+ "category": "Features/Enrich/Tags",
1421
+ "summary": "### Introduction"
1014
1422
  },
1015
1423
  "Working with Cache": {
1016
1424
  "file": "Working with Cache.md",
1017
- "category": "Guides"
1425
+ "category": "Guides",
1426
+ "summary": "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."
1427
+ },
1428
+ "Collection to Entity Flow": {
1429
+ "file": "Collection to Entity Flow.md",
1430
+ "category": "Guides",
1431
+ "summary": "A collection page and the form for one of its items are **two patterns pages**, not a page plus a modal. That holds for creating a record as much as editing one: an \"add new\" form writes the record, so it is an `EntityPage` however small it is.",
1432
+ "relatedComponents": [
1433
+ "CollectionPage",
1434
+ "EntityPage",
1435
+ "EntityPageState",
1436
+ "useEntityPage",
1437
+ "useEntity",
1438
+ "useCreateCollection",
1439
+ "usePatternsNavigate",
1440
+ "PatternsReactRouter",
1441
+ "PatternsReactRoute"
1442
+ ]
1443
+ },
1444
+ "Collection Toolkit": {
1445
+ "file": "Collection Toolkit.md",
1446
+ "category": "Guides",
1447
+ "summary": "Which component to reach for, arranged by what the person using the dashboard is trying to do: understand the situation, narrow it, open one record, act, and be told what happened.",
1448
+ "relatedComponents": [
1449
+ "SummaryBar",
1450
+ "CollectionSearch",
1451
+ "CollectionToolbarFilters",
1452
+ "MultiSelectCheckboxFilter",
1453
+ "MultiInlineCheckboxFilter",
1454
+ "MultiAutoInlineCheckboxFilter",
1455
+ "SingleSelectFilter",
1456
+ "RadioGroupFilter",
1457
+ "TabsFilter",
1458
+ "MultiSelectCollectionFilter",
1459
+ "useFilterCollection",
1460
+ "AutoCompleteFilter",
1461
+ "DateRangeFilter",
1462
+ "NumberRangeFilter",
1463
+ "OperatorFilterPicker",
1464
+ "operatorFilter",
1465
+ "idNameArrayFilter",
1466
+ "stringFilter",
1467
+ "stringsArrayFilter",
1468
+ "arrayFilter",
1469
+ "dateRangeFilter",
1470
+ "customFilter",
1471
+ "useStaticListFilterCollection",
1472
+ "Sortable Columns",
1473
+ "MultiLevelSorting",
1474
+ "EntityPage",
1475
+ "useEntityPage",
1476
+ "usePatternsNavigate",
1477
+ "PickerModal",
1478
+ "usePickerModal",
1479
+ "bulkActionModal",
1480
+ "PrimaryActions",
1481
+ "SecondaryActions",
1482
+ "More Actions",
1483
+ "deleteSecondaryAction",
1484
+ "PrimaryActionButton",
1485
+ "MultiBulkActionToolbar",
1486
+ "useOptimisticActions",
1487
+ "CollectionOptimisticActions",
1488
+ "TableTopNotification",
1489
+ "CollectionEmptyState",
1490
+ "CollectionNoResultsState",
1491
+ "CollectionPremiumEmptyState",
1492
+ "ExportButton"
1493
+ ]
1494
+ },
1495
+ "Composition and Providers": {
1496
+ "file": "Composition and Providers.md",
1497
+ "category": "Guides",
1498
+ "summary": "Every patterns page is four nested layers. Getting the nesting wrong is the most common way a page that looks right throws at runtime.",
1499
+ "relatedComponents": [
1500
+ "WixPatternsProvider",
1501
+ "WixPatternsBMProvider",
1502
+ "WixPatternsGizaProvider",
1503
+ "WixPatternsEssentialsProvider",
1504
+ "WixPatternsBaseProvider",
1505
+ "CollectionPage",
1506
+ "EntityPage",
1507
+ "SettingsPage",
1508
+ "Table",
1509
+ "Grid",
1510
+ "TableGridSwitch",
1511
+ "TableFolders",
1512
+ "GridFolders",
1513
+ "TableState",
1514
+ "GridState",
1515
+ "TableGridSwitchState",
1516
+ "TableFoldersState",
1517
+ "GridFoldersState",
1518
+ "useTableCollection",
1519
+ "useGridCollection",
1520
+ "useTableGridSwitchCollection",
1521
+ "useTableFolders",
1522
+ "useGridFolders",
1523
+ "PatternsReactRouter",
1524
+ "PatternsReactRoute",
1525
+ "usePatternsNavigate",
1526
+ "withDashboard"
1527
+ ]
1018
1528
  },
1019
1529
  "Filter Overview": {
1020
1530
  "file": "Filter Overview.md",
1021
1531
  "category": "Features/Filter",
1532
+ "summary": "To better understand the use and configuration of filters in Wix Patterns and especially in Tabs Filter, Toolbar Filters and Views it is important to know the difference between the Filter Components and the `Filter` object including all the built-in factories Wix Patterns provides.",
1022
1533
  "examples": [
1023
1534
  "Filter Overview/interactive-example.tsx"
1024
1535
  ]
1025
1536
  },
1026
1537
  "Next.js": {
1027
1538
  "file": "Next.js.md",
1028
- "category": "Guides"
1539
+ "category": "Guides",
1540
+ "summary": "**Next.js** is replacing the Yoshi fullstack flow. It's not yet officially supported by the infra team, however early adopters can try it out using the WIX Next.js template."
1541
+ },
1542
+ "Reading the Doc Indices": {
1543
+ "file": "Reading the Doc Indices.md",
1544
+ "category": "Guides",
1545
+ "summary": "`@wix/patterns` ships two machine-readable indices under `dist/`, and they answer different questions. This is what their conventions mean, so a consumer reading them does not mistake a deliberate stub for a truncated file."
1029
1546
  },
1030
1547
  "Component Tests": {
1031
1548
  "file": "Component Tests.md",
1032
- "category": "Guides/Component Tests"
1549
+ "category": "Guides/Component Tests",
1550
+ "summary": "`Wix Patterns` provides uni driver testkits, similarly to `@wix/design-system` testing"
1033
1551
  },
1034
1552
  "Sled Tests": {
1035
1553
  "file": "Sled Tests.md",
1036
- "category": "Guides/Sled Tests"
1554
+ "category": "Guides/Sled Tests",
1555
+ "summary": "The power of uni drivers provided by `Wix Patterns` is that we can use them also in `puppeteer` environment."
1037
1556
  }
1038
1557
  }