@wix/patterns 1.478.0 → 1.480.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 (715) hide show
  1. package/dist/cjs/components/CardContainer/CardContainer.st.css.js +2 -2
  2. package/dist/cjs/components/CardContainer/CardContainer.st.css.js.map +1 -1
  3. package/dist/cjs/components/CmsFieldManagement/CmsFieldForm.st.css.js +3 -3
  4. package/dist/cjs/components/CmsFieldManagement/CmsFieldForm.st.css.js.map +1 -1
  5. package/dist/cjs/components/CmsFieldManagement/CmsFieldModal.st.css.js +3 -3
  6. package/dist/cjs/components/CmsFieldManagement/CmsFieldModal.st.css.js.map +1 -1
  7. package/dist/cjs/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js +3 -3
  8. package/dist/cjs/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js.map +1 -1
  9. package/dist/cjs/components/Collapse/Collapse.st.css.js +3 -3
  10. package/dist/cjs/components/Collapse/Collapse.st.css.js.map +1 -1
  11. package/dist/cjs/components/CollectionPageHeaderNew/CollectionPageHeader.js.map +1 -1
  12. package/dist/cjs/components/CollectionPageNew/CollectionPage.st.css +9 -3
  13. package/dist/cjs/components/CollectionPageNew/CollectionPage.st.css.js +2 -2
  14. package/dist/cjs/components/CollectionPageNew/CollectionPage.st.css.js.map +1 -1
  15. package/dist/cjs/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js +3 -3
  16. package/dist/cjs/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js.map +1 -1
  17. package/dist/cjs/components/CollectionTable/CollectionTable.st.css.js +2 -2
  18. package/dist/cjs/components/CollectionTable/CollectionTable.st.css.js.map +1 -1
  19. package/dist/cjs/components/CollectionTable/CollectionTableWSRTable.st.css.js +2 -2
  20. package/dist/cjs/components/CollectionTable/CollectionTableWSRTable.st.css.js.map +1 -1
  21. package/dist/cjs/components/CollectionToolbar/CollectionToolbar.st.css.js +5 -5
  22. package/dist/cjs/components/CollectionToolbar/CollectionToolbar.st.css.js.map +1 -1
  23. package/dist/cjs/components/CollectionToolbar/SearchOrCustomFilter.st.css.js +4 -4
  24. package/dist/cjs/components/CollectionToolbar/SearchOrCustomFilter.st.css.js.map +1 -1
  25. package/dist/cjs/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js +2 -2
  26. package/dist/cjs/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js.map +1 -1
  27. package/dist/cjs/components/CollectionViewsDropdown/ViewsDropdown.st.css.js +2 -2
  28. package/dist/cjs/components/CollectionViewsDropdown/ViewsDropdown.st.css.js.map +1 -1
  29. package/dist/cjs/components/CustomFieldModal/CustomFieldForm.js +9 -8
  30. package/dist/cjs/components/CustomFieldModal/CustomFieldForm.js.map +1 -1
  31. package/dist/cjs/components/CustomFieldModal/CustomFieldFormPiiFields.st.css.js +3 -3
  32. package/dist/cjs/components/CustomFieldModal/CustomFieldFormPiiFields.st.css.js.map +1 -1
  33. package/dist/cjs/components/CustomFieldModal/CustomFieldTypeDropdown.js +15 -6
  34. package/dist/cjs/components/CustomFieldModal/CustomFieldTypeDropdown.js.map +1 -1
  35. package/dist/cjs/components/DragHandle/DragHandle.st.css.js +2 -2
  36. package/dist/cjs/components/DragHandle/DragHandle.st.css.js.map +1 -1
  37. package/dist/cjs/components/EditableTable/EditableCell.js +13 -7
  38. package/dist/cjs/components/EditableTable/EditableCell.js.map +1 -1
  39. package/dist/cjs/components/EditableTable/EditableCell.st.css.js +3 -3
  40. package/dist/cjs/components/EditableTable/EditableCell.st.css.js.map +1 -1
  41. package/dist/cjs/components/EditableTable/EditableTable.js +17 -10
  42. package/dist/cjs/components/EditableTable/EditableTable.js.map +1 -1
  43. package/dist/cjs/components/EditableTable/EditableTableContextMenu.js +4 -4
  44. package/dist/cjs/components/EditableTable/EditableTableContextMenu.js.map +1 -1
  45. package/dist/cjs/components/EditableTable/HeaderActionsPopover.st.css.js +2 -2
  46. package/dist/cjs/components/EditableTable/HeaderActionsPopover.st.css.js.map +1 -1
  47. package/dist/cjs/components/EditableTable/HeaderFieldActions.js +11 -3
  48. package/dist/cjs/components/EditableTable/HeaderFieldActions.js.map +1 -1
  49. package/dist/cjs/components/EditableTable/cellTypes/CellViewLayout.st.css.js +2 -2
  50. package/dist/cjs/components/EditableTable/cellTypes/CellViewLayout.st.css.js.map +1 -1
  51. package/dist/cjs/components/EditableTable/cellTypes/address/Edit.st.css.js +3 -3
  52. package/dist/cjs/components/EditableTable/cellTypes/address/Edit.st.css.js.map +1 -1
  53. package/dist/cjs/components/EditableTable/cellTypes/array/Edit.st.css.js +3 -3
  54. package/dist/cjs/components/EditableTable/cellTypes/array/Edit.st.css.js.map +1 -1
  55. package/dist/cjs/components/EditableTable/cellTypes/boolean/Edit.st.css.js +3 -3
  56. package/dist/cjs/components/EditableTable/cellTypes/boolean/Edit.st.css.js.map +1 -1
  57. package/dist/cjs/components/EditableTable/cellTypes/boolean/View.st.css.js +3 -3
  58. package/dist/cjs/components/EditableTable/cellTypes/boolean/View.st.css.js.map +1 -1
  59. package/dist/cjs/components/EditableTable/cellTypes/color/Edit.st.css.js +2 -2
  60. package/dist/cjs/components/EditableTable/cellTypes/color/Edit.st.css.js.map +1 -1
  61. package/dist/cjs/components/EditableTable/cellTypes/date/Edit.st.css.js +3 -3
  62. package/dist/cjs/components/EditableTable/cellTypes/date/Edit.st.css.js.map +1 -1
  63. package/dist/cjs/components/EditableTable/cellTypes/date/View.st.css.js +2 -2
  64. package/dist/cjs/components/EditableTable/cellTypes/date/View.st.css.js.map +1 -1
  65. package/dist/cjs/components/EditableTable/cellTypes/datetime/Edit.st.css.js +8 -8
  66. package/dist/cjs/components/EditableTable/cellTypes/datetime/Edit.st.css.js.map +1 -1
  67. package/dist/cjs/components/EditableTable/cellTypes/datetime/View.st.css.js +7 -7
  68. package/dist/cjs/components/EditableTable/cellTypes/datetime/View.st.css.js.map +1 -1
  69. package/dist/cjs/components/EditableTable/cellTypes/email/Edit.st.css.js +3 -3
  70. package/dist/cjs/components/EditableTable/cellTypes/email/Edit.st.css.js.map +1 -1
  71. package/dist/cjs/components/EditableTable/cellTypes/email/View.st.css.js +2 -2
  72. package/dist/cjs/components/EditableTable/cellTypes/email/View.st.css.js.map +1 -1
  73. package/dist/cjs/components/EditableTable/cellTypes/number/Edit.st.css.js +3 -3
  74. package/dist/cjs/components/EditableTable/cellTypes/number/Edit.st.css.js.map +1 -1
  75. package/dist/cjs/components/EditableTable/cellTypes/number/View.st.css.js +3 -3
  76. package/dist/cjs/components/EditableTable/cellTypes/number/View.st.css.js.map +1 -1
  77. package/dist/cjs/components/EditableTable/cellTypes/object/Edit.st.css.js +3 -3
  78. package/dist/cjs/components/EditableTable/cellTypes/object/Edit.st.css.js.map +1 -1
  79. package/dist/cjs/components/EditableTable/cellTypes/object/View.st.css.js +2 -2
  80. package/dist/cjs/components/EditableTable/cellTypes/object/View.st.css.js.map +1 -1
  81. package/dist/cjs/components/EditableTable/cellTypes/select/Edit.st.css.js +3 -3
  82. package/dist/cjs/components/EditableTable/cellTypes/select/Edit.st.css.js.map +1 -1
  83. package/dist/cjs/components/EditableTable/cellTypes/text/Edit.st.css.js +4 -4
  84. package/dist/cjs/components/EditableTable/cellTypes/text/Edit.st.css.js.map +1 -1
  85. package/dist/cjs/components/EditableTable/cellTypes/text/View.st.css.js +2 -2
  86. package/dist/cjs/components/EditableTable/cellTypes/text/View.st.css.js.map +1 -1
  87. package/dist/cjs/components/EditableTable/cellTypes/time/Edit.st.css.js +4 -4
  88. package/dist/cjs/components/EditableTable/cellTypes/time/Edit.st.css.js.map +1 -1
  89. package/dist/cjs/components/EditableTable/cellTypes/url/Edit.st.css.js +3 -3
  90. package/dist/cjs/components/EditableTable/cellTypes/url/Edit.st.css.js.map +1 -1
  91. package/dist/cjs/components/EditableTable/cellTypes/url/View.st.css.js +5 -5
  92. package/dist/cjs/components/EditableTable/cellTypes/url/View.st.css.js.map +1 -1
  93. package/dist/cjs/components/EditableTable/useEditableTableContextMenu.js +13 -1
  94. package/dist/cjs/components/EditableTable/useEditableTableContextMenu.js.map +1 -1
  95. package/dist/cjs/components/EmptyState/EmptyStateBase.st.css.js +2 -2
  96. package/dist/cjs/components/EmptyState/EmptyStateBase.st.css.js.map +1 -1
  97. package/dist/cjs/components/EntityPage/EntityPagePlain.st.css.js +2 -2
  98. package/dist/cjs/components/EntityPage/EntityPagePlain.st.css.js.map +1 -1
  99. package/dist/cjs/components/Fade/Fade.st.css.js +2 -2
  100. package/dist/cjs/components/Fade/Fade.st.css.js.map +1 -1
  101. package/dist/cjs/components/FieldActions/HeaderActionsPopover.js +19 -6
  102. package/dist/cjs/components/FieldActions/HeaderActionsPopover.js.map +1 -1
  103. package/dist/cjs/components/Grid/Grid.js.map +1 -1
  104. package/dist/cjs/components/Heading/Heading.st.css.js +2 -2
  105. package/dist/cjs/components/Heading/Heading.st.css.js.map +1 -1
  106. package/dist/cjs/components/ImportButton/ImportStepUpload.st.css.js +3 -3
  107. package/dist/cjs/components/ImportButton/ImportStepUpload.st.css.js.map +1 -1
  108. package/dist/cjs/components/InputOverflow/InputOverflow.st.css.js +2 -2
  109. package/dist/cjs/components/InputOverflow/InputOverflow.st.css.js.map +1 -1
  110. package/dist/cjs/components/LoadingRow/LoadingRow.st.css.js +3 -3
  111. package/dist/cjs/components/LoadingRow/LoadingRow.st.css.js.map +1 -1
  112. package/dist/cjs/components/MaxHeightText/MaxHeightText.st.css.js +2 -2
  113. package/dist/cjs/components/MaxHeightText/MaxHeightText.st.css.js.map +1 -1
  114. package/dist/cjs/components/MaxLines/MaxLines.st.css.js +2 -2
  115. package/dist/cjs/components/MaxLines/MaxLines.st.css.js.map +1 -1
  116. package/dist/cjs/components/MoreActions/MoreActionsIcon.js +28 -25
  117. package/dist/cjs/components/MoreActions/MoreActionsIcon.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/PageSubTitle/PageSubTitle.js +7 -7
  129. package/dist/cjs/components/PageSubTitle/PageSubTitle.js.map +1 -1
  130. package/dist/cjs/components/PickerContent/PickerContent.st.css.js +2 -2
  131. package/dist/cjs/components/PickerContent/PickerContent.st.css.js.map +1 -1
  132. package/dist/cjs/components/PickerContent/PickerContentAdditionalStep.st.css.js +4 -4
  133. package/dist/cjs/components/PickerContent/PickerContentAdditionalStep.st.css.js.map +1 -1
  134. package/dist/cjs/components/PickerTableListItem/PickerTableListItem.st.css.js +2 -2
  135. package/dist/cjs/components/PickerTableListItem/PickerTableListItem.st.css.js.map +1 -1
  136. package/dist/cjs/components/PrimaryActions/PrimaryActions.js +1 -2
  137. package/dist/cjs/components/PrimaryActions/PrimaryActions.js.map +1 -1
  138. package/dist/cjs/components/ScrollableContent/ScrollableContent.st.css.js +2 -2
  139. package/dist/cjs/components/ScrollableContent/ScrollableContent.st.css.js.map +1 -1
  140. package/dist/cjs/components/SetupWidget/SetupWidget.st.css.js +10 -10
  141. package/dist/cjs/components/SetupWidget/SetupWidget.st.css.js.map +1 -1
  142. package/dist/cjs/components/SkeletonCard/SkeletonCard.st.css.js +3 -3
  143. package/dist/cjs/components/SkeletonCard/SkeletonCard.st.css.js.map +1 -1
  144. package/dist/cjs/components/SlidingModal/SlidingModal.st.css.js +2 -2
  145. package/dist/cjs/components/SlidingModal/SlidingModal.st.css.js.map +1 -1
  146. package/dist/cjs/components/Table/AddFieldColumnHeader.st.css.js +6 -6
  147. package/dist/cjs/components/Table/AddFieldColumnHeader.st.css.js.map +1 -1
  148. package/dist/cjs/components/TabsFilter/TabsFilter.st.css.js +3 -3
  149. package/dist/cjs/components/TabsFilter/TabsFilter.st.css.js.map +1 -1
  150. package/dist/cjs/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js +2 -2
  151. package/dist/cjs/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js.map +1 -1
  152. package/dist/cjs/components/ToolbarCollection/ToolbarCollection.js.map +1 -1
  153. package/dist/cjs/components/ToolbarItem/ToolbarItem.st.css.js +2 -2
  154. package/dist/cjs/components/ToolbarItem/ToolbarItem.st.css.js.map +1 -1
  155. package/dist/cjs/components/ToolbarItemBox/ToolbarItemBox.st.css.js +2 -2
  156. package/dist/cjs/components/ToolbarItemBox/ToolbarItemBox.st.css.js.map +1 -1
  157. package/dist/cjs/components/common.st.css.js +4 -4
  158. package/dist/cjs/components/common.st.css.js.map +1 -1
  159. package/dist/cjs/hooks/useCollectionPageChild/useCollectionPageChild.js +32 -1
  160. package/dist/cjs/hooks/useCollectionPageChild/useCollectionPageChild.js.map +1 -1
  161. package/dist/cjs/hooks/useLayoutSwitchCollection.js +2 -1
  162. package/dist/cjs/hooks/useLayoutSwitchCollection.js.map +1 -1
  163. package/dist/cjs/hooks/usePickerModal/UsePickerModalParamsBase.js.map +1 -1
  164. package/dist/cjs/index.js.map +1 -1
  165. package/dist/cjs/schema/useLayoutSwitchCollection.js +2 -0
  166. package/dist/cjs/schema/useLayoutSwitchCollection.js.map +1 -1
  167. package/dist/cjs/state/CollectionPage/CollectionPageActionsBar.js +23 -11
  168. package/dist/cjs/state/CollectionPage/CollectionPageActionsBar.js.map +1 -1
  169. package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css +11 -5
  170. package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css.js +6 -3
  171. package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css.js.map +1 -1
  172. package/dist/cjs/state/CollectionPage/MobilePrimaryActionBar.js +25 -0
  173. package/dist/cjs/state/CollectionPage/MobilePrimaryActionBar.js.map +1 -0
  174. package/dist/cjs/state/CollectionPage/MobilePrimaryActionBar.st.css +6 -0
  175. package/dist/cjs/state/CollectionPage/MobilePrimaryActionBar.st.css.js +25 -0
  176. package/dist/cjs/state/CollectionPage/MobilePrimaryActionBar.st.css.js.map +1 -0
  177. package/dist/cjs/state/CollectionPage/TitleBadges.js +8 -7
  178. package/dist/cjs/state/CollectionPage/TitleBadges.js.map +1 -1
  179. package/dist/cjs/state/CollectionPage/TitleBadges.st.css.js +4 -4
  180. package/dist/cjs/state/CollectionPage/TitleBadges.st.css.js.map +1 -1
  181. package/dist/cjs/state/CollectionPage/useCollectionPageHeader.js +59 -21
  182. package/dist/cjs/state/CollectionPage/useCollectionPageHeader.js.map +1 -1
  183. package/dist/cjs/state/EditableTable/CellInteractionState.js +19 -2
  184. package/dist/cjs/state/EditableTable/CellInteractionState.js.map +1 -1
  185. package/dist/cjs/state/EditableTable/CellValueState.js +19 -1
  186. package/dist/cjs/state/EditableTable/CellValueState.js.map +1 -1
  187. package/dist/cjs/state/EditableTable/ClipboardState.js +37 -6
  188. package/dist/cjs/state/EditableTable/ClipboardState.js.map +1 -1
  189. package/dist/cjs/state/EditableTable/EditableTableState.js +14 -2
  190. package/dist/cjs/state/EditableTable/EditableTableState.js.map +1 -1
  191. package/dist/cjs/state/EditableTable/EditableTableStateBIReporter.js +17 -3
  192. package/dist/cjs/state/EditableTable/EditableTableStateBIReporter.js.map +1 -1
  193. package/dist/cjs/state/FormPage/FormPageHeader.st.css.js +2 -2
  194. package/dist/cjs/state/FormPage/FormPageHeader.st.css.js.map +1 -1
  195. package/dist/cjs/state/LayoutSwitchState.js +2 -1
  196. package/dist/cjs/state/LayoutSwitchState.js.map +1 -1
  197. package/dist/cjs/state/TableState.js.map +1 -1
  198. package/dist/cjs/state/ViewTypeState.js +6 -2
  199. package/dist/cjs/state/ViewTypeState.js.map +1 -1
  200. package/dist/cjs/styles.global.css +2 -2
  201. package/dist/cjs/version.js +1 -1
  202. package/dist/cjs/version.js.map +1 -1
  203. package/dist/docs/ActionSubItem.md +1 -1
  204. package/dist/docs/Allow Users to Add Extended Fields.md +3 -3
  205. package/dist/docs/BulkSelectState.md +1 -1
  206. package/dist/docs/CMS Collection and Entity Template.md +57 -0
  207. package/dist/docs/Category.md +1 -1
  208. package/dist/docs/Collection Toolkit.md +7 -0
  209. package/dist/docs/Collection and Entity Template.md +59 -0
  210. package/dist/docs/Collection and Read-Only Detail Template.md +47 -0
  211. package/dist/docs/CollectionEmptyState.md +1 -1
  212. package/dist/docs/CollectionErrorState.md +1 -1
  213. package/dist/docs/CollectionNoResultsState.md +1 -1
  214. package/dist/docs/CollectionOptimisticActions.md +2 -2
  215. package/dist/docs/CollectionPage.Content.md +1 -1
  216. package/dist/docs/CollectionPage.Header.md +6 -6
  217. package/dist/docs/CollectionPage.md +2 -2
  218. package/dist/docs/CollectionPremiumEmptyState.md +1 -1
  219. package/dist/docs/CollectionSearch.md +5 -5
  220. package/dist/docs/CollectionState.md +3 -3
  221. package/dist/docs/CollectionToolbar.md +2 -2
  222. package/dist/docs/Component Tests.md +2 -2
  223. package/dist/docs/ComputedQuery.md +1 -1
  224. package/dist/docs/CustomColumns.md +2 -2
  225. package/dist/docs/CustomFieldsViewWidget.md +1 -1
  226. package/dist/docs/CustomFieldsWidget.md +3 -3
  227. package/dist/docs/Data Extension Overview.md +5 -5
  228. package/dist/docs/DataResultRaw.md +1 -1
  229. package/dist/docs/Display Extended Fields.md +4 -4
  230. package/dist/docs/Enable Filters for Extended Fields.md +3 -3
  231. package/dist/docs/EntityPage.AdditionalContent.md +2 -2
  232. package/dist/docs/EntityPage.Card.md +1 -1
  233. package/dist/docs/EntityPage.Content.md +2 -2
  234. package/dist/docs/EntityPage.Header.md +2 -2
  235. package/dist/docs/EntityPage.MainContent.md +2 -2
  236. package/dist/docs/EntityPage.Slots.md +1 -1
  237. package/dist/docs/EntityPage.md +8 -8
  238. package/dist/docs/EntityPageState.md +2 -2
  239. package/dist/docs/Explore Apps.md +1 -1
  240. package/dist/docs/ExportTo.md +2 -2
  241. package/dist/docs/Filter Overview.md +23 -23
  242. package/dist/docs/FilterProps.md +1 -1
  243. package/dist/docs/FormPageState.md +1 -1
  244. package/dist/docs/Grid Sections.md +4 -4
  245. package/dist/docs/Grid.md +4 -4
  246. package/dist/docs/GridDragAndDrop.md +3 -3
  247. package/dist/docs/GridFolders.md +1 -1
  248. package/dist/docs/GridFoldersSection.md +1 -1
  249. package/dist/docs/GridFoldersState.md +2 -2
  250. package/dist/docs/GridSectionsProp.md +3 -3
  251. package/dist/docs/GridState.md +2 -2
  252. package/dist/docs/InMemoryBackend.md +3 -3
  253. package/dist/docs/More Actions.md +5 -5
  254. package/dist/docs/MoreActionsItem.md +2 -2
  255. package/dist/docs/MultiAutoInlineCheckboxFilter.md +1 -1
  256. package/dist/docs/MultiBulkActionToolbar.md +1 -1
  257. package/dist/docs/MultiLevelSorting.md +3 -3
  258. package/dist/docs/MultiSelectCheckboxFilter.md +2 -2
  259. package/dist/docs/MultiSelectCollectionFilter.md +1 -1
  260. package/dist/docs/NestedTable.md +19 -19
  261. package/dist/docs/NestedTableLevel.md +3 -3
  262. package/dist/docs/NestedTableNodeState.md +3 -3
  263. package/dist/docs/NestedTableState.md +4 -4
  264. package/dist/docs/Page Templates.md +47 -0
  265. package/dist/docs/PageWrapper.md +1 -1
  266. package/dist/docs/PickerContent.md +7 -7
  267. package/dist/docs/PickerModal.md +4 -4
  268. package/dist/docs/PickerStandalone.md +2 -2
  269. package/dist/docs/PrimaryPageButton.md +1 -1
  270. package/dist/docs/RadioGroupFilter.md +1 -1
  271. package/dist/docs/Reading the Doc Indices.md +22 -5
  272. package/dist/docs/Settings Page Template.md +41 -0
  273. package/dist/docs/SettingsPage.AdditionalContent.md +2 -2
  274. package/dist/docs/SettingsPage.Card.md +1 -1
  275. package/dist/docs/SettingsPage.Content.md +2 -2
  276. package/dist/docs/SettingsPage.Header.md +2 -2
  277. package/dist/docs/SettingsPage.MainContent.md +2 -2
  278. package/dist/docs/SettingsPage.md +4 -4
  279. package/dist/docs/SettingsPageState.md +1 -1
  280. package/dist/docs/SingleSelectFilter.md +2 -2
  281. package/dist/docs/Sortable Columns.md +4 -4
  282. package/dist/docs/SummaryBar.md +1 -1
  283. package/dist/docs/Table Sections.md +4 -4
  284. package/dist/docs/Table.md +4 -4
  285. package/dist/docs/TableColumn.md +3 -3
  286. package/dist/docs/TableDragAndDrop.md +3 -3
  287. package/dist/docs/TableFolders.md +1 -1
  288. package/dist/docs/TableFoldersState.md +2 -2
  289. package/dist/docs/TableGridSwitch.md +4 -4
  290. package/dist/docs/TableGridSwitchDragAndDrop.md +3 -3
  291. package/dist/docs/TableGridSwitchFolders.md +20 -20
  292. package/dist/docs/TableGridSwitchFoldersState.md +5 -5
  293. package/dist/docs/TableGridSwitchState.md +2 -2
  294. package/dist/docs/TableSectionsProp.md +3 -3
  295. package/dist/docs/TableState.md +2 -2
  296. package/dist/docs/TableTopNotification.md +2 -2
  297. package/dist/docs/TabsFilter.md +1 -1
  298. package/dist/docs/Tags Overview.md +1 -1
  299. package/dist/docs/Tags.md +3 -3
  300. package/dist/docs/TagsWidget.md +3 -3
  301. package/dist/docs/ToolbarCollectionState.md +1 -1
  302. package/dist/docs/ToolbarFilters.md +1 -1
  303. package/dist/docs/ToolbarSecondaryActions.md +1 -1
  304. package/dist/docs/View.md +1 -1
  305. package/dist/docs/Views.md +1 -1
  306. package/dist/docs/WidgetsFormProvider.md +3 -3
  307. package/dist/docs/WixPatternsEssentialsProvider.md +1 -1
  308. package/dist/docs/WixPatternsProvider.md +3 -3
  309. package/dist/docs/arrayFilter.md +2 -2
  310. package/dist/docs/bulkActionModal.md +2 -2
  311. package/dist/docs/createNestedTableLevel.md +3 -3
  312. package/dist/docs/createNestedTableSingleEntityLevels.md +1 -1
  313. package/dist/docs/customFilter.md +2 -2
  314. package/dist/docs/dateRangeFilter.Factories.md +1 -1
  315. package/dist/docs/index.json +120 -0
  316. package/dist/docs/useAmbassadorCollection.md +2 -2
  317. package/dist/docs/useCollection.md +2 -2
  318. package/dist/docs/useCreateCollection.md +1 -1
  319. package/dist/docs/useCreateNestedOptimisticActions.md +5 -5
  320. package/dist/docs/useEntity.md +2 -2
  321. package/dist/docs/useEntityPage.md +3 -3
  322. package/dist/docs/useEntityPageContext.md +2 -2
  323. package/dist/docs/useGridCollection.md +2 -2
  324. package/dist/docs/useGridFolders.md +2 -2
  325. package/dist/docs/useNestedTable.md +5 -5
  326. package/dist/docs/useOptimisticActions.md +2 -2
  327. package/dist/docs/usePatternsNavigate.md +1 -1
  328. package/dist/docs/usePickerContent.md +2 -2
  329. package/dist/docs/usePickerModal.md +1 -1
  330. package/dist/docs/usePickerStandalone.md +2 -2
  331. package/dist/docs/useSettingsPage.md +2 -2
  332. package/dist/docs/useSettingsPageContext.md +2 -2
  333. package/dist/docs/useStaticListFilterCollection.md +2 -2
  334. package/dist/docs/useTableCollection.md +1 -1
  335. package/dist/docs/useTableFolders.md +2 -2
  336. package/dist/docs/useTableGridSwitchCollection.md +2 -2
  337. package/dist/docs/useTableGridSwitchFolders.md +4 -4
  338. package/dist/docs/useWidgetsFormContext.md +2 -2
  339. package/dist/dts-bundle/components/CollectionPage.d.ts +5 -5
  340. package/dist/dts-bundle/components/Grid.d.ts +1 -1
  341. package/dist/dts-bundle/components/LayoutSwitch.d.ts +1 -1
  342. package/dist/dts-bundle/components/TableGridSwitch.d.ts +1 -1
  343. package/dist/dts-bundle/components/schema/Grid.d.ts +1 -1
  344. package/dist/dts-bundle/hooks/useLayoutSwitchCollection.d.ts +7 -0
  345. package/dist/dts-bundle/hooks/usePickerModal.d.ts +1 -1
  346. package/dist/dts-bundle/index.json +46 -46
  347. package/dist/dts-bundle/index.txt +12 -12
  348. package/dist/dts-bundle/types/SchemaSource.d.ts +5 -1
  349. package/dist/dts-bundle/types/SchemaSourceInput.d.ts +5 -1
  350. package/dist/dts-bundle/types/TableState.d.ts +1 -1
  351. package/dist/dts-bundle/types/ToolbarCollectionBaseProps.d.ts +6 -6
  352. package/dist/dts-bundle/types/UseCmsSchemaSourceDeps.d.ts +5 -1
  353. package/dist/esm/components/CardContainer/CardContainer.st.css.js +2 -2
  354. package/dist/esm/components/CmsFieldManagement/CmsFieldForm.st.css.js +2 -2
  355. package/dist/esm/components/CmsFieldManagement/CmsFieldModal.st.css.js +2 -2
  356. package/dist/esm/components/CmsFieldManagement/CmsFieldModal.st.css.js.map +1 -1
  357. package/dist/esm/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js +2 -2
  358. package/dist/esm/components/Collapse/Collapse.st.css.js +2 -2
  359. package/dist/esm/components/CollectionPageNew/CollectionPage.st.css +9 -3
  360. package/dist/esm/components/CollectionPageNew/CollectionPage.st.css.js +2 -2
  361. package/dist/esm/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js +2 -2
  362. package/dist/esm/components/CollectionTable/CollectionTable.st.css.js +2 -2
  363. package/dist/esm/components/CollectionTable/CollectionTableWSRTable.st.css.js +2 -2
  364. package/dist/esm/components/CollectionToolbar/CollectionToolbar.st.css.js +2 -2
  365. package/dist/esm/components/CollectionToolbar/CollectionToolbar.st.css.js.map +1 -1
  366. package/dist/esm/components/CollectionToolbar/SearchOrCustomFilter.st.css.js +2 -2
  367. package/dist/esm/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js +2 -2
  368. package/dist/esm/components/CollectionViewsDropdown/ViewsDropdown.st.css.js +2 -2
  369. package/dist/esm/components/CustomFieldModal/CustomFieldForm.js +2 -2
  370. package/dist/esm/components/CustomFieldModal/CustomFieldForm.js.map +1 -1
  371. package/dist/esm/components/CustomFieldModal/CustomFieldFormPiiFields.st.css.js +2 -2
  372. package/dist/esm/components/CustomFieldModal/CustomFieldFormPiiFields.st.css.js.map +1 -1
  373. package/dist/esm/components/CustomFieldModal/CustomFieldTypeDropdown.js +10 -2
  374. package/dist/esm/components/CustomFieldModal/CustomFieldTypeDropdown.js.map +1 -1
  375. package/dist/esm/components/DragHandle/DragHandle.st.css.js +2 -2
  376. package/dist/esm/components/DragHandle/DragHandle.st.css.js.map +1 -1
  377. package/dist/esm/components/EditableTable/EditableCell.js +7 -1
  378. package/dist/esm/components/EditableTable/EditableCell.js.map +1 -1
  379. package/dist/esm/components/EditableTable/EditableCell.st.css.js +2 -2
  380. package/dist/esm/components/EditableTable/EditableCell.st.css.js.map +1 -1
  381. package/dist/esm/components/EditableTable/EditableTable.js +9 -2
  382. package/dist/esm/components/EditableTable/EditableTable.js.map +1 -1
  383. package/dist/esm/components/EditableTable/EditableTableContextMenu.js +4 -4
  384. package/dist/esm/components/EditableTable/EditableTableContextMenu.js.map +1 -1
  385. package/dist/esm/components/EditableTable/HeaderActionsPopover.st.css.js +2 -2
  386. package/dist/esm/components/EditableTable/HeaderFieldActions.js +9 -2
  387. package/dist/esm/components/EditableTable/HeaderFieldActions.js.map +1 -1
  388. package/dist/esm/components/EditableTable/cellTypes/CellViewLayout.st.css.js +2 -2
  389. package/dist/esm/components/EditableTable/cellTypes/CellViewLayout.st.css.js.map +1 -1
  390. package/dist/esm/components/EditableTable/cellTypes/address/Edit.st.css.js +2 -2
  391. package/dist/esm/components/EditableTable/cellTypes/array/Edit.st.css.js +2 -2
  392. package/dist/esm/components/EditableTable/cellTypes/array/Edit.st.css.js.map +1 -1
  393. package/dist/esm/components/EditableTable/cellTypes/boolean/Edit.st.css.js +2 -2
  394. package/dist/esm/components/EditableTable/cellTypes/boolean/View.st.css.js +2 -2
  395. package/dist/esm/components/EditableTable/cellTypes/boolean/View.st.css.js.map +1 -1
  396. package/dist/esm/components/EditableTable/cellTypes/color/Edit.st.css.js +2 -2
  397. package/dist/esm/components/EditableTable/cellTypes/date/Edit.st.css.js +2 -2
  398. package/dist/esm/components/EditableTable/cellTypes/date/Edit.st.css.js.map +1 -1
  399. package/dist/esm/components/EditableTable/cellTypes/date/View.st.css.js +2 -2
  400. package/dist/esm/components/EditableTable/cellTypes/datetime/Edit.st.css.js +2 -2
  401. package/dist/esm/components/EditableTable/cellTypes/datetime/View.st.css.js +2 -2
  402. package/dist/esm/components/EditableTable/cellTypes/datetime/View.st.css.js.map +1 -1
  403. package/dist/esm/components/EditableTable/cellTypes/email/Edit.st.css.js +2 -2
  404. package/dist/esm/components/EditableTable/cellTypes/email/Edit.st.css.js.map +1 -1
  405. package/dist/esm/components/EditableTable/cellTypes/email/View.st.css.js +2 -2
  406. package/dist/esm/components/EditableTable/cellTypes/email/View.st.css.js.map +1 -1
  407. package/dist/esm/components/EditableTable/cellTypes/number/Edit.st.css.js +2 -2
  408. package/dist/esm/components/EditableTable/cellTypes/number/Edit.st.css.js.map +1 -1
  409. package/dist/esm/components/EditableTable/cellTypes/number/View.st.css.js +2 -2
  410. package/dist/esm/components/EditableTable/cellTypes/object/Edit.st.css.js +2 -2
  411. package/dist/esm/components/EditableTable/cellTypes/object/Edit.st.css.js.map +1 -1
  412. package/dist/esm/components/EditableTable/cellTypes/object/View.st.css.js +2 -2
  413. package/dist/esm/components/EditableTable/cellTypes/object/View.st.css.js.map +1 -1
  414. package/dist/esm/components/EditableTable/cellTypes/select/Edit.st.css.js +2 -2
  415. package/dist/esm/components/EditableTable/cellTypes/text/Edit.st.css.js +2 -2
  416. package/dist/esm/components/EditableTable/cellTypes/text/View.st.css.js +2 -2
  417. package/dist/esm/components/EditableTable/cellTypes/time/Edit.st.css.js +2 -2
  418. package/dist/esm/components/EditableTable/cellTypes/time/Edit.st.css.js.map +1 -1
  419. package/dist/esm/components/EditableTable/cellTypes/url/Edit.st.css.js +2 -2
  420. package/dist/esm/components/EditableTable/cellTypes/url/Edit.st.css.js.map +1 -1
  421. package/dist/esm/components/EditableTable/cellTypes/url/View.st.css.js +2 -2
  422. package/dist/esm/components/EditableTable/cellTypes/url/View.st.css.js.map +1 -1
  423. package/dist/esm/components/EditableTable/useEditableTableContextMenu.js +12 -1
  424. package/dist/esm/components/EditableTable/useEditableTableContextMenu.js.map +1 -1
  425. package/dist/esm/components/EmptyState/EmptyStateBase.st.css.js +2 -2
  426. package/dist/esm/components/EmptyState/EmptyStateBase.st.css.js.map +1 -1
  427. package/dist/esm/components/EntityPage/EntityPagePlain.st.css.js +2 -2
  428. package/dist/esm/components/Fade/Fade.st.css.js +2 -2
  429. package/dist/esm/components/Fade/Fade.st.css.js.map +1 -1
  430. package/dist/esm/components/FieldActions/HeaderActionsPopover.js +13 -2
  431. package/dist/esm/components/FieldActions/HeaderActionsPopover.js.map +1 -1
  432. package/dist/esm/components/Heading/Heading.st.css.js +2 -2
  433. package/dist/esm/components/ImportButton/ImportStepUpload.st.css.js +2 -2
  434. package/dist/esm/components/InputOverflow/InputOverflow.st.css.js +2 -2
  435. package/dist/esm/components/InputOverflow/InputOverflow.st.css.js.map +1 -1
  436. package/dist/esm/components/LoadingRow/LoadingRow.st.css.js +3 -3
  437. package/dist/esm/components/MaxHeightText/MaxHeightText.st.css.js +2 -2
  438. package/dist/esm/components/MaxHeightText/MaxHeightText.st.css.js.map +1 -1
  439. package/dist/esm/components/MaxLines/MaxLines.st.css.js +2 -2
  440. package/dist/esm/components/MoreActions/MoreActionsIcon.js +5 -4
  441. package/dist/esm/components/MoreActions/MoreActionsIcon.js.map +1 -1
  442. package/dist/esm/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js +2 -2
  443. package/dist/esm/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js.map +1 -1
  444. package/dist/esm/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js +2 -2
  445. package/dist/esm/components/NestedTable/NestedTableRow.st.css.js +2 -2
  446. package/dist/esm/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js +2 -2
  447. package/dist/esm/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js +2 -2
  448. package/dist/esm/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js.map +1 -1
  449. package/dist/esm/components/PageSubTitle/PageSubTitle.js +9 -7
  450. package/dist/esm/components/PageSubTitle/PageSubTitle.js.map +1 -1
  451. package/dist/esm/components/PickerContent/PickerContent.st.css.js +2 -2
  452. package/dist/esm/components/PickerContent/PickerContent.st.css.js.map +1 -1
  453. package/dist/esm/components/PickerContent/PickerContentAdditionalStep.st.css.js +2 -2
  454. package/dist/esm/components/PickerContent/PickerContentAdditionalStep.st.css.js.map +1 -1
  455. package/dist/esm/components/PickerTableListItem/PickerTableListItem.st.css.js +2 -2
  456. package/dist/esm/components/PickerTableListItem/PickerTableListItem.st.css.js.map +1 -1
  457. package/dist/esm/components/PrimaryActions/PrimaryActions.js +1 -1
  458. package/dist/esm/components/PrimaryActions/PrimaryActions.js.map +1 -1
  459. package/dist/esm/components/ScrollableContent/ScrollableContent.st.css.js +2 -2
  460. package/dist/esm/components/SetupWidget/SetupWidget.st.css.js +2 -2
  461. package/dist/esm/components/SkeletonCard/SkeletonCard.st.css.js +2 -2
  462. package/dist/esm/components/SlidingModal/SlidingModal.st.css.js +2 -2
  463. package/dist/esm/components/Table/AddFieldColumnHeader.st.css.js +2 -2
  464. package/dist/esm/components/TabsFilter/TabsFilter.st.css.js +2 -2
  465. package/dist/esm/components/TabsFilter/TabsFilter.st.css.js.map +1 -1
  466. package/dist/esm/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js +2 -2
  467. package/dist/esm/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js.map +1 -1
  468. package/dist/esm/components/ToolbarItem/ToolbarItem.st.css.js +2 -2
  469. package/dist/esm/components/ToolbarItem/ToolbarItem.st.css.js.map +1 -1
  470. package/dist/esm/components/ToolbarItemBox/ToolbarItemBox.st.css.js +2 -2
  471. package/dist/esm/components/common.st.css.js +2 -2
  472. package/dist/esm/hooks/useCollectionPageChild/useCollectionPageChild.js +17 -1
  473. package/dist/esm/hooks/useCollectionPageChild/useCollectionPageChild.js.map +1 -1
  474. package/dist/esm/hooks/useLayoutSwitchCollection.js +1 -0
  475. package/dist/esm/hooks/useLayoutSwitchCollection.js.map +1 -1
  476. package/dist/esm/index.js.map +1 -1
  477. package/dist/esm/schema/useLayoutSwitchCollection.js +2 -1
  478. package/dist/esm/schema/useLayoutSwitchCollection.js.map +1 -1
  479. package/dist/esm/state/CollectionPage/CollectionPageActionsBar.js +4 -1
  480. package/dist/esm/state/CollectionPage/CollectionPageActionsBar.js.map +1 -1
  481. package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css +11 -5
  482. package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css.js +3 -3
  483. package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css.js.map +1 -1
  484. package/dist/esm/state/CollectionPage/MobilePrimaryActionBar.js +7 -0
  485. package/dist/esm/state/CollectionPage/MobilePrimaryActionBar.js.map +1 -0
  486. package/dist/esm/state/CollectionPage/MobilePrimaryActionBar.st.css +6 -0
  487. package/dist/esm/state/CollectionPage/MobilePrimaryActionBar.st.css.js +15 -0
  488. package/dist/esm/state/CollectionPage/MobilePrimaryActionBar.st.css.js.map +1 -0
  489. package/dist/esm/state/CollectionPage/TitleBadges.js +2 -2
  490. package/dist/esm/state/CollectionPage/TitleBadges.js.map +1 -1
  491. package/dist/esm/state/CollectionPage/TitleBadges.st.css.js +2 -2
  492. package/dist/esm/state/CollectionPage/TitleBadges.st.css.js.map +1 -1
  493. package/dist/esm/state/CollectionPage/useCollectionPageHeader.js +32 -8
  494. package/dist/esm/state/CollectionPage/useCollectionPageHeader.js.map +1 -1
  495. package/dist/esm/state/EditableTable/CellInteractionState.js +13 -2
  496. package/dist/esm/state/EditableTable/CellInteractionState.js.map +1 -1
  497. package/dist/esm/state/EditableTable/CellValueState.js +7 -1
  498. package/dist/esm/state/EditableTable/CellValueState.js.map +1 -1
  499. package/dist/esm/state/EditableTable/ClipboardState.js +33 -6
  500. package/dist/esm/state/EditableTable/ClipboardState.js.map +1 -1
  501. package/dist/esm/state/EditableTable/EditableTableState.js +15 -3
  502. package/dist/esm/state/EditableTable/EditableTableState.js.map +1 -1
  503. package/dist/esm/state/EditableTable/EditableTableStateBIReporter.js +19 -3
  504. package/dist/esm/state/EditableTable/EditableTableStateBIReporter.js.map +1 -1
  505. package/dist/esm/state/FormPage/FormPageHeader.st.css.js +2 -2
  506. package/dist/esm/state/LayoutSwitchState.js +1 -0
  507. package/dist/esm/state/LayoutSwitchState.js.map +1 -1
  508. package/dist/esm/state/ViewTypeState.js +9 -2
  509. package/dist/esm/state/ViewTypeState.js.map +1 -1
  510. package/dist/esm/styles.global.css +2 -2
  511. package/dist/esm/version.js +1 -1
  512. package/dist/templates/cms-collection-entity/ItemEntityPage.tsx +47 -0
  513. package/dist/templates/cms-collection-entity/ItemsApp.tsx +28 -0
  514. package/dist/templates/cms-collection-entity/ItemsCollectionPage.tsx +56 -0
  515. package/dist/templates/cms-collection-entity/collection.ts +9 -0
  516. package/dist/templates/cms-collection-entity/page.tsx +32 -0
  517. package/dist/templates/collection-detail/ItemDetailPage.tsx +44 -0
  518. package/dist/templates/collection-detail/ItemsApp.tsx +26 -0
  519. package/dist/templates/collection-detail/ItemsCollectionPage.tsx +111 -0
  520. package/dist/templates/collection-detail/items-api.ts +66 -0
  521. package/dist/templates/collection-detail/page.tsx +32 -0
  522. package/dist/templates/collection-entity/ItemEntityPage.tsx +73 -0
  523. package/dist/templates/collection-entity/ItemsApp.tsx +30 -0
  524. package/dist/templates/collection-entity/ItemsCollectionPage.tsx +120 -0
  525. package/dist/templates/collection-entity/items-api.ts +66 -0
  526. package/dist/templates/collection-entity/page.tsx +32 -0
  527. package/dist/templates/settings-page/SettingsPageView.tsx +78 -0
  528. package/dist/templates/settings-page/page.tsx +18 -0
  529. package/dist/templates/settings-page/settings-api.ts +17 -0
  530. package/dist/types/components/CmsFieldManagement/CmsFieldModal.st.css.d.ts.map +1 -1
  531. package/dist/types/components/CollectionPageHeaderNew/CollectionPageHeader.d.ts +5 -5
  532. package/dist/types/components/CollectionToolbar/CollectionToolbar.st.css.d.ts.map +1 -1
  533. package/dist/types/components/CustomFieldModal/CustomFieldForm.d.ts.map +1 -1
  534. package/dist/types/components/CustomFieldModal/CustomFieldFormPiiFields.st.css.d.ts.map +1 -1
  535. package/dist/types/components/CustomFieldModal/CustomFieldTypeDropdown.d.ts.map +1 -1
  536. package/dist/types/components/DragHandle/DragHandle.st.css.d.ts.map +1 -1
  537. package/dist/types/components/EditableTable/EditableCell.d.ts.map +1 -1
  538. package/dist/types/components/EditableTable/EditableCell.st.css.d.ts.map +1 -1
  539. package/dist/types/components/EditableTable/EditableTable.d.ts.map +1 -1
  540. package/dist/types/components/EditableTable/HeaderFieldActions.d.ts.map +1 -1
  541. package/dist/types/components/EditableTable/cellTypes/CellViewLayout.st.css.d.ts.map +1 -1
  542. package/dist/types/components/EditableTable/cellTypes/array/Edit.st.css.d.ts.map +1 -1
  543. package/dist/types/components/EditableTable/cellTypes/boolean/View.st.css.d.ts.map +1 -1
  544. package/dist/types/components/EditableTable/cellTypes/date/Edit.st.css.d.ts.map +1 -1
  545. package/dist/types/components/EditableTable/cellTypes/datetime/View.st.css.d.ts.map +1 -1
  546. package/dist/types/components/EditableTable/cellTypes/email/Edit.st.css.d.ts.map +1 -1
  547. package/dist/types/components/EditableTable/cellTypes/email/View.st.css.d.ts.map +1 -1
  548. package/dist/types/components/EditableTable/cellTypes/number/Edit.st.css.d.ts.map +1 -1
  549. package/dist/types/components/EditableTable/cellTypes/object/Edit.st.css.d.ts.map +1 -1
  550. package/dist/types/components/EditableTable/cellTypes/object/View.st.css.d.ts.map +1 -1
  551. package/dist/types/components/EditableTable/cellTypes/time/Edit.st.css.d.ts.map +1 -1
  552. package/dist/types/components/EditableTable/cellTypes/url/Edit.st.css.d.ts.map +1 -1
  553. package/dist/types/components/EditableTable/cellTypes/url/View.st.css.d.ts.map +1 -1
  554. package/dist/types/components/EditableTable/useEditableTableContextMenu.d.ts +1 -1
  555. package/dist/types/components/EditableTable/useEditableTableContextMenu.d.ts.map +1 -1
  556. package/dist/types/components/EmptyState/EmptyStateBase.st.css.d.ts.map +1 -1
  557. package/dist/types/components/Fade/Fade.st.css.d.ts.map +1 -1
  558. package/dist/types/components/FieldActions/HeaderActionsPopover.d.ts +2 -1
  559. package/dist/types/components/FieldActions/HeaderActionsPopover.d.ts.map +1 -1
  560. package/dist/types/components/Grid/Grid.d.ts +1 -1
  561. package/dist/types/components/InputOverflow/InputOverflow.st.css.d.ts.map +1 -1
  562. package/dist/types/components/MaxHeightText/MaxHeightText.st.css.d.ts.map +1 -1
  563. package/dist/types/components/MoreActions/MoreActionsIcon.d.ts.map +1 -1
  564. package/dist/types/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.d.ts.map +1 -1
  565. package/dist/types/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.d.ts.map +1 -1
  566. package/dist/types/components/PageSubTitle/PageSubTitle.d.ts.map +1 -1
  567. package/dist/types/components/PickerContent/PickerContent.st.css.d.ts.map +1 -1
  568. package/dist/types/components/PickerContent/PickerContentAdditionalStep.st.css.d.ts.map +1 -1
  569. package/dist/types/components/PickerTableListItem/PickerTableListItem.st.css.d.ts.map +1 -1
  570. package/dist/types/components/PrimaryActions/PrimaryActions.d.ts.map +1 -1
  571. package/dist/types/components/TabsFilter/TabsFilter.st.css.d.ts.map +1 -1
  572. package/dist/types/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.d.ts.map +1 -1
  573. package/dist/types/components/ToolbarCollection/ToolbarCollection.d.ts +6 -6
  574. package/dist/types/components/ToolbarItem/ToolbarItem.st.css.d.ts.map +1 -1
  575. package/dist/types/hooks/useCollectionPageChild/useCollectionPageChild.d.ts.map +1 -1
  576. package/dist/types/hooks/useLayoutSwitchCollection.d.ts +6 -0
  577. package/dist/types/hooks/useLayoutSwitchCollection.d.ts.map +1 -1
  578. package/dist/types/hooks/usePickerModal/UsePickerModalParamsBase.d.ts +1 -1
  579. package/dist/types/index.d.ts +1 -0
  580. package/dist/types/index.d.ts.map +1 -1
  581. package/dist/types/schema/useLayoutSwitchCollection.d.ts +6 -0
  582. package/dist/types/schema/useLayoutSwitchCollection.d.ts.map +1 -1
  583. package/dist/types/state/CollectionPage/CollectionPageActionsBar.d.ts.map +1 -1
  584. package/dist/types/state/CollectionPage/CollectionPageHeader.st.css.d.ts +4 -1
  585. package/dist/types/state/CollectionPage/CollectionPageHeader.st.css.d.ts.map +1 -1
  586. package/dist/types/state/CollectionPage/MobilePrimaryActionBar.d.ts +5 -0
  587. package/dist/types/state/CollectionPage/MobilePrimaryActionBar.d.ts.map +1 -0
  588. package/dist/types/state/CollectionPage/MobilePrimaryActionBar.st.css.d.ts +16 -0
  589. package/dist/types/state/CollectionPage/MobilePrimaryActionBar.st.css.d.ts.map +1 -0
  590. package/dist/types/state/CollectionPage/TitleBadges.d.ts +3 -1
  591. package/dist/types/state/CollectionPage/TitleBadges.d.ts.map +1 -1
  592. package/dist/types/state/CollectionPage/TitleBadges.st.css.d.ts.map +1 -1
  593. package/dist/types/state/CollectionPage/useCollectionPageHeader.d.ts.map +1 -1
  594. package/dist/types/state/EditableTable/CellInteractionState.d.ts.map +1 -1
  595. package/dist/types/state/EditableTable/CellValueState.d.ts +3 -2
  596. package/dist/types/state/EditableTable/CellValueState.d.ts.map +1 -1
  597. package/dist/types/state/EditableTable/ClipboardState.d.ts +5 -3
  598. package/dist/types/state/EditableTable/ClipboardState.d.ts.map +1 -1
  599. package/dist/types/state/EditableTable/EditableTableState.d.ts +2 -2
  600. package/dist/types/state/EditableTable/EditableTableState.d.ts.map +1 -1
  601. package/dist/types/state/EditableTable/EditableTableStateBIReporter.d.ts +9 -2
  602. package/dist/types/state/EditableTable/EditableTableStateBIReporter.d.ts.map +1 -1
  603. package/dist/types/state/LayoutSwitchState.d.ts +3 -0
  604. package/dist/types/state/LayoutSwitchState.d.ts.map +1 -1
  605. package/dist/types/state/TableState.d.ts +1 -1
  606. package/dist/types/state/ViewTypeState.d.ts +2 -0
  607. package/dist/types/state/ViewTypeState.d.ts.map +1 -1
  608. package/dist/types/version.d.ts +1 -1
  609. package/package.json +11 -8
  610. package/src/components/CardContainer/CardContainer.st.css.ts +2 -2
  611. package/src/components/CmsFieldManagement/CmsFieldForm.st.css.ts +2 -2
  612. package/src/components/CmsFieldManagement/CmsFieldModal.st.css.ts +2 -2
  613. package/src/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.ts +2 -2
  614. package/src/components/Collapse/Collapse.st.css.ts +2 -2
  615. package/src/components/CollectionPageHeaderNew/CollectionPageHeader.tsx +5 -5
  616. package/src/components/CollectionPageNew/CollectionPage.st.css +9 -3
  617. package/src/components/CollectionPageNew/CollectionPage.st.css.ts +2 -2
  618. package/src/components/CollectionSectionHeader/CollectionSectionHeader.st.css.ts +2 -2
  619. package/src/components/CollectionTable/CollectionTable.st.css.ts +2 -2
  620. package/src/components/CollectionTable/CollectionTableWSRTable.st.css.ts +2 -2
  621. package/src/components/CollectionToolbar/CollectionToolbar.st.css.ts +2 -2
  622. package/src/components/CollectionToolbar/SearchOrCustomFilter.st.css.ts +2 -2
  623. package/src/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.ts +2 -2
  624. package/src/components/CollectionViewsDropdown/ViewsDropdown.st.css.ts +2 -2
  625. package/src/components/CustomFieldModal/CustomFieldForm.tsx +11 -9
  626. package/src/components/CustomFieldModal/CustomFieldFormPiiFields.st.css.ts +2 -2
  627. package/src/components/CustomFieldModal/CustomFieldTypeDropdown.tsx +12 -1
  628. package/src/components/DragHandle/DragHandle.st.css.ts +2 -2
  629. package/src/components/EditableTable/EditableCell.st.css.ts +2 -2
  630. package/src/components/EditableTable/EditableCell.tsx +7 -1
  631. package/src/components/EditableTable/EditableTable.tsx +16 -2
  632. package/src/components/EditableTable/EditableTableContextMenu.tsx +4 -4
  633. package/src/components/EditableTable/HeaderActionsPopover.st.css.ts +2 -2
  634. package/src/components/EditableTable/HeaderFieldActions.tsx +13 -1
  635. package/src/components/EditableTable/cellTypes/CellViewLayout.st.css.ts +2 -2
  636. package/src/components/EditableTable/cellTypes/address/Edit.st.css.ts +2 -2
  637. package/src/components/EditableTable/cellTypes/array/Edit.st.css.ts +2 -2
  638. package/src/components/EditableTable/cellTypes/boolean/Edit.st.css.ts +2 -2
  639. package/src/components/EditableTable/cellTypes/boolean/View.st.css.ts +2 -2
  640. package/src/components/EditableTable/cellTypes/color/Edit.st.css.ts +2 -2
  641. package/src/components/EditableTable/cellTypes/date/Edit.st.css.ts +2 -2
  642. package/src/components/EditableTable/cellTypes/date/View.st.css.ts +2 -2
  643. package/src/components/EditableTable/cellTypes/datetime/Edit.st.css.ts +2 -2
  644. package/src/components/EditableTable/cellTypes/datetime/View.st.css.ts +2 -2
  645. package/src/components/EditableTable/cellTypes/email/Edit.st.css.ts +2 -2
  646. package/src/components/EditableTable/cellTypes/email/View.st.css.ts +2 -2
  647. package/src/components/EditableTable/cellTypes/number/Edit.st.css.ts +2 -2
  648. package/src/components/EditableTable/cellTypes/number/View.st.css.ts +2 -2
  649. package/src/components/EditableTable/cellTypes/object/Edit.st.css.ts +2 -2
  650. package/src/components/EditableTable/cellTypes/object/View.st.css.ts +2 -2
  651. package/src/components/EditableTable/cellTypes/select/Edit.st.css.ts +2 -2
  652. package/src/components/EditableTable/cellTypes/text/Edit.st.css.ts +2 -2
  653. package/src/components/EditableTable/cellTypes/text/View.st.css.ts +2 -2
  654. package/src/components/EditableTable/cellTypes/time/Edit.st.css.ts +2 -2
  655. package/src/components/EditableTable/cellTypes/url/Edit.st.css.ts +2 -2
  656. package/src/components/EditableTable/cellTypes/url/View.st.css.ts +2 -2
  657. package/src/components/EditableTable/useEditableTableContextMenu.ts +13 -0
  658. package/src/components/EmptyState/EmptyStateBase.st.css.ts +2 -2
  659. package/src/components/EntityPage/EntityPagePlain.st.css.ts +2 -2
  660. package/src/components/Fade/Fade.st.css.ts +2 -2
  661. package/src/components/FieldActions/HeaderActionsPopover.tsx +15 -1
  662. package/src/components/Grid/Grid.tsx +1 -1
  663. package/src/components/Heading/Heading.st.css.ts +2 -2
  664. package/src/components/ImportButton/ImportStepUpload.st.css.ts +2 -2
  665. package/src/components/InputOverflow/InputOverflow.st.css.ts +2 -2
  666. package/src/components/LoadingRow/LoadingRow.st.css.ts +3 -3
  667. package/src/components/MaxHeightText/MaxHeightText.st.css.ts +2 -2
  668. package/src/components/MaxLines/MaxLines.st.css.ts +2 -2
  669. package/src/components/MoreActions/MoreActionsIcon.tsx +27 -13
  670. package/src/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.ts +2 -2
  671. package/src/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.ts +2 -2
  672. package/src/components/NestedTable/NestedTableRow.st.css.ts +2 -2
  673. package/src/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.ts +2 -2
  674. package/src/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.ts +2 -2
  675. package/src/components/PageSubTitle/PageSubTitle.tsx +24 -20
  676. package/src/components/PickerContent/PickerContent.st.css.ts +2 -2
  677. package/src/components/PickerContent/PickerContentAdditionalStep.st.css.ts +2 -2
  678. package/src/components/PickerTableListItem/PickerTableListItem.st.css.ts +2 -2
  679. package/src/components/PrimaryActions/PrimaryActions.tsx +0 -1
  680. package/src/components/ScrollableContent/ScrollableContent.st.css.ts +2 -2
  681. package/src/components/SetupWidget/SetupWidget.st.css.ts +2 -2
  682. package/src/components/SkeletonCard/SkeletonCard.st.css.ts +2 -2
  683. package/src/components/SlidingModal/SlidingModal.st.css.ts +2 -2
  684. package/src/components/Table/AddFieldColumnHeader.st.css.ts +2 -2
  685. package/src/components/TabsFilter/TabsFilter.st.css.ts +2 -2
  686. package/src/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.ts +2 -2
  687. package/src/components/ToolbarCollection/ToolbarCollection.tsx +6 -6
  688. package/src/components/ToolbarItem/ToolbarItem.st.css.ts +2 -2
  689. package/src/components/ToolbarItemBox/ToolbarItemBox.st.css.ts +2 -2
  690. package/src/components/common.st.css.ts +2 -2
  691. package/src/hooks/useCollectionPageChild/useCollectionPageChild.tsx +26 -1
  692. package/src/hooks/useLayoutSwitchCollection.ts +7 -0
  693. package/src/hooks/usePickerModal/UsePickerModalParamsBase.ts +1 -1
  694. package/src/index.ts +1 -0
  695. package/src/schema/useLayoutSwitchCollection.ts +24 -11
  696. package/src/state/CollectionPage/CollectionPageActionsBar.tsx +7 -1
  697. package/src/state/CollectionPage/CollectionPageHeader.st.css +11 -5
  698. package/src/state/CollectionPage/CollectionPageHeader.st.css.ts +3 -3
  699. package/src/state/CollectionPage/MobilePrimaryActionBar.st.css +6 -0
  700. package/src/state/CollectionPage/MobilePrimaryActionBar.st.css.ts +25 -0
  701. package/src/state/CollectionPage/MobilePrimaryActionBar.tsx +15 -0
  702. package/src/state/CollectionPage/TitleBadges.st.css.ts +2 -2
  703. package/src/state/CollectionPage/TitleBadges.tsx +4 -2
  704. package/src/state/CollectionPage/useCollectionPageHeader.tsx +43 -10
  705. package/src/state/EditableTable/CellInteractionState.ts +19 -2
  706. package/src/state/EditableTable/CellValueState.ts +12 -2
  707. package/src/state/EditableTable/ClipboardState.ts +42 -7
  708. package/src/state/EditableTable/EditableTableState.ts +19 -3
  709. package/src/state/EditableTable/EditableTableStateBIReporter.ts +23 -3
  710. package/src/state/FormPage/FormPageHeader.st.css.ts +2 -2
  711. package/src/state/LayoutSwitchState.ts +4 -0
  712. package/src/state/TableState.ts +1 -1
  713. package/src/state/ViewTypeState.ts +12 -2
  714. package/src/styles.global.css +2 -2
  715. package/src/version.ts +1 -1
