@wix/patterns 1.459.0 → 1.461.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 (719) 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/CollectionPageNew/CollectionPage.st.css.js +2 -2
  12. package/dist/cjs/components/CollectionPageNew/CollectionPage.st.css.js.map +1 -1
  13. package/dist/cjs/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js +3 -3
  14. package/dist/cjs/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js.map +1 -1
  15. package/dist/cjs/components/CollectionTable/CollectionTable.st.css.js +2 -2
  16. package/dist/cjs/components/CollectionTable/CollectionTable.st.css.js.map +1 -1
  17. package/dist/cjs/components/CollectionTable/CollectionTableWSRTable.st.css.js +2 -2
  18. package/dist/cjs/components/CollectionTable/CollectionTableWSRTable.st.css.js.map +1 -1
  19. package/dist/cjs/components/CollectionToolbar/CollectionToolbar.st.css.js +5 -5
  20. package/dist/cjs/components/CollectionToolbar/CollectionToolbar.st.css.js.map +1 -1
  21. package/dist/cjs/components/CollectionToolbar/SearchOrCustomFilter.st.css.js +4 -4
  22. package/dist/cjs/components/CollectionToolbar/SearchOrCustomFilter.st.css.js.map +1 -1
  23. package/dist/cjs/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js +2 -2
  24. package/dist/cjs/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js.map +1 -1
  25. package/dist/cjs/components/CollectionViewsDropdown/ViewsDropdown.st.css.js +2 -2
  26. package/dist/cjs/components/CollectionViewsDropdown/ViewsDropdown.st.css.js.map +1 -1
  27. package/dist/cjs/components/CustomFieldModal/CustomFieldForm.js +33 -29
  28. package/dist/cjs/components/CustomFieldModal/CustomFieldForm.js.map +1 -1
  29. package/dist/cjs/components/CustomFieldModal/CustomFieldTypeDropdown.js +6 -5
  30. package/dist/cjs/components/CustomFieldModal/CustomFieldTypeDropdown.js.map +1 -1
  31. package/dist/cjs/components/DragHandle/DragHandle.st.css.js +2 -2
  32. package/dist/cjs/components/DragHandle/DragHandle.st.css.js.map +1 -1
  33. package/dist/cjs/components/EditableTable/EditableCell.st.css.js +3 -3
  34. package/dist/cjs/components/EditableTable/EditableCell.st.css.js.map +1 -1
  35. package/dist/cjs/components/EditableTable/EditableTable.uni.driver.js +17 -0
  36. package/dist/cjs/components/EditableTable/EditableTable.uni.driver.js.map +1 -1
  37. package/dist/cjs/components/EditableTable/EditableTableContextMenu.js +7 -11
  38. package/dist/cjs/components/EditableTable/EditableTableContextMenu.js.map +1 -1
  39. package/dist/cjs/components/EditableTable/HeaderActionsPopover.st.css.js +2 -2
  40. package/dist/cjs/components/EditableTable/HeaderActionsPopover.st.css.js.map +1 -1
  41. package/dist/cjs/components/EditableTable/cellTypes/CellViewLayout.st.css.js +2 -2
  42. package/dist/cjs/components/EditableTable/cellTypes/CellViewLayout.st.css.js.map +1 -1
  43. package/dist/cjs/components/EditableTable/cellTypes/address/Edit.st.css.js +3 -3
  44. package/dist/cjs/components/EditableTable/cellTypes/address/Edit.st.css.js.map +1 -1
  45. package/dist/cjs/components/EditableTable/cellTypes/array/Edit.st.css.js +3 -3
  46. package/dist/cjs/components/EditableTable/cellTypes/array/Edit.st.css.js.map +1 -1
  47. package/dist/cjs/components/EditableTable/cellTypes/boolean/Edit.st.css.js +3 -3
  48. package/dist/cjs/components/EditableTable/cellTypes/boolean/Edit.st.css.js.map +1 -1
  49. package/dist/cjs/components/EditableTable/cellTypes/boolean/View.st.css.js +3 -3
  50. package/dist/cjs/components/EditableTable/cellTypes/boolean/View.st.css.js.map +1 -1
  51. package/dist/cjs/components/EditableTable/cellTypes/color/Edit.st.css.js +2 -2
  52. package/dist/cjs/components/EditableTable/cellTypes/color/Edit.st.css.js.map +1 -1
  53. package/dist/cjs/components/EditableTable/cellTypes/date/Edit.st.css.js +3 -3
  54. package/dist/cjs/components/EditableTable/cellTypes/date/Edit.st.css.js.map +1 -1
  55. package/dist/cjs/components/EditableTable/cellTypes/date/View.st.css.js +2 -2
  56. package/dist/cjs/components/EditableTable/cellTypes/date/View.st.css.js.map +1 -1
  57. package/dist/cjs/components/EditableTable/cellTypes/datetime/Edit.st.css.js +8 -8
  58. package/dist/cjs/components/EditableTable/cellTypes/datetime/Edit.st.css.js.map +1 -1
  59. package/dist/cjs/components/EditableTable/cellTypes/datetime/View.st.css.js +7 -7
  60. package/dist/cjs/components/EditableTable/cellTypes/datetime/View.st.css.js.map +1 -1
  61. package/dist/cjs/components/EditableTable/cellTypes/email/Edit.st.css.js +3 -3
  62. package/dist/cjs/components/EditableTable/cellTypes/email/Edit.st.css.js.map +1 -1
  63. package/dist/cjs/components/EditableTable/cellTypes/email/View.st.css.js +2 -2
  64. package/dist/cjs/components/EditableTable/cellTypes/email/View.st.css.js.map +1 -1
  65. package/dist/cjs/components/EditableTable/cellTypes/mediaGallery/index.js +4 -4
  66. package/dist/cjs/components/EditableTable/cellTypes/mediaGallery/index.js.map +1 -1
  67. package/dist/cjs/components/EditableTable/cellTypes/number/Edit.st.css.js +3 -3
  68. package/dist/cjs/components/EditableTable/cellTypes/number/Edit.st.css.js.map +1 -1
  69. package/dist/cjs/components/EditableTable/cellTypes/number/View.st.css.js +3 -3
  70. package/dist/cjs/components/EditableTable/cellTypes/number/View.st.css.js.map +1 -1
  71. package/dist/cjs/components/EditableTable/cellTypes/object/Edit.st.css.js +3 -3
  72. package/dist/cjs/components/EditableTable/cellTypes/object/Edit.st.css.js.map +1 -1
  73. package/dist/cjs/components/EditableTable/cellTypes/object/View.st.css.js +2 -2
  74. package/dist/cjs/components/EditableTable/cellTypes/object/View.st.css.js.map +1 -1
  75. package/dist/cjs/components/EditableTable/cellTypes/richContent/index.js +1 -1
  76. package/dist/cjs/components/EditableTable/cellTypes/richContent/index.js.map +1 -1
  77. package/dist/cjs/components/EditableTable/cellTypes/richText/index.js +1 -1
  78. package/dist/cjs/components/EditableTable/cellTypes/richText/index.js.map +1 -1
  79. package/dist/cjs/components/EditableTable/cellTypes/select/Edit.st.css.js +3 -3
  80. package/dist/cjs/components/EditableTable/cellTypes/select/Edit.st.css.js.map +1 -1
  81. package/dist/cjs/components/EditableTable/cellTypes/text/Edit.st.css.js +4 -4
  82. package/dist/cjs/components/EditableTable/cellTypes/text/Edit.st.css.js.map +1 -1
  83. package/dist/cjs/components/EditableTable/cellTypes/text/View.st.css.js +2 -2
  84. package/dist/cjs/components/EditableTable/cellTypes/text/View.st.css.js.map +1 -1
  85. package/dist/cjs/components/EditableTable/cellTypes/time/Edit.st.css.js +4 -4
  86. package/dist/cjs/components/EditableTable/cellTypes/time/Edit.st.css.js.map +1 -1
  87. package/dist/cjs/components/EditableTable/cellTypes/url/Edit.st.css.js +3 -3
  88. package/dist/cjs/components/EditableTable/cellTypes/url/Edit.st.css.js.map +1 -1
  89. package/dist/cjs/components/EditableTable/cellTypes/url/View.st.css.js +5 -5
  90. package/dist/cjs/components/EditableTable/cellTypes/url/View.st.css.js.map +1 -1
  91. package/dist/cjs/components/EditableTable/useClipboardHandler.js +0 -3
  92. package/dist/cjs/components/EditableTable/useClipboardHandler.js.map +1 -1
  93. package/dist/cjs/components/EmptyState/EmptyStateBase.st.css.js +2 -2
  94. package/dist/cjs/components/EmptyState/EmptyStateBase.st.css.js.map +1 -1
  95. package/dist/cjs/components/EntityPage/EntityPagePlain.st.css.js +2 -2
  96. package/dist/cjs/components/EntityPage/EntityPagePlain.st.css.js.map +1 -1
  97. package/dist/cjs/components/Fade/Fade.st.css.js +2 -2
  98. package/dist/cjs/components/Fade/Fade.st.css.js.map +1 -1
  99. package/dist/cjs/components/Heading/Heading.st.css.js +2 -2
  100. package/dist/cjs/components/Heading/Heading.st.css.js.map +1 -1
  101. package/dist/cjs/components/ImportButton/ImportStepUpload.st.css.js +3 -3
  102. package/dist/cjs/components/ImportButton/ImportStepUpload.st.css.js.map +1 -1
  103. package/dist/cjs/components/InputOverflow/InputOverflow.st.css.js +2 -2
  104. package/dist/cjs/components/InputOverflow/InputOverflow.st.css.js.map +1 -1
  105. package/dist/cjs/components/LoadingRow/LoadingRow.st.css.js +3 -3
  106. package/dist/cjs/components/LoadingRow/LoadingRow.st.css.js.map +1 -1
  107. package/dist/cjs/components/MaxHeightText/MaxHeightText.st.css.js +2 -2
  108. package/dist/cjs/components/MaxHeightText/MaxHeightText.st.css.js.map +1 -1
  109. package/dist/cjs/components/MaxLines/MaxLines.st.css.js +2 -2
  110. package/dist/cjs/components/MaxLines/MaxLines.st.css.js.map +1 -1
  111. package/dist/cjs/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js +5 -5
  112. package/dist/cjs/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js.map +1 -1
  113. package/dist/cjs/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js +2 -2
  114. package/dist/cjs/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js.map +1 -1
  115. package/dist/cjs/components/NestedTable/NestedTableRow.st.css.js +5 -5
  116. package/dist/cjs/components/NestedTable/NestedTableRow.st.css.js.map +1 -1
  117. package/dist/cjs/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js +2 -2
  118. package/dist/cjs/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js.map +1 -1
  119. package/dist/cjs/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js +2 -2
  120. package/dist/cjs/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js.map +1 -1
  121. package/dist/cjs/components/PickerContent/PickerContent.st.css.js +2 -2
  122. package/dist/cjs/components/PickerContent/PickerContent.st.css.js.map +1 -1
  123. package/dist/cjs/components/PickerContent/PickerContentAdditionalStep.st.css.js +4 -4
  124. package/dist/cjs/components/PickerContent/PickerContentAdditionalStep.st.css.js.map +1 -1
  125. package/dist/cjs/components/PickerTableListItem/PickerTableListItem.st.css.js +2 -2
  126. package/dist/cjs/components/PickerTableListItem/PickerTableListItem.st.css.js.map +1 -1
  127. package/dist/cjs/components/ScrollableContent/ScrollableContent.st.css.js +2 -2
  128. package/dist/cjs/components/ScrollableContent/ScrollableContent.st.css.js.map +1 -1
  129. package/dist/cjs/components/SetupWidget/SetupWidget.st.css.js +10 -10
  130. package/dist/cjs/components/SetupWidget/SetupWidget.st.css.js.map +1 -1
  131. package/dist/cjs/components/SkeletonCard/SkeletonCard.st.css.js +3 -3
  132. package/dist/cjs/components/SkeletonCard/SkeletonCard.st.css.js.map +1 -1
  133. package/dist/cjs/components/SlidingModal/SlidingModal.st.css.js +2 -2
  134. package/dist/cjs/components/SlidingModal/SlidingModal.st.css.js.map +1 -1
  135. package/dist/cjs/components/Table/AddFieldColumnHeader.st.css.js +4 -4
  136. package/dist/cjs/components/Table/AddFieldColumnHeader.st.css.js.map +1 -1
  137. package/dist/cjs/components/TabsFilter/TabsFilter.st.css.js +3 -3
  138. package/dist/cjs/components/TabsFilter/TabsFilter.st.css.js.map +1 -1
  139. package/dist/cjs/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js +2 -2
  140. package/dist/cjs/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js.map +1 -1
  141. package/dist/cjs/components/ToolbarItem/ToolbarItem.st.css.js +2 -2
  142. package/dist/cjs/components/ToolbarItem/ToolbarItem.st.css.js.map +1 -1
  143. package/dist/cjs/components/ToolbarItemBox/ToolbarItemBox.st.css.js +2 -2
  144. package/dist/cjs/components/ToolbarItemBox/ToolbarItemBox.st.css.js.map +1 -1
  145. package/dist/cjs/components/common.st.css.js +4 -4
  146. package/dist/cjs/components/common.st.css.js.map +1 -1
  147. package/dist/cjs/schema/entityPageFieldManagement.js +3 -1
  148. package/dist/cjs/schema/entityPageFieldManagement.js.map +1 -1
  149. package/dist/cjs/state/CollectionFieldsSourceState.js +3 -1
  150. package/dist/cjs/state/CollectionFieldsSourceState.js.map +1 -1
  151. package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css.js +2 -2
  152. package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css.js.map +1 -1
  153. package/dist/cjs/state/CustomFields/CustomFieldsPanelState.js +3 -0
  154. package/dist/cjs/state/CustomFields/CustomFieldsPanelState.js.map +1 -1
  155. package/dist/cjs/state/EditableTable/CellValueState.js +1 -2
  156. package/dist/cjs/state/EditableTable/CellValueState.js.map +1 -1
  157. package/dist/cjs/state/EditableTable/ClipboardState.js +10 -14
  158. package/dist/cjs/state/EditableTable/ClipboardState.js.map +1 -1
  159. package/dist/cjs/state/EditableTable/utils.js +3 -0
  160. package/dist/cjs/state/EditableTable/utils.js.map +1 -1
  161. package/dist/cjs/state/FormPage/FormPageHeader.st.css.js +2 -2
  162. package/dist/cjs/state/FormPage/FormPageHeader.st.css.js.map +1 -1
  163. package/dist/cjs/state/ManageFieldsSource.js.map +1 -1
  164. package/dist/cjs/state/ToolbarCollectionState.js +6 -2
  165. package/dist/cjs/state/ToolbarCollectionState.js.map +1 -1
  166. package/dist/cjs/styles.global.css +2 -2
  167. package/dist/cjs/version.js +1 -1
  168. package/dist/cjs/version.js.map +1 -1
  169. package/dist/docs/ActionCellProps.md +6 -21
  170. package/dist/docs/AutoCompleteFilter.md +6 -128
  171. package/dist/docs/BulkActionModalRenderProp.md +6 -9
  172. package/dist/docs/CollectionEmptyState/2-ctas.tsx +67 -0
  173. package/dist/docs/CollectionEmptyState/demo.tsx +61 -0
  174. package/dist/docs/CollectionEmptyState/passive-empty-state.tsx +59 -0
  175. package/dist/docs/CollectionEmptyState.md +9 -207
  176. package/dist/docs/CollectionNoResultsState.md +6 -11
  177. package/dist/docs/CollectionOptimisticActions/create-many.tsx +110 -0
  178. package/dist/docs/CollectionOptimisticActions/create-one.tsx +104 -0
  179. package/dist/docs/CollectionOptimisticActions/delete-all.tsx +132 -0
  180. package/dist/docs/CollectionOptimisticActions/delete-many.tsx +104 -0
  181. package/dist/docs/CollectionOptimisticActions/delete-one.tsx +94 -0
  182. package/dist/docs/CollectionOptimisticActions/update-all.tsx +142 -0
  183. package/dist/docs/CollectionOptimisticActions/update-many.tsx +119 -0
  184. package/dist/docs/CollectionOptimisticActions/update-one.tsx +108 -0
  185. package/dist/docs/CollectionOptimisticActions.md +14 -939
  186. package/dist/docs/CollectionPage.md +6 -19
  187. package/dist/docs/CollectionPremiumEmptyState.md +6 -14
  188. package/dist/docs/CollectionSearch/default.tsx +57 -0
  189. package/dist/docs/CollectionSearch/max-length.tsx +59 -0
  190. package/dist/docs/CollectionSearch/placeholder.tsx +59 -0
  191. package/dist/docs/CollectionSearch/search-highlighting.tsx +60 -0
  192. package/dist/docs/CollectionSearch.md +10 -247
  193. package/dist/docs/ComputedQuery.md +6 -15
  194. package/dist/docs/CustomColumns/add-a-tooltip.tsx +85 -0
  195. package/dist/docs/CustomColumns/basic.tsx +78 -0
  196. package/dist/docs/CustomColumns/exclude-columns.tsx +79 -0
  197. package/dist/docs/CustomColumns/freeze-column-reorder.tsx +111 -0
  198. package/dist/docs/CustomColumns/get-visible-columns.tsx +92 -0
  199. package/dist/docs/CustomColumns/hide-specific-columns-by-default.tsx +79 -0
  200. package/dist/docs/CustomColumns/load-only-selected-columns.tsx +85 -0
  201. package/dist/docs/CustomColumns/lock-columns.tsx +80 -0
  202. package/dist/docs/CustomColumns/reorder-columns.tsx +84 -0
  203. package/dist/docs/CustomColumns.md +9 -791
  204. package/dist/docs/CustomFieldType/add-field-modal.tsx +206 -0
  205. package/dist/docs/CustomFieldType/editable-cell.tsx +206 -0
  206. package/dist/docs/CustomFieldType/entity-page-form.tsx +133 -0
  207. package/dist/docs/CustomFieldType/table-cell-and-filter.tsx +165 -0
  208. package/dist/docs/CustomFieldType.md +4 -718
  209. package/dist/docs/CustomFieldsWidget/basic.tsx +53 -0
  210. package/dist/docs/CustomFieldsWidget/controllable-state.tsx +78 -0
  211. package/dist/docs/CustomFieldsWidget/empty-state.tsx +20 -0
  212. package/dist/docs/CustomFieldsWidget/inline-theme.tsx +54 -0
  213. package/dist/docs/CustomFieldsWidget/responsive.tsx +44 -0
  214. package/dist/docs/CustomFieldsWidget/with-tpa-fields.tsx +57 -0
  215. package/dist/docs/CustomFieldsWidget/without-entity-page.tsx +42 -0
  216. package/dist/docs/CustomFieldsWidget.md +7 -362
  217. package/dist/docs/DateRangeFilter.Components.md +6 -71
  218. package/dist/docs/EntityPage/2-columns.tsx +72 -0
  219. package/dist/docs/EntityPage/basic.tsx +72 -0
  220. package/dist/docs/EntityPage/delete-action.tsx +77 -0
  221. package/dist/docs/EntityPage/delete-error-handling.tsx +65 -0
  222. package/dist/docs/EntityPage/demo.tsx +212 -0
  223. package/dist/docs/EntityPage/error-on-fetch.tsx +68 -0
  224. package/dist/docs/EntityPage/error-on-save.tsx +59 -0
  225. package/dist/docs/EntityPage/input-initialization-with-controller.tsx +96 -0
  226. package/dist/docs/EntityPage/input-initialization-with-usecontroller.tsx +99 -0
  227. package/dist/docs/EntityPage/loading.tsx +107 -0
  228. package/dist/docs/EntityPage/overriding-save-button-text.tsx +75 -0
  229. package/dist/docs/EntityPage.md +17 -1045
  230. package/dist/docs/ExportTo/cta-is-out-of-the-table.tsx +157 -0
  231. package/dist/docs/ExportTo/export-all-table.tsx +144 -0
  232. package/dist/docs/ExportTo/export-filtered-table.tsx +148 -0
  233. package/dist/docs/ExportTo/export-table-with-selection-bulk-selection.tsx +203 -0
  234. package/dist/docs/ExportTo.md +10 -674
  235. package/dist/docs/Filter Overview/interactive-example.tsx +211 -0
  236. package/dist/docs/Filter Overview.md +1 -213
  237. package/dist/docs/FilterProps.md +6 -13
  238. package/dist/docs/Grid/card-with-a-cta-that-opens-a-modal.tsx +103 -0
  239. package/dist/docs/Grid/card-with-a-cta-that-opens-a-popup.tsx +91 -0
  240. package/dist/docs/Grid/demo.tsx +73 -0
  241. package/dist/docs/Grid/grid-sections.tsx +62 -0
  242. package/dist/docs/Grid/grid-with-a-reduced-width.tsx +72 -0
  243. package/dist/docs/Grid/use-the-preset-prop.tsx +55 -0
  244. package/dist/docs/Grid.md +12 -509
  245. package/dist/docs/GridFolders.md +6 -45
  246. package/dist/docs/GridFoldersState.md +6 -3
  247. package/dist/docs/GridState.md +6 -5
  248. package/dist/docs/ImportButton/backup-error-handling.tsx +80 -0
  249. package/dist/docs/ImportButton/cms-import.tsx +38 -0
  250. package/dist/docs/ImportButton/create-new-field.tsx +40 -0
  251. package/dist/docs/ImportButton/platformized-import-fields-inline.tsx +65 -0
  252. package/dist/docs/ImportButton/platformized-import-from-a-source.tsx +50 -0
  253. package/dist/docs/ImportButton/required-fields.tsx +65 -0
  254. package/dist/docs/ImportButton/update-or-skip-by-id.tsx +40 -0
  255. package/dist/docs/ImportButton.md +7 -392
  256. package/dist/docs/Indeterminate/all-indeterminate.tsx +127 -0
  257. package/dist/docs/Indeterminate/items-indeterminate-status.tsx +126 -0
  258. package/dist/docs/Indeterminate.md +2 -257
  259. package/dist/docs/Internal Scroll/full-width-section.tsx +96 -0
  260. package/dist/docs/Internal Scroll/narrow-side-section.tsx +82 -0
  261. package/dist/docs/Internal Scroll.md +2 -182
  262. package/dist/docs/More Actions/collection-page-2.tsx +98 -0
  263. package/dist/docs/More Actions/collection-page.tsx +97 -0
  264. package/dist/docs/More Actions/explore-related-apps.tsx +129 -0
  265. package/dist/docs/More Actions/featured-more-actions-custom-position.tsx +116 -0
  266. package/dist/docs/More Actions/featured-more-actions-opt-out.tsx +86 -0
  267. package/dist/docs/More Actions/featured-more-actions.tsx +82 -0
  268. package/dist/docs/More Actions/integrate-with-extension.tsx +100 -0
  269. package/dist/docs/More Actions/more-actions-in-the-toolbar.tsx +96 -0
  270. package/dist/docs/More Actions/more-actions-with-a-divider.tsx +115 -0
  271. package/dist/docs/More Actions.md +9 -937
  272. package/dist/docs/MoreActionsItem.md +6 -16
  273. package/dist/docs/MultiAutoInlineCheckboxFilter.md +6 -879
  274. package/dist/docs/MultiBulkActionToolbar/basic-secondary-action.tsx +177 -0
  275. package/dist/docs/MultiBulkActionToolbar/bulk-action.tsx +169 -0
  276. package/dist/docs/MultiBulkActionToolbar/extend-menu-items.tsx +174 -0
  277. package/dist/docs/MultiBulkActionToolbar/maximum-selection.tsx +168 -0
  278. package/dist/docs/MultiBulkActionToolbar/popover-menu.tsx +123 -0
  279. package/dist/docs/MultiBulkActionToolbar/primary-secondary-actions-with-a-divider.tsx +218 -0
  280. package/dist/docs/MultiBulkActionToolbar.md +12 -1048
  281. package/dist/docs/MultiInlineCheckboxFilter.md +6 -878
  282. package/dist/docs/MultiLevelSorting/basic-multi-level-sorting.tsx +93 -0
  283. package/dist/docs/MultiLevelSorting/multi-level-sorting-with-custom-sort-order.tsx +100 -0
  284. package/dist/docs/MultiLevelSorting/multi-level-sorting-with-defined-sort-directions.tsx +96 -0
  285. package/dist/docs/MultiLevelSorting.md +9 -301
  286. package/dist/docs/MultiSelectCheckboxFilter.md +6 -133
  287. package/dist/docs/MultiSelectCollectionFilter.md +6 -138
  288. package/dist/docs/NestedTable/drag-and-drop.tsx +107 -0
  289. package/dist/docs/NestedTable/filters.tsx +192 -0
  290. package/dist/docs/NestedTable/flat-mode-search.tsx +92 -0
  291. package/dist/docs/NestedTable/node-api-usage.tsx +188 -0
  292. package/dist/docs/NestedTable/single-entity.tsx +85 -0
  293. package/dist/docs/NestedTable/various-entities.tsx +138 -0
  294. package/dist/docs/NestedTable.md +6 -814
  295. package/dist/docs/NumberRangeFilter.md +6 -13
  296. package/dist/docs/OperatorFilterPicker.md +6 -13
  297. package/dist/docs/PatternsReactRoute.md +6 -7
  298. package/dist/docs/PatternsReactRouter.md +9 -0
  299. package/dist/docs/PickerModal/multi-select.tsx +97 -0
  300. package/dist/docs/PickerModal/pre-selected-item.tsx +120 -0
  301. package/dist/docs/PickerModal/search-override.tsx +99 -0
  302. package/dist/docs/PickerModal/single-selection.tsx +98 -0
  303. package/dist/docs/PickerModal/with-filter-dropdown.tsx +139 -0
  304. package/dist/docs/PickerModal.md +11 -605
  305. package/dist/docs/PickerStandalone/basic.tsx +49 -0
  306. package/dist/docs/PickerStandalone/createnew.tsx +65 -0
  307. package/dist/docs/PickerStandalone/custom-empty-state.tsx +33 -0
  308. package/dist/docs/PickerStandalone/custom-items.tsx +78 -0
  309. package/dist/docs/PickerStandalone.md +4 -233
  310. package/dist/docs/PrimaryActionButton.md +6 -71
  311. package/dist/docs/PrimaryActions.md +6 -14
  312. package/dist/docs/PrimaryPageButton.md +6 -69
  313. package/dist/docs/RadioGroupFilter.md +6 -19
  314. package/dist/docs/SecondaryActions.md +6 -14
  315. package/dist/docs/SettingsPage/2-columns.tsx +70 -0
  316. package/dist/docs/SettingsPage/basic.tsx +66 -0
  317. package/dist/docs/SettingsPage/error-on-fetch.tsx +65 -0
  318. package/dist/docs/SettingsPage/error-on-save.tsx +59 -0
  319. package/dist/docs/SettingsPage/input-initialization-with-controller.tsx +89 -0
  320. package/dist/docs/SettingsPage/input-initialization-with-usecontroller.tsx +92 -0
  321. package/dist/docs/SettingsPage/loading.tsx +99 -0
  322. package/dist/docs/SettingsPage.md +13 -574
  323. package/dist/docs/SingleSelectFilter/custom-render-items.tsx +57 -0
  324. package/dist/docs/SingleSelectFilter/empty-state.tsx +33 -0
  325. package/dist/docs/SingleSelectFilter/sections.tsx +69 -0
  326. package/dist/docs/SingleSelectFilter/server-data.tsx +53 -0
  327. package/dist/docs/SingleSelectFilter/static-data.tsx +25 -0
  328. package/dist/docs/SingleSelectFilter.md +11 -374
  329. package/dist/docs/Sortable Columns/basic-sortable-column.tsx +90 -0
  330. package/dist/docs/Sortable Columns/custom-sort-order.tsx +94 -0
  331. package/dist/docs/Sortable Columns.md +2 -188
  332. package/dist/docs/Suggestions/carousel-customization.tsx +27 -0
  333. package/dist/docs/Suggestions/carousel-vs-container-layout.tsx +40 -0
  334. package/dist/docs/Suggestions/custom-card-rendering.tsx +99 -0
  335. package/dist/docs/Suggestions/with-transform-function.tsx +56 -0
  336. package/dist/docs/Suggestions.md +4 -230
  337. package/dist/docs/SummaryBar/error.tsx +75 -0
  338. package/dist/docs/SummaryBar/loading-with-error.tsx +96 -0
  339. package/dist/docs/SummaryBar/loading-with-success.tsx +105 -0
  340. package/dist/docs/SummaryBar/loading.tsx +73 -0
  341. package/dist/docs/SummaryBar/success.tsx +73 -0
  342. package/dist/docs/SummaryBar.md +11 -437
  343. package/dist/docs/Table/basic-table.tsx +74 -0
  344. package/dist/docs/Table/cursor-pagination.tsx +61 -0
  345. package/dist/docs/Table/fetch-total-async.tsx +83 -0
  346. package/dist/docs/Table/filters.tsx +152 -0
  347. package/dist/docs/Table/header.tsx +85 -0
  348. package/dist/docs/Table/horizontal-scroll.tsx +90 -0
  349. package/dist/docs/Table/table-disabled-rows.tsx +99 -0
  350. package/dist/docs/Table/using-ambassador.tsx +72 -0
  351. package/dist/docs/Table/using-with-external-data-source.tsx +79 -0
  352. package/dist/docs/Table/virtual.tsx +77 -0
  353. package/dist/docs/Table Sections/demo.tsx +96 -0
  354. package/dist/docs/Table Sections/with-badge.tsx +107 -0
  355. package/dist/docs/Table Sections/with-collapse.tsx +104 -0
  356. package/dist/docs/Table Sections/with-summary.tsx +118 -0
  357. package/dist/docs/Table Sections.md +4 -433
  358. package/dist/docs/Table.md +16 -961
  359. package/dist/docs/TableColumn.md +6 -21
  360. package/dist/docs/TableDragAndDrop/save-order-mode.tsx +85 -0
  361. package/dist/docs/TableDragAndDrop/specific-filters.tsx +135 -0
  362. package/dist/docs/TableDragAndDrop/specific-tabs.tsx +117 -0
  363. package/dist/docs/TableDragAndDrop/table.tsx +83 -0
  364. package/dist/docs/TableDragAndDrop.md +4 -428
  365. package/dist/docs/TableFolders/demo.tsx +101 -0
  366. package/dist/docs/TableFolders/table-folders.tsx +101 -0
  367. package/dist/docs/TableFolders/with-tags.tsx +124 -0
  368. package/dist/docs/TableFolders.md +9 -391
  369. package/dist/docs/TableFoldersState.md +6 -5
  370. package/dist/docs/TableGridSwitch/basic-table-grid-switch.tsx +91 -0
  371. package/dist/docs/TableGridSwitch/custom-columns.tsx +94 -0
  372. package/dist/docs/TableGridSwitch.md +8 -255
  373. package/dist/docs/TableGridSwitchFolders/demo.tsx +103 -0
  374. package/dist/docs/TableGridSwitchFolders/tablegridswitchfolders.tsx +103 -0
  375. package/dist/docs/TableGridSwitchFolders/with-tags.tsx +124 -0
  376. package/dist/docs/TableGridSwitchFolders.md +3 -336
  377. package/dist/docs/TableGridSwitchState.md +6 -6
  378. package/dist/docs/TableState.md +6 -7
  379. package/dist/docs/TableTopNotification/base.tsx +92 -0
  380. package/dist/docs/TableTopNotification/nested-table.tsx +114 -0
  381. package/dist/docs/TableTopNotification.md +8 -235
  382. package/dist/docs/TabsFilter/basic-tabs.tsx +96 -0
  383. package/dist/docs/TabsFilter/disabled-tabs.tsx +100 -0
  384. package/dist/docs/TabsFilter/tabs-with-a-basic-counter.tsx +149 -0
  385. package/dist/docs/TabsFilter/tabs-with-a-counter-badge.tsx +153 -0
  386. package/dist/docs/TabsFilter.md +10 -515
  387. package/dist/docs/Tags/basic.tsx +90 -0
  388. package/dist/docs/Tags/custom-config-for-tags-column.tsx +95 -0
  389. package/dist/docs/Tags/customized-filter-position.tsx +121 -0
  390. package/dist/docs/Tags/customized-tags-column-position.tsx +94 -0
  391. package/dist/docs/Tags/on-table-with-folders.tsx +124 -0
  392. package/dist/docs/Tags.md +5 -534
  393. package/dist/docs/ToolbarCollectionState.md +1 -1
  394. package/dist/docs/ToolbarFilters/2-filters-with-a-title.tsx +162 -0
  395. package/dist/docs/ToolbarFilters/2-filters-without-a-title.tsx +158 -0
  396. package/dist/docs/ToolbarFilters/add-filter-presets-for-future-dates.tsx +108 -0
  397. package/dist/docs/ToolbarFilters/apply-changes.tsx +167 -0
  398. package/dist/docs/ToolbarFilters/custom-label-for-tags.tsx +167 -0
  399. package/dist/docs/ToolbarFilters/customize-filter-display-tags.tsx +163 -0
  400. package/dist/docs/ToolbarFilters/mini-toolbar-with-filters.tsx +121 -0
  401. package/dist/docs/ToolbarFilters/mini-toolbar.tsx +80 -0
  402. package/dist/docs/ToolbarFilters/more-than-2-filters.tsx +164 -0
  403. package/dist/docs/ToolbarFilters/postpone-collection-filter-initial-fetch.tsx +158 -0
  404. package/dist/docs/ToolbarFilters.md +17 -1466
  405. package/dist/docs/ToolbarSecondaryActions/grouped-actions-with-dividers.tsx +91 -0
  406. package/dist/docs/ToolbarSecondaryActions/mixed-buttons-and-dropdown-menus.tsx +80 -0
  407. package/dist/docs/ToolbarSecondaryActions/multiple-actions-with-dropdown-menus.tsx +88 -0
  408. package/dist/docs/ToolbarSecondaryActions/multiple-secondary-action-buttons.tsx +73 -0
  409. package/dist/docs/ToolbarSecondaryActions.md +4 -340
  410. package/dist/docs/ToolbarTitle/title-and-count.tsx +60 -0
  411. package/dist/docs/ToolbarTitle/title-count-and-the-collection-s-item-limit.tsx +60 -0
  412. package/dist/docs/ToolbarTitle/title-subtitle-and-learn-more.tsx +68 -0
  413. package/dist/docs/ToolbarTitle/title.tsx +60 -0
  414. package/dist/docs/ToolbarTitle.md +4 -256
  415. package/dist/docs/Views/basic-view-that-can-be-chosen.tsx +142 -0
  416. package/dist/docs/Views/basic-view.tsx +134 -0
  417. package/dist/docs/Views/view-with-selected-columns.tsx +142 -0
  418. package/dist/docs/Views/views-separated-by-category-in-the-dropdown.tsx +209 -0
  419. package/dist/docs/Views.md +4 -635
  420. package/dist/docs/WidgetsFormProvider.md +9 -0
  421. package/dist/docs/WixPatternsBMProvider.md +9 -0
  422. package/dist/docs/WixPatternsBaseProvider.md +6 -3
  423. package/dist/docs/WixPatternsEssentialsProvider.md +9 -0
  424. package/dist/docs/WixPatternsGizaProvider.md +9 -0
  425. package/dist/docs/WixPatternsProvider.md +9 -0
  426. package/dist/docs/arrayFilter.md +6 -12
  427. package/dist/docs/customFilter.md +6 -19
  428. package/dist/docs/dateRangeFilter.Factories.md +6 -13
  429. package/dist/docs/deleteSecondaryAction.md +6 -13
  430. package/dist/docs/idNameArrayFilter.md +6 -12
  431. package/dist/docs/index.json +164 -90
  432. package/dist/docs/operatorFilter.md +6 -13
  433. package/dist/docs/stringFilter.md +6 -4
  434. package/dist/docs/stringsArrayFilter.md +6 -12
  435. package/dist/docs/useCreateCollection.md +6 -19
  436. package/dist/docs/useEntityPage.md +6 -13
  437. package/dist/docs/useFilterCollection.md +6 -13
  438. package/dist/docs/useGridCollection.md +6 -19
  439. package/dist/docs/useGridFolders.md +6 -4
  440. package/dist/docs/useOptimisticActions/custom-error-handling.tsx +178 -0
  441. package/dist/docs/useOptimisticActions/default-behaviour.tsx +155 -0
  442. package/dist/docs/useOptimisticActions/error-handling-and-retries.tsx +175 -0
  443. package/dist/docs/useOptimisticActions/items-orders.tsx +165 -0
  444. package/dist/docs/useOptimisticActions/revision-handling.tsx +109 -0
  445. package/dist/docs/useOptimisticActions/success-toast-with-undo.tsx +164 -0
  446. package/dist/docs/useOptimisticActions/update-with-query.tsx +195 -0
  447. package/dist/docs/useOptimisticActions.md +13 -1164
  448. package/dist/docs/usePatternsNavigate.md +11 -0
  449. package/dist/docs/usePickerModal.md +6 -16
  450. package/dist/docs/useStaticListFilterCollection.md +6 -4
  451. package/dist/docs/useTableCollection.md +6 -19
  452. package/dist/docs/useTableFolders.md +6 -4
  453. package/dist/docs/useTableGridSwitchCollection.md +6 -19
  454. package/dist/dts-bundle/index.json +1 -1
  455. package/dist/dts-bundle/types/EntityPageStateParams.d.ts +13 -0
  456. package/dist/esm/components/CardContainer/CardContainer.st.css.js +2 -2
  457. package/dist/esm/components/CmsFieldManagement/CmsFieldForm.st.css.js +2 -2
  458. package/dist/esm/components/CmsFieldManagement/CmsFieldModal.st.css.js +2 -2
  459. package/dist/esm/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js +2 -2
  460. package/dist/esm/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js.map +1 -1
  461. package/dist/esm/components/Collapse/Collapse.st.css.js +2 -2
  462. package/dist/esm/components/CollectionPageNew/CollectionPage.st.css.js +2 -2
  463. package/dist/esm/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js +2 -2
  464. package/dist/esm/components/CollectionTable/CollectionTable.st.css.js +2 -2
  465. package/dist/esm/components/CollectionTable/CollectionTableWSRTable.st.css.js +2 -2
  466. package/dist/esm/components/CollectionTable/CollectionTableWSRTable.st.css.js.map +1 -1
  467. package/dist/esm/components/CollectionToolbar/CollectionToolbar.st.css.js +2 -2
  468. package/dist/esm/components/CollectionToolbar/SearchOrCustomFilter.st.css.js +2 -2
  469. package/dist/esm/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js +2 -2
  470. package/dist/esm/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js.map +1 -1
  471. package/dist/esm/components/CollectionViewsDropdown/ViewsDropdown.st.css.js +2 -2
  472. package/dist/esm/components/CustomFieldModal/CustomFieldForm.js +5 -4
  473. package/dist/esm/components/CustomFieldModal/CustomFieldForm.js.map +1 -1
  474. package/dist/esm/components/CustomFieldModal/CustomFieldTypeDropdown.js +2 -2
  475. package/dist/esm/components/CustomFieldModal/CustomFieldTypeDropdown.js.map +1 -1
  476. package/dist/esm/components/DragHandle/DragHandle.st.css.js +2 -2
  477. package/dist/esm/components/EditableTable/EditableCell.st.css.js +2 -2
  478. package/dist/esm/components/EditableTable/EditableCell.st.css.js.map +1 -1
  479. package/dist/esm/components/EditableTable/EditableTable.uni.driver.js +14 -0
  480. package/dist/esm/components/EditableTable/EditableTable.uni.driver.js.map +1 -1
  481. package/dist/esm/components/EditableTable/EditableTableContextMenu.js +0 -4
  482. package/dist/esm/components/EditableTable/EditableTableContextMenu.js.map +1 -1
  483. package/dist/esm/components/EditableTable/HeaderActionsPopover.st.css.js +2 -2
  484. package/dist/esm/components/EditableTable/cellTypes/CellViewLayout.st.css.js +2 -2
  485. package/dist/esm/components/EditableTable/cellTypes/address/Edit.st.css.js +2 -2
  486. package/dist/esm/components/EditableTable/cellTypes/address/Edit.st.css.js.map +1 -1
  487. package/dist/esm/components/EditableTable/cellTypes/array/Edit.st.css.js +2 -2
  488. package/dist/esm/components/EditableTable/cellTypes/array/Edit.st.css.js.map +1 -1
  489. package/dist/esm/components/EditableTable/cellTypes/boolean/Edit.st.css.js +2 -2
  490. package/dist/esm/components/EditableTable/cellTypes/boolean/View.st.css.js +2 -2
  491. package/dist/esm/components/EditableTable/cellTypes/color/Edit.st.css.js +2 -2
  492. package/dist/esm/components/EditableTable/cellTypes/color/Edit.st.css.js.map +1 -1
  493. package/dist/esm/components/EditableTable/cellTypes/date/Edit.st.css.js +2 -2
  494. package/dist/esm/components/EditableTable/cellTypes/date/Edit.st.css.js.map +1 -1
  495. package/dist/esm/components/EditableTable/cellTypes/date/View.st.css.js +2 -2
  496. package/dist/esm/components/EditableTable/cellTypes/datetime/Edit.st.css.js +2 -2
  497. package/dist/esm/components/EditableTable/cellTypes/datetime/Edit.st.css.js.map +1 -1
  498. package/dist/esm/components/EditableTable/cellTypes/datetime/View.st.css.js +2 -2
  499. package/dist/esm/components/EditableTable/cellTypes/email/Edit.st.css.js +2 -2
  500. package/dist/esm/components/EditableTable/cellTypes/email/Edit.st.css.js.map +1 -1
  501. package/dist/esm/components/EditableTable/cellTypes/email/View.st.css.js +2 -2
  502. package/dist/esm/components/EditableTable/cellTypes/mediaGallery/index.js +3 -2
  503. package/dist/esm/components/EditableTable/cellTypes/mediaGallery/index.js.map +1 -1
  504. package/dist/esm/components/EditableTable/cellTypes/number/Edit.st.css.js +2 -2
  505. package/dist/esm/components/EditableTable/cellTypes/number/View.st.css.js +2 -2
  506. package/dist/esm/components/EditableTable/cellTypes/number/View.st.css.js.map +1 -1
  507. package/dist/esm/components/EditableTable/cellTypes/object/Edit.st.css.js +2 -2
  508. package/dist/esm/components/EditableTable/cellTypes/object/Edit.st.css.js.map +1 -1
  509. package/dist/esm/components/EditableTable/cellTypes/object/View.st.css.js +2 -2
  510. package/dist/esm/components/EditableTable/cellTypes/richContent/index.js +1 -1
  511. package/dist/esm/components/EditableTable/cellTypes/richContent/index.js.map +1 -1
  512. package/dist/esm/components/EditableTable/cellTypes/richText/index.js +1 -1
  513. package/dist/esm/components/EditableTable/cellTypes/richText/index.js.map +1 -1
  514. package/dist/esm/components/EditableTable/cellTypes/select/Edit.st.css.js +2 -2
  515. package/dist/esm/components/EditableTable/cellTypes/text/Edit.st.css.js +2 -2
  516. package/dist/esm/components/EditableTable/cellTypes/text/View.st.css.js +2 -2
  517. package/dist/esm/components/EditableTable/cellTypes/time/Edit.st.css.js +2 -2
  518. package/dist/esm/components/EditableTable/cellTypes/url/Edit.st.css.js +2 -2
  519. package/dist/esm/components/EditableTable/cellTypes/url/Edit.st.css.js.map +1 -1
  520. package/dist/esm/components/EditableTable/cellTypes/url/View.st.css.js +2 -2
  521. package/dist/esm/components/EditableTable/cellTypes/url/View.st.css.js.map +1 -1
  522. package/dist/esm/components/EditableTable/useClipboardHandler.js +0 -3
  523. package/dist/esm/components/EditableTable/useClipboardHandler.js.map +1 -1
  524. package/dist/esm/components/EmptyState/EmptyStateBase.st.css.js +2 -2
  525. package/dist/esm/components/EntityPage/EntityPagePlain.st.css.js +2 -2
  526. package/dist/esm/components/Fade/Fade.st.css.js +2 -2
  527. package/dist/esm/components/Fade/Fade.st.css.js.map +1 -1
  528. package/dist/esm/components/Heading/Heading.st.css.js +2 -2
  529. package/dist/esm/components/ImportButton/ImportStepUpload.st.css.js +2 -2
  530. package/dist/esm/components/ImportButton/ImportStepUpload.st.css.js.map +1 -1
  531. package/dist/esm/components/InputOverflow/InputOverflow.st.css.js +2 -2
  532. package/dist/esm/components/InputOverflow/InputOverflow.st.css.js.map +1 -1
  533. package/dist/esm/components/LoadingRow/LoadingRow.st.css.js +3 -3
  534. package/dist/esm/components/MaxHeightText/MaxHeightText.st.css.js +2 -2
  535. package/dist/esm/components/MaxLines/MaxLines.st.css.js +2 -2
  536. package/dist/esm/components/MaxLines/MaxLines.st.css.js.map +1 -1
  537. package/dist/esm/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js +2 -2
  538. package/dist/esm/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js +2 -2
  539. package/dist/esm/components/NestedTable/NestedTableRow.st.css.js +2 -2
  540. package/dist/esm/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js +2 -2
  541. package/dist/esm/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js.map +1 -1
  542. package/dist/esm/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js +2 -2
  543. package/dist/esm/components/PickerContent/PickerContent.st.css.js +2 -2
  544. package/dist/esm/components/PickerContent/PickerContent.st.css.js.map +1 -1
  545. package/dist/esm/components/PickerContent/PickerContentAdditionalStep.st.css.js +2 -2
  546. package/dist/esm/components/PickerTableListItem/PickerTableListItem.st.css.js +2 -2
  547. package/dist/esm/components/PickerTableListItem/PickerTableListItem.st.css.js.map +1 -1
  548. package/dist/esm/components/ScrollableContent/ScrollableContent.st.css.js +2 -2
  549. package/dist/esm/components/ScrollableContent/ScrollableContent.st.css.js.map +1 -1
  550. package/dist/esm/components/SetupWidget/SetupWidget.st.css.js +2 -2
  551. package/dist/esm/components/SkeletonCard/SkeletonCard.st.css.js +2 -2
  552. package/dist/esm/components/SlidingModal/SlidingModal.st.css.js +2 -2
  553. package/dist/esm/components/Table/AddFieldColumnHeader.st.css.js +2 -2
  554. package/dist/esm/components/Table/AddFieldColumnHeader.st.css.js.map +1 -1
  555. package/dist/esm/components/TabsFilter/TabsFilter.st.css.js +2 -2
  556. package/dist/esm/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js +2 -2
  557. package/dist/esm/components/ToolbarItem/ToolbarItem.st.css.js +2 -2
  558. package/dist/esm/components/ToolbarItemBox/ToolbarItemBox.st.css.js +2 -2
  559. package/dist/esm/components/ToolbarItemBox/ToolbarItemBox.st.css.js.map +1 -1
  560. package/dist/esm/components/common.st.css.js +2 -2
  561. package/dist/esm/components/common.st.css.js.map +1 -1
  562. package/dist/esm/schema/entityPageFieldManagement.js +2 -0
  563. package/dist/esm/schema/entityPageFieldManagement.js.map +1 -1
  564. package/dist/esm/state/CollectionFieldsSourceState.js +2 -0
  565. package/dist/esm/state/CollectionFieldsSourceState.js.map +1 -1
  566. package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css.js +2 -2
  567. package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css.js.map +1 -1
  568. package/dist/esm/state/CustomFields/CustomFieldsPanelState.js +4 -0
  569. package/dist/esm/state/CustomFields/CustomFieldsPanelState.js.map +1 -1
  570. package/dist/esm/state/EditableTable/CellValueState.js +5 -2
  571. package/dist/esm/state/EditableTable/CellValueState.js.map +1 -1
  572. package/dist/esm/state/EditableTable/ClipboardState.js +12 -16
  573. package/dist/esm/state/EditableTable/ClipboardState.js.map +1 -1
  574. package/dist/esm/state/EditableTable/utils.js +3 -0
  575. package/dist/esm/state/EditableTable/utils.js.map +1 -1
  576. package/dist/esm/state/FormPage/FormPageHeader.st.css.js +2 -2
  577. package/dist/esm/state/ToolbarCollectionState.js +6 -2
  578. package/dist/esm/state/ToolbarCollectionState.js.map +1 -1
  579. package/dist/esm/styles.global.css +2 -2
  580. package/dist/esm/version.js +1 -1
  581. package/dist/types/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.d.ts.map +1 -1
  582. package/dist/types/components/CollectionTable/CollectionTableWSRTable.st.css.d.ts.map +1 -1
  583. package/dist/types/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.d.ts.map +1 -1
  584. package/dist/types/components/CustomFieldModal/CustomFieldForm.d.ts.map +1 -1
  585. package/dist/types/components/CustomFieldModal/CustomFieldTypeDropdown.d.ts.map +1 -1
  586. package/dist/types/components/EditableTable/EditableCell.st.css.d.ts.map +1 -1
  587. package/dist/types/components/EditableTable/EditableTable.uni.driver.d.ts +2 -0
  588. package/dist/types/components/EditableTable/EditableTable.uni.driver.d.ts.map +1 -1
  589. package/dist/types/components/EditableTable/EditableTableContextMenu.d.ts.map +1 -1
  590. package/dist/types/components/EditableTable/cellTypes/address/Edit.st.css.d.ts.map +1 -1
  591. package/dist/types/components/EditableTable/cellTypes/array/Edit.st.css.d.ts.map +1 -1
  592. package/dist/types/components/EditableTable/cellTypes/color/Edit.st.css.d.ts.map +1 -1
  593. package/dist/types/components/EditableTable/cellTypes/date/Edit.st.css.d.ts.map +1 -1
  594. package/dist/types/components/EditableTable/cellTypes/datetime/Edit.st.css.d.ts.map +1 -1
  595. package/dist/types/components/EditableTable/cellTypes/email/Edit.st.css.d.ts.map +1 -1
  596. package/dist/types/components/EditableTable/cellTypes/mediaGallery/index.d.ts.map +1 -1
  597. package/dist/types/components/EditableTable/cellTypes/number/View.st.css.d.ts.map +1 -1
  598. package/dist/types/components/EditableTable/cellTypes/object/Edit.st.css.d.ts.map +1 -1
  599. package/dist/types/components/EditableTable/cellTypes/url/Edit.st.css.d.ts.map +1 -1
  600. package/dist/types/components/EditableTable/cellTypes/url/View.st.css.d.ts.map +1 -1
  601. package/dist/types/components/EditableTable/useClipboardHandler.d.ts.map +1 -1
  602. package/dist/types/components/Fade/Fade.st.css.d.ts.map +1 -1
  603. package/dist/types/components/ImportButton/ImportStepUpload.st.css.d.ts.map +1 -1
  604. package/dist/types/components/InputOverflow/InputOverflow.st.css.d.ts.map +1 -1
  605. package/dist/types/components/MaxLines/MaxLines.st.css.d.ts.map +1 -1
  606. package/dist/types/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.d.ts.map +1 -1
  607. package/dist/types/components/PickerContent/PickerContent.st.css.d.ts.map +1 -1
  608. package/dist/types/components/PickerTableListItem/PickerTableListItem.st.css.d.ts.map +1 -1
  609. package/dist/types/components/ScrollableContent/ScrollableContent.st.css.d.ts.map +1 -1
  610. package/dist/types/components/Table/AddFieldColumnHeader.st.css.d.ts.map +1 -1
  611. package/dist/types/components/ToolbarItemBox/ToolbarItemBox.st.css.d.ts.map +1 -1
  612. package/dist/types/components/common.st.css.d.ts.map +1 -1
  613. package/dist/types/schema/entityPageFieldManagement.d.ts.map +1 -1
  614. package/dist/types/state/CollectionFieldsSourceState.d.ts +2 -6
  615. package/dist/types/state/CollectionFieldsSourceState.d.ts.map +1 -1
  616. package/dist/types/state/CollectionPage/CollectionPageHeader.st.css.d.ts.map +1 -1
  617. package/dist/types/state/CustomFields/CustomFieldsPanelState.d.ts +2 -4
  618. package/dist/types/state/CustomFields/CustomFieldsPanelState.d.ts.map +1 -1
  619. package/dist/types/state/EditableTable/CellValueState.d.ts.map +1 -1
  620. package/dist/types/state/EditableTable/ClipboardState.d.ts +1 -1
  621. package/dist/types/state/EditableTable/ClipboardState.d.ts.map +1 -1
  622. package/dist/types/state/EditableTable/utils.d.ts.map +1 -1
  623. package/dist/types/state/ManageFieldsSource.d.ts +2 -6
  624. package/dist/types/state/ManageFieldsSource.d.ts.map +1 -1
  625. package/dist/types/state/ToolbarCollectionState.d.ts +2 -4
  626. package/dist/types/state/ToolbarCollectionState.d.ts.map +1 -1
  627. package/dist/types/testkit/jsdom.d.ts +1 -0
  628. package/dist/types/testkit/jsdom.d.ts.map +1 -1
  629. package/dist/types/testkit/playwright.d.ts +1 -0
  630. package/dist/types/testkit/playwright.d.ts.map +1 -1
  631. package/dist/types/testkit/puppeteer.d.ts +1 -0
  632. package/dist/types/testkit/puppeteer.d.ts.map +1 -1
  633. package/dist/types/version.d.ts +1 -1
  634. package/package.json +7 -7
  635. package/src/components/CardContainer/CardContainer.st.css.ts +2 -2
  636. package/src/components/CmsFieldManagement/CmsFieldForm.st.css.ts +2 -2
  637. package/src/components/CmsFieldManagement/CmsFieldModal.st.css.ts +2 -2
  638. package/src/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.ts +2 -2
  639. package/src/components/Collapse/Collapse.st.css.ts +2 -2
  640. package/src/components/CollectionPageNew/CollectionPage.st.css.ts +2 -2
  641. package/src/components/CollectionSectionHeader/CollectionSectionHeader.st.css.ts +2 -2
  642. package/src/components/CollectionTable/CollectionTable.st.css.ts +2 -2
  643. package/src/components/CollectionTable/CollectionTableWSRTable.st.css.ts +2 -2
  644. package/src/components/CollectionToolbar/CollectionToolbar.st.css.ts +2 -2
  645. package/src/components/CollectionToolbar/SearchOrCustomFilter.st.css.ts +2 -2
  646. package/src/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.ts +2 -2
  647. package/src/components/CollectionViewsDropdown/ViewsDropdown.st.css.ts +2 -2
  648. package/src/components/CustomFieldModal/CustomFieldForm.tsx +11 -3
  649. package/src/components/CustomFieldModal/CustomFieldTypeDropdown.tsx +3 -1
  650. package/src/components/DragHandle/DragHandle.st.css.ts +2 -2
  651. package/src/components/EditableTable/EditableCell.st.css.ts +2 -2
  652. package/src/components/EditableTable/EditableTable.uni.driver.ts +18 -0
  653. package/src/components/EditableTable/EditableTableContextMenu.tsx +0 -4
  654. package/src/components/EditableTable/HeaderActionsPopover.st.css.ts +2 -2
  655. package/src/components/EditableTable/cellTypes/CellViewLayout.st.css.ts +2 -2
  656. package/src/components/EditableTable/cellTypes/address/Edit.st.css.ts +2 -2
  657. package/src/components/EditableTable/cellTypes/array/Edit.st.css.ts +2 -2
  658. package/src/components/EditableTable/cellTypes/boolean/Edit.st.css.ts +2 -2
  659. package/src/components/EditableTable/cellTypes/boolean/View.st.css.ts +2 -2
  660. package/src/components/EditableTable/cellTypes/color/Edit.st.css.ts +2 -2
  661. package/src/components/EditableTable/cellTypes/date/Edit.st.css.ts +2 -2
  662. package/src/components/EditableTable/cellTypes/date/View.st.css.ts +2 -2
  663. package/src/components/EditableTable/cellTypes/datetime/Edit.st.css.ts +2 -2
  664. package/src/components/EditableTable/cellTypes/datetime/View.st.css.ts +2 -2
  665. package/src/components/EditableTable/cellTypes/email/Edit.st.css.ts +2 -2
  666. package/src/components/EditableTable/cellTypes/email/View.st.css.ts +2 -2
  667. package/src/components/EditableTable/cellTypes/mediaGallery/index.tsx +6 -2
  668. package/src/components/EditableTable/cellTypes/number/Edit.st.css.ts +2 -2
  669. package/src/components/EditableTable/cellTypes/number/View.st.css.ts +2 -2
  670. package/src/components/EditableTable/cellTypes/object/Edit.st.css.ts +2 -2
  671. package/src/components/EditableTable/cellTypes/object/View.st.css.ts +2 -2
  672. package/src/components/EditableTable/cellTypes/richContent/index.tsx +1 -1
  673. package/src/components/EditableTable/cellTypes/richText/index.tsx +1 -1
  674. package/src/components/EditableTable/cellTypes/select/Edit.st.css.ts +2 -2
  675. package/src/components/EditableTable/cellTypes/text/Edit.st.css.ts +2 -2
  676. package/src/components/EditableTable/cellTypes/text/View.st.css.ts +2 -2
  677. package/src/components/EditableTable/cellTypes/time/Edit.st.css.ts +2 -2
  678. package/src/components/EditableTable/cellTypes/url/Edit.st.css.ts +2 -2
  679. package/src/components/EditableTable/cellTypes/url/View.st.css.ts +2 -2
  680. package/src/components/EditableTable/useClipboardHandler.ts +0 -4
  681. package/src/components/EmptyState/EmptyStateBase.st.css.ts +2 -2
  682. package/src/components/EntityPage/EntityPagePlain.st.css.ts +2 -2
  683. package/src/components/Fade/Fade.st.css.ts +2 -2
  684. package/src/components/Heading/Heading.st.css.ts +2 -2
  685. package/src/components/ImportButton/ImportStepUpload.st.css.ts +2 -2
  686. package/src/components/InputOverflow/InputOverflow.st.css.ts +2 -2
  687. package/src/components/LoadingRow/LoadingRow.st.css.ts +3 -3
  688. package/src/components/MaxHeightText/MaxHeightText.st.css.ts +2 -2
  689. package/src/components/MaxLines/MaxLines.st.css.ts +2 -2
  690. package/src/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.ts +2 -2
  691. package/src/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.ts +2 -2
  692. package/src/components/NestedTable/NestedTableRow.st.css.ts +2 -2
  693. package/src/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.ts +2 -2
  694. package/src/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.ts +2 -2
  695. package/src/components/PickerContent/PickerContent.st.css.ts +2 -2
  696. package/src/components/PickerContent/PickerContentAdditionalStep.st.css.ts +2 -2
  697. package/src/components/PickerTableListItem/PickerTableListItem.st.css.ts +2 -2
  698. package/src/components/ScrollableContent/ScrollableContent.st.css.ts +2 -2
  699. package/src/components/SetupWidget/SetupWidget.st.css.ts +2 -2
  700. package/src/components/SkeletonCard/SkeletonCard.st.css.ts +2 -2
  701. package/src/components/SlidingModal/SlidingModal.st.css.ts +2 -2
  702. package/src/components/Table/AddFieldColumnHeader.st.css.ts +2 -2
  703. package/src/components/TabsFilter/TabsFilter.st.css.ts +2 -2
  704. package/src/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.ts +2 -2
  705. package/src/components/ToolbarItem/ToolbarItem.st.css.ts +2 -2
  706. package/src/components/ToolbarItemBox/ToolbarItemBox.st.css.ts +2 -2
  707. package/src/components/common.st.css.ts +2 -2
  708. package/src/schema/entityPageFieldManagement.ts +2 -0
  709. package/src/state/CollectionFieldsSourceState.ts +4 -5
  710. package/src/state/CollectionPage/CollectionPageHeader.st.css.ts +2 -2
  711. package/src/state/CustomFields/CustomFieldsPanelState.ts +9 -5
  712. package/src/state/EditableTable/CellValueState.ts +5 -2
  713. package/src/state/EditableTable/ClipboardState.ts +14 -21
  714. package/src/state/EditableTable/utils.ts +4 -0
  715. package/src/state/FormPage/FormPageHeader.st.css.ts +2 -2
  716. package/src/state/ManageFieldsSource.ts +2 -6
  717. package/src/state/ToolbarCollectionState.ts +14 -2
  718. package/src/styles.global.css +2 -2
  719. package/src/version.ts +1 -1