@@ -22,7 +22,7 @@ The Nested Table component handles hierarchical data with multiple levels of nes
22
22
 
23
23
  ### Supported Features
24
24
  The following collection features are supported also by the Nested Table component:
25
- - [Empty State](./?path=/story/features-display-empty-states--collectionemptystate)
25
+ - [Empty State](CollectionEmptyState.md)
26
26
  - Error State - See `renderError` prop
27
27
  - Loading state
28
28
  - Filters
@@ -39,23 +39,23 @@ The component's initial load logic detects the number of items in the dataset to
39
39
 
40
40
  - **Eager Mode:** When the dataset contains less than 1000 items, all data will be rendered in the expanded mode state by default. Users can immediately see the complete dataset without needing to trigger any additional requests to the server.
41
41
  - **Lazy Mode:** If the dataset contains more than 1000 items, the Nested Table will render only the first 100 items of the first level in a collapsed state. When the user expands a collapsed item, the component will trigger a query request to the server to retrieve the child items for that specific parent.
42
- > The number 1000 can be configured via [useNestedTable.fetchAllThreshold](./?path=/story/base-components-collections-nestedtable--usenestedtable) option.
42
+ > The number 1000 can be configured via [useNestedTable.fetchAllThreshold](useNestedTable.md) option.
43
43
 