@@ -38,220 +38,7 @@ This comprehensive demo demonstrates all the key functionalities supported by `E
38
38
  Explore the [Examples](./?path=/story/components-page-entitypage--entitypage&tab=Examples) section for a clearer understanding of the various states of the entity state, and examine each sub-component to see their available states and examples.
39
39
 
40
40
 
41
- ```tsx
42
- import React from 'react';
43
- import {
44
- CustomFieldsWidget,
45
- EntityPage,
46
- EntityPageState,
47
- MoreActions,
48
- TagsWidget,
49
- useEntity,
50
- useEntityPage,
51
- useEntityPageContext,
52
- } from '@wix/patterns';
53
- import { useController, useForm } from '@wix/patterns/form';
54
- import { ExtendedFields, Tags } from '@wix/patterns/core';
55
- import {
56
- Box,
57
- Card,
58
- FormField,
59
- Input,
60
- Text,
61
- Checkbox,
62
- } from '@wix/design-system';
63
- import { InvoiceSmall } from '@wix/wix-ui-icons-common';
64
-
65
- interface MyEntity {
66
- id?: string;
67
- name?: string;
68
- booleanField?: boolean;
69
- createdDate?: Date;
70
- updatedDate?: Date;
71
- extendedFields?: ExtendedFields;
72
- tags?: Tags;
73
- }
74
-
75
- interface FormFields {
76
- name?: string;
77
- booleanField?: boolean;
78
- }
79
-
80
- function FullExample() {
81
- const form = useForm<FormFields>();
82
- const state: EntityPageState<MyEntity> = useEntityPage<MyEntity, FormFields>({
83
- parentPageId: 'YOUR_PARENT_PAGE_ID',
84
- form,
85
- onSave: ({ widgetsFormData: { extendedFields, tags } }) =>
86
- new Promise((res) => {
87
- window.setTimeout(() => {
88
- const formValues = form.getValues();
89
-
90
- const updatedEntity: MyEntity = {
91
- ...state.entity,
92
- ...formValues,
93
- extendedFields,
94
- tags,
95
- };
96
-
97
- console.log('updated entity:', updatedEntity);
98
-
99
- if (state.entity?.id) {
100
- console.log('update request');
101
- } else {
102
- console.log('create request');
103
- }
104
-
105
- res({ updatedEntity });
106
- }, 1000);
107
- }),
108
- saveErrorToast: (e) => 'Failed to save',
109
- fetch: () =>
110
- new Promise((res) => {
111
- window.setTimeout(
112
- () =>
113
- res({
114
- entity: {
115
- id: 'id',
116
- name: 'Entity Name',
117
- booleanField: true,
118
- createdDate: new window.Date(),
119
- updatedDate: new window.Date(),
120
- extendedFields: {
121
- namespaces: {
122
- _user_fields: {
123
- datetime: '2023-05-31T21:00:00.000Z',
124
- date: '1990-06-13',
125
- shortText: 'Hello world!',
126
- longText: 'Hello world! '.repeat(15),
127
- checkbox: true,
128
- decimal: 3.14,
129
- integer: 43,
130
- url: 'https://www.wix.com/',
131
- },
132
- },
133
- },
134
- tags: { privateTags: { tagIds: [] } },
135
- },
136
- }),
137
- 500,
138
- );
139
- }),
140
- });
141
-
142
- // Usually we will extract this component to a separate file
143
- const MainContent = () => {
144
- const pageState = useEntityPageContext<MyEntity, FormFields>();
145
-
146
- const name = useController({
147
- name: 'name',
148
- control: pageState.form.control,
149
- defaultValue: pageState.entity?.name,
150
- rules: { required: { value: true, message: 'This field is required!' } },
151
- });
152
-
153
- const booleanField = useController({
154
- name: 'booleanField',
155
- control: pageState.form.control,
156
- defaultValue: pageState.entity?.booleanField,
157
- });
158
-
159
- return (
160
- <Card.Content>
161
- <Box gap="SP2" direction="vertical">
162
- <FormField label="Name">
163
- <Input
164
- dataHook="name-input"
165
- status={name.fieldState.invalid ? 'error' : undefined}
166
- statusMessage={name.fieldState.error?.message}
167
- inputRef={name.field.ref}
168
- value={name.field.value}
169
- onChange={name.field.onChange}
170
- onBlur={name.field.onBlur}
171
- />
172
- </FormField>
173
- <FormField label="Boolean Field">
174
- <Checkbox
175
- dataHook="boolean-field-checkbox"
176
- checked={booleanField.field.value}
177
- onChange={booleanField.field.onChange}
178
- >
179
- Use boolean field
180
- </Checkbox>
181
- </FormField>
182
- </Box>
183
- </Card.Content>
184
- );
185
- };
186
-
187
- const entity = useEntity<MyEntity, FormFields>(state);
188
-
189
- return (
190
- <EntityPage state={state}>
191
- <EntityPage.Header
192
- title={{ text: entity?.name ?? '' }}
193
- subtitle={{
194
- text: `id: ${entity?.id}`,
195
- learnMore: {
196
- url: 'https://www.wix.com/',
197
- label: 'My custom learn more', // Defaults to "Learn more"
198
- },
199
- }}
200
- moreActions={
201
- <MoreActions
202
- containerId="cd910877-1bb2-445e-822a-aa04a342c2f5"
203
- items={[
204
- [
205
- {
206
- biName: 'open-subscriptions',
207
- text: 'Open Subscriptions',
208
- prefixIcon: <InvoiceSmall />,
209
- onClick: () => {
210
- console.log('Open Subscriptions');
211
- },
212
- },
213
- ],
214
- ]}
215
- />
216
- }
217
- />
218
- <EntityPage.Content>
219
- <EntityPage.MainContent>
220
- <EntityPage.Card minHeight="24px">
221
- <Card.Header title="Main Content Card" />
222
- <Card.Divider />
223
- <MainContent />
224
- </EntityPage.Card>
225
- <CustomFieldsWidget
226
- fqdn="wix.patterns.dummyservice.v1.dummy_entity"
227
- dataHook="demo-custom-fields-widget"
228
- extendedFields={entity?.extendedFields}
229
- />
230
- </EntityPage.MainContent>
231
- <EntityPage.AdditionalContent>
232
- <EntityPage.Card minHeight="24px">
233
- <Card.Header title="Side Content Card" />
234
- <Card.Divider />
235
- <Card.Content>
236
- <Box gap="SP2" direction="vertical">
237
- <Text>Stretched to 4/12 of available space.</Text>
238
- </Box>
239
- </Card.Content>
240
- </EntityPage.Card>
241
- <EntityPage.Slots containerId="cd910877-1bb2-445e-822a-aa04a342c2f5" />
242
- <TagsWidget
243
- fqdn="wix.patterns.dummyservice.v1.dummy_entity"
244
- dataHook="demo-tags-widget"
245
- entityTypeName="My Entity"
246
- entityId={entity?.id}
247
- initialTags={entity?.tags}
248
- />
249
- </EntityPage.AdditionalContent>
250
- </EntityPage.Content>
251
- </EntityPage>
252
- );
253
- }
254
- ```
41
+ Example code: read `dist/docs/EntityPage/demo.tsx`
255
42
 
256
43
  ## Examples
257
44
 
@@ -261,80 +48,7 @@ function FullExample() {
261
48
 
262
49
  This example demonstrates a basic usage of the `EntityPage`.
263
50
 
264
- ```tsx
265
- import React from 'react';
266
- import {
267
- EntityPage,
268
- EntityPageState,
269
- useEntity,
270
- useEntityPage,
271
- } from '@wix/patterns';
272
- import { useForm } from '@wix/patterns/form';
273
- import { Box, Card, Text } from '@wix/design-system';
274
-
275
- interface MyEntity {
276
- id: string;
277
- name?: string;
278
- createdAt: Date;
279
- updatedAt: Date;
280
- }
281
-
282
- interface FormValues {
283
- name?: string;
284
- }
285
-
286
- function Basic() {
287
- const form = useForm<FormValues>();
288
- const state: EntityPageState<MyEntity, FormValues> = useEntityPage<
289
- MyEntity,
290
- FormValues
291
- >({
292
- parentPageId: '',
293
- form,
294
- onSave: async () => {
295
- const formValues = form.getValues();
296
-
297
- return Promise.resolve({
298
- updatedEntity: {
299
- ...state.entity,
300
- ...formValues,
301
- } as MyEntity,
302
- });
303
- },
304
- saveErrorToast: (e) => 'Failed to save',
305
- fetch: () =>
306
- Promise.resolve({
307
- entity: {
308
- id: 'id',
309
- name: 'Entity Name',
310
- createdAt: new window.Date(),
311
- updatedAt: new window.Date(),
312
- },
313
- }),
314
- });
315
-
316
- const entity = useEntity<MyEntity, FormValues>(state);
317
-
318
- return (
319
- <EntityPage state={state}>
320
- <EntityPage.Header title={{ text: entity?.name ?? '' }} />
321
- <EntityPage.Content>
322
- <EntityPage.MainContent>
323
- <EntityPage.Card minHeight="24px">
324
- <Card.Header title="Name Card" />
325
- <Card.Divider />
326
- <Card.Content>
327
- <Box gap="SP2" direction="vertical">
328
- <Text>{entity?.name}</Text>
329
- </Box>
330
- </Card.Content>
331
- </EntityPage.Card>
332
- </EntityPage.MainContent>
333
- </EntityPage.Content>
334
- </EntityPage>
335
- );
336
- }
337
- ```
51
+ Example code: read `dist/docs/EntityPage/basic.tsx`
338
52
 
339
53
  ---
340
54
 
@@ -342,80 +56,7 @@ function Basic() {
342
56
 
343
57
  This example illustrates the use of both main and additional content.
344
58
 
345
- ```tsx
346
- import React from 'react';
347
- import {
348
- EntityPage,
349
- EntityPageState,
350
- useEntity,
351
- useEntityPage,
352
- } from '@wix/patterns';
353
- import { useForm } from '@wix/patterns/form';
354
- import { Box, Card, Text } from '@wix/design-system';
355
-
356
- interface MyEntity {
357
- id: string;
358
- name?: string;
359
- createdAt: Date;
360
- updatedAt: Date;
361
- }
362
-
363
- function TwoColumns() {
364
- const form = useForm();
365
- const state: EntityPageState<MyEntity> = useEntityPage<MyEntity>({
366
- parentPageId: '',
367
- form,
368
- onSave: () =>
369
- Promise.resolve({
370
- updatedEntity: {
371
- ...state.entity,
372
- } as MyEntity,
373
- }),
374
- saveErrorToast: (e) => 'Failed to save',
375
- fetch: () =>
376
- Promise.resolve({
377
- entity: {
378
- id: 'id',
379
- name: 'Entity Name',
380
- createdAt: new window.Date(),
381
- updatedAt: new window.Date(),
382
- },
383
- }),
384
- });
385
-
386
- const entity = useEntity<MyEntity>(state);
387
-
388
- return (
389
- <EntityPage state={state}>
390
- <EntityPage.Header title={{ text: entity?.name ?? '' }} />
391
- <EntityPage.Content>
392
- <EntityPage.MainContent>
393
- <EntityPage.Card minHeight="24px">
394
- <Card.Header title="Main Content Card" />
395
- <Card.Divider />
396
- <Card.Content>
397
- <Box gap="SP2" direction="vertical">
398
- <Text>Stretched to 8/12 of available space.</Text>
399
- </Box>
400
- </Card.Content>
401
- </EntityPage.Card>
402
- </EntityPage.MainContent>
403
- <EntityPage.AdditionalContent>
404
- <EntityPage.Card minHeight="24px">
405
- <Card.Header title="Side Content Card" />
406
- <Card.Divider />
407
- <Card.Content>
408
- <Box gap="SP2" direction="vertical">
409
- <Text>Stretched to 4/12 of available space.</Text>
410
- </Box>
411
- </Card.Content>
412
- </EntityPage.Card>
413
- </EntityPage.AdditionalContent>
414
- </EntityPage.Content>
415
- </EntityPage>
416
- );
417
- }
418
- ```
59
+ Example code: read `dist/docs/EntityPage/2-columns.tsx`
419
60
 
420
61
  ---
421
62
 
@@ -423,115 +64,7 @@ function TwoColumns() {
423
64
 
424
65
  This sample illustrates the skeleton state of an entity page based on the provided structure.
425
66
 
426
- ```tsx
427
- import React from 'react';
428
- import { EntityPage, EntityPageState, useEntityPage } from '@wix/patterns';
429
- import { useForm } from '@wix/patterns/form';
430
- import { Box, Card, Text } from '@wix/design-system';
431
-
432
- interface MyEntity {
433
- id: string;
434
- name?: string;
435
- createdAt: Date;
436
- updatedAt: Date;
437
- }
438
-
439
- interface FormFields {
440
- id: string;
441
- name?: string;
442
- }
443
-
444
- function Loading() {
445
- const form = useForm<FormFields>();
446
- const state: EntityPageState<MyEntity, FormFields> = useEntityPage<
447
- MyEntity,
448
- FormFields
449
- >({
450
- parentPageId: 'YOUR_PARENT_ID_HERE',
451
- form,
452
- onSave: () =>
453
- new Promise((resolve) => {
454
- const formValues = form.getValues();
455
- console.log('form values:', formValues);
456
-
457
- window.setTimeout(
458
- () =>
459
- resolve({
460
- updatedEntity: {
461
- ...state.entity,
462
- ...formValues,
463
- } as MyEntity,
464
- }),
465
- 1000,
466
- );
467
- }),
468
- saveErrorToast: (e) => 'Failed to save',
469
- fetch: () =>
470
- new Promise((resolve) => {
471
- const dateToResolve = new window.Date(window.Date.now());
472
- // keep waiting :)
473
- if (dateToResolve.getFullYear() === 2500) {
474
- resolve({
475
- entity: {
476
- id: 'id',
477
- name: 'My Entity',
478
- createdAt: new window.Date(),
479
- updatedAt: new window.Date(),
480
- },
481
- });
482
- }
483
- }),
484
- });
485
-
486
- return (
487
- <EntityPage state={state}>
488
- <EntityPage.Header title={{ text: 'Entity Page' }} />
489
- <EntityPage.Content>
490
- <EntityPage.MainContent>
491
- <EntityPage.Card minHeight="24px">
492
- <Card.Header title="Card" />
493
- <Card.Divider />
494
- <Card.Content>
495
- <Box>
496
- <Text>Main Card #1</Text>
497
- </Box>
498
- </Card.Content>
499
- </EntityPage.Card>
500
- <EntityPage.Card minHeight="24px">
501
- <Card.Header title="Card" />
502
- <Card.Divider />
503
- <Card.Content>
504
- <Box>
505
- <Text>Main Card #2</Text>
506
- </Box>
507
- </Card.Content>
508
- </EntityPage.Card>
509
- </EntityPage.MainContent>
510
- <EntityPage.AdditionalContent>
511
- <EntityPage.Card minHeight="24px">
512
- <Card.Header title="Card" />
513
- <Card.Divider />
514
- <Card.Content>
515
- <Box>
516
- <Text>Side Card #1</Text>
517
- </Box>
518
- </Card.Content>
519
- </EntityPage.Card>
520
- <EntityPage.Card minHeight="24px">
521
- <Card.Header title="Card" />
522
- <Card.Divider />
523
- <Card.Content>
524
- <Box>
525
- <Text>Side Card #2</Text>
526
- </Box>
527
- </Card.Content>
528
- </EntityPage.Card>
529
- </EntityPage.AdditionalContent>
530
- </EntityPage.Content>
531
- </EntityPage>
532
- );
533
- }
534
- ```
67
+ Example code: read `dist/docs/EntityPage/loading.tsx`
535
68
 
536
69
  ---
537
70
 
@@ -539,76 +72,7 @@ function Loading() {
539
72
 
540
73
  This example demonstrates the error state when fetching an entity fails.
541
74
 
542
- ```tsx
543
- import React from 'react';
544
- import {
545
- EntityPage,
546
- EntityPageState,
547
- useEntity,
548
- useEntityPage,
549
- } from '@wix/patterns';
550
- import { useForm } from '@wix/patterns/form';
551
- import { Box, Card, Text } from '@wix/design-system';
552
-
553
- interface MyEntity {
554
- id: string;
555
- name?: string;
556
- createdAt: Date;
557
- updatedAt: Date;
558
- }
559
-
560
- function FetchError() {
561
- const form = useForm();
562
- const state: EntityPageState<MyEntity> = useEntityPage<MyEntity>({
563
- parentPageId: '',
564
- form,
565
- onSave: async () => {
566
- return Promise.resolve({
567
- updatedEntity: {
568
- ...state.entity,
569
- } as MyEntity,
570
- });
571
- },
572
- saveErrorToast: (e) => 'Failed to save',
573
- fetch: () =>
574
- new Promise((_, reject) =>
575
- window.setTimeout(() => reject(new Error('Something went wrong')), 1000),
576
- ),
577
- });
578
-
579
- const entity = useEntity<MyEntity>(state);
580
-
581
- return (
582
- <EntityPage state={state}>
583
- <EntityPage.Header title={{ text: entity?.name ?? '' }} />
584
- <EntityPage.Content>
585
- <EntityPage.MainContent>
586
- <EntityPage.Card minHeight="24px">
587
- <Card.Header title="Main Content Card" />
588
- <Card.Divider />
589
- <Card.Content>
590
- <Box gap="SP2" direction="vertical">
591
- <Text>Stretched to 8/12 of available space.</Text>
592
- </Box>
593
- </Card.Content>
594
- </EntityPage.Card>
595
- </EntityPage.MainContent>
596
- <EntityPage.AdditionalContent>
597
- <EntityPage.Card minHeight="24px">
598
- <Card.Header title="Side Content Card" />
599
- <Card.Divider />
600
- <Card.Content>
601
- <Box gap="SP2" direction="vertical">
602
- <Text>Stretched to 4/12 of available space.</Text>
603
- </Box>
604
- </Card.Content>
605
- </EntityPage.Card>
606
- </EntityPage.AdditionalContent>
607
- </EntityPage.Content>
608
- </EntityPage>
609
- );
610
- }
611
- ```
75
+ Example code: read `dist/docs/EntityPage/error-on-fetch.tsx`
612
76
 
613
77
  ---
614
78
 
@@ -616,67 +80,7 @@ function FetchError() {
616
80
 
617
81
  This example demonstrates the error toast when saving an entity fails.
618
82
 
619
- ```tsx
620
- import React from 'react';
621
- import {
622
- EntityPage,
623
- EntityPageState,
624
- useEntity,
625
- useEntityPage,
626
- } from '@wix/patterns';
627
- import { useForm } from '@wix/patterns/form';
628
- import { Box, Card, Text } from '@wix/design-system';
629
-
630
- interface MyEntity {
631
- id: string;
632
- name?: string;
633
- createdAt: Date;
634
- updatedAt: Date;
635
- }
636
-
637
- function SaveError() {
638
- const form = useForm();
639
- const state: EntityPageState<MyEntity> = useEntityPage<MyEntity>({
640
- parentPageId: '',
641
- form,
642
- onSave: () => Promise.reject(new Error('Something went wrong')),
643
- saveErrorToast: (e, { retry }) => ({
644
- message: 'oops.. unknown error',
645
- action: { text: 'Retry', onClick: retry },
646
- }),
647
- fetch: () =>
648
- Promise.resolve({
649
- entity: {
650
- id: 'id',
651
- name: 'Entity Name',
652
- createdAt: new window.Date(),
653
- updatedAt: new window.Date(),
654
- },
655
- }),
656
- });
657
-
658
- const entity = useEntity<MyEntity>(state);
659
-
660
- return (
661
- <EntityPage state={state}>
662
- <EntityPage.Header title={{ text: entity?.name ?? '' }} />
663
- <EntityPage.Content>
664
- <EntityPage.MainContent>
665
- <EntityPage.Card minHeight="24px">
666
- <Card.Header title="Card" />
667
- <Card.Divider />
668
- <Card.Content>
669
- <Box gap="SP2" direction="vertical">
670
- <Text>I'm a card</Text>
671
- </Box>
672
- </Card.Content>
673
- </EntityPage.Card>
674
- </EntityPage.MainContent>
675
- </EntityPage.Content>
676
- </EntityPage>
677
- );
678
- }
679
- ```
83
+ Example code: read `dist/docs/EntityPage/error-on-save.tsx`
680
84
 
681
85
  ---
682
86
 
@@ -684,83 +88,7 @@ function SaveError() {
684
88
 
685
89
  This examples demonstrates how to use the `saveCta` prop to override the default **Save** button text.
686
90
 
687
- ```tsx
688
- import React from 'react';
689
- import {
690
- EntityPage,
691
- EntityPageState,
692
- useEntity,
693
- useEntityPage,
694
- } from '@wix/patterns';
695
- import { useForm } from '@wix/patterns/form';
696
- import { Box, Card, Text } from '@wix/design-system';
697
-
698
- interface MyEntity {
699
- id: string;
700
- name?: string;
701
- createdAt: Date;
702
- updatedAt: Date;
703
- }
704
-
705
- interface FormValues {
706
- name?: string;
707
- }
708
-
709
- function SaveCta() {
710
- const form = useForm<FormValues>();
711
- const state: EntityPageState<MyEntity, FormValues> = useEntityPage<
712
- MyEntity,
713
- FormValues
714
- >({
715
- parentPageId: 'YOUR_PARENT_PAGE_ID',
716
- form,
717
- onSave: async () => {
718
- const formValues = form.getValues();
719
-
720
- return Promise.resolve({
721
- updatedEntity: {
722
- ...state.entity,
723
- ...formValues,
724
- } as MyEntity,
725
- });
726
- },
727
- saveErrorToast: (e) => 'Failed to save',
728
- fetch: () =>
729
- Promise.resolve({
730
- entity: {
731
- id: 'id',
732
- name: 'Entity Name',
733
- createdAt: new window.Date(),
734
- updatedAt: new window.Date(),
735
- },
736
- }),
737
- });
738
-
739
- const entity = useEntity<MyEntity, FormValues>(state);
740
-
741
- return (
742
- <EntityPage
743
- state={state}
744
- actionsBarConfig={{ saveCta: { text: 'ACTIVATE' } }}
745
- >
746
- <EntityPage.Header title={{ text: entity?.name ?? '' }} />
747
- <EntityPage.Content>
748
- <EntityPage.MainContent>
749
- <EntityPage.Card minHeight="24px">
750
- <Card.Header title="Name Card" />
751
- <Card.Divider />
752
- <Card.Content>
753
- <Box gap="SP2" direction="vertical">
754
- <Text>{entity?.name}</Text>
755
- </Box>
756
- </Card.Content>
757
- </EntityPage.Card>
758
- </EntityPage.MainContent>
759
- </EntityPage.Content>
760
- </EntityPage>
761
- );
762
- }
763
- ```
91
+ Example code: read `dist/docs/EntityPage/overriding-save-button-text.tsx`
764
92
 
765
93
  ---
766
94
 
@@ -768,85 +96,7 @@ function SaveCta() {
768
96
 
769
97
  This example demonstrates how to enable item deletion from the entity page using the `deleteAction` option. A delete icon button appears in the actions bar. Clicking it opens a confirmation modal, and on success Cairo shows a toast and navigates back to the collection page.
770
98
 
771
- ```tsx
772
- import React from 'react';
773
- import {
774
- EntityPage,
775
- EntityPageState,
776
- useEntity,
777
- useEntityPage,
778
- } from '@wix/patterns';
779
- import { useForm } from '@wix/patterns/form';
780
- import { Box, Card, Text } from '@wix/design-system';
781
-
782
- interface MyEntity {
783
- id: string;
784
- name?: string;
785
- createdAt: Date;
786
- updatedAt: Date;
787
- }
788
-
789
- interface FormValues {
790
- name?: string;
791
- }
792
-
793
- function Delete() {
794
- const form = useForm<FormValues>();
795
- const state: EntityPageState<MyEntity, FormValues> = useEntityPage<
796
- MyEntity,
797
- FormValues
798
- >({
799
- parentPageId: '',
800
- form,
801
- onSave: async () => {
802
- const formValues = form.getValues();
803
-
804
- return Promise.resolve({
805
- updatedEntity: {
806
- ...state.entity,
807
- ...formValues,
808
- } as MyEntity,
809
- });
810
- },
811
- fetch: () =>
812
- Promise.resolve({
813
- entity: {
814
- id: 'entity-1',
815
- name: 'Entity Name',
816
- createdAt: new window.Date(),
817
- updatedAt: new window.Date(),
818
- },
819
- }),
820
- deleteAction: {
821
- onDelete: async (entity) => {
822
- console.log('Deleted entity:', entity.id);
823
- },
824
- itemName: (entity) => entity.name ?? 'item',
825
- },
826
- });
827
-
828
- const entity = useEntity<MyEntity, FormValues>(state);
829
-
830
- return (
831
- <EntityPage state={state}>
832
- <EntityPage.Header title={{ text: entity?.name ?? '' }} />
833
- <EntityPage.Content>
834
- <EntityPage.MainContent>
835
- <EntityPage.Card minHeight="24px">
836
- <Card.Header title="Name Card" />
837
- <Card.Divider />
838
- <Card.Content>
839
- <Box gap="SP2" direction="vertical">
840
- <Text>{entity?.name}</Text>
841
- </Box>
842
- </Card.Content>
843
- </EntityPage.Card>
844
- </EntityPage.MainContent>
845
- </EntityPage.Content>
846
- </EntityPage>
847
- );
848
- }
849
- ```
99
+ Example code: read `dist/docs/EntityPage/delete-action.tsx`
850
100
 
851
101
  ---
852
102
 
@@ -854,73 +104,7 @@ function Delete() {
854
104
 
855
105
  This example demonstrates error handling when the delete operation fails. A custom `errorToast` provides a retry action.
856
106
 
857
- ```tsx
858
- import React from 'react';
859
- import {
860
- EntityPage,
861
- EntityPageState,
862
- useEntity,
863
- useEntityPage,
864
- } from '@wix/patterns';
865
- import { useForm } from '@wix/patterns/form';
866
- import { Box, Card, Text } from '@wix/design-system';
867
-
868
- interface MyEntity {
869
- id: string;
870
- name?: string;
871
- createdAt: Date;
872
- updatedAt: Date;
873
- }
874
-
875
- function DeleteError() {
876
- const form = useForm();
877
- const state: EntityPageState<MyEntity> = useEntityPage<MyEntity>({
878
- parentPageId: '',
879
- form,
880
- onSave: async () =>
881
- Promise.resolve({
882
- updatedEntity: { ...state.entity } as MyEntity,
883
- }),
884
- fetch: () =>
885
- Promise.resolve({
886
- entity: {
887
- id: 'entity-1',
888
- name: 'Entity Name',
889
- createdAt: new window.Date(),
890
- updatedAt: new window.Date(),
891
- },
892
- }),
893
- deleteAction: {
894
- onDelete: () => Promise.reject(new Error('Something went wrong')),
895
- errorToast: (e, { retry }) => ({
896
- message: 'Failed to delete entity',
897
- action: { text: 'Retry', onClick: retry },
898
- }),
899
- },
900
- });
901
-
902
- const entity = useEntity<MyEntity>(state);
903
-
904
- return (
905
- <EntityPage state={state}>
906
- <EntityPage.Header title={{ text: entity?.name ?? '' }} />
907
- <EntityPage.Content>
908
- <EntityPage.MainContent>
909
- <EntityPage.Card minHeight="24px">
910
- <Card.Header title="Card" />
911
- <Card.Divider />
912
- <Card.Content>
913
- <Box gap="SP2" direction="vertical">
914
- <Text>Click the delete icon to see the error toast.</Text>
915
- </Box>
916
- </Card.Content>
917
- </EntityPage.Card>
918
- </EntityPage.MainContent>
919
- </EntityPage.Content>
920
- </EntityPage>
921
- );
922
- }
923
- ```
107
+ Example code: read `dist/docs/EntityPage/delete-error-handling.tsx`
924
108
 
925
109
  ---
926
110
 
@@ -930,107 +114,7 @@ function DeleteError() {
930
114
 
931
115
  This demonstrates how to use [useController](https://react-hook-form.com/docs/usecontroller) with the default value set at the `Card.Content` level. Note that the `state.entity` value is initialized following the Card skeleton loader. To obtain the initial value, it must be accessed within the Card.Content child, as illustrated in the following example. Accessing it before or at a higher level will result in an `undefined` value.
932
116
 
933
- ```tsx
934
- import React from 'react';
935
- import {
936
- EntityPage,
937
- EntityPageState,
938
- useEntity,
939
- useEntityPage,
940
- useEntityPageContext,
941
- } from '@wix/patterns';
942
- import { useController, useForm } from '@wix/patterns/form';
943
- import { Box, Card, FormField, Input } from '@wix/design-system';
944
- import { CardContainerProps } from '../../../dist/types/components/CardContainer';
945
-
946
- interface MyEntity {
947
- id: string;
948
- name?: string;
949
- createdAt: Date;
950
- updatedAt: Date;
951
- }
952
-
953
- interface FormValues {
954
- name?: string;
955
- }
956
-
957
- function useControllerExample() {
958
- const form = useForm<FormValues>();
959
- const state: EntityPageState<MyEntity, FormValues> = useEntityPage<
960
- MyEntity,
961
- FormValues
962
- >({
963
- parentPageId: '',
964
- form,
965
- onSave: async () => {
966
- const formValues = form.getValues();
967
-
968
- return Promise.resolve({
969
- updatedEntity: {
970
- ...state.entity,
971
- ...formValues,
972
- } as MyEntity,
973
- });
974
- },
975
- saveErrorToast: (e) => 'Failed to save',
976
- fetch: () =>
977
- Promise.resolve({
978
- entity: {
979
- id: 'id',
980
- name: 'Entity Name',
981
- createdAt: new window.Date(),
982
- updatedAt: new window.Date(),
983
- },
984
- }),
985
- });
986
-
987
- // Usually we will extract this component to a separate file
988
- const CardContent = () => {
989
- const pageState = useEntityPageContext<MyEntity, FormValues>();
990
- const name = useController({
991
- name: 'name',
992
- control: pageState.form.control,
993
- defaultValue: pageState.entity?.name,
994
- rules: {
995
- required: { value: true, message: 'This field is required!' },
996
- },
997
- });
998
-
999
- return (
1000
- <Box gap="SP2" direction="vertical">
1001
- <FormField label="Name">
1002
- <Input
1003
- dataHook="name-input"
1004
- inputRef={name.field.ref}
1005
- value={name.field.value}
1006
- onChange={name.field.onChange}
1007
- onBlur={name.field.onBlur}
1008
- />
1009
- </FormField>
1010
- </Box>
1011
- );
1012
- };
1013
-
1014
- const entity = useEntity<MyEntity, FormValues>(state);
1015
-
1016
- return (
1017
- <EntityPage state={state}>
1018
- <EntityPage.Header title={{ text: entity?.name ?? '' }} />
1019
- <EntityPage.Content>
1020
- <EntityPage.MainContent>
1021
- <EntityPage.Card minHeight="24px">
1022
- <Card.Header title="Name Card" />
1023
- <Card.Divider />
1024
- <Card.Content>
1025
- <CardContent />
1026
- </Card.Content>
1027
- </EntityPage.Card>
1028
- </EntityPage.MainContent>
1029
- </EntityPage.Content>
1030
- </EntityPage>
1031
- );
1032
- }
1033
- ```
117
+ Example code: read `dist/docs/EntityPage/input-initialization-with-usecontroller.tsx`
1034
118
 
1035
119
  ---
1036
120
 
@@ -1038,130 +122,18 @@ function useControllerExample() {
1038
122
 
1039
123
  This demonstrates how to use [Controller](https://react-hook-form.com/docs/usecontroller/controller) where you can easily access the entity by using `useEntity`. This method allows for accessing the entity much earlier in the process. As a result, the default value will be dynamically updated as soon as the entity itself is updated, as shown in the example below.
1040
124
 
1041
- ```tsx
1042
- import React from 'react';
1043
- import {
1044
- EntityPage,
1045
- EntityPageState,
1046
- useEntity,
1047
- useEntityPage,
1048
- } from '@wix/patterns';
1049
- import { Controller, useController, useForm } from '@wix/patterns/form';
1050
- import { Box, Card, FormField, Input } from '@wix/design-system';
1051
- import { CardContainerProps } from '../../../dist/types/components/CardContainer';
1052
-
1053
- interface MyEntity {
1054
- id: string;
1055
- name?: string;
1056
- createdAt: Date;
1057
- updatedAt: Date;
1058
- }
1059
-
1060
- interface FormValues {
1061
- name?: string;
1062
- }
1063
-
1064
- function ControllerExample() {
1065
- const form = useForm<FormValues>();
1066
- const state: EntityPageState<MyEntity, FormValues> = useEntityPage<
1067
- MyEntity,
1068
- FormValues
1069
- >({
1070
- parentPageId: '',
1071
- form,
1072
- onSave: async () => {
1073
- const formValues = form.getValues();
1074
-
1075
- return Promise.resolve({
1076
- updatedEntity: {
1077
- ...state.entity,
1078
- ...formValues,
1079
- } as MyEntity,
1080
- });
1081
- },
1082
- saveErrorToast: (e) => 'Failed to save',
1083
- fetch: () =>
1084
- Promise.resolve({
1085
- entity: {
1086
- id: 'id',
1087
- name: 'Entity Name',
1088
- createdAt: new window.Date(),
1089
- updatedAt: new window.Date(),
1090
- },
1091
- }),
1092
- });
1093
-
1094
- const entity = useEntity<MyEntity, FormValues>(state);
1095
-
1096
- return (
1097
- <EntityPage state={state}>
1098
- <EntityPage.Header title={{ text: entity?.name ?? '' }} />
1099
- <EntityPage.Content>
1100
- <EntityPage.MainContent>
1101
- <EntityPage.Card minHeight="24px">
1102
- <Card.Header title="Name Card" />
1103
- <Card.Divider />
1104
- <Card.Content>
1105
- <Controller
1106
- control={form.control}
1107
- name="name"
1108
- defaultValue={entity?.name}
1109
- rules={{
1110
- required: { value: true, message: 'This field is required!' },
1111
- }}
1112
- render={({
1113
- field: { onChange, onBlur, value, ref },
1114
- fieldState: { invalid, error },
1115
- }) => (
1116
- <FormField
1117
- label="Name"
1118
- status={invalid ? 'error' : undefined}
1119
- statusMessage={error?.message}
1120
- >
1121
- <Input
1122
- dataHook="name-input"
1123
- inputRef={ref}
1124
- value={value}
1125
- onChange={onChange}
1126
- onBlur={onBlur}
1127
- />
1128
- </FormField>
1129
- )}
1130
- />
1131
- </Card.Content>
1132
- </EntityPage.Card>
1133
- </EntityPage.MainContent>
1134
- </EntityPage.Content>
1135
- </EntityPage>
1136
- );
1137
- }
1138
- ```
125
+ Example code: read `dist/docs/EntityPage/input-initialization-with-controller.tsx`
1139
126
 
1140
127
  ## API
1141
128
 
1142
- ### Extends
1143
-
1144
- [Page](https://www.docs.wixdesignsystem.com/?path=/story/components-layout-page--page)
1145
-
1146
129
  ### Props
1147
130
 
1148
- | Prop | Type | Required | Default | Description |
1149
- |------|------|----------|---------|-------------|
1150
- | `state` | `EntityPageState<T, V>` | Yes | - | EntityPageState instance created with the `useEntityPage` hook |
1151
- | `actionsBarConfig` | `ActionsBarConfig` | No | - | Configuration for the actions bar |
1152
- | `children` | `ReactNode` | No | - | Accepts compound components as child items: - `<Page.Header/>` - `<Page.Content/>` - `<Page.Tail/>` - `<Page.Section/>` - `<Page.Footer/>` |
1153
- | `dataHook` | `string` | No | - | Applies a data-hook HTML attribute that can be used in the tests |
1154
- | `backgroundImageUrl` | `string` | No | - | Provides a link to the background image source (URL). Image will be displayed at the top of a page, underneath the \<Page.Header/>. |
1155
- | `maxWidth` | `number` | No | - | Sets the maximum width of the page (paddings excluded) |
1156
- | `minWidth` | `number` | No | - | Sets the minimum width of the page (paddings excluded). When `mobile` is enabled on `<WixDesignSystemProvider/>`, the default minimum width is removed, but an explicitly provided value is still applied. |
1157
- | `height` | `string` | No | - | Sets the height of the page in pixels (px), viewport height (vh), etc. |
1158
- | `sidePadding` | `number` | No | - | Sets the side paddings of a page |
1159
- | `className` | `string` | No | - | Specifies a CSS class name to be appended to the component’s root element. |
1160
- | `gradientClassName` | `string` | No | - | Specifies a CSS class name that defines a gradient background for \<Page.Header/> |
1161
- | `scrollableContentRef` | `((ref: HTMLElement \| null) => void)` | No | - | Defines a reference called together with page scrollable content ref after page mount. <br/> **Note** - if you need this ref only for listening to scroll events on the scrollable content then use this prop instead: `scrollProps = {onScrollChanged/onScrollAreaChanged}` |
1162
- | `zIndex` | `number` | No | - | Specifies the stack order (z-index) of a page |
1163
- | `horizontalScroll` | `boolean` | No | - | Enables page content to scroll horizontally when its width exceed maximum allowed width |
1164
- | `scrollProps` | `ScrollableContainerCommonProps` | No | - | Pass properties related to the scrollable content of the page. <br/> **onScrollAreaChanged** - defines a handler function for scroll area changes. Function is triggered when the user scrolls to a different area of the scrollable content. See signature for possible areas: `function({area: {y: AreaY, x: AreaX}, target: HTMLElement}) => void` `AreaY`: top \| middle \| bottom \| none `AreaX`: start \| middle \| end \| none (not implemented yet) <br/> **onScrollAreaChanged** - defines a general handler for scroll changes with throttling (100ms): `function({target: HTMLElement}) => void` |
131
+ Read `dist/dts-bundle/components/EntityPage.d.ts` for `EntityPage`'s full prop list, with types and
132
+ descriptions. They are not repeated here, so the bundle is the single source of truth.
133
+
134
+ A one-line stub in that file is an answer, not a truncation: an empty body with a
135
+ "Produced by" note means you get the value from that hook or factory rather than
136
+ constructing it. `dist/dts-bundle/index.json` maps every name to its bundle path.
1165
137
 
1166
138
  ## BI
1167
139