44
44
  #### Supported data types and query endpoints
45
45
 
46
46
  The Nested Table component offers flexibility in handling data retrieval from different APIs, supporting two distinct types of query APIs:
47
47
 
48
48
  - **Single Entity API:** This type of API is designed to retrieve data from all levels of the Nested Table in one request.
49
- Each level will be configured using the same [useNestedTable.levels[].createCollection.collection.fetchData](./?path=/story/base-components-collections-nestedtable--usenestedtable) implementation, simplifying the setup process.
50
- To facilitate this configuration, Wix Patterns provides a helper function called [createNestedTableSingleEntityLevels](./?path=/story/base-components-collections-nestedtable--createnestedtablesingleentitylevels).
49
+ Each level will be configured using the same [useNestedTable.levels[].createCollection.collection.fetchData](useNestedTable.md) implementation, simplifying the setup process.
50
+ To facilitate this configuration, Wix Patterns provides a helper function called [createNestedTableSingleEntityLevels](createNestedTableSingleEntityLevels.md).
51
51
  Developers can use this helper function to define the data-fetching logic for each level of nesting, ensuring consistency and ease of implementation.
52
- See the [Single Entity](./?path=/story/base-components-collections-nestedtable--nestedtable#Single_Entity) example for more details.
52
+ See the [Single Entity](NestedTable.md) example for more details.
53
53
 
54
54
  - **Various Entities API:**
55
55
  In contrast, the Nested Table also supports scenarios where each level requires data retrieval from different query endpoints.
56
56
  This approach allows developers to customize and fine-tune the data retrieval process for individual levels, accommodating diverse data structures and sources.
57
57
  By providing the flexibility to specify relevant query endpoints for each nesting level, developers can tailor the data-fetching behavior to their specific needs.
58
- See the [Various Entities](./?path=/story/base-components-collections-nestedtable--nestedtable#Various_Entities) example for more details.
58
+ See the [Various Entities](NestedTable.md) example for more details.
59
59
 
60
60
  #### Filters
61
61
  Nested table supports filters for each level. The filters are passed to the `fetchData` function for all collections across all levels.
@@ -69,7 +69,7 @@ The server must handle the filters and return the relevant data. When a user app
69
69
 
70
70
  We recommend using a proxy server to coordinate communication between the different entities that each level represents. You can find:
71
71
  * A mock server example in [this repo](https://github.com/wix-private/cairo-backend-examples)
72
- * A client-side implementation in the [Filters example](./?path=/story/base-components-collections-nestedtable--nestedtable#Filters)
72
+ * A client-side implementation in the [Filters example](NestedTable.md)
73
73
 
74
74
  ### Server API Requirements
75
75
 
@@ -77,7 +77,7 @@ In both cases, each level configuration must adhere to the following API require
77
77
 
78
78
  #### All data types must have a property that references its parent (except for the root level)
79
79
 
80
- > Configured via [useNestedTable.levels[].parentKey](./?path=/story/base-components-collections-nestedtable--usenestedtable) option.
80
+ > Configured via [useNestedTable.levels[].parentKey](useNestedTable.md) option.
81
81
 
82
82
  For example:
83
83
 
@@ -110,7 +110,7 @@ interface City {
110
110
 
111
111
  **Important:** In case of single entity API + lazy mode, the value `'null'` will be passed to the `query.filters.parentId` filter - this means that the `fetchData` function must handle this case and return only the root level data.
112
112
 
113
- > Configured via [useNestedTable.levels[].parentFilter](./?path=/story/base-components-collections-nestedtable--usenestedtable) option.
113
+ > Configured via [useNestedTable.levels[].parentFilter](useNestedTable.md) option.
114
114
 
115
115
  For example:
116
116
 
@@ -271,25 +271,25 @@ Example code: read `dist/examples/NestedTable/drag-and-drop.tsx`
271
271
 
272
272
  | Prop | Type | Required | Default | Description |
273
273
  |------|------|----------|---------|-------------|
274
- | `state` | `NestedTableState<C, OptionalFiltersMap>` | Yes | - | A state object created with [`useNestedTable`](./?path=/story/base-components-collections-nestedtable--usenestedtable) |
275
- | `renderError` | `((params: { err: unknown; isOnline: boolean; retry: () => void; }) => ReactElement<any, string \| JSXElementConstructor<any>>)` | No | - | A function that renders when there's an error fetching data from the server.<br> <br> Supported parameters: <br> - `err`: [object] The error thrown by the [`fetchData()`](./?path=/story/common-hooks--usecollection) function. <br> - `isOnline`: [bool] Whether internet connection is available. <br> - `retry`: [func] Retry collection fetch on failed response. Similar to `collection.retryFetch`. @deprecated Use `errorState` instead. |
276
- | `errorState` | `((err: unknown, params: { isOnline: boolean; retry: () => void; }) => ReactElement<any, string \| JSXElementConstructor<any>>)` | No | - | A function that renders when there's an error fetching data from the server.<br> <br> Supported parameters: <br> - `err`: [object] The error thrown by the [`fetchData()`](./?path=/story/common-hooks--usecollection) function. <br> - `isOnline`: [bool] Whether internet connection is available. <br> - `retry`: [func] Retry collection fetch on failed response. Similar to `collection.retryFetch`. |
277
- | `emptyState` | `ReactNode` | No | - | Shown when the collection is empty. Pass either a [`<CollectionEmptyState />`](./?path=/story/features-display-empty-states--collectionemptystate) or [`<CollectionPremiuimEmptyState />`](./?path=/story/features-display-empty-states--collectionpremiumemptystate) component. |
278
- | `noResultsState` | `ReactNode` | No | - | Shown when a search or filter has no results. Accepts a [`CollectionNoResultsState`](./?path=/story/features-display-empty-states--collectionnoresultsstate) component. |
274
+ | `state` | `NestedTableState<C, OptionalFiltersMap>` | Yes | - | A state object created with [`useNestedTable`](useNestedTable.md) |
275
+ | `renderError` | `((params: { err: unknown; isOnline: boolean; retry: () => void; }) => ReactElement<any, string \| JSXElementConstructor<any>>)` | No | - | A function that renders when there's an error fetching data from the server.<br> <br> Supported parameters: <br> - `err`: [object] The error thrown by the [`fetchData()`](useCollection.md) function. <br> - `isOnline`: [bool] Whether internet connection is available. <br> - `retry`: [func] Retry collection fetch on failed response. Similar to `collection.retryFetch`. @deprecated Use `errorState` instead. |
276
+ | `errorState` | `((err: unknown, params: { isOnline: boolean; retry: () => void; }) => ReactElement<any, string \| JSXElementConstructor<any>>)` | No | - | A function that renders when there's an error fetching data from the server.<br> <br> Supported parameters: <br> - `err`: [object] The error thrown by the [`fetchData()`](useCollection.md) function. <br> - `isOnline`: [bool] Whether internet connection is available. <br> - `retry`: [func] Retry collection fetch on failed response. Similar to `collection.retryFetch`. |
277
+ | `emptyState` | `ReactNode` | No | - | Shown when the collection is empty. Pass either a [`<CollectionEmptyState />`](CollectionEmptyState.md) or [`<CollectionPremiuimEmptyState />`](CollectionPremiumEmptyState.md) component. |
278
+ | `noResultsState` | `ReactNode` | No | - | Shown when a search or filter has no results. Accepts a [`CollectionNoResultsState`](CollectionNoResultsState.md) component. |
279
279
  | `horizontalScroll` | `boolean` | No | - | Indicates whether the table should have horizontal scrolling. Defining column widths as percentages is not supported with horizontal scrolling. |
280
280
  | `actionCellWidth` | `string \| number` | No | - | Width of the column containing the `actionCell` component. |
281
281
  | `dragAndDrop` | `{ createDragHandleColumn: null; NestedTableDragAndDropContext: (<C extends string, T, F extends FiltersMap>(props: NestedTableDragAndDropContextProps<C, T, F>) => Element) & { ...; }; ... 5 more ...; DraggableTableRow: NamedExoticComponent<...>; }` | No | - | Adds functionality to allow visitors to reorder items manually. This prop accepts a [Drag and Drop](./?path=/story/features-sort-drag-and-drop--overview) component. |
282
282
  | `internalScroll` | `boolean` | No | - | Indicates whether the table should have an internal scroll (instead of the default page scroll) |
283
- | `topNotification` | `ReactElement<any, string \| JSXElementConstructor<any>>` | No | - | Renders a notification below the header. Accepts a [`TableTopNotification`](./?path=/story/features-display-tabletopnotification--tabletopnotification) component. |
283
+ | `topNotification` | `ReactElement<any, string \| JSXElementConstructor<any>>` | No | - | Renders a notification below the header. Accepts a [`TableTopNotification`](TableTopNotification.md) component. |
284
284
  | `filters` | `CollectionToolbarFiltersElement` | No | - | Adds filters to the toolbar and/or a sliding panel. Accepts a `ToolbarFilters` component, which must have the `panelTitle` prop defined. |
285
- | `summaryBar` | `ReactNode` | No | - | Display a summary bar below the toolbar. Accepts a [`SummaryBar`](./?path=/story/features-display-toolbar--summarybar) component. |
285
+ | `summaryBar` | `ReactNode` | No | - | Display a summary bar below the toolbar. Accepts a [`SummaryBar`](SummaryBar.md) component. |
286
286
  | `tags` | `TagsElement<C, any>` | No | - | Enables tags feature. In this element you can pass the configuration |
287
- | `title` | `ToolbarTitleElement` | No | - | Displays a title at the left of a toolbar. Accepts a [ToolbarTitle](./?path=/story/features-display-toolbar--toolbartitle) component. |
287
+ | `title` | `ToolbarTitleElement` | No | - | Displays a title at the left of a toolbar. Accepts a [ToolbarTitle](ToolbarTitle.md) component. |
288
288
  | `search` | `boolean \| FilterElement \| CollectionSearchElement` | No | `true` | Displays a search input on the right side of the table toolbar.<br> <br> Accepts a boolean or a custom React element as a parameter. When passing `false`, no search input is displayed. |
289
289
  | `showTitleBar` | `boolean` | No | `true` | Indicates whether to show Table Title Bar or not. Note: if you pass `showTitleBar = false` title bar is not removed from the DOM. For better accessibility column titles should be defined as well. |
290
- | `exportButton` | `ReactElement<any, string \| JSXElementConstructor<any>>` | No | - | A [`<ExportButton />`](./?path=/story/features-export--exportto) react element to be added to the toolbar |
290
+ | `exportButton` | `ReactElement<any, string \| JSXElementConstructor<any>>` | No | - | A [`<ExportButton />`](ExportTo.md) react element to be added to the toolbar |
291
291
  | `importButton` | `ReactElement<any, string \| JSXElementConstructor<any>>` | No | - | A [`<ImportButton />`] react element to be added to the toolbar. |
292
- | `exportModal` | `ReactElement<any, string \| JSXElementConstructor<any>>` | No | - | A [`<ExportModal />`](./?path=/story/features-export--exportto#CTA_is_out_of_the_table) react element to be rendered in table's context. |
292
+ | `exportModal` | `ReactElement<any, string \| JSXElementConstructor<any>>` | No | - | A [`<ExportModal />`](ExportTo.md) react element to be rendered in table's context. |
293
293
  | `importModal` | `ReactElement<any, string \| JSXElementConstructor<any>>` | No | - | A [`<ImportModal />`] react element to be rendered in table's context. |
294
294
  | `dragAndDropCategories` | `never[][] \| null` | No | - | By default, drag and drop works only without filters. To enable drag and drop with filters, pass an array of filters to this prop. The functionality will then work only for the specified filters, and to enable without filters, you must pass an empty array. For more information, see the [Drag and Drop Overview](//?path=/story/features-sort-drag-and-drop--overview). |
295
295
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  ### Overview
8
8
 
9
- Describes a single level in a [`NestedTable`](./?path=/story/base-components-collections-nestedtable--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.
9
+ Describes a single level in a [`NestedTable`](NestedTable.md) 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.
10
10
 
11
11
  ### Props
12
12
 
@@ -19,6 +19,6 @@ Describes a single level in a [`NestedTable`](./?path=/story/base-components-col
19
19
  | `expandable` | `((item: T) => boolean)` | No | - | A function that accepts the item of the current level and returns a boolean value that indicates whether the item can be expanded. By default, all items are expandable. |
20
20
  | `isRowHighlight` | `((item: T) => boolean)` | No | - | A function that accepts the item of the current level and returns a boolean value indicating whether the item should be highlighted. |
21
21
  | `parentKey` | `(item: T) => string \| null \| undefined` | Yes | - | A function that accepts the item of the current level and returns the key of the parent item, for example: `(item) => item.parentId`. |
22
- | `createCollection` | `(params?: NestedOptimisticActionsState<T, F> \| undefined) => { collection: CollectionState<T, F>; parentFilter?: Filter<...> \| undefined; }` | Yes | - | A function that creates a collection for the current level (using [useCreateCollection](./?path=/story/common-hooks--usecreatecollection) hook), and returns the collection state and a reference to a filter object within this collection that filters the collection by the parent key. => { collection: [CollectionState](./?path=/story/common-state--collectionstate); parentFilter?: [Filter<string[]>](./?path=/story/features-filter-factories--stringsarrayfilter); } |
23
- | `optimisticActionsPredicate` | `((query: ComputedQuery<F>) => (item: T) => boolean)` | No | - | A [predicate](./?path=/story/features-actions-updates--useoptimisticactions) function to pass to the internal [OptimisticActions](/?path=/story/features-actions-updates--collectionoptimisticactions) created by NestedTable |
22
+ | `createCollection` | `(params?: NestedOptimisticActionsState<T, F> \| undefined) => { collection: CollectionState<T, F>; parentFilter?: Filter<...> \| undefined; }` | Yes | - | A function that creates a collection for the current level (using [useCreateCollection](useCreateCollection.md) hook), and returns the collection state and a reference to a filter object within this collection that filters the collection by the parent key. => { collection: [CollectionState](CollectionState.md); parentFilter?: [Filter<string[]>](stringsArrayFilter.md); } |
23
+ | `optimisticActionsPredicate` | `((query: ComputedQuery<F>) => (item: T) => boolean)` | No | - | A [predicate](useOptimisticActions.md) function to pass to the internal [OptimisticActions](/?path=/story/features-actions-updates--collectionoptimisticactions) created by NestedTable |
24
24
 
@@ -6,18 +6,18 @@
6
6
 
7
7
  ### Overview
8
8
 
9
- `NestedTableNodeState` represents a single node in a [`NestedTable`](./?path=/story/base-components-collections-nestedtable--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.
9
+ `NestedTableNodeState` represents a single node in a [`NestedTable`](NestedTable.md) 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.
10
10
 
11
11
  ### Props
12
12
 
13
13
  | Prop | Type | Required | Default | Description |
14
14
  |------|------|----------|---------|-------------|
15
- | `getParent` | `<TD, FD extends FiltersMap>() => NestedTableNodeStatePublicAPI<C, TD, FD> \| null` | Yes | - | Get the node this node is a child of => [NestedTableNodeState](./?path=/story/base-components-collections-nestedtable--nestedtablenodestate) \| `undefined` |
15
+ | `getParent` | `<TD, FD extends FiltersMap>() => NestedTableNodeStatePublicAPI<C, TD, FD> \| null` | Yes | - | Get the node this node is a child of => [NestedTableNodeState](NestedTableNodeState.md) \| `undefined` |
16
16
  | `children` | `CollectionState<T, F>` | No | - | The collection of the node |
17
17
  | `optimisticActions` | `NestedTableNodeStateOptimisticActionsPublicAPI<T>` | No | - | The optimistic actions of the node, affects items both in nested & flat mode |
18
18
  | `getData` | `<TD>() => TD \| null` | Yes | - | The "parent" item of this node => T \| null |
19
19
  | `toggleExpand` | `() => void` | Yes | - | Toggle the expand/collapse state of the node |
20
20
  | `expanded` | `boolean` | Yes | - | Whether the node is expanded |
21
21
  | `depth` | `number` | Yes | - | The depth of the node in the tree |
22
- | `getDescendants` | `<TD, FD extends FiltersMap>() => NestedTableNodeStatePublicAPI<C, TD, FD>[]` | Yes | - | Get all the nodes that are descendants of this node from all levels => [NestedTableNodeState](./?path=/story/base-components-collections-nestedtable--nestedtablenodestate)[] |
22
+ | `getDescendants` | `<TD, FD extends FiltersMap>() => NestedTableNodeStatePublicAPI<C, TD, FD>[]` | Yes | - | Get all the nodes that are descendants of this node from all levels => [NestedTableNodeState](NestedTableNodeState.md)[] |
23
23
 
@@ -6,15 +6,15 @@
6
6
 
7
7
  ### Overview
8
8
 
9
- `NestedTableState` manages the state for a [`NestedTable`](./?path=/story/base-components-collections-nestedtable--nestedtable) component. It handles multi-level hierarchical data with expand/collapse, flat and nested view modes, toolbar, and optimistic actions. Created by [`useNestedTable`](./?path=/story/base-components-collections-nestedtable-usenestedtable--usenestedtable).
9
+ `NestedTableState` manages the state for a [`NestedTable`](NestedTable.md) component. It handles multi-level hierarchical data with expand/collapse, flat and nested view modes, toolbar, and optimistic actions. Created by [`useNestedTable`](useNestedTable.md).
10
10
 
11
11
  ### Props
12
12
 
13
13
  | Prop | Type | Required | Default | Description |
14
14
  |------|------|----------|---------|-------------|
15
- | `toolbar` | `ToolbarCollectionState<unknown, {}>` | Yes | - | Underlying [ToolbarCollectionState](./?path=/story/common-state--toolbarcollectionstate) instance |
16
- | `tableState` | `TableState<unknown, {}>` | Yes | - | Underlying [TableState](./?path=/story/base-components-collections-table-tablestate--tablestate) instance |
17
- | `getNode` | `<TD, FD extends FiltersMap>(key: string) => NestedTableNodeStatePublicAPI<C, TD, FD> \| undefined` | Yes | - | Get the node this item is the parent of. i.e. this node's collection items' parent id is the `key` @param key string) => [NestedTableNodeState](./?path=/story/base-components-collections-nestedtable--nestedtablenodestate) \| undefined |
15
+ | `toolbar` | `ToolbarCollectionState<unknown, {}>` | Yes | - | Underlying [ToolbarCollectionState](ToolbarCollectionState.md) instance |
16
+ | `tableState` | `TableState<unknown, {}>` | Yes | - | Underlying [TableState](TableState.md) instance |
17
+ | `getNode` | `<TD, FD extends FiltersMap>(key: string) => NestedTableNodeStatePublicAPI<C, TD, FD> \| undefined` | Yes | - | Get the node this item is the parent of. i.e. this node's collection items' parent id is the `key` @param key string) => [NestedTableNodeState](NestedTableNodeState.md) \| undefined |
18
18
  | `getRootNode` | `<TD, FD extends FiltersMap>() => NestedTableNodeStatePublicAPI<C, TD, FD>` | Yes | - | Get the root node of the nested table, this node's collection items' parent id is `null`, the items are the top level items |
19
19
  | `getAllNodes` | `<TD, FD extends FiltersMap>() => NestedTableNodeStatePublicAPI<C, TD, FD>[]` | Yes | - | Get all the nodes in the table |
20
20
  | `refreshAll` | `() => void` | Yes | - | An API to refresh all items in the nested table. |
@@ -0,0 +1,47 @@
1
+ # Page Templates
2
+
3
+ **Category:** Guides
4
+
5
+ Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
6
+
7
+ ## Page templates
8
+
9
+ `Collection and Entity Template`, `Collection and Read-Only Detail Template`, `Settings Page Template`, `CMS Collection and Entity Template`
10
+
11
+ Each is an entry in `dist/docs/index.json`, whose `templateFiles` lists the files to copy.
12
+
13
+ ## Overview
14
+
15
+ Start a dashboard page from one of the page templates rather than from an empty file. Each is a complete, working page that this package compiles against its own release, shipped as a directory under `dist/templates/` and listed on its docs-index entry as `templateFiles`. Choose one with the two questions below, copy its whole directory into your page, then rename and replace what its own page says to.
16
+
17
+ ## Which pages the request needs
18
+
19
+ | The request needs | Template |
20
+ | --- | --- |
21
+ | A list whose records are only read, with nothing to create or edit | [Collection and Read-Only Detail Template](<Collection and Read-Only Detail Template.md>) |
22
+ | A list, and a way to create and edit each record | [Collection and Entity Template](<Collection and Entity Template.md>) |
23
+ | App-wide settings, and no list | [Settings Page Template](<Settings Page Template.md>) |
24
+ | A list, create and edit, and an app-wide settings area | [Collection and Entity Template](<Collection and Entity Template.md>), with the settings page added as one more route |
25
+
26
+ Pick the smallest one that covers what the request names. A settings area or an edit form the request never asked for is more page for the user to learn, not a more complete one.
27
+
28
+ Every template except the settings one has a router, because in all of them a row opens a page of its own. A side panel is not a drill-in: on a patterns page it hosts the page's own panels, such as the table's column settings.
29
+
30
+ ## Where the rows come from
31
+
32
+ | The rows come from | Template |
33
+ | --- | --- |
34
+ | An SDK or an API you call yourself | [Collection and Entity Template](<Collection and Entity Template.md>), or its read-only variant |
35
+ | A CMS collection | [CMS Collection and Entity Template](<CMS Collection and Entity Template.md>) |
36
+
37
+ Decide this before writing the page. The two share the entry file and the routes and almost nothing else, so switching later rewrites both the collection page and the entity page. A CMS collection built the first way compiles and runs, and silently loses its schema-driven columns, its field management and its generated form.
38
+
39
+ **On a CMS collection, the fields a request lists are the collection's fields.** The CMS template shows every field as a column, so a request listing what each row holds names the fields to create, and none of them gets a hand-written column. An existing collection stays on the CMS template too: all its fields show, and the user hides what they don't need in the table's column picker. A stated column list decides the columns only when you fetch the rows yourself.
40
+
41
+ ## Using a template
42
+
43
+ Read the template's own page first: it lists each file and the wiring to keep, most of which compiles and builds when it is wrong and fails only in the browser. Then copy every file listed in `templateFiles`, keeping their names relative to each other, since the files import one another.
44
+
45
+ The data functions in each template are in-memory stand-ins with the signatures the pages call. Replace their bodies and keep the signatures, and nothing in the pages changes.
46
+
47
+
@@ -48,5 +48,5 @@ function BasicPage() {
48
48
 
49
49
  ### Required Providers
50
50
 
51
- [WixPatternsProvider](./?path=/story/base-components-providers--wixpatternsprovider)
51
+ [WixPatternsProvider](WixPatternsProvider.md)
52
52
 
@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
8
8
 
9
9
  ### Overview
10
10
 
11
- `PickerContent` displays the content of a picker (list of selectable items). It is used inside [`PickerModal`](./?path=/story/base-components-picker--pickermodal) and [`PickerStandalone`](./?path=/story/base-components-picker--pickerstandalone). Configure it via the [`usePickerContent`](./?path=/story/base-components-picker-hooks--usepickercontent) hook.
11
+ `PickerContent` displays the content of a picker (list of selectable items). It is used inside [`PickerModal`](PickerModal.md) and [`PickerStandalone`](PickerStandalone.md). Configure it via the [`usePickerContent`](usePickerContent.md) hook.
12
12
 
13
13
  ```tsx
14
14
  import { PickerContent } from '@wix/patterns';
@@ -30,14 +30,14 @@ A picker content component accepts props that are being passed by the parent `<P
30
30
 
31
31
  We should do the following with those props:
32
32
 
33
- - Forward them to `<PickerContent />` and to [`usePickerContent`](./?path=/story/base-components-collections-picker-hooks--usepickercontent)
34
- - If we have filters, we should build the filters schema using `props.modalState.filters` raw parameters (see ["With Filters" example](./?path=/story/base-components-collections-picker--pickermodal))
35
- - We also must wrap with [`<WixPatternsProvider />`](./?path=/story/base-components-providers--wixpatternsprovider) because the parent doesn't do that as it's just a modal and not a collection component.
33
+ - Forward them to `<PickerContent />` and to [`usePickerContent`](usePickerContent.md)
34
+ - If we have filters, we should build the filters schema using `props.modalState.filters` raw parameters (see ["With Filters" example](PickerModal.md))
35
+ - We also must wrap with [`<WixPatternsProvider />`](WixPatternsProvider.md) because the parent doesn't do that as it's just a modal and not a collection component.
36
36
 
37
37
  ##### `usePickerContent`
38
38
 
39
39
  This hook is a helper hook that helps us to create a picker state object, using the config we already provided to the parent modal `usePickerModal` hook.
40
- It accepts everything [`useCollection`](./?path=/story/common-hooks--usecollection) accepts minus `fetchData`, `paginationMode` & `limit` which were already provided to the parent modal `usePickerModal` hook.
40
+ It accepts everything [`useCollection`](useCollection.md) accepts minus `fetchData`, `paginationMode` & `limit` which were already provided to the parent modal `usePickerModal` hook.
41
41
 
42
42
  #### Example
43
43
 
@@ -104,13 +104,13 @@ export function PickerModalExample() {
104
104
 
105
105
  | Prop | Type | Required | Default | Description |
106
106
  |------|------|----------|---------|-------------|
107
- | `state` | `UsePickerContentParams<T, F> \| PickerContentState<T, F>` | Yes | - | A state object created with [`usePickerContent`](./?path=/story/base-components-collections-picker-hooks--usepickercontent) |
107
+ | `state` | `UsePickerContentParams<T, F> \| PickerContentState<T, F>` | Yes | - | A state object created with [`usePickerContent`](usePickerContent.md) |
108
108
  | `selectorListProps` | `Partial<SelectorListContentProps>` | No | - | Additional props to pass to [SelectorList](https://www.docs.wixdesignsystem.com/?path=/story/components-lists--selectorlist), i.e `imageSize`, `imageShape` etc. |
109
109
  | `customContentButtonOnClick` | `((param: { onClose: (newItems?: T[]) => void; }) => void)` | No | - | A callback to be called when the custom content button is clicked |
110
110
  | `showSelectAllCheckbox` | `boolean` | No | - | Shows "Select All" checkbox as a side action (overrides "customContent" prop). If `multiple={number}` or `multiple={false}` are used, this prop does nothing. |
111
111
  | `filterComponent` | `ReactElement<any, string \| JSXElementConstructor<any>>` | No | - | Shows a SingleSelectFilter component in a picker modal to filter items; |
112
112
  | `renderItem` | `(item: T, index: number) => Partial<PickerListItemProps>` | Yes | - | A function that render a item row in the selector list |
113
- | `renderEmptyState` | `((params: { hasAvailableItems: boolean; query: ComputedQuery<F>; }) => ReactElement<any, any> \| null)` | No | - | A render function to be rendered when there're no items to show in the table.<br> You can use the built in [`<CollectionEmptyState />`](./?path=/story/features-display-empty-states--collectionemptystate).<br> The function accepts the following parameters * `hasAvailableItems`: Indicates whether other items might have been shown using other filtering / search * `query`: An instance of [ComputedQuery](./?path=/story/common-types--computedquery) that represents the query that resulted with an empty state |
113
+ | `renderEmptyState` | `((params: { hasAvailableItems: boolean; query: ComputedQuery<F>; }) => ReactElement<any, any> \| null)` | No | - | A render function to be rendered when there're no items to show in the table.<br> You can use the built in [`<CollectionEmptyState />`](CollectionEmptyState.md).<br> The function accepts the following parameters * `hasAvailableItems`: Indicates whether other items might have been shown using other filtering / search * `query`: An instance of [ComputedQuery](ComputedQuery.md) that represents the query that resulted with an empty state |
114
114
  | `enablePrimaryButton` | `boolean` | No | - | When set to `true`, the modal primary button will be always enabled. |
115
115
  | `search` | `boolean \| CollectionSearchElement` | No | `true` | Displays a search input in the picker modal. Accepts a boolean or a custom CollectionSearch element as a parameter. When passing `false`, no search input is displayed. |
116
116
  | `hideSearch` | `boolean` | No | - | @deprecated Use search={false} instead Hides the search input of the picker |
@@ -65,16 +65,16 @@ Example code: read `dist/examples/PickerModal/search-override.tsx`
65
65
 
66
66
  - `Lazy Loading` - `PickerModal` is designed not to bundle `Wix Patterns` code in the original application that wants to open the modal.
67
67
  Instead, it loads it dynamically when the modal actually needs to be open.
68
- To allow this feature to work, we split the modal integration to 2 components - a lite modal component, and a "heavy" (dynamically imported) picker component. For pre-fetching the data of the first page we ask for the `fetchData`, `paginationMode`, `filters` & `limit` options upfront (see ["With Filters" example](./?path=/story/base-components-collections-picker--pickermodal#With_filter_dropdown) below).
68
+ To allow this feature to work, we split the modal integration to 2 components - a lite modal component, and a "heavy" (dynamically imported) picker component. For pre-fetching the data of the first page we ask for the `fetchData`, `paginationMode`, `filters` & `limit` options upfront (see ["With Filters" example](PickerModal.md) below).
69
69
  - Immediate call to action - when only 1 item is available on the server, the call to action (`onSelect`) will be triggered immediately without opening the modal.
70
70
 
71
71
  #### Integration
72
- > Make sure to import `usePickerModal` from the sub-package relevant to your environment, see import examples here: [`usePickerModal`](./?path=/story/base-components-collections-picker-hooks--usepickermodal)
72
+ > Make sure to import `usePickerModal` from the sub-package relevant to your environment, see import examples here: [`usePickerModal`](usePickerModal.md)
73
73
 
74
74
  Integrating with `PickerModal` is usually done by the following steps
75
75
 
76
- - Writing a custom component for the modal content using [`<PickerContent />`](./?path=/story/base-components-collections-picker--pickercontent)
77
- - Initializing a state object using [`usePickerModal`](./?path=/story/base-components-collections-picker-hooks--usepickermodal) by passing the custom modal content component as a dynamic import to the `pickerContentComponent` option
76
+ - Writing a custom component for the modal content using [`<PickerContent />`](PickerContent.md)
77
+ - Initializing a state object using [`usePickerModal`](usePickerModal.md) by passing the custom modal content component as a dynamic import to the `pickerContentComponent` option
78
78
  - Passing the state object to `<PickerModal />`
79
79
  - Rendering a button that will open the modal (`Wix Patterns` provides a ready-to-use button `<PickerModalOpenButton />`)
80
80
 
@@ -67,9 +67,9 @@ Example code: read `dist/examples/PickerStandalone/createnew.tsx`
67
67
 
68
68
  | Prop | Type | Required | Default | Description |
69
69
  |------|------|----------|---------|-------------|
70
- | `state` | `PickerStandaloneState<T, F>` | Yes | - | A picker standalone state instance created with [`usePickerStandalone`](./?path=/story/base-components-collections-picker-hooks--usepickerstandalone) |
70
+ | `state` | `PickerStandaloneState<T, F>` | Yes | - | A picker standalone state instance created with [`usePickerStandalone`](usePickerStandalone.md) |
71
71
  | `renderItem` | `((item: T, index: number, options: { isMobileView?: boolean; }) => Partial<PickerListItemProps>)` | No | - | A function that renders an item row in the `SelectorList` |
72
- | `renderEmptyState` | `((params: { hasAvailableItems: boolean; query: ComputedQuery<F>; }) => ReactElement<any, string \| JSXElementConstructor<any>> \| null)` | No | - | A render function to be rendered when there're no items to show in the table.<br> You can use the built in [`<CollectionEmptyState />`](./?path=/story/features-display-empty-states--collectionemptystate).<br> The function accepts the following parameters * `hasAvailableItems`: Indicates whether other items might have been shown using other filtering / search * `query`: An instance of [`ComputedQuery`](./?path=/story/common-types--computedquery) that represents the query that resulted with an empty state |
72
+ | `renderEmptyState` | `((params: { hasAvailableItems: boolean; query: ComputedQuery<F>; }) => ReactElement<any, string \| JSXElementConstructor<any>> \| null)` | No | - | A render function to be rendered when there're no items to show in the table.<br> You can use the built in [`<CollectionEmptyState />`](CollectionEmptyState.md).<br> The function accepts the following parameters * `hasAvailableItems`: Indicates whether other items might have been shown using other filtering / search * `query`: An instance of [`ComputedQuery`](ComputedQuery.md) that represents the query that resulted with an empty state |
73
73
  | `defaultTitle` | `string` | No | - | Picker title if not provided via URL query parameter |
74
74
  | `defaultSubtitle` | `string` | No | - | Picker subtitle if not provided via URL query parameter |
75
75
  | `defaultPrimaryButtonText` | `string` | No | - | The text for the item primary button, if not provided via URL query parameter |
@@ -12,7 +12,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
12
12
 
13
13
  ### Description
14
14
 
15
- A primary [button](https://www.docs.wixdesignsystem.com/?path=/story/components-actions--button) that should be use on [CollectionPage.Header](./?path=/story/components-page-collectionpage--collectionpage-header) component.
15
+ A primary [button](https://www.docs.wixdesignsystem.com/?path=/story/components-actions--button) that should be use on [CollectionPage.Header](CollectionPage.Header.md) component.
16
16
  It has the same API as the [Button](https://www.docs.wixdesignsystem.com/?path=/story/components-actions--button) component, excluding the `size` and `skin` props, and with a `text` prop that is replacing the `children` prop.
17
17
 
18
18
 
@@ -12,7 +12,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
12
12
 
13
13
  `RadioGroupFilter` is based on `RadioGroup` component of `@wix/design-system`.
14
14
  Use `RadioGroupFilter` for rendering a filter that shows a list of items and allow users to choose a single item from the list.
15
- Render it by providing [ArrayFilter](./?path=/story/features-filter-factories--arrayfilter) to the filter prop and a list of options via the data props.
15
+ Render it by providing [ArrayFilter](arrayFilter.md) to the filter prop and a list of options via the data props.
16
16
 
17
17
 
18
18
  ```tsx
@@ -12,7 +12,7 @@ a deliberate stub for a truncated file.
12
12
 
13
13
  | Index | Covers | Use it for |
14
14
  | --- | --- | --- |
15
- | `dist/docs/index.json` | every documented name — components, hooks, factories, state types, guides | finding a name's doc, its examples, and the guides |
15
+ | `dist/docs/index.json` | every documented name — components, hooks, factories, state types, guides, page templates | finding a name's doc, its examples, the guides, and the page templates |
16
16
  | `dist/dts-bundle/index.json` | a curated set of names | reading a real, fully-resolved declaration |
17
17
 
18
18
  The docs index is the larger of the two: everything documented has an entry, while the
@@ -30,6 +30,8 @@ undocumented — look it up in the docs index.
30
30
  | `symbols` | export names that resolve to this entry, where the doc's title is not the export |
31
31
  | `examples` | worked examples for this name, relative to `dist/examples/` |
32
32
  | `relatedComponents` | on a guide: the components it recommends |
33
+ | `templateFiles` | on a page template: every file of the page, relative to `dist/templates/` |
34
+ | `relatedTemplates` | on a guide: the page templates it chooses between |
33
35
  | `variants` | the same name exported from another entry point with a different declaration — see below |
34
36
  | `status`, `statusMessage` | see *Lifecycle*, below |
35
37
 
@@ -190,18 +192,33 @@ write are curated and carry an `importPath` like anything else — `useForm`, `u
190
192
  neither index, and react-hook-form's own docs are their reference. So a react-hook-form name
191
193
  is never unexported merely because the docs index has no page for it; none of them does.
192
194
 
195
+ ## Page templates
196
+
197
+ An entry in the `Templates` category is a whole dashboard page rather than one name's API:
198
+ several files that import one another by relative path, published under `dist/templates/`
199
+ in a directory of their own and listed in the entry's `templateFiles`. Copy every file on
200
+ the list into one directory; one on its own does not compile. The files are type-checked
201
+ against this release, under the configuration `wix generate` ships, before it is published.
202
+ Template pages exist only here, not in the Storybook site, since what they document is files
203
+ in the package.
204
+
205
+ The `Page Templates` guide chooses between them. Its `relatedTemplates` names each one, and
206
+ the build fails when a name there is not an entry that publishes files.
207
+
193
208
  ## Cross-references and examples
194
209
 
195
- Docs link to related names as Storybook URLs — `[TableState](./?path=/story/…--tablestate)`.
196
- Resolve the link text back to a file through `dist/docs/index.json`, the same way you found
197
- the first doc. There is no automatic multi-level expansion. Links to
210
+ A link to another documented name is a relative link to its page, beside this one in
211
+ `dist/docs/` — `[TableState](TableState.md)`, or `[Collection Toolkit](<Collection Toolkit.md>)`
212
+ when the file name has a space. Open it directly; the page is the same one its index entry's
213
+ `file` names. A link that still reads `./?path=/story/…` goes to a page that exists only in the
214
+ Storybook site, such as Getting Started, and has no file here. Links to
198
215
  `https://www.docs.wixdesignsystem.com/` are the design system's, not this library's.
199
216
 
200
217
  Compound components have a doc per sub-part — `CollectionPage.md`,
201
218
  `CollectionPage.Header.md`, `CollectionPage.Content.md`.
202
219
 
203
220
  Heavy examples are written beside the doc rather than inlined. The doc keeps the heading and
204
- the description and names the path: `Example code: read \`dist/docs/ToolbarFilters/apply-changes.tsx\``.
221
+ the description and names the path: `Example code: read \`dist/examples/ToolbarFilters/apply-changes.tsx\``.
205
222
  The same files are listed in the entry's `examples` field.
206
223
 
207
224
 
@@ -0,0 +1,41 @@
1
+ # Settings Page Template
2
+
3
+ **Category:** Templates
4
+
5
+ Paths written as `dist/…` below are relative to the `@wix/patterns` package root — the directory holding its `package.json`.
6
+
7
+ ## Related components
8
+
9
+ `withDashboard`, `WixPatternsProvider`, `SettingsPage`, `useSettingsPage`, `useSettingsPageContext`
10
+
11
+ Each name resolves in `dist/docs/index.json` — as a key, or as one of an entry's `symbols` aliases.
12
+
13
+ ## Template files
14
+
15
+ Copy all of them into one directory: they import one another by relative path.
16
+
17
+ - `dist/templates/settings-page/SettingsPageView.tsx`
18
+ - `dist/templates/settings-page/page.tsx`
19
+ - `dist/templates/settings-page/settings-api.ts`
20
+
21
+ ## Overview
22
+
23
+ A complete dashboard page for app-wide settings with no list: the entry file, a settings page with one card of form fields, and the functions that load and store the settings. Use it when the page configures the app rather than listing records. Copy the whole directory, replace the fields with your own, and replace the bodies in the api file.
24
+
25
+ ## Files
26
+
27
+ | File | What it is |
28
+ | --- | --- |
29
+ | page.tsx | The entry file. There is no router, so it renders the settings page directly. |
30
+ | SettingsPageView.tsx | The settings page and its fields. |
31
+ | settings-api.ts | Loads and stores the settings. The in-memory value is only there so the template runs. |
32
+
33
+ ## What to keep
34
+
35
+ **Every settings-page parameter is required except the two toasts**: the form, the fetch, the save and the cancel. There is no parent path, because a settings page is not reached from a row and has no back navigation.
36
+
37
+ **Fields read their default inside the card content.** The settings have loaded by the time the card content renders, so a field there starts from the saved value. A field read higher up starts empty.
38
+
39
+ **No router, and no page-location wiring.** Both exist for pages that open a record. A settings page next to a list is a route inside the list's app instead: see the Collection and Entity Template.
40
+
41
+
@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
8
8
 
9
9
  ### Overview
10
10
 
11
- A slot component for the side panel of a [`SettingsPage`](./?path=/story/base-components-pages-settings-page--settingspage). Place it inside `<SettingsPage.Content>` alongside `<SettingsPage.MainContent>`. Supports an optional `sticky` prop to keep the content fixed while scrolling.
11
+ A slot component for the side panel of a [`SettingsPage`](SettingsPage.md). Place it inside `<SettingsPage.Content>` alongside `<SettingsPage.MainContent>`. Supports an optional `sticky` prop to keep the content fixed while scrolling.
12
12
 
13
13
  ```tsx
14
14
  import { SettingsPage } from '@wix/patterns';
@@ -16,7 +16,7 @@ import { SettingsPage } from '@wix/patterns';
16
16
 
17
17
  ### Usage
18
18
 
19
- This component acts as a container for [SettingsPage.Card](./?path=/story/base-components-pages-settings-page--settingspage-card) child components and is displayed on the right side of the Page layout. For examples of how this component is used, please refer to the [SettingsPage](./?path=/story/base-components-pages-settings-page--settingspage) examples.
19
+ This component acts as a container for [SettingsPage.Card](SettingsPage.Card.md) child components and is displayed on the right side of the Page layout. For examples of how this component is used, please refer to the [SettingsPage](SettingsPage.md) examples.
20
20
 
21
21
  ### Props
22
22
 
@@ -202,7 +202,7 @@ function States() {
202
202
 
203
203
  ### Overview
204
204
 
205
- A card container used inside [`SettingsPage.MainContent`](./?path=/story/base-components-pages-settings-page--settingspage-maincontent) or [`SettingsPage.AdditionalContent`](./?path=/story/base-components-pages-settings-page--settingspage-additionalcontent). It wraps form fields and content sections with a card layout, and supports loading/error/success states for async content.
205
+ A card container used inside [`SettingsPage.MainContent`](SettingsPage.MainContent.md) or [`SettingsPage.AdditionalContent`](SettingsPage.AdditionalContent.md). It wraps form fields and content sections with a card layout, and supports loading/error/success states for async content.
206
206
 
207
207
  ```tsx
208
208
  import { SettingsPage } from '@wix/patterns';
@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
8
8
 
9
9
  ### Overview
10
10
 
11
- A layout slot for the body of a [`SettingsPage`](./?path=/story/base-components-pages-settings-page--settingspage). Wraps `<SettingsPage.MainContent>` and optionally `<SettingsPage.AdditionalContent>` to create the two-column layout.
11
+ A layout slot for the body of a [`SettingsPage`](SettingsPage.md). Wraps `<SettingsPage.MainContent>` and optionally `<SettingsPage.AdditionalContent>` to create the two-column layout.
12
12
 
13
13
  ```tsx
14
14
  import { SettingsPage } from '@wix/patterns';
@@ -16,7 +16,7 @@ import { SettingsPage } from '@wix/patterns';
16
16
 
17
17
  ### Usage
18
18
 
19
- This component acts as a container for [SettingsPage.MainContent](./?path=/story/base-components-pages-settings-page--settingspage-maincontent) and [SettingsPage.AdditionalContent](./?path=/story/base-components-pages-settings-page--settingspage-additionalcontent) components. For examples of how this component is used, please refer to the [SettingsPage](./?path=/story/base-components-pages-settings-page--settingspage&tab=Examples) examples.
19
+ This component acts as a container for [SettingsPage.MainContent](SettingsPage.MainContent.md) and [SettingsPage.AdditionalContent](SettingsPage.AdditionalContent.md) components. For examples of how this component is used, please refer to the [SettingsPage](SettingsPage.md) examples.
20
20
 
21
21
  ### Props
22
22
 
@@ -76,7 +76,7 @@ function Basic() {
76
76
 
77
77
  ### More Actions
78
78
 
79
- This example displays a header with more actions CTA. To learn how to create a more actions menu, see [`MoreActions`](./?path=/story/features-actions-more-actions--more-actions).
79
+ This example displays a header with more actions CTA. To learn how to create a more actions menu, see [`MoreActions`](<More Actions.md>).
80
80
 
81
81
  ```tsx
82
82
  import React from 'react';
@@ -153,7 +153,7 @@ function Basic() {
153
153
 
154
154
  ### Overview
155
155
 
156
- The header component for a [`SettingsPage`](./?path=/story/base-components-pages-settings-page--settingspage). Renders the page title, optional subtitle, and a more-actions menu. Place it as a direct child of `<SettingsPage>`.
156
+ The header component for a [`SettingsPage`](SettingsPage.md). Renders the page title, optional subtitle, and a more-actions menu. Place it as a direct child of `<SettingsPage>`.
157
157
 
158
158
  ```tsx
159
159
  import { SettingsPage } from '@wix/patterns';
@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
8
8
 
9
9
  ### Overview
10
10
 
11
- A slot component for the main content area of a [`SettingsPage`](./?path=/story/base-components-pages-settings-page--settingspage). Place it inside `<SettingsPage.Content>`. This is where you render the primary form fields and cards.
11
+ A slot component for the main content area of a [`SettingsPage`](SettingsPage.md). Place it inside `<SettingsPage.Content>`. This is where you render the primary form fields and cards.
12
12
 
13
13
  ```tsx
14
14
  import { SettingsPage } from '@wix/patterns';
@@ -16,7 +16,7 @@ import { SettingsPage } from '@wix/patterns';
16
16
 
17
17
  ### Usage
18
18
 
19
- This component acts as a container for [SettingsPage.Card](./?path=/story/base-components-pages-settings-page--settingspage-card) child components and is displayed on the left side of the Page layout. For examples of how this component is used, please refer to the [SettingsPage](./?path=/story/base-components-pages-settings-page--settingspage&tab=Examples) examples.
19
+ This component acts as a container for [SettingsPage.Card](SettingsPage.Card.md) child components and is displayed on the left side of the Page layout. For examples of how this component is used, please refer to the [SettingsPage](SettingsPage.md) examples.
20
20
 
21
21
  ### Props
22
22
 
@@ -16,13 +16,13 @@ Here's a breakdown of its main purposes:
16
16
 
17
17
  1. **Appearance of the Settings Page**: The `SettingsPage` component handles the overall layout and structure of the settings page. It defines how the page is organized, including title and subtitle, more actions dropdown, CTAs, content basic layout and widgets. Also, it is responsible for rendering loading skeletons, error state, displaying notifications and other.
18
18
 
19
- 2. **Handling Fetch**: The `SettingsPage` component typically integrates with a fetch mechanism (e.g., an API call) to retrieve data related to the settings being displayed on the page. This integration is done through the `fetch` function passed as a prop to the [`useSettingsPage`](./?path=/story/base-components-pages-settings-page-hooks-usesettingspage--usesettingspage) hook, allowing the component to retrieve the necessary data for rendering. You can use the [`useSettings`](./?path=/story/base-components-pages-settings-page-hooks-usesettings--usesettings) to access a fetched settings.
19
+ 2. **Handling Fetch**: The `SettingsPage` component typically integrates with a fetch mechanism (e.g., an API call) to retrieve data related to the settings being displayed on the page. This integration is done through the `fetch` function passed as a prop to the [`useSettingsPage`](useSettingsPage.md) hook, allowing the component to retrieve the necessary data for rendering. You can use the `useSettings` to access a fetched settings.
20
20
 
21
- 3. **Handling Save and Validation Logic**: The [useForm](https://react-hook-form.com/docs/useform) hook from [react-hook-form](https://react-hook-form.com/) is used to create a form object, and the `onSave` function passed as a prop to the [`useSettingsPage`](./?path=/story/components-page-settingspage-hooks-usesettingspage--usesettingspage) hook, is triggered when the user initiates a save action.
21
+ 3. **Handling Save and Validation Logic**: The [useForm](https://react-hook-form.com/docs/useform) hook from [react-hook-form](https://react-hook-form.com/) is used to create a form object, and the `onSave` function passed as a prop to the [`useSettingsPage`](useSettingsPage.md) hook, is triggered when the user initiates a save action.
22
22
 
23
- 4. **Easy integration with open platform capabilities**: You can create a container in DevCenter and WixPatterns will fetch and present relevant extensions. You can use [`MoreActions`](./?path=/story/features-actions-more-actions--moreactions) to get Menu Item Extensions.
23
+ 4. **Easy integration with open platform capabilities**: You can create a container in DevCenter and WixPatterns will fetch and present relevant extensions. You can use [`MoreActions`](<More Actions.md>) to get Menu Item Extensions.
24
24
 
25
- In summary, the ``SettingsPage`` component and the associated [`useSettingsPage`](./?path=/story/base-components-pages-settings-page-hooks-usesettingspage--usesettingspage) hook together provide a streamlined approach to rendering, fetching, saving, and validating data for a specific settings within an application.
25
+ In summary, the ``SettingsPage`` component and the associated [`useSettingsPage`](useSettingsPage.md) hook together provide a streamlined approach to rendering, fetching, saving, and validating data for a specific settings within an application.
26
26
 
27
27
 
28
28
  ## Examples
@@ -8,7 +8,7 @@ Examples below are illustrative: each one demonstrates this page's API, and ever
8
8
 
9
9
  ### Overview
10
10
 
11
- `SettingsPageState` is the state object that drives a [`SettingsPage`](./?path=/story/base-components-pages-settings-page--settingspage). It is created by the [`useSettingsPage`](./?path=/story/base-components-pages-settings-page-hooks-usesettingspage--usesettingspage) hook and manages:
11
+ `SettingsPageState` is the state object that drives a [`SettingsPage`](SettingsPage.md). It is created by the [`useSettingsPage`](useSettingsPage.md) hook and manages:
12
12
 
13
13
  - **Settings fetching** — loads the current settings from the server via `fetch`
14
14
  - **Form state** — integrates with `react-hook-form` for editing
@@ -14,9 +14,9 @@ Some of that scaffolding is environment-scoped and is **not** needed to use this
14
14
 
15
15
  Renders a [Dropdown](https://www.docs.wixdesignsystem.com/?path=/story/components-form--dropdown) filter that shows a list of items fetched from a server.
16
16
 
17
- Use [useFilterCollection](./?path=/story/features-filter-hooks--usefiltercollection) to create the collection state object for fetching the list of items.
17
+ Use [useFilterCollection](useFilterCollection.md) to create the collection state object for fetching the list of items.
18
18
 
19
- Use [useStaticListFilterCollection](./?path=/story/features-filter-hooks--usestaticlistfiltercollection) to create the collection state object for a list of static items.
19
+ Use [useStaticListFilterCollection](useStaticListFilterCollection.md) to create the collection state object for a list of static items.
20
20
 
21
21
  Note that the server should return sections in a strict order.
22
22