@wix/patterns 1.474.0 → 1.476.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.
- package/dist/cjs/components/CardContainer/CardContainer.st.css.js +2 -2
- package/dist/cjs/components/CardContainer/CardContainer.st.css.js.map +1 -1
- package/dist/cjs/components/CmsFieldManagement/CmsFieldForm.st.css.js +3 -3
- package/dist/cjs/components/CmsFieldManagement/CmsFieldForm.st.css.js.map +1 -1
- package/dist/cjs/components/CmsFieldManagement/CmsFieldModal.st.css.js +3 -3
- package/dist/cjs/components/CmsFieldManagement/CmsFieldModal.st.css.js.map +1 -1
- package/dist/cjs/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js +3 -3
- package/dist/cjs/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js.map +1 -1
- package/dist/cjs/components/Collapse/Collapse.st.css.js +3 -3
- package/dist/cjs/components/Collapse/Collapse.st.css.js.map +1 -1
- package/dist/cjs/components/CollectionPageNew/CollectionPage.st.css.js +2 -2
- package/dist/cjs/components/CollectionPageNew/CollectionPage.st.css.js.map +1 -1
- package/dist/cjs/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js +3 -3
- package/dist/cjs/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js.map +1 -1
- package/dist/cjs/components/CollectionTable/CollectionTable.st.css.js +2 -2
- package/dist/cjs/components/CollectionTable/CollectionTable.st.css.js.map +1 -1
- package/dist/cjs/components/CollectionTable/CollectionTableWSRTable.st.css.js +2 -2
- package/dist/cjs/components/CollectionTable/CollectionTableWSRTable.st.css.js.map +1 -1
- package/dist/cjs/components/CollectionToolbar/CollectionToolbar.st.css.js +5 -5
- package/dist/cjs/components/CollectionToolbar/CollectionToolbar.st.css.js.map +1 -1
- package/dist/cjs/components/CollectionToolbar/SearchOrCustomFilter.st.css.js +4 -4
- package/dist/cjs/components/CollectionToolbar/SearchOrCustomFilter.st.css.js.map +1 -1
- package/dist/cjs/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js +2 -2
- package/dist/cjs/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js.map +1 -1
- package/dist/cjs/components/CollectionViewsDropdown/ViewsDropdown.st.css.js +2 -2
- package/dist/cjs/components/CollectionViewsDropdown/ViewsDropdown.st.css.js.map +1 -1
- package/dist/cjs/components/DragHandle/DragHandle.st.css.js +2 -2
- package/dist/cjs/components/DragHandle/DragHandle.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/EditableCell.js +5 -4
- package/dist/cjs/components/EditableTable/EditableCell.js.map +1 -1
- package/dist/cjs/components/EditableTable/EditableCell.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/EditableCell.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/HeaderActionsPopover.st.css.js +2 -2
- package/dist/cjs/components/EditableTable/HeaderActionsPopover.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/CellViewLayout.st.css.js +2 -2
- package/dist/cjs/components/EditableTable/cellTypes/CellViewLayout.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/address/Edit.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/address/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/array/Edit.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/array/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/boolean/Edit.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/boolean/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/boolean/View.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/boolean/View.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/color/Edit.st.css.js +2 -2
- package/dist/cjs/components/EditableTable/cellTypes/color/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/date/Edit.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/date/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/date/View.st.css.js +2 -2
- package/dist/cjs/components/EditableTable/cellTypes/date/View.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/datetime/Edit.st.css.js +8 -8
- package/dist/cjs/components/EditableTable/cellTypes/datetime/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/datetime/View.js +9 -5
- package/dist/cjs/components/EditableTable/cellTypes/datetime/View.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/datetime/View.st.css.js +7 -7
- package/dist/cjs/components/EditableTable/cellTypes/datetime/View.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/email/Edit.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/email/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/email/View.st.css.js +2 -2
- package/dist/cjs/components/EditableTable/cellTypes/email/View.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/number/Edit.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/number/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/number/View.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/number/View.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/object/Edit.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/object/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/object/View.st.css.js +2 -2
- package/dist/cjs/components/EditableTable/cellTypes/object/View.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/select/Edit.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/select/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/text/Edit.st.css.js +4 -4
- package/dist/cjs/components/EditableTable/cellTypes/text/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/text/View.st.css.js +2 -2
- package/dist/cjs/components/EditableTable/cellTypes/text/View.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/time/Edit.st.css.js +4 -4
- package/dist/cjs/components/EditableTable/cellTypes/time/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/url/Edit.st.css.js +3 -3
- package/dist/cjs/components/EditableTable/cellTypes/url/Edit.st.css.js.map +1 -1
- package/dist/cjs/components/EditableTable/cellTypes/url/View.st.css.js +5 -5
- package/dist/cjs/components/EditableTable/cellTypes/url/View.st.css.js.map +1 -1
- package/dist/cjs/components/EmptyState/EmptyStateBase.st.css.js +2 -2
- package/dist/cjs/components/EmptyState/EmptyStateBase.st.css.js.map +1 -1
- package/dist/cjs/components/EntityPage/EntityPagePlain.st.css.js +2 -2
- package/dist/cjs/components/EntityPage/EntityPagePlain.st.css.js.map +1 -1
- package/dist/cjs/components/Fade/Fade.st.css.js +2 -2
- package/dist/cjs/components/Fade/Fade.st.css.js.map +1 -1
- package/dist/cjs/components/Heading/Heading.st.css.js +2 -2
- package/dist/cjs/components/Heading/Heading.st.css.js.map +1 -1
- package/dist/cjs/components/ImportButton/ImportStepUpload.st.css.js +3 -3
- package/dist/cjs/components/ImportButton/ImportStepUpload.st.css.js.map +1 -1
- package/dist/cjs/components/InputOverflow/InputOverflow.st.css.js +2 -2
- package/dist/cjs/components/InputOverflow/InputOverflow.st.css.js.map +1 -1
- package/dist/cjs/components/LoadingRow/LoadingRow.st.css.js +3 -3
- package/dist/cjs/components/LoadingRow/LoadingRow.st.css.js.map +1 -1
- package/dist/cjs/components/MaxHeightText/MaxHeightText.st.css.js +2 -2
- package/dist/cjs/components/MaxHeightText/MaxHeightText.st.css.js.map +1 -1
- package/dist/cjs/components/MaxLines/MaxLines.st.css.js +2 -2
- package/dist/cjs/components/MaxLines/MaxLines.st.css.js.map +1 -1
- package/dist/cjs/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js +5 -5
- package/dist/cjs/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js.map +1 -1
- package/dist/cjs/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js +2 -2
- package/dist/cjs/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js.map +1 -1
- package/dist/cjs/components/NestedTable/NestedTableRow.st.css.js +5 -5
- package/dist/cjs/components/NestedTable/NestedTableRow.st.css.js.map +1 -1
- package/dist/cjs/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js +2 -2
- package/dist/cjs/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js.map +1 -1
- package/dist/cjs/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js +2 -2
- package/dist/cjs/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js.map +1 -1
- package/dist/cjs/components/PickerContent/PickerContent.st.css.js +2 -2
- package/dist/cjs/components/PickerContent/PickerContent.st.css.js.map +1 -1
- package/dist/cjs/components/PickerContent/PickerContentAdditionalStep.st.css.js +4 -4
- package/dist/cjs/components/PickerContent/PickerContentAdditionalStep.st.css.js.map +1 -1
- package/dist/cjs/components/PickerTableListItem/PickerTableListItem.st.css.js +2 -2
- package/dist/cjs/components/PickerTableListItem/PickerTableListItem.st.css.js.map +1 -1
- package/dist/cjs/components/ScrollableContent/ScrollableContent.st.css.js +2 -2
- package/dist/cjs/components/ScrollableContent/ScrollableContent.st.css.js.map +1 -1
- package/dist/cjs/components/SetupWidget/SetupStepRow.js +45 -30
- package/dist/cjs/components/SetupWidget/SetupStepRow.js.map +1 -1
- package/dist/cjs/components/SetupWidget/SetupWidget.js +16 -21
- package/dist/cjs/components/SetupWidget/SetupWidget.js.map +1 -1
- package/dist/cjs/components/SetupWidget/SetupWidget.st.css.js +10 -10
- package/dist/cjs/components/SetupWidget/SetupWidget.st.css.js.map +1 -1
- package/dist/cjs/components/SetupWidget/SetupWidget.uni.driver.js.map +1 -1
- package/dist/cjs/components/SkeletonCard/SkeletonCard.st.css.js +3 -3
- package/dist/cjs/components/SkeletonCard/SkeletonCard.st.css.js.map +1 -1
- package/dist/cjs/components/SlidingModal/SlidingModal.st.css.js +2 -2
- package/dist/cjs/components/SlidingModal/SlidingModal.st.css.js.map +1 -1
- package/dist/cjs/components/Table/AddFieldColumnHeader.st.css.js +6 -6
- package/dist/cjs/components/Table/AddFieldColumnHeader.st.css.js.map +1 -1
- package/dist/cjs/components/TabsFilter/TabsFilter.st.css.js +3 -3
- package/dist/cjs/components/TabsFilter/TabsFilter.st.css.js.map +1 -1
- package/dist/cjs/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js +2 -2
- package/dist/cjs/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js.map +1 -1
- package/dist/cjs/components/ToolbarItem/ToolbarItem.st.css.js +2 -2
- package/dist/cjs/components/ToolbarItem/ToolbarItem.st.css.js.map +1 -1
- package/dist/cjs/components/ToolbarItemBox/ToolbarItemBox.st.css.js +2 -2
- package/dist/cjs/components/ToolbarItemBox/ToolbarItemBox.st.css.js.map +1 -1
- package/dist/cjs/components/common.st.css.js +4 -4
- package/dist/cjs/components/common.st.css.js.map +1 -1
- package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css.js +2 -2
- package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css.js.map +1 -1
- package/dist/cjs/state/CollectionPage/TitleBadges.st.css.js +4 -4
- package/dist/cjs/state/CollectionPage/TitleBadges.st.css.js.map +1 -1
- package/dist/cjs/state/FormPage/FormPageHeader.st.css.js +2 -2
- package/dist/cjs/state/FormPage/FormPageHeader.st.css.js.map +1 -1
- package/dist/cjs/styles.global.css +2 -2
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/version.js.map +1 -1
- package/dist/docs/ImportButton.md +1 -1
- package/dist/docs/PickerContent.md +3 -3
- package/dist/docs/TableGridSwitchFolders.md +2 -2
- package/dist/docs/index.json +646 -646
- package/dist/dts-bundle/index.json +6 -6
- package/dist/dts-bundle/index.txt +1 -1
- package/dist/dts-bundle/types/SchemaSource.d.ts +2 -0
- package/dist/esm/components/CardContainer/CardContainer.st.css.js +2 -2
- package/dist/esm/components/CardContainer/CardContainer.st.css.js.map +1 -1
- package/dist/esm/components/CmsFieldManagement/CmsFieldForm.st.css.js +2 -2
- package/dist/esm/components/CmsFieldManagement/CmsFieldForm.st.css.js.map +1 -1
- package/dist/esm/components/CmsFieldManagement/CmsFieldModal.st.css.js +2 -2
- package/dist/esm/components/CmsFieldManagement/CmsFieldModal.st.css.js.map +1 -1
- package/dist/esm/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js +2 -2
- package/dist/esm/components/Collapse/Collapse.st.css.js +2 -2
- package/dist/esm/components/CollectionPageNew/CollectionPage.st.css.js +2 -2
- package/dist/esm/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js +2 -2
- package/dist/esm/components/CollectionTable/CollectionTable.st.css.js +2 -2
- package/dist/esm/components/CollectionTable/CollectionTableWSRTable.st.css.js +2 -2
- package/dist/esm/components/CollectionTable/CollectionTableWSRTable.st.css.js.map +1 -1
- package/dist/esm/components/CollectionToolbar/CollectionToolbar.st.css.js +2 -2
- package/dist/esm/components/CollectionToolbar/CollectionToolbar.st.css.js.map +1 -1
- package/dist/esm/components/CollectionToolbar/SearchOrCustomFilter.st.css.js +2 -2
- package/dist/esm/components/CollectionToolbar/SearchOrCustomFilter.st.css.js.map +1 -1
- package/dist/esm/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js +2 -2
- package/dist/esm/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js.map +1 -1
- package/dist/esm/components/CollectionViewsDropdown/ViewsDropdown.st.css.js +2 -2
- package/dist/esm/components/CollectionViewsDropdown/ViewsDropdown.st.css.js.map +1 -1
- package/dist/esm/components/DragHandle/DragHandle.st.css.js +2 -2
- package/dist/esm/components/DragHandle/DragHandle.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/EditableCell.js +1 -1
- package/dist/esm/components/EditableTable/EditableCell.js.map +1 -1
- package/dist/esm/components/EditableTable/EditableCell.st.css.js +2 -2
- package/dist/esm/components/EditableTable/EditableCell.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/HeaderActionsPopover.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/CellViewLayout.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/address/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/address/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/array/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/array/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/boolean/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/boolean/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/boolean/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/color/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/color/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/date/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/date/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/datetime/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/datetime/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/datetime/View.js +4 -1
- package/dist/esm/components/EditableTable/cellTypes/datetime/View.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/datetime/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/email/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/email/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/email/View.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/number/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/number/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/number/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/object/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/object/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/object/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/select/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/select/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/text/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/text/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/text/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/text/View.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/time/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/time/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/url/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/url/View.st.css.js +2 -2
- package/dist/esm/components/EmptyState/EmptyStateBase.st.css.js +2 -2
- package/dist/esm/components/EntityPage/EntityPagePlain.st.css.js +2 -2
- package/dist/esm/components/Fade/Fade.st.css.js +2 -2
- package/dist/esm/components/Fade/Fade.st.css.js.map +1 -1
- package/dist/esm/components/Heading/Heading.st.css.js +2 -2
- package/dist/esm/components/ImportButton/ImportStepUpload.st.css.js +2 -2
- package/dist/esm/components/InputOverflow/InputOverflow.st.css.js +2 -2
- package/dist/esm/components/LoadingRow/LoadingRow.st.css.js +3 -3
- package/dist/esm/components/LoadingRow/LoadingRow.st.css.js.map +1 -1
- package/dist/esm/components/MaxHeightText/MaxHeightText.st.css.js +2 -2
- package/dist/esm/components/MaxHeightText/MaxHeightText.st.css.js.map +1 -1
- package/dist/esm/components/MaxLines/MaxLines.st.css.js +2 -2
- package/dist/esm/components/MaxLines/MaxLines.st.css.js.map +1 -1
- package/dist/esm/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js +2 -2
- package/dist/esm/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js +2 -2
- package/dist/esm/components/NestedTable/NestedTableRow.st.css.js +2 -2
- package/dist/esm/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js +2 -2
- package/dist/esm/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js +2 -2
- package/dist/esm/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.js.map +1 -1
- package/dist/esm/components/PickerContent/PickerContent.st.css.js +2 -2
- package/dist/esm/components/PickerContent/PickerContentAdditionalStep.st.css.js +2 -2
- package/dist/esm/components/PickerTableListItem/PickerTableListItem.st.css.js +2 -2
- package/dist/esm/components/ScrollableContent/ScrollableContent.st.css.js +2 -2
- package/dist/esm/components/SetupWidget/SetupStepRow.js +16 -4
- package/dist/esm/components/SetupWidget/SetupStepRow.js.map +1 -1
- package/dist/esm/components/SetupWidget/SetupWidget.js +1 -5
- package/dist/esm/components/SetupWidget/SetupWidget.js.map +1 -1
- package/dist/esm/components/SetupWidget/SetupWidget.st.css.js +2 -2
- package/dist/esm/components/SetupWidget/SetupWidget.uni.driver.js +1 -3
- package/dist/esm/components/SetupWidget/SetupWidget.uni.driver.js.map +1 -1
- package/dist/esm/components/SkeletonCard/SkeletonCard.st.css.js +2 -2
- package/dist/esm/components/SlidingModal/SlidingModal.st.css.js +2 -2
- package/dist/esm/components/Table/AddFieldColumnHeader.st.css.js +2 -2
- package/dist/esm/components/TabsFilter/TabsFilter.st.css.js +2 -2
- package/dist/esm/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js +2 -2
- package/dist/esm/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js.map +1 -1
- package/dist/esm/components/ToolbarItem/ToolbarItem.st.css.js +2 -2
- package/dist/esm/components/ToolbarItemBox/ToolbarItemBox.st.css.js +2 -2
- package/dist/esm/components/ToolbarItemBox/ToolbarItemBox.st.css.js.map +1 -1
- package/dist/esm/components/common.st.css.js +2 -2
- package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css.js +2 -2
- package/dist/esm/state/CollectionPage/TitleBadges.st.css.js +2 -2
- package/dist/esm/state/CollectionPage/TitleBadges.st.css.js.map +1 -1
- package/dist/esm/state/FormPage/FormPageHeader.st.css.js +2 -2
- package/dist/esm/state/FormPage/FormPageHeader.st.css.js.map +1 -1
- package/dist/esm/styles.global.css +2 -2
- package/dist/esm/version.js +1 -1
- package/dist/types/components/CardContainer/CardContainer.st.css.d.ts.map +1 -1
- package/dist/types/components/CmsFieldManagement/CmsFieldForm.st.css.d.ts.map +1 -1
- package/dist/types/components/CmsFieldManagement/CmsFieldModal.st.css.d.ts.map +1 -1
- package/dist/types/components/CollectionTable/CollectionTableWSRTable.st.css.d.ts.map +1 -1
- package/dist/types/components/CollectionToolbar/CollectionToolbar.st.css.d.ts.map +1 -1
- package/dist/types/components/CollectionToolbar/SearchOrCustomFilter.st.css.d.ts.map +1 -1
- package/dist/types/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.d.ts.map +1 -1
- package/dist/types/components/CollectionViewsDropdown/ViewsDropdown.st.css.d.ts.map +1 -1
- package/dist/types/components/DragHandle/DragHandle.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/EditableCell.d.ts.map +1 -1
- package/dist/types/components/EditableTable/EditableCell.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/address/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/array/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/boolean/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/color/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/datetime/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/datetime/View.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/email/View.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/number/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/object/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/select/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/text/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/text/View.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/time/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/Fade/Fade.st.css.d.ts.map +1 -1
- package/dist/types/components/LoadingRow/LoadingRow.st.css.d.ts.map +1 -1
- package/dist/types/components/MaxHeightText/MaxHeightText.st.css.d.ts.map +1 -1
- package/dist/types/components/MaxLines/MaxLines.st.css.d.ts.map +1 -1
- package/dist/types/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.d.ts.map +1 -1
- package/dist/types/components/SetupWidget/SetupStepRow.d.ts +2 -4
- package/dist/types/components/SetupWidget/SetupStepRow.d.ts.map +1 -1
- package/dist/types/components/SetupWidget/SetupWidget.d.ts.map +1 -1
- package/dist/types/components/SetupWidget/SetupWidget.uni.driver.d.ts.map +1 -1
- package/dist/types/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.d.ts.map +1 -1
- package/dist/types/components/ToolbarItemBox/ToolbarItemBox.st.css.d.ts.map +1 -1
- package/dist/types/state/CollectionPage/TitleBadges.st.css.d.ts.map +1 -1
- package/dist/types/state/FormPage/FormPageHeader.st.css.d.ts.map +1 -1
- package/dist/types/version.d.ts +1 -1
- package/package.json +7 -7
- package/src/components/CardContainer/CardContainer.st.css.ts +2 -2
- package/src/components/CmsFieldManagement/CmsFieldForm.st.css.ts +2 -2
- package/src/components/CmsFieldManagement/CmsFieldModal.st.css.ts +2 -2
- package/src/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.ts +2 -2
- package/src/components/Collapse/Collapse.st.css.ts +2 -2
- package/src/components/CollectionPageNew/CollectionPage.st.css.ts +2 -2
- package/src/components/CollectionSectionHeader/CollectionSectionHeader.st.css.ts +2 -2
- package/src/components/CollectionTable/CollectionTable.st.css.ts +2 -2
- package/src/components/CollectionTable/CollectionTableWSRTable.st.css.ts +2 -2
- package/src/components/CollectionToolbar/CollectionToolbar.st.css.ts +2 -2
- package/src/components/CollectionToolbar/SearchOrCustomFilter.st.css.ts +2 -2
- package/src/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.ts +2 -2
- package/src/components/CollectionViewsDropdown/ViewsDropdown.st.css.ts +2 -2
- package/src/components/DragHandle/DragHandle.st.css.ts +2 -2
- package/src/components/EditableTable/EditableCell.st.css.ts +2 -2
- package/src/components/EditableTable/EditableCell.tsx +1 -0
- package/src/components/EditableTable/HeaderActionsPopover.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/CellViewLayout.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/address/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/array/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/boolean/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/boolean/View.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/color/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/date/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/date/View.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/datetime/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/datetime/View.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/datetime/View.tsx +4 -0
- package/src/components/EditableTable/cellTypes/email/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/email/View.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/number/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/number/View.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/object/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/object/View.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/select/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/text/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/text/View.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/time/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/url/Edit.st.css.ts +2 -2
- package/src/components/EditableTable/cellTypes/url/View.st.css.ts +2 -2
- package/src/components/EmptyState/EmptyStateBase.st.css.ts +2 -2
- package/src/components/EntityPage/EntityPagePlain.st.css.ts +2 -2
- package/src/components/Fade/Fade.st.css.ts +2 -2
- package/src/components/Heading/Heading.st.css.ts +2 -2
- package/src/components/ImportButton/ImportStepUpload.st.css.ts +2 -2
- package/src/components/InputOverflow/InputOverflow.st.css.ts +2 -2
- package/src/components/LoadingRow/LoadingRow.st.css.ts +3 -3
- package/src/components/MaxHeightText/MaxHeightText.st.css.ts +2 -2
- package/src/components/MaxLines/MaxLines.st.css.ts +2 -2
- package/src/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.ts +2 -2
- package/src/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.ts +2 -2
- package/src/components/NestedTable/NestedTableRow.st.css.ts +2 -2
- package/src/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.ts +2 -2
- package/src/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.ts +2 -2
- package/src/components/PickerContent/PickerContent.st.css.ts +2 -2
- package/src/components/PickerContent/PickerContentAdditionalStep.st.css.ts +2 -2
- package/src/components/PickerTableListItem/PickerTableListItem.st.css.ts +2 -2
- package/src/components/ScrollableContent/ScrollableContent.st.css.ts +2 -2
- package/src/components/SetupWidget/SetupStepRow.tsx +18 -6
- package/src/components/SetupWidget/SetupWidget.st.css.ts +2 -2
- package/src/components/SetupWidget/SetupWidget.tsx +0 -5
- package/src/components/SetupWidget/SetupWidget.uni.driver.ts +1 -3
- package/src/components/SkeletonCard/SkeletonCard.st.css.ts +2 -2
- package/src/components/SlidingModal/SlidingModal.st.css.ts +2 -2
- package/src/components/Table/AddFieldColumnHeader.st.css.ts +2 -2
- package/src/components/TabsFilter/TabsFilter.st.css.ts +2 -2
- package/src/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.ts +2 -2
- package/src/components/ToolbarItem/ToolbarItem.st.css.ts +2 -2
- package/src/components/ToolbarItemBox/ToolbarItemBox.st.css.ts +2 -2
- package/src/components/common.st.css.ts +2 -2
- package/src/state/CollectionPage/CollectionPageHeader.st.css.ts +2 -2
- package/src/state/CollectionPage/TitleBadges.st.css.ts +2 -2
- package/src/state/FormPage/FormPageHeader.st.css.ts +2 -2
- package/src/styles.global.css +2 -2
- package/src/version.ts +1 -1
package/dist/docs/index.json
CHANGED
|
@@ -1,4 +1,17 @@
|
|
|
1
1
|
{
|
|
2
|
+
"ActionCellProps": {
|
|
3
|
+
"file": "ActionCellProps.md",
|
|
4
|
+
"category": "Features/Actions/Action Cell",
|
|
5
|
+
"summary": "TableActionCellProps",
|
|
6
|
+
"bundle": "types/ActionCellProps.d.ts",
|
|
7
|
+
"propsTotal": 15,
|
|
8
|
+
"propsTypeName": "ActionCellProps"
|
|
9
|
+
},
|
|
10
|
+
"ActionSubItem": {
|
|
11
|
+
"file": "ActionSubItem.md",
|
|
12
|
+
"category": "Common/Types",
|
|
13
|
+
"summary": "Pass `ActionSubItem` to PrimaryActions, SecondaryActions , or in MultiBulkActionToolbar."
|
|
14
|
+
},
|
|
2
15
|
"AI Assistant": {
|
|
3
16
|
"file": "AI Assistant.md",
|
|
4
17
|
"category": "Integrations/AI Assistant",
|
|
@@ -8,11 +21,6 @@
|
|
|
8
21
|
"createAiAssistant"
|
|
9
22
|
]
|
|
10
23
|
},
|
|
11
|
-
"ActionSubItem": {
|
|
12
|
-
"file": "ActionSubItem.md",
|
|
13
|
-
"category": "Common/Types",
|
|
14
|
-
"summary": "Pass `ActionSubItem` to PrimaryActions, SecondaryActions , or in MultiBulkActionToolbar."
|
|
15
|
-
},
|
|
16
24
|
"AutoCompleteFilter": {
|
|
17
25
|
"file": "AutoCompleteFilter.md",
|
|
18
26
|
"category": "Features/Filter/Components",
|
|
@@ -22,11 +30,23 @@
|
|
|
22
30
|
"propsTotal": 122,
|
|
23
31
|
"propsTypeName": "Omit"
|
|
24
32
|
},
|
|
25
|
-
"
|
|
26
|
-
"file": "
|
|
33
|
+
"BulkActionModalRenderProp": {
|
|
34
|
+
"file": "BulkActionModalRenderProp.md",
|
|
35
|
+
"category": "Common/Types",
|
|
36
|
+
"summary": "A render-prop type for the `bulkActionModal` prop on collection components (`Table`, `Grid`, etc.). The render function receives selection state (`selectedValues`, `uncheckedValues`, `allSelected`), a `query` object, and modal controls (`openModal`, `closeModal`). Return a React element for the modal content.",
|
|
37
|
+
"bundle": "types/BulkActionModalRenderPropParams.d.ts",
|
|
38
|
+
"propsTotal": 7,
|
|
39
|
+
"propsTypeName": "BulkActionModalRenderPropParams"
|
|
40
|
+
},
|
|
41
|
+
"BulkSelectState": {
|
|
42
|
+
"file": "BulkSelectState.md",
|
|
27
43
|
"category": "Common/State",
|
|
28
|
-
"summary": "
|
|
29
|
-
|
|
44
|
+
"summary": "`BulkSelectState` manages the selection state for bulk actions in collection components. It tracks which items are selected, supports \"Select All\", and provides `allSelected`, `selectedValues`, and `uncheckedValues` properties. Created internally by `CollectionState` — you typically access it via `state.collection.bulkSelect`."
|
|
45
|
+
},
|
|
46
|
+
"Category": {
|
|
47
|
+
"file": "Category.md",
|
|
48
|
+
"category": "Common/Types",
|
|
49
|
+
"summary": "Defines a category in the `Views` dropdown. A category groups related views and appears as a section header. Each category has a unique `id`, a display `name`, and an array of `View` objects."
|
|
30
50
|
},
|
|
31
51
|
"CollectionEmptyState": {
|
|
32
52
|
"file": "CollectionEmptyState.md",
|
|
@@ -42,6 +62,12 @@
|
|
|
42
62
|
"CollectionEmptyState/passive-empty-state.tsx"
|
|
43
63
|
]
|
|
44
64
|
},
|
|
65
|
+
"CollectionErrorState": {
|
|
66
|
+
"file": "CollectionErrorState.md",
|
|
67
|
+
"category": "Common/State",
|
|
68
|
+
"summary": "The `CollectionErrorState` component displays an error state for a collection when a data fetch fails. Pass this component to the `errorState` prop of a collection component, such as a Grid or a Table.",
|
|
69
|
+
"importPath": "@wix/patterns"
|
|
70
|
+
},
|
|
45
71
|
"CollectionNoResultsState": {
|
|
46
72
|
"file": "CollectionNoResultsState.md",
|
|
47
73
|
"category": "Features/Display/Empty States",
|
|
@@ -122,6 +148,25 @@
|
|
|
122
148
|
"CollectionSearch/search-highlighting.tsx"
|
|
123
149
|
]
|
|
124
150
|
},
|
|
151
|
+
"CollectionSection": {
|
|
152
|
+
"file": "CollectionSection.md",
|
|
153
|
+
"category": "Common/Types"
|
|
154
|
+
},
|
|
155
|
+
"CollectionState": {
|
|
156
|
+
"file": "CollectionState.md",
|
|
157
|
+
"category": "Common/State",
|
|
158
|
+
"summary": "`CollectionState` is the core state object for all collection components. It manages server data fetching, pagination, filtering, sorting, search, and bulk selection. Created by hooks like `useTableCollection` or `useGridCollection`. Key methods: `invalidate()`, `refreshCurrentPage()`, `clearResultAndMoveToStart()`, `retryErrorState()`."
|
|
159
|
+
},
|
|
160
|
+
"CollectionSubToolbar": {
|
|
161
|
+
"file": "CollectionSubToolbar.md",
|
|
162
|
+
"category": "Common/Components",
|
|
163
|
+
"summary": "The sub-toolbar is rendered below the main collection toolbar. It displays applied filter tags so users can see and remove active filters at a glance. This component is used internally by `Table`, `Grid`, and other collection components — you do not need to render it directly. To control its behavior, configure filters on the collection state."
|
|
164
|
+
},
|
|
165
|
+
"CollectionToolbar": {
|
|
166
|
+
"file": "CollectionToolbar.md",
|
|
167
|
+
"category": "Common/Components",
|
|
168
|
+
"summary": "`CollectionToolbar` is the internal toolbar component rendered by `Table`, `Grid`, and other collection components. It displays the title, search input, filters, custom columns, sort, export button, primary/secondary actions, more actions, and view switcher. You do not render this component directly — instead, configure the toolbar through props on the collection component (e.g."
|
|
169
|
+
},
|
|
125
170
|
"ToolbarFilters": {
|
|
126
171
|
"file": "ToolbarFilters.md",
|
|
127
172
|
"category": "Features/Filter/Components",
|
|
@@ -144,32 +189,18 @@
|
|
|
144
189
|
"ToolbarFilters/mini-toolbar-with-filters.tsx"
|
|
145
190
|
]
|
|
146
191
|
},
|
|
147
|
-
"
|
|
148
|
-
"file": "
|
|
149
|
-
"category": "Common/
|
|
150
|
-
"summary": "`
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
"
|
|
154
|
-
"category": "Common/Components",
|
|
155
|
-
"summary": "The sub-toolbar is rendered below the main collection toolbar. It displays applied filter tags so users can see and remove active filters at a glance. This component is used internally by `Table`, `Grid`, and other collection components — you do not need to render it directly. To control its behavior, configure filters on the collection state."
|
|
156
|
-
},
|
|
157
|
-
"CustomFieldType": {
|
|
158
|
-
"file": "CustomFieldType.md",
|
|
159
|
-
"category": "Features/Enrich/Custom Field Types",
|
|
160
|
-
"summary": "A **custom field type** is a consumer-defined field that plugs into every schema-driven surface. Define it once with `defineFieldType<V>()` and register it on the schema source via `fieldTypes` — the page wires nothing per surface. Each surface resolves its own slot from the definition:",
|
|
161
|
-
"examples": [
|
|
162
|
-
"CustomFieldType/table-cell-and-filter.tsx",
|
|
163
|
-
"CustomFieldType/editable-cell.tsx",
|
|
164
|
-
"CustomFieldType/add-field-modal.tsx",
|
|
165
|
-
"CustomFieldType/entity-page-form.tsx"
|
|
166
|
-
]
|
|
192
|
+
"ComputedQuery": {
|
|
193
|
+
"file": "ComputedQuery.md",
|
|
194
|
+
"category": "Common/Types",
|
|
195
|
+
"summary": "`ComputedQuery` represents the current paging, sorting, and filtering state passed to `fetchData`. It includes `offset` (or `cursor`), `limit`, `sort`, and `filter` values derived from the active filters. Use it in bulk operations like `updateAll` or `deleteAll` to apply the same filters server-side.",
|
|
196
|
+
"bundle": "types/ComputedQuery.d.ts",
|
|
197
|
+
"propsTotal": 13,
|
|
198
|
+
"propsTypeName": "ComputedQuery"
|
|
167
199
|
},
|
|
168
|
-
"
|
|
169
|
-
"file": "
|
|
170
|
-
"category": "
|
|
171
|
-
"summary": "
|
|
172
|
-
"importPath": "@wix/patterns"
|
|
200
|
+
"CtaBaseProps": {
|
|
201
|
+
"file": "CtaBaseProps.md",
|
|
202
|
+
"category": "Common/Types",
|
|
203
|
+
"summary": "Base props for call-to-action buttons used in section headers, toolbar actions, and other action triggers. Defines the common `id`, `onClick`, `label`, and `prefixIcon` properties."
|
|
173
204
|
},
|
|
174
205
|
"CustomColumns": {
|
|
175
206
|
"file": "CustomColumns.md",
|
|
@@ -188,6 +219,23 @@
|
|
|
188
219
|
"CustomColumns/get-visible-columns.tsx"
|
|
189
220
|
]
|
|
190
221
|
},
|
|
222
|
+
"CustomFieldType": {
|
|
223
|
+
"file": "CustomFieldType.md",
|
|
224
|
+
"category": "Features/Enrich/Custom Field Types",
|
|
225
|
+
"summary": "A **custom field type** is a consumer-defined field that plugs into every schema-driven surface. Define it once with `defineFieldType<V>()` and register it on the schema source via `fieldTypes` — the page wires nothing per surface. Each surface resolves its own slot from the definition:",
|
|
226
|
+
"examples": [
|
|
227
|
+
"CustomFieldType/table-cell-and-filter.tsx",
|
|
228
|
+
"CustomFieldType/editable-cell.tsx",
|
|
229
|
+
"CustomFieldType/add-field-modal.tsx",
|
|
230
|
+
"CustomFieldType/entity-page-form.tsx"
|
|
231
|
+
]
|
|
232
|
+
},
|
|
233
|
+
"CustomFieldsViewWidget": {
|
|
234
|
+
"file": "CustomFieldsViewWidget.md",
|
|
235
|
+
"category": "Features/Enrich/Data Extension/Components",
|
|
236
|
+
"summary": "The `CustomFieldsViewWidget` component enhances the entity page by displaying both user-defined custom fields and custom fields that are defined by apps that are installed on the site.",
|
|
237
|
+
"importPath": "@wix/patterns"
|
|
238
|
+
},
|
|
191
239
|
"CustomFieldsWidget": {
|
|
192
240
|
"file": "CustomFieldsWidget.md",
|
|
193
241
|
"category": "Features/Enrich/Data Extension/Components",
|
|
@@ -203,6 +251,43 @@
|
|
|
203
251
|
"CustomFieldsWidget/with-tpa-fields.tsx"
|
|
204
252
|
]
|
|
205
253
|
},
|
|
254
|
+
"customFilter": {
|
|
255
|
+
"file": "customFilter.md",
|
|
256
|
+
"category": "Features/Filter/Factories",
|
|
257
|
+
"summary": "A generic filter factory to be passed to useCollection `filters` property. This factory, allows creating custom filters that are not provided by Wix Patterns.",
|
|
258
|
+
"importPath": "@wix/patterns",
|
|
259
|
+
"bundle": "functions/customFilter.d.ts",
|
|
260
|
+
"propsTotal": 17,
|
|
261
|
+
"propsTypeName": "CustomFilterStateParams"
|
|
262
|
+
},
|
|
263
|
+
"Data Extension Overview": {
|
|
264
|
+
"file": "Data Extension Overview.md",
|
|
265
|
+
"category": "Features/Enrich/Data Extension",
|
|
266
|
+
"summary": "Patterns Data Extension feature builds on the open platform Data Extensions capability."
|
|
267
|
+
},
|
|
268
|
+
"Display Extended Fields": {
|
|
269
|
+
"file": "Display Extended Fields.md",
|
|
270
|
+
"category": "Features/Enrich/Data Extension",
|
|
271
|
+
"summary": "This guide explains how to display extended fields in your table."
|
|
272
|
+
},
|
|
273
|
+
"Enable Filters for Extended Fields": {
|
|
274
|
+
"file": "Enable Filters for Extended Fields.md",
|
|
275
|
+
"category": "Features/Enrich/Data Extension",
|
|
276
|
+
"summary": "This article explains how to enable filters on your extended fields."
|
|
277
|
+
},
|
|
278
|
+
"Allow Users to Add Extended Fields": {
|
|
279
|
+
"file": "Allow Users to Add Extended Fields.md",
|
|
280
|
+
"category": "Features/Enrich/Data Extension",
|
|
281
|
+
"summary": "This guide shows you how to let users add and manage extended fields."
|
|
282
|
+
},
|
|
283
|
+
"DataResultRaw": {
|
|
284
|
+
"file": "DataResultRaw.md",
|
|
285
|
+
"category": "Common/Types",
|
|
286
|
+
"summary": "The return type of the `fetchData` function passed to collection hooks. Contains the `items` array, optional `total` count (after filters), `available` count (before filters), `cursor` for cursor-based pagination, and `hasNext` flag.",
|
|
287
|
+
"bundle": "types/DataResultRaw.d.ts",
|
|
288
|
+
"propsTotal": 5,
|
|
289
|
+
"propsTypeName": "DataResultRaw"
|
|
290
|
+
},
|
|
206
291
|
"DateRangeFilter": {
|
|
207
292
|
"file": "DateRangeFilter.Components.md",
|
|
208
293
|
"category": "Features/Filter/Components",
|
|
@@ -212,24 +297,6 @@
|
|
|
212
297
|
"propsTotal": 69,
|
|
213
298
|
"propsTypeName": "DateRangeFilterProps"
|
|
214
299
|
},
|
|
215
|
-
"EntityPage.AdditionalContent": {
|
|
216
|
-
"file": "EntityPage.AdditionalContent.md",
|
|
217
|
-
"category": "Base Components/Pages/Entity Page",
|
|
218
|
-
"summary": "A slot component for the side panel of an `EntityPage`. Place it inside `<EntityPage.Content>` alongside `<EntityPage.MainContent>`. Supports an optional `sticky` prop to keep the content fixed while scrolling.",
|
|
219
|
-
"importPath": "@wix/patterns"
|
|
220
|
-
},
|
|
221
|
-
"EntityPage.Card": {
|
|
222
|
-
"file": "EntityPage.Card.md",
|
|
223
|
-
"category": "Base Components/Pages/Entity Page",
|
|
224
|
-
"summary": "A card container used inside `EntityPage.MainContent` or `EntityPage.AdditionalContent`. It wraps form fields and content sections with a card layout, and supports loading/error/success states for async content.",
|
|
225
|
-
"importPath": "@wix/patterns"
|
|
226
|
-
},
|
|
227
|
-
"EntityPage.Content": {
|
|
228
|
-
"file": "EntityPage.Content.md",
|
|
229
|
-
"category": "Base Components/Pages/Entity Page",
|
|
230
|
-
"summary": "A layout slot for the body of an `EntityPage`. Wraps `<EntityPage.MainContent>` and optionally `<EntityPage.AdditionalContent>` to create the two-column layout.",
|
|
231
|
-
"importPath": "@wix/patterns"
|
|
232
|
-
},
|
|
233
300
|
"EntityPage": {
|
|
234
301
|
"file": "EntityPage.md",
|
|
235
302
|
"category": "Base Components/Pages/Entity Page",
|
|
@@ -252,6 +319,24 @@
|
|
|
252
319
|
"EntityPage/input-initialization-with-controller.tsx"
|
|
253
320
|
]
|
|
254
321
|
},
|
|
322
|
+
"EntityPage.AdditionalContent": {
|
|
323
|
+
"file": "EntityPage.AdditionalContent.md",
|
|
324
|
+
"category": "Base Components/Pages/Entity Page",
|
|
325
|
+
"summary": "A slot component for the side panel of an `EntityPage`. Place it inside `<EntityPage.Content>` alongside `<EntityPage.MainContent>`. Supports an optional `sticky` prop to keep the content fixed while scrolling.",
|
|
326
|
+
"importPath": "@wix/patterns"
|
|
327
|
+
},
|
|
328
|
+
"EntityPage.Card": {
|
|
329
|
+
"file": "EntityPage.Card.md",
|
|
330
|
+
"category": "Base Components/Pages/Entity Page",
|
|
331
|
+
"summary": "A card container used inside `EntityPage.MainContent` or `EntityPage.AdditionalContent`. It wraps form fields and content sections with a card layout, and supports loading/error/success states for async content.",
|
|
332
|
+
"importPath": "@wix/patterns"
|
|
333
|
+
},
|
|
334
|
+
"EntityPage.Content": {
|
|
335
|
+
"file": "EntityPage.Content.md",
|
|
336
|
+
"category": "Base Components/Pages/Entity Page",
|
|
337
|
+
"summary": "A layout slot for the body of an `EntityPage`. Wraps `<EntityPage.MainContent>` and optionally `<EntityPage.AdditionalContent>` to create the two-column layout.",
|
|
338
|
+
"importPath": "@wix/patterns"
|
|
339
|
+
},
|
|
255
340
|
"EntityPage.Header": {
|
|
256
341
|
"file": "EntityPage.Header.md",
|
|
257
342
|
"category": "Base Components/Pages/Entity Page",
|
|
@@ -270,6 +355,45 @@
|
|
|
270
355
|
"summary": "A slot container for rendering TPA plugin widgets inside an `EntityPage`. Pass a `containerId` from your Dev Center app to render third-party plugins in the entity page layout. Learn more about Slots and Plugins.",
|
|
271
356
|
"importPath": "@wix/patterns"
|
|
272
357
|
},
|
|
358
|
+
"EntityPageState": {
|
|
359
|
+
"file": "EntityPageState.md",
|
|
360
|
+
"category": "Base Components/Pages/Entity Page/State",
|
|
361
|
+
"summary": "`EntityPageState` is the state object that drives an `EntityPage`. It is created by the `useEntityPage` hook and manages: - **Entity fetching** — loads the entity from the server via `fetch` - **Form state** — integrates with `react-hook-form` for editing - **Save / cancel flow** — calls `onSave` with form values and handles success/error toasts - **Dirty-form protection** — warns on `beforeunload…",
|
|
362
|
+
"bundle": "types/EntityPageState.d.ts",
|
|
363
|
+
"propsTotal": 4,
|
|
364
|
+
"propsTypeName": "EntityPageState"
|
|
365
|
+
},
|
|
366
|
+
"ExportTo": {
|
|
367
|
+
"file": "ExportTo.md",
|
|
368
|
+
"category": "Features/Export",
|
|
369
|
+
"summary": "The ExportTo is a platformised solution for exporting lists of data.",
|
|
370
|
+
"importPath": "@wix/patterns",
|
|
371
|
+
"bundle": "components/ExportButton.d.ts",
|
|
372
|
+
"propsTotal": 12,
|
|
373
|
+
"propsTypeName": "ExportButtonProps",
|
|
374
|
+
"symbols": [
|
|
375
|
+
"ExportButton"
|
|
376
|
+
],
|
|
377
|
+
"examples": [
|
|
378
|
+
"ExportTo/export-all-table.tsx",
|
|
379
|
+
"ExportTo/export-filtered-table.tsx",
|
|
380
|
+
"ExportTo/export-table-with-selection-bulk-selection.tsx",
|
|
381
|
+
"ExportTo/cta-is-out-of-the-table.tsx"
|
|
382
|
+
]
|
|
383
|
+
},
|
|
384
|
+
"FilterProps": {
|
|
385
|
+
"file": "FilterProps.md",
|
|
386
|
+
"category": "Features/Filter/Props",
|
|
387
|
+
"summary": "The base filter component interface used by all filter types in Wix Patterns. Each filter defines how it renders in the toolbar, its value type, and how it maps to query parameters. See specific filter implementations like `SingleSelectFilter`, `MultiSelectCheckboxFilter`, and `DateRangeFilter`.",
|
|
388
|
+
"bundle": "types/FilterProps.d.ts",
|
|
389
|
+
"propsTotal": 11,
|
|
390
|
+
"propsTypeName": "FilterProps"
|
|
391
|
+
},
|
|
392
|
+
"FormPageState": {
|
|
393
|
+
"file": "FormPageState.md",
|
|
394
|
+
"category": "Common/State",
|
|
395
|
+
"summary": "`FormPageState` manages form state for page components (`EntityPage`, `SettingsPage`). It wraps a `react-hook-form` `UseFormReturn` instance and adds initialization/submission task tracking and optional widgets form state. You typically do not create this directly — it is managed internally by `EntityPageState` or `SettingsPageState`."
|
|
396
|
+
},
|
|
273
397
|
"Grid": {
|
|
274
398
|
"file": "Grid.md",
|
|
275
399
|
"category": "Base Components/Collections/Grid/Grid",
|
|
@@ -287,6 +411,12 @@
|
|
|
287
411
|
"Grid/grid-sections.tsx"
|
|
288
412
|
]
|
|
289
413
|
},
|
|
414
|
+
"GridDragAndDrop": {
|
|
415
|
+
"file": "GridDragAndDrop.md",
|
|
416
|
+
"category": "Features/Sort/Drag and Drop",
|
|
417
|
+
"summary": "Enables drag and drop functionality on a `Grid` component.",
|
|
418
|
+
"importPath": "@wix/patterns"
|
|
419
|
+
},
|
|
290
420
|
"GridFolders": {
|
|
291
421
|
"file": "GridFolders.md",
|
|
292
422
|
"category": "Base Components/Collections/GridFolders/GridFolders",
|
|
@@ -301,6 +431,14 @@
|
|
|
301
431
|
"category": "Base Components/Collections/GridFolders/GridFoldersSection",
|
|
302
432
|
"summary": "`GridFoldersSection` renders a section within a `GridFolders` layout — either the folders section or the items section. Each section can include an optional `header` (e.g. a section title) and accepts `children` for the grid content. This component is typically used in conjunction with `GridFolders` and `useGridCollection`."
|
|
303
433
|
},
|
|
434
|
+
"GridFoldersState": {
|
|
435
|
+
"file": "GridFoldersState.md",
|
|
436
|
+
"category": "Base Components/Collections/GridFolders/GridFoldersState",
|
|
437
|
+
"summary": "`GridFoldersState` manages the state for a `GridFolders` component, which displays both folders and items in a grid layout. It holds separate `CollectionState` instances for folders and items, plus a shared toolbar. Created by `useGridCollection` with a folders configuration.",
|
|
438
|
+
"bundle": "types/GridFoldersState.d.ts",
|
|
439
|
+
"propsTotal": 1,
|
|
440
|
+
"propsTypeName": "GridFoldersStatePublicAPI"
|
|
441
|
+
},
|
|
304
442
|
"Grid Sections": {
|
|
305
443
|
"file": "Grid Sections.md",
|
|
306
444
|
"category": "Features/Display/Grid Sections",
|
|
@@ -311,14 +449,157 @@
|
|
|
311
449
|
"category": "Common/Types",
|
|
312
450
|
"summary": "Configuration object for the `sections` prop on `Grid`. Enables grouping grid items into sections with headers. Provide a `GridSections` component, a `groupBy` function that extracts the grouping key from each item, and an optional `renderSection` callback for custom section headers."
|
|
313
451
|
},
|
|
314
|
-
"
|
|
315
|
-
"file": "
|
|
316
|
-
"category": "
|
|
317
|
-
"summary": "
|
|
452
|
+
"GridState": {
|
|
453
|
+
"file": "GridState.md",
|
|
454
|
+
"category": "Base Components/Collections/Grid/GridState",
|
|
455
|
+
"summary": "`GridState` manages the state for a `Grid` component. It wraps a `CollectionState` for data, a `ToolbarCollectionState` for the toolbar, and tracks grid-specific UI state like size presets and sections. Created by `useGridCollection`.",
|
|
456
|
+
"bundle": "types/GridState.d.ts",
|
|
457
|
+
"propsTotal": 3,
|
|
458
|
+
"propsTypeName": "GridStatePublicAPI"
|
|
318
459
|
},
|
|
319
|
-
"
|
|
320
|
-
"file": "
|
|
321
|
-
"category": "
|
|
460
|
+
"InMemoryBackend": {
|
|
461
|
+
"file": "InMemoryBackend.md",
|
|
462
|
+
"category": "Guides",
|
|
463
|
+
"summary": "A mocking utility which acts as a collection server API.",
|
|
464
|
+
"importPath": "@wix/patterns/testkit/backend"
|
|
465
|
+
},
|
|
466
|
+
"Tags Overview": {
|
|
467
|
+
"file": "Tags Overview.md",
|
|
468
|
+
"category": "Features/Enrich/Tags",
|
|
469
|
+
"summary": "### Introduction"
|
|
470
|
+
},
|
|
471
|
+
"Working with Cache": {
|
|
472
|
+
"file": "Working with Cache.md",
|
|
473
|
+
"category": "Guides",
|
|
474
|
+
"summary": "Wix Patterns uses cache to optimize the request time, more specifically it uses the \"in-memory\" cache strategy which means that the cache persists only during the browser session. Once the browser tab is closed all cache is cleared."
|
|
475
|
+
},
|
|
476
|
+
"Collection to Entity Flow": {
|
|
477
|
+
"file": "Collection to Entity Flow.md",
|
|
478
|
+
"category": "Guides",
|
|
479
|
+
"summary": "A collection page and the form for one of its items are **two patterns pages**, not a page plus a modal. That holds for creating a record as much as editing one: an \"add new\" form writes the record, so it is an `EntityPage` however small it is.",
|
|
480
|
+
"relatedComponents": [
|
|
481
|
+
"CollectionPage",
|
|
482
|
+
"EntityPage",
|
|
483
|
+
"EntityPageState",
|
|
484
|
+
"useEntityPage",
|
|
485
|
+
"useEntity",
|
|
486
|
+
"useCreateCollection",
|
|
487
|
+
"usePatternsNavigate",
|
|
488
|
+
"PatternsReactRouter",
|
|
489
|
+
"PatternsReactRoute"
|
|
490
|
+
]
|
|
491
|
+
},
|
|
492
|
+
"Collection Toolkit": {
|
|
493
|
+
"file": "Collection Toolkit.md",
|
|
494
|
+
"category": "Guides",
|
|
495
|
+
"summary": "Which component to reach for, arranged by what the person using the dashboard is trying to do: understand the situation, narrow it, open one record, act, and be told what happened.",
|
|
496
|
+
"relatedComponents": [
|
|
497
|
+
"SummaryBar",
|
|
498
|
+
"CollectionSearch",
|
|
499
|
+
"CollectionToolbarFilters",
|
|
500
|
+
"MultiSelectCheckboxFilter",
|
|
501
|
+
"MultiInlineCheckboxFilter",
|
|
502
|
+
"MultiAutoInlineCheckboxFilter",
|
|
503
|
+
"SingleSelectFilter",
|
|
504
|
+
"RadioGroupFilter",
|
|
505
|
+
"TabsFilter",
|
|
506
|
+
"MultiSelectCollectionFilter",
|
|
507
|
+
"useFilterCollection",
|
|
508
|
+
"AutoCompleteFilter",
|
|
509
|
+
"DateRangeFilter",
|
|
510
|
+
"NumberRangeFilter",
|
|
511
|
+
"OperatorFilterPicker",
|
|
512
|
+
"operatorFilter",
|
|
513
|
+
"idNameArrayFilter",
|
|
514
|
+
"stringFilter",
|
|
515
|
+
"stringsArrayFilter",
|
|
516
|
+
"arrayFilter",
|
|
517
|
+
"dateRangeFilter",
|
|
518
|
+
"customFilter",
|
|
519
|
+
"useStaticListFilterCollection",
|
|
520
|
+
"Sortable Columns",
|
|
521
|
+
"MultiLevelSorting",
|
|
522
|
+
"EntityPage",
|
|
523
|
+
"useEntityPage",
|
|
524
|
+
"usePatternsNavigate",
|
|
525
|
+
"PickerModal",
|
|
526
|
+
"usePickerModal",
|
|
527
|
+
"bulkActionModal",
|
|
528
|
+
"PrimaryActions",
|
|
529
|
+
"SecondaryActions",
|
|
530
|
+
"More Actions",
|
|
531
|
+
"deleteSecondaryAction",
|
|
532
|
+
"PrimaryActionButton",
|
|
533
|
+
"MultiBulkActionToolbar",
|
|
534
|
+
"useOptimisticActions",
|
|
535
|
+
"CollectionOptimisticActions",
|
|
536
|
+
"TableTopNotification",
|
|
537
|
+
"CollectionEmptyState",
|
|
538
|
+
"CollectionNoResultsState",
|
|
539
|
+
"CollectionPremiumEmptyState",
|
|
540
|
+
"ExportButton"
|
|
541
|
+
]
|
|
542
|
+
},
|
|
543
|
+
"Composition and Providers": {
|
|
544
|
+
"file": "Composition and Providers.md",
|
|
545
|
+
"category": "Guides",
|
|
546
|
+
"summary": "Every patterns page is four nested layers. Getting the nesting wrong is the most common way a page that looks right throws at runtime.",
|
|
547
|
+
"relatedComponents": [
|
|
548
|
+
"WixPatternsProvider",
|
|
549
|
+
"WixPatternsBMProvider",
|
|
550
|
+
"WixPatternsGizaProvider",
|
|
551
|
+
"WixPatternsEssentialsProvider",
|
|
552
|
+
"WixPatternsBaseProvider",
|
|
553
|
+
"CollectionPage",
|
|
554
|
+
"EntityPage",
|
|
555
|
+
"SettingsPage",
|
|
556
|
+
"Table",
|
|
557
|
+
"Grid",
|
|
558
|
+
"TableGridSwitch",
|
|
559
|
+
"TableFolders",
|
|
560
|
+
"GridFolders",
|
|
561
|
+
"TableState",
|
|
562
|
+
"GridState",
|
|
563
|
+
"TableGridSwitchState",
|
|
564
|
+
"TableFoldersState",
|
|
565
|
+
"GridFoldersState",
|
|
566
|
+
"useTableCollection",
|
|
567
|
+
"useGridCollection",
|
|
568
|
+
"useTableGridSwitchCollection",
|
|
569
|
+
"useTableFolders",
|
|
570
|
+
"useGridFolders",
|
|
571
|
+
"PatternsReactRouter",
|
|
572
|
+
"PatternsReactRoute",
|
|
573
|
+
"usePatternsNavigate",
|
|
574
|
+
"withDashboard"
|
|
575
|
+
]
|
|
576
|
+
},
|
|
577
|
+
"Filter Overview": {
|
|
578
|
+
"file": "Filter Overview.md",
|
|
579
|
+
"category": "Features/Filter",
|
|
580
|
+
"summary": "To better understand the use and configuration of filters in Wix Patterns and especially in Tabs Filter, Toolbar Filters and Views it is important to know the difference between the Filter Components and the `Filter` object including all the built-in factories Wix Patterns provides.",
|
|
581
|
+
"examples": [
|
|
582
|
+
"Filter Overview/interactive-example.tsx"
|
|
583
|
+
]
|
|
584
|
+
},
|
|
585
|
+
"Next.js": {
|
|
586
|
+
"file": "Next.js.md",
|
|
587
|
+
"category": "Guides",
|
|
588
|
+
"summary": "**Next.js** is replacing the Yoshi fullstack flow. It's not yet officially supported by the infra team, however early adopters can try it out using the WIX Next.js template."
|
|
589
|
+
},
|
|
590
|
+
"Reading the Doc Indices": {
|
|
591
|
+
"file": "Reading the Doc Indices.md",
|
|
592
|
+
"category": "Guides",
|
|
593
|
+
"summary": "`@wix/patterns` ships two machine-readable indices under `dist/`, and they answer different questions. This is what their conventions mean, so a consumer reading them does not mistake a deliberate stub for a truncated file."
|
|
594
|
+
},
|
|
595
|
+
"Highlighted Search": {
|
|
596
|
+
"file": "Highlighted Search.md",
|
|
597
|
+
"category": "Features/Display/Highlighted Search",
|
|
598
|
+
"summary": "The searchable prop on table columns allows you to specify whether a column's content is included in search operations. When a search is performed, matching text within searchable columns is automatically highlighted in the UI."
|
|
599
|
+
},
|
|
600
|
+
"ImportButton": {
|
|
601
|
+
"file": "ImportButton.md",
|
|
602
|
+
"category": "Features/Import",
|
|
322
603
|
"summary": "The `ImportButton` is the platformized solution for importing a CSV file into a collection.",
|
|
323
604
|
"importPath": "@wix/patterns",
|
|
324
605
|
"examples": [
|
|
@@ -361,6 +642,14 @@
|
|
|
361
642
|
"More Actions/featured-more-actions-custom-position.tsx"
|
|
362
643
|
]
|
|
363
644
|
},
|
|
645
|
+
"MoreActionsItem": {
|
|
646
|
+
"file": "MoreActionsItem.md",
|
|
647
|
+
"category": "Common/Types",
|
|
648
|
+
"summary": "Defines an action item in the `MoreActions` dropdown menu. Each item has a `text` label, an `onClick` handler, and optional properties like `prefixIcon`, `skin` (`dark` or `destructive`), `disabled`, `subtitle`, and `dataHook`.",
|
|
649
|
+
"bundle": "types/MoreActionsItem.d.ts",
|
|
650
|
+
"propsTotal": 10,
|
|
651
|
+
"propsTypeName": "MoreActionsItem"
|
|
652
|
+
},
|
|
364
653
|
"MultiAutoInlineCheckboxFilter": {
|
|
365
654
|
"file": "MultiAutoInlineCheckboxFilter.md",
|
|
366
655
|
"category": "Features/Filter/Components",
|
|
@@ -370,6 +659,23 @@
|
|
|
370
659
|
"propsTotal": 50,
|
|
371
660
|
"propsTypeName": "MultiAutoInlineCheckboxFilterProps"
|
|
372
661
|
},
|
|
662
|
+
"MultiBulkActionToolbar": {
|
|
663
|
+
"file": "MultiBulkActionToolbar.md",
|
|
664
|
+
"category": "Features/Actions/Bulk Actions",
|
|
665
|
+
"summary": "Provides the ability to perform multiple operations on multiple items.",
|
|
666
|
+
"importPath": "@wix/patterns",
|
|
667
|
+
"bundle": "components/MultiBulkActionToolbar.d.ts",
|
|
668
|
+
"propsTotal": 5,
|
|
669
|
+
"propsTypeName": "MultiBulkActionToolbarProps",
|
|
670
|
+
"examples": [
|
|
671
|
+
"MultiBulkActionToolbar/bulk-action.tsx",
|
|
672
|
+
"MultiBulkActionToolbar/popover-menu.tsx",
|
|
673
|
+
"MultiBulkActionToolbar/basic-secondary-action.tsx",
|
|
674
|
+
"MultiBulkActionToolbar/primary-secondary-actions-with-a-divider.tsx",
|
|
675
|
+
"MultiBulkActionToolbar/maximum-selection.tsx",
|
|
676
|
+
"MultiBulkActionToolbar/extend-menu-items.tsx"
|
|
677
|
+
]
|
|
678
|
+
},
|
|
373
679
|
"MultiInlineCheckboxFilter": {
|
|
374
680
|
"file": "MultiInlineCheckboxFilter.md",
|
|
375
681
|
"category": "Features/Filter/Components",
|
|
@@ -379,6 +685,20 @@
|
|
|
379
685
|
"propsTotal": 49,
|
|
380
686
|
"propsTypeName": "MultiInlineCheckboxFilterProps"
|
|
381
687
|
},
|
|
688
|
+
"MultiLevelSorting": {
|
|
689
|
+
"file": "MultiLevelSorting.md",
|
|
690
|
+
"category": "Features/Sort/Sortable Columns/MultiLevelSorting",
|
|
691
|
+
"summary": "Allows visitors to apply sorting to multiple columns (in hierarchical order).",
|
|
692
|
+
"importPath": "@wix/patterns",
|
|
693
|
+
"bundle": "types/MultiLevelSorting.d.ts",
|
|
694
|
+
"propsTotal": 4,
|
|
695
|
+
"propsTypeName": "IMultiLevelSortingProps",
|
|
696
|
+
"examples": [
|
|
697
|
+
"MultiLevelSorting/basic-multi-level-sorting.tsx",
|
|
698
|
+
"MultiLevelSorting/multi-level-sorting-with-defined-sort-directions.tsx",
|
|
699
|
+
"MultiLevelSorting/multi-level-sorting-with-custom-sort-order.tsx"
|
|
700
|
+
]
|
|
701
|
+
},
|
|
382
702
|
"MultiSelectCheckboxFilter": {
|
|
383
703
|
"file": "MultiSelectCheckboxFilter.md",
|
|
384
704
|
"category": "Features/Filter/Components",
|
|
@@ -411,6 +731,26 @@
|
|
|
411
731
|
"NestedTable/drag-and-drop.tsx"
|
|
412
732
|
]
|
|
413
733
|
},
|
|
734
|
+
"NestedTableLevel": {
|
|
735
|
+
"file": "NestedTableLevel.md",
|
|
736
|
+
"category": "Base Components/Collections/NestedTable",
|
|
737
|
+
"summary": "Describes a single level in a `NestedTable` hierarchy. Each level defines how its items are fetched (`createCollection`), how they relate to parents (`parentKey`), and how they render (`columns`, `renderMainColumn`, `actionCell`). Supports expandability, breadcrumbs, drag-and-drop, and row highlighting."
|
|
738
|
+
},
|
|
739
|
+
"NestedTableNodeState": {
|
|
740
|
+
"file": "NestedTableNodeState.md",
|
|
741
|
+
"category": "Base Components/Collections/NestedTable",
|
|
742
|
+
"summary": "`NestedTableNodeState` represents a single node in a `NestedTable` tree. Each node has a `depth`, `expanded` state, `children` collection, `optimisticActions`, and access to its parent via `getParent()`. Use `getData()` to access the item and `toggleExpand()` to expand/collapse."
|
|
743
|
+
},
|
|
744
|
+
"NestedTableOptimisticActions": {
|
|
745
|
+
"file": "NestedTableOptimisticActions.md",
|
|
746
|
+
"category": "Base Components/Collections/NestedTable",
|
|
747
|
+
"summary": "Extends the standard optimistic actions API with nested-table-specific operations. Provides `updateMany`, `updateOne`, `deleteMany`, and `deleteOne` methods that accept a `propagate` parameter to cascade changes to child nodes. Access via `nodeState.optimisticActions`."
|
|
748
|
+
},
|
|
749
|
+
"NestedTableState": {
|
|
750
|
+
"file": "NestedTableState.md",
|
|
751
|
+
"category": "Base Components/Collections/NestedTable",
|
|
752
|
+
"summary": "`NestedTableState` manages the state for a `NestedTable` component. It handles multi-level hierarchical data with expand/collapse, flat and nested view modes, toolbar, and optimistic actions. Created by `useNestedTable`."
|
|
753
|
+
},
|
|
414
754
|
"NumberRangeFilter": {
|
|
415
755
|
"file": "NumberRangeFilter.md",
|
|
416
756
|
"category": "Features/Filter/Components",
|
|
@@ -420,6 +760,15 @@
|
|
|
420
760
|
"propsTotal": 11,
|
|
421
761
|
"propsTypeName": "NumberRangeFilterProps"
|
|
422
762
|
},
|
|
763
|
+
"operatorFilter": {
|
|
764
|
+
"file": "operatorFilter.md",
|
|
765
|
+
"category": "Features/Filter/Factories",
|
|
766
|
+
"summary": "The `operatorFilter` factory creates a filter that combines an operator selection with a value input. It is ideal for advanced filtering scenarios where users need to specify how they want to filter data.",
|
|
767
|
+
"importPath": "@wix/patterns",
|
|
768
|
+
"bundle": "functions/operatorFilter.d.ts",
|
|
769
|
+
"propsTotal": 11,
|
|
770
|
+
"propsTypeName": "OperatorFilterStateParams"
|
|
771
|
+
},
|
|
423
772
|
"OperatorFilterPicker": {
|
|
424
773
|
"file": "OperatorFilterPicker.md",
|
|
425
774
|
"category": "Features/Filter/Components",
|
|
@@ -611,6 +960,11 @@
|
|
|
611
960
|
"summary": "A slot component for the main content area of a `SettingsPage`. Place it inside `<SettingsPage.Content>`. This is where you render the primary form fields and cards.",
|
|
612
961
|
"importPath": "@wix/patterns"
|
|
613
962
|
},
|
|
963
|
+
"SettingsPageState": {
|
|
964
|
+
"file": "SettingsPageState.md",
|
|
965
|
+
"category": "Base Components/Pages/Settings Page/State",
|
|
966
|
+
"summary": "`SettingsPageState` is the state object that drives a `SettingsPage`. It is created by the `useSettingsPage` hook and manages: - **Settings fetching** — loads the current settings from the server via `fetch` - **Form state** — integrates with `react-hook-form` for editing - **Save / cancel flow** — calls `onSave` and `onCancel` with success/error toasts - **Dirty-form protection** — warns on `befo…"
|
|
967
|
+
},
|
|
614
968
|
"SingleSelectFilter": {
|
|
615
969
|
"file": "SingleSelectFilter.md",
|
|
616
970
|
"category": "Features/Filter/Components",
|
|
@@ -685,6 +1039,26 @@
|
|
|
685
1039
|
"Table/using-with-external-data-source.tsx"
|
|
686
1040
|
]
|
|
687
1041
|
},
|
|
1042
|
+
"TableColumn": {
|
|
1043
|
+
"file": "TableColumn.md",
|
|
1044
|
+
"category": "Common/Types",
|
|
1045
|
+
"summary": "Defines a column in a `Table` component. Extends the Wix Design System table column with Patterns-specific features: `sortable` / `defaultSortOrder`, `searchable`, `hideable` (for `CustomColumns`), and `mobile` layout configuration.",
|
|
1046
|
+
"bundle": "types/TableColumn.d.ts",
|
|
1047
|
+
"propsTotal": 19,
|
|
1048
|
+
"propsTypeName": "Column"
|
|
1049
|
+
},
|
|
1050
|
+
"TableDragAndDrop": {
|
|
1051
|
+
"file": "TableDragAndDrop.md",
|
|
1052
|
+
"category": "Features/Sort/Drag and Drop",
|
|
1053
|
+
"summary": "Enables drag and drop functionality on a `Table` component.",
|
|
1054
|
+
"importPath": "@wix/patterns",
|
|
1055
|
+
"examples": [
|
|
1056
|
+
"TableDragAndDrop/table.tsx",
|
|
1057
|
+
"TableDragAndDrop/specific-tabs.tsx",
|
|
1058
|
+
"TableDragAndDrop/specific-filters.tsx",
|
|
1059
|
+
"TableDragAndDrop/save-order-mode.tsx"
|
|
1060
|
+
]
|
|
1061
|
+
},
|
|
688
1062
|
"TableFolders": {
|
|
689
1063
|
"file": "TableFolders.md",
|
|
690
1064
|
"category": "Base Components/Collections/TableFolders/TableFolders",
|
|
@@ -699,6 +1073,14 @@
|
|
|
699
1073
|
"TableFolders/with-tags.tsx"
|
|
700
1074
|
]
|
|
701
1075
|
},
|
|
1076
|
+
"TableFoldersState": {
|
|
1077
|
+
"file": "TableFoldersState.md",
|
|
1078
|
+
"category": "Base Components/Collections/TableFolders/TableFoldersState",
|
|
1079
|
+
"summary": "`TableFoldersState` manages the state for a `TableFolders` component, which displays folders and items in a table layout. Holds separate `CollectionState` instances for folders and items, plus a shared `TableState` and toolbar. Created by `useTableCollection` with a folders configuration.",
|
|
1080
|
+
"bundle": "types/TableFoldersState.d.ts",
|
|
1081
|
+
"propsTotal": 3,
|
|
1082
|
+
"propsTypeName": "TableFoldersStatePublicAPI"
|
|
1083
|
+
},
|
|
702
1084
|
"TableGridSwitch": {
|
|
703
1085
|
"file": "TableGridSwitch.md",
|
|
704
1086
|
"category": "Base Components/Collections/TableGridSwitch/TableGridSwitch",
|
|
@@ -712,6 +1094,12 @@
|
|
|
712
1094
|
"TableGridSwitch/custom-columns.tsx"
|
|
713
1095
|
]
|
|
714
1096
|
},
|
|
1097
|
+
"TableGridSwitchDragAndDrop": {
|
|
1098
|
+
"file": "TableGridSwitchDragAndDrop.md",
|
|
1099
|
+
"category": "Features/Sort/Drag and Drop",
|
|
1100
|
+
"summary": "Enables drag and drop functionality on a `TableGridSwitch` component.",
|
|
1101
|
+
"importPath": "@wix/patterns"
|
|
1102
|
+
},
|
|
715
1103
|
"TableGridSwitchFolders": {
|
|
716
1104
|
"file": "TableGridSwitchFolders.md",
|
|
717
1105
|
"category": "Base Components/Collections/TableGridSwitchFolders/TableGridSwitchFolders",
|
|
@@ -723,12 +1111,25 @@
|
|
|
723
1111
|
"TableGridSwitchFolders/with-tags.tsx"
|
|
724
1112
|
]
|
|
725
1113
|
},
|
|
726
|
-
"
|
|
727
|
-
"file": "
|
|
728
|
-
"category": "
|
|
729
|
-
"summary": "
|
|
730
|
-
|
|
731
|
-
|
|
1114
|
+
"TableGridSwitchFoldersState": {
|
|
1115
|
+
"file": "TableGridSwitchFoldersState.md",
|
|
1116
|
+
"category": "Base Components/Collections/TableGridSwitchFolders/TableGridSwitchFoldersState",
|
|
1117
|
+
"summary": "`TableGridSwitchFoldersState` manages the state for a `TableGridSwitchFolders` component — a collection that supports switching between table and grid views while also displaying folders. Holds a `GridFoldersState`, a `TableFoldersState`, and a `viewTypeState` for toggling layouts."
|
|
1118
|
+
},
|
|
1119
|
+
"TableGridSwitchState": {
|
|
1120
|
+
"file": "TableGridSwitchState.md",
|
|
1121
|
+
"category": "Base Components/Collections/TableGridSwitch/TableGridSwitchState",
|
|
1122
|
+
"summary": "`TableGridSwitchState` manages the state for a `TableGridSwitch` component, which lets users switch between table and grid views. Wraps a `GridState` and a `TableState` with a shared `viewTypeState`. Created by `useTableGridSwitchCollection`.",
|
|
1123
|
+
"bundle": "types/TableGridSwitchState.d.ts",
|
|
1124
|
+
"propsTotal": 4,
|
|
1125
|
+
"propsTypeName": "_TableGridSwitchState"
|
|
1126
|
+
},
|
|
1127
|
+
"Table Sections": {
|
|
1128
|
+
"file": "Table Sections.md",
|
|
1129
|
+
"category": "Features/Display/Table Sections",
|
|
1130
|
+
"summary": "Group `Table` data into sections.",
|
|
1131
|
+
"examples": [
|
|
1132
|
+
"Table Sections/demo.tsx",
|
|
732
1133
|
"Table Sections/with-badge.tsx",
|
|
733
1134
|
"Table Sections/with-summary.tsx",
|
|
734
1135
|
"Table Sections/with-collapse.tsx"
|
|
@@ -739,6 +1140,14 @@
|
|
|
739
1140
|
"category": "Common/Types",
|
|
740
1141
|
"summary": "Configuration object for the `sections` prop on `Table`. Enables grouping table rows into collapsible sections with headers. Provide a `TableSections` component, a `groupBy` function, a `renderSection` callback, and optional `collapsible` and `events` properties."
|
|
741
1142
|
},
|
|
1143
|
+
"TableState": {
|
|
1144
|
+
"file": "TableState.md",
|
|
1145
|
+
"category": "Base Components/Collections/Table/TableState",
|
|
1146
|
+
"summary": "`TableState` manages the state for a `Table` component. It wraps a `CollectionState` for data, a `ToolbarCollectionState` for the toolbar, tracks visible columns and sorting, and supports virtual scrolling and drag-and-drop. Created by `useTableCollection`.",
|
|
1147
|
+
"bundle": "types/TableState.d.ts",
|
|
1148
|
+
"propsTotal": 5,
|
|
1149
|
+
"propsTypeName": "TableStatePublicAPI"
|
|
1150
|
+
},
|
|
742
1151
|
"TableTopNotification": {
|
|
743
1152
|
"file": "TableTopNotification.md",
|
|
744
1153
|
"category": "Features/Display/TableTopNotification",
|
|
@@ -786,6 +1195,11 @@
|
|
|
786
1195
|
"summary": "The `TagsWidget` component enhances the entity page by displaying the tags that are associated with the entity. It also enables to add new tags to the entity, and remove existing tags from it.",
|
|
787
1196
|
"importPath": "@wix/patterns"
|
|
788
1197
|
},
|
|
1198
|
+
"ToolbarCollectionState": {
|
|
1199
|
+
"file": "ToolbarCollectionState.md",
|
|
1200
|
+
"category": "Common/State",
|
|
1201
|
+
"summary": "`ToolbarCollectionState` manages the toolbar state for collection components. It handles filter panel visibility, custom columns selection, data capsule persistence, fedops reporting, and responsive layout calculations. You typically do not create this directly — it is managed internally by `TableState`, `GridState`, and similar component states."
|
|
1202
|
+
},
|
|
789
1203
|
"ToolbarSecondaryActions": {
|
|
790
1204
|
"file": "ToolbarSecondaryActions.md",
|
|
791
1205
|
"category": "Features/Actions/SecondaryActions",
|
|
@@ -810,6 +1224,11 @@
|
|
|
810
1224
|
"ToolbarTitle/title-count-and-the-collection-s-item-limit.tsx"
|
|
811
1225
|
]
|
|
812
1226
|
},
|
|
1227
|
+
"View": {
|
|
1228
|
+
"file": "View.md",
|
|
1229
|
+
"category": "Common/Types",
|
|
1230
|
+
"summary": "Defines a saved view in the `Views` dropdown. A view captures a snapshot of filters, visible columns, column order, sort directions, and layout type (table or grid). Use `isDefaultView` to set the initial view when the collection loads."
|
|
1231
|
+
},
|
|
813
1232
|
"Views": {
|
|
814
1233
|
"file": "Views.md",
|
|
815
1234
|
"category": "Features/Display/Views",
|
|
@@ -866,11 +1285,39 @@
|
|
|
866
1285
|
"importPath": "@wix/patterns/provider",
|
|
867
1286
|
"bundle": "components/WixPatternsProvider.d.ts"
|
|
868
1287
|
},
|
|
1288
|
+
"arrayFilter": {
|
|
1289
|
+
"file": "arrayFilter.md",
|
|
1290
|
+
"category": "Features/Filter/Factories",
|
|
1291
|
+
"summary": "A generic filter factory that can be used with the `filters` property of the `useCollection` hook, for selecting one or multiple values from a fixed or dynamic list of items.",
|
|
1292
|
+
"importPath": "@wix/patterns",
|
|
1293
|
+
"bundle": "functions/arrayFilter.d.ts",
|
|
1294
|
+
"propsTotal": 10,
|
|
1295
|
+
"propsTypeName": "ArrayFilterStateParams"
|
|
1296
|
+
},
|
|
869
1297
|
"bulkActionModal": {
|
|
870
1298
|
"file": "bulkActionModal.md",
|
|
871
1299
|
"category": "Features/Actions/Bulk Actions",
|
|
872
1300
|
"summary": "`bulkActionModal` is a render-prop passed to collection components (`Table`, `Grid`, `TableFolders`, etc.) that opens a custom modal when a bulk action is triggered from the `MultiBulkActionToolbar`. The render function receives: - `selectedValues` — the items selected via the checkbox column - `uncheckedValues` — the items that were unchecked (relevant when \"Select All\" is active) - `isSelectAll`…"
|
|
873
1301
|
},
|
|
1302
|
+
"createNestedTableLevel": {
|
|
1303
|
+
"file": "createNestedTableLevel.md",
|
|
1304
|
+
"category": "Base Components/Collections/NestedTable",
|
|
1305
|
+
"summary": "A helper function that creates a `NestedTableLevel` descriptor without specifying `depth` (depth is assigned automatically based on array position). Pass the result to the `levels` array in `useNestedTable`."
|
|
1306
|
+
},
|
|
1307
|
+
"createNestedTableSingleEntityLevels": {
|
|
1308
|
+
"file": "createNestedTableSingleEntityLevels.md",
|
|
1309
|
+
"category": "Base Components/Collections/NestedTable",
|
|
1310
|
+
"summary": "A helper function to create multiple nested table levels out of the same configurations for a single entity type."
|
|
1311
|
+
},
|
|
1312
|
+
"dateRangeFilter": {
|
|
1313
|
+
"file": "dateRangeFilter.Factories.md",
|
|
1314
|
+
"category": "Features/Filter/Factories",
|
|
1315
|
+
"summary": "The filter is used together with DateRangeFilter component. Check the component examples section to see all possibilities for this filter.",
|
|
1316
|
+
"importPath": "@wix/patterns",
|
|
1317
|
+
"bundle": "functions/dateRangeFilter.d.ts",
|
|
1318
|
+
"propsTotal": 11,
|
|
1319
|
+
"propsTypeName": "Partial"
|
|
1320
|
+
},
|
|
874
1321
|
"deleteSecondaryAction": {
|
|
875
1322
|
"file": "deleteSecondaryAction.md",
|
|
876
1323
|
"category": "Features/Actions/Action Cell",
|
|
@@ -879,6 +1326,71 @@
|
|
|
879
1326
|
"propsTotal": 11,
|
|
880
1327
|
"propsTypeName": "DeleteSecondaryActionProps"
|
|
881
1328
|
},
|
|
1329
|
+
"idNameArrayFilter": {
|
|
1330
|
+
"file": "idNameArrayFilter.md",
|
|
1331
|
+
"category": "Features/Filter/Factories",
|
|
1332
|
+
"summary": "This filter is often used for complex objects and types that do not have official support in Wix Patterns.",
|
|
1333
|
+
"importPath": "@wix/patterns",
|
|
1334
|
+
"bundle": "functions/idNameArrayFilter.d.ts",
|
|
1335
|
+
"propsTotal": 10,
|
|
1336
|
+
"propsTypeName": "ArrayFilterStateParams"
|
|
1337
|
+
},
|
|
1338
|
+
"stringFilter": {
|
|
1339
|
+
"file": "stringFilter.md",
|
|
1340
|
+
"category": "Features/Filter/Factories",
|
|
1341
|
+
"summary": "This filter was primarily designed to be used in conjunction with the search functionality within the WixPatterns collection. It is not typically necessary to use this filter instead of the other available filters.",
|
|
1342
|
+
"importPath": "@wix/patterns",
|
|
1343
|
+
"bundle": "functions/stringFilter.d.ts",
|
|
1344
|
+
"propsTotal": 2,
|
|
1345
|
+
"propsTypeName": "Partial"
|
|
1346
|
+
},
|
|
1347
|
+
"stringsArrayFilter": {
|
|
1348
|
+
"file": "stringsArrayFilter.md",
|
|
1349
|
+
"category": "Features/Filter/Factories",
|
|
1350
|
+
"summary": "The filter is used to manage an array of strings. The string value can be a simple string that is displayed to the user, an enum value that is translated using `itemName` prop, or even an array of IDs that is not used with UI component but rather as an internal filter for querying data.",
|
|
1351
|
+
"importPath": "@wix/patterns",
|
|
1352
|
+
"bundle": "functions/stringsArrayFilter.d.ts",
|
|
1353
|
+
"propsTotal": 10,
|
|
1354
|
+
"propsTypeName": "ArrayFilterStateParams"
|
|
1355
|
+
},
|
|
1356
|
+
"Component Tests": {
|
|
1357
|
+
"file": "Component Tests.md",
|
|
1358
|
+
"category": "Guides/Component Tests",
|
|
1359
|
+
"summary": "`Wix Patterns` provides uni driver testkits, similarly to `@wix/design-system` testing"
|
|
1360
|
+
},
|
|
1361
|
+
"Sled Tests": {
|
|
1362
|
+
"file": "Sled Tests.md",
|
|
1363
|
+
"category": "Guides/Sled Tests",
|
|
1364
|
+
"summary": "The power of uni drivers provided by `Wix Patterns` is that we can use them also in `puppeteer` environment."
|
|
1365
|
+
},
|
|
1366
|
+
"useAmbassadorCollection": {
|
|
1367
|
+
"file": "useAmbassadorCollection.md",
|
|
1368
|
+
"category": "Common/Hooks",
|
|
1369
|
+
"summary": "A React hook that initializes a collection state using an Ambassador SDK package. The ambassador package should implement the `crud.ts` module. This is a higher-level alternative to `useCollection` that auto-generates `fetchData`, `queryName`, and `itemKey` from the Ambassador SDK.",
|
|
1370
|
+
"importPath": "@wix/patterns"
|
|
1371
|
+
},
|
|
1372
|
+
"useCollection": {
|
|
1373
|
+
"file": "useCollection.md",
|
|
1374
|
+
"category": "Common/Hooks",
|
|
1375
|
+
"summary": "The base React hook for creating a `CollectionState`. All other collection hooks (`useTableCollection`, `useGridCollection`, etc.) build on top of `useCollection`. Use this hook directly when you need a collection state that is not tied to a specific component, or when building custom collection components.",
|
|
1376
|
+
"importPath": "@wix/patterns",
|
|
1377
|
+
"bundle": "hooks/useCollection.d.ts",
|
|
1378
|
+
"propsTotal": 17,
|
|
1379
|
+
"propsTypeName": "CollectionConfig"
|
|
1380
|
+
},
|
|
1381
|
+
"useCreateCollection": {
|
|
1382
|
+
"file": "useCreateCollection.md",
|
|
1383
|
+
"category": "Common/Hooks",
|
|
1384
|
+
"summary": "React hook that that retuns a function that initializes a collection state. Similiar to useCollection, but it returns a function that initializes a collection state instead of the collection state itself.",
|
|
1385
|
+
"bundle": "hooks/useCreateCollection.d.ts",
|
|
1386
|
+
"propsTotal": 17,
|
|
1387
|
+
"propsTypeName": "CollectionConfig"
|
|
1388
|
+
},
|
|
1389
|
+
"useCreateNestedOptimisticActions": {
|
|
1390
|
+
"file": "useCreateNestedOptimisticActions.md",
|
|
1391
|
+
"category": "Base Components/Collections/NestedTable",
|
|
1392
|
+
"summary": "A React hook that returns a function to create OptimisticActions instance for a nested table collection created in the `levels.createCollection` prop of useNestedTable."
|
|
1393
|
+
},
|
|
882
1394
|
"useEntity": {
|
|
883
1395
|
"file": "useEntity.md",
|
|
884
1396
|
"category": "Base Components/Pages/Entity Page/Hooks/useEntity",
|
|
@@ -904,12 +1416,45 @@
|
|
|
904
1416
|
"importPath": "@wix/patterns",
|
|
905
1417
|
"bundle": "hooks/useEntityPageContext.d.ts"
|
|
906
1418
|
},
|
|
1419
|
+
"useFilterCollection": {
|
|
1420
|
+
"file": "useFilterCollection.md",
|
|
1421
|
+
"category": "Features/Filter/Hooks",
|
|
1422
|
+
"summary": "React hook that connects a filter to a collection state.",
|
|
1423
|
+
"importPath": "@wix/patterns",
|
|
1424
|
+
"bundle": "hooks/useFilterCollection.d.ts",
|
|
1425
|
+
"propsTotal": 11,
|
|
1426
|
+
"propsTypeName": "FilterCollectionConfig"
|
|
1427
|
+
},
|
|
1428
|
+
"useGridCollection": {
|
|
1429
|
+
"file": "useGridCollection.md",
|
|
1430
|
+
"category": "Base Components/Collections/Grid/useGridCollection",
|
|
1431
|
+
"summary": "`useGridCollection` is a React hook designed to facilitate the management of the `Grid` component.It returns a `GridState` to pass to the `state` prop of the `Grid` component.",
|
|
1432
|
+
"importPath": "@wix/patterns",
|
|
1433
|
+
"bundle": "hooks/useGridCollection.d.ts",
|
|
1434
|
+
"propsTotal": 17,
|
|
1435
|
+
"propsTypeName": "CollectionConfig"
|
|
1436
|
+
},
|
|
1437
|
+
"useGridFolders": {
|
|
1438
|
+
"file": "useGridFolders.md",
|
|
1439
|
+
"category": "Base Components/Collections/GridFolders/useGridFolders",
|
|
1440
|
+
"summary": "`useGridFolders` is a React hook designed to facilitate the management of the `GridFolders` component.It returns a `GridFoldersState` to pass to the `state` prop of the `GridFolders` component.",
|
|
1441
|
+
"importPath": "@wix/patterns",
|
|
1442
|
+
"bundle": "hooks/useGridFolders.d.ts",
|
|
1443
|
+
"propsTotal": 2,
|
|
1444
|
+
"propsTypeName": "GridFoldersConfig"
|
|
1445
|
+
},
|
|
907
1446
|
"useItemsSelectionFilter": {
|
|
908
1447
|
"file": "useItemsSelectionFilter.md",
|
|
909
1448
|
"category": "Common/hooks",
|
|
910
1449
|
"summary": "The `useItemsSelectionFilter` hook creates a filter that fetches and displays items from a specific provider.",
|
|
911
1450
|
"importPath": "@wix/patterns"
|
|
912
1451
|
},
|
|
1452
|
+
"useNestedTable": {
|
|
1453
|
+
"file": "useNestedTable.md",
|
|
1454
|
+
"category": "Base Components/Collections/NestedTable",
|
|
1455
|
+
"summary": "`useNestedTable` is a React hook that creates the state for a `NestedTable` component — a table that displays hierarchical data with expand/collapse, flat and nested view modes, and multi-level optimistic actions. You define the hierarchy through `levels`, where each level describes how to fetch its items, how they relate to their parent, and how to render columns.",
|
|
1456
|
+
"importPath": "@wix/patterns"
|
|
1457
|
+
},
|
|
913
1458
|
"useOptimisticActions": {
|
|
914
1459
|
"file": "useOptimisticActions.md",
|
|
915
1460
|
"category": "Features/Actions/Updates",
|
|
@@ -927,6 +1472,12 @@
|
|
|
927
1472
|
"useOptimisticActions/custom-error-handling.tsx"
|
|
928
1473
|
]
|
|
929
1474
|
},
|
|
1475
|
+
"usePickerContent": {
|
|
1476
|
+
"file": "usePickerContent.md",
|
|
1477
|
+
"category": "Base Components/Collections/Picker/Hooks",
|
|
1478
|
+
"summary": "`usePickerContent` is a React hook that creates the collection state for the content displayed inside a `PickerModal`. It extends the collection config (like `filters`, `itemName`) and adds picker-specific options such as `modalState`, `events`, and `initialSelect`.",
|
|
1479
|
+
"importPath": "@wix/patterns"
|
|
1480
|
+
},
|
|
930
1481
|
"usePickerModal": {
|
|
931
1482
|
"file": "usePickerModal.md",
|
|
932
1483
|
"category": "Base Components/Collections/Picker/Hooks",
|
|
@@ -960,447 +1511,41 @@
|
|
|
960
1511
|
"summary": "A React hook that retrieves `SettingsPageState` from React context. Use it in any child component rendered within `SettingsPage` to access the page state without prop-drilling.",
|
|
961
1512
|
"importPath": "@wix/patterns"
|
|
962
1513
|
},
|
|
963
|
-
"
|
|
964
|
-
"file": "
|
|
965
|
-
"category": "Features/
|
|
966
|
-
"summary": "
|
|
967
|
-
"
|
|
968
|
-
"
|
|
969
|
-
"
|
|
970
|
-
|
|
971
|
-
"BulkActionModalRenderProp": {
|
|
972
|
-
"file": "BulkActionModalRenderProp.md",
|
|
973
|
-
"category": "Common/Types",
|
|
974
|
-
"summary": "A render-prop type for the `bulkActionModal` prop on collection components (`Table`, `Grid`, etc.). The render function receives selection state (`selectedValues`, `uncheckedValues`, `allSelected`), a `query` object, and modal controls (`openModal`, `closeModal`). Return a React element for the modal content.",
|
|
975
|
-
"bundle": "types/BulkActionModalRenderPropParams.d.ts",
|
|
976
|
-
"propsTotal": 7,
|
|
977
|
-
"propsTypeName": "BulkActionModalRenderPropParams"
|
|
978
|
-
},
|
|
979
|
-
"Category": {
|
|
980
|
-
"file": "Category.md",
|
|
981
|
-
"category": "Common/Types",
|
|
982
|
-
"summary": "Defines a category in the `Views` dropdown. A category groups related views and appears as a section header. Each category has a unique `id`, a display `name`, and an array of `View` objects."
|
|
983
|
-
},
|
|
984
|
-
"BulkSelectState": {
|
|
985
|
-
"file": "BulkSelectState.md",
|
|
986
|
-
"category": "Common/State",
|
|
987
|
-
"summary": "`BulkSelectState` manages the selection state for bulk actions in collection components. It tracks which items are selected, supports \"Select All\", and provides `allSelected`, `selectedValues`, and `uncheckedValues` properties. Created internally by `CollectionState` — you typically access it via `state.collection.bulkSelect`."
|
|
988
|
-
},
|
|
989
|
-
"CollectionSection": {
|
|
990
|
-
"file": "CollectionSection.md",
|
|
991
|
-
"category": "Common/Types"
|
|
992
|
-
},
|
|
993
|
-
"CollectionState": {
|
|
994
|
-
"file": "CollectionState.md",
|
|
995
|
-
"category": "Common/State",
|
|
996
|
-
"summary": "`CollectionState` is the core state object for all collection components. It manages server data fetching, pagination, filtering, sorting, search, and bulk selection. Created by hooks like `useTableCollection` or `useGridCollection`. Key methods: `invalidate()`, `refreshCurrentPage()`, `clearResultAndMoveToStart()`, `retryErrorState()`."
|
|
1514
|
+
"useStaticListFilterCollection": {
|
|
1515
|
+
"file": "useStaticListFilterCollection.md",
|
|
1516
|
+
"category": "Features/Filter/Hooks",
|
|
1517
|
+
"summary": "`useStaticListFilterCollection` is a hook that connects a filter (ArrayFilter, usually), to a CollectionState created from a static list of items. It also providers search functionality (search term, will be matched against the itemName function configured on the `filter` object).",
|
|
1518
|
+
"importPath": "@wix/patterns",
|
|
1519
|
+
"bundle": "hooks/useStaticListFilterCollection.d.ts",
|
|
1520
|
+
"propsTotal": 2,
|
|
1521
|
+
"propsTypeName": "UseStaticListFilterCollectionProps"
|
|
997
1522
|
},
|
|
998
|
-
"
|
|
999
|
-
"file": "
|
|
1000
|
-
"category": "
|
|
1001
|
-
"summary": "`
|
|
1002
|
-
"
|
|
1003
|
-
"
|
|
1004
|
-
"
|
|
1523
|
+
"useTableCollection": {
|
|
1524
|
+
"file": "useTableCollection.md",
|
|
1525
|
+
"category": "Base Components/Collections/Table/useTableCollection",
|
|
1526
|
+
"summary": "`useTableCollection` is a React hook designed to facilitate the management of the `Table` component.It returns a `TableState` to pass to the `state` prop of the `Table` component.",
|
|
1527
|
+
"importPath": "@wix/patterns",
|
|
1528
|
+
"bundle": "hooks/useTableCollection.d.ts",
|
|
1529
|
+
"propsTotal": 17,
|
|
1530
|
+
"propsTypeName": "CollectionConfig"
|
|
1005
1531
|
},
|
|
1006
|
-
"
|
|
1007
|
-
"file": "
|
|
1008
|
-
"category": "
|
|
1009
|
-
"summary": "
|
|
1532
|
+
"useTableFolders": {
|
|
1533
|
+
"file": "useTableFolders.md",
|
|
1534
|
+
"category": "Base Components/Collections/TableFolders/useTableFolders",
|
|
1535
|
+
"summary": "`useTableFolders` is a React hook designed to facilitate the management of the `TableFolders` component.It returns a `TableFoldersState` to pass to the `state` prop of the `TableFolders` component.",
|
|
1536
|
+
"importPath": "@wix/patterns",
|
|
1537
|
+
"bundle": "hooks/useTableFolders.d.ts",
|
|
1538
|
+
"propsTotal": 2,
|
|
1539
|
+
"propsTypeName": "TableFoldersConfig"
|
|
1010
1540
|
},
|
|
1011
|
-
"
|
|
1012
|
-
"file": "
|
|
1013
|
-
"category": "
|
|
1014
|
-
"summary": "
|
|
1541
|
+
"useTableGridSwitchCollection": {
|
|
1542
|
+
"file": "useTableGridSwitchCollection.md",
|
|
1543
|
+
"category": "Base Components/Collections/TableGridSwitch/useTableGridSwitchCollection",
|
|
1544
|
+
"summary": "`useTableGridSwitchCollection` is a React hook designed to facilitate the management of the `TableGridSwitch` component.It returns a `TableGridSwitchState` to pass to the `state` prop of the `TableGridSwitch` component.",
|
|
1015
1545
|
"importPath": "@wix/patterns",
|
|
1016
|
-
"bundle": "
|
|
1546
|
+
"bundle": "hooks/useTableGridSwitchCollection.d.ts",
|
|
1017
1547
|
"propsTotal": 17,
|
|
1018
|
-
"propsTypeName": "
|
|
1019
|
-
},
|
|
1020
|
-
"Data Extension Overview": {
|
|
1021
|
-
"file": "Data Extension Overview.md",
|
|
1022
|
-
"category": "Features/Enrich/Data Extension",
|
|
1023
|
-
"summary": "Patterns Data Extension feature builds on the open platform Data Extensions capability."
|
|
1024
|
-
},
|
|
1025
|
-
"Display Extended Fields": {
|
|
1026
|
-
"file": "Display Extended Fields.md",
|
|
1027
|
-
"category": "Features/Enrich/Data Extension",
|
|
1028
|
-
"summary": "This guide explains how to display extended fields in your table."
|
|
1029
|
-
},
|
|
1030
|
-
"Enable Filters for Extended Fields": {
|
|
1031
|
-
"file": "Enable Filters for Extended Fields.md",
|
|
1032
|
-
"category": "Features/Enrich/Data Extension",
|
|
1033
|
-
"summary": "This article explains how to enable filters on your extended fields."
|
|
1034
|
-
},
|
|
1035
|
-
"Allow Users to Add Extended Fields": {
|
|
1036
|
-
"file": "Allow Users to Add Extended Fields.md",
|
|
1037
|
-
"category": "Features/Enrich/Data Extension",
|
|
1038
|
-
"summary": "This guide shows you how to let users add and manage extended fields."
|
|
1039
|
-
},
|
|
1040
|
-
"DataResultRaw": {
|
|
1041
|
-
"file": "DataResultRaw.md",
|
|
1042
|
-
"category": "Common/Types",
|
|
1043
|
-
"summary": "The return type of the `fetchData` function passed to collection hooks. Contains the `items` array, optional `total` count (after filters), `available` count (before filters), `cursor` for cursor-based pagination, and `hasNext` flag.",
|
|
1044
|
-
"bundle": "types/DataResultRaw.d.ts",
|
|
1045
|
-
"propsTotal": 5,
|
|
1046
|
-
"propsTypeName": "DataResultRaw"
|
|
1047
|
-
},
|
|
1048
|
-
"EntityPageState": {
|
|
1049
|
-
"file": "EntityPageState.md",
|
|
1050
|
-
"category": "Base Components/Pages/Entity Page/State",
|
|
1051
|
-
"summary": "`EntityPageState` is the state object that drives an `EntityPage`. It is created by the `useEntityPage` hook and manages: - **Entity fetching** — loads the entity from the server via `fetch` - **Form state** — integrates with `react-hook-form` for editing - **Save / cancel flow** — calls `onSave` with form values and handles success/error toasts - **Dirty-form protection** — warns on `beforeunload…",
|
|
1052
|
-
"bundle": "types/EntityPageState.d.ts",
|
|
1053
|
-
"propsTotal": 4,
|
|
1054
|
-
"propsTypeName": "EntityPageState"
|
|
1055
|
-
},
|
|
1056
|
-
"ExportTo": {
|
|
1057
|
-
"file": "ExportTo.md",
|
|
1058
|
-
"category": "Features/Export",
|
|
1059
|
-
"summary": "The ExportTo is a platformised solution for exporting lists of data.",
|
|
1060
|
-
"importPath": "@wix/patterns",
|
|
1061
|
-
"bundle": "components/ExportButton.d.ts",
|
|
1062
|
-
"propsTotal": 12,
|
|
1063
|
-
"propsTypeName": "ExportButtonProps",
|
|
1064
|
-
"symbols": [
|
|
1065
|
-
"ExportButton"
|
|
1066
|
-
],
|
|
1067
|
-
"examples": [
|
|
1068
|
-
"ExportTo/export-all-table.tsx",
|
|
1069
|
-
"ExportTo/export-filtered-table.tsx",
|
|
1070
|
-
"ExportTo/export-table-with-selection-bulk-selection.tsx",
|
|
1071
|
-
"ExportTo/cta-is-out-of-the-table.tsx"
|
|
1072
|
-
]
|
|
1073
|
-
},
|
|
1074
|
-
"FilterProps": {
|
|
1075
|
-
"file": "FilterProps.md",
|
|
1076
|
-
"category": "Features/Filter/Props",
|
|
1077
|
-
"summary": "The base filter component interface used by all filter types in Wix Patterns. Each filter defines how it renders in the toolbar, its value type, and how it maps to query parameters. See specific filter implementations like `SingleSelectFilter`, `MultiSelectCheckboxFilter`, and `DateRangeFilter`.",
|
|
1078
|
-
"bundle": "types/FilterProps.d.ts",
|
|
1079
|
-
"propsTotal": 11,
|
|
1080
|
-
"propsTypeName": "FilterProps"
|
|
1081
|
-
},
|
|
1082
|
-
"FormPageState": {
|
|
1083
|
-
"file": "FormPageState.md",
|
|
1084
|
-
"category": "Common/State",
|
|
1085
|
-
"summary": "`FormPageState` manages form state for page components (`EntityPage`, `SettingsPage`). It wraps a `react-hook-form` `UseFormReturn` instance and adds initialization/submission task tracking and optional widgets form state. You typically do not create this directly — it is managed internally by `EntityPageState` or `SettingsPageState`."
|
|
1086
|
-
},
|
|
1087
|
-
"GridDragAndDrop": {
|
|
1088
|
-
"file": "GridDragAndDrop.md",
|
|
1089
|
-
"category": "Features/Sort/Drag and Drop",
|
|
1090
|
-
"summary": "Enables drag and drop functionality on a `Grid` component.",
|
|
1091
|
-
"importPath": "@wix/patterns"
|
|
1092
|
-
},
|
|
1093
|
-
"GridFoldersState": {
|
|
1094
|
-
"file": "GridFoldersState.md",
|
|
1095
|
-
"category": "Base Components/Collections/GridFolders/GridFoldersState",
|
|
1096
|
-
"summary": "`GridFoldersState` manages the state for a `GridFolders` component, which displays both folders and items in a grid layout. It holds separate `CollectionState` instances for folders and items, plus a shared toolbar. Created by `useGridCollection` with a folders configuration.",
|
|
1097
|
-
"bundle": "types/GridFoldersState.d.ts",
|
|
1098
|
-
"propsTotal": 1,
|
|
1099
|
-
"propsTypeName": "GridFoldersStatePublicAPI"
|
|
1100
|
-
},
|
|
1101
|
-
"GridState": {
|
|
1102
|
-
"file": "GridState.md",
|
|
1103
|
-
"category": "Base Components/Collections/Grid/GridState",
|
|
1104
|
-
"summary": "`GridState` manages the state for a `Grid` component. It wraps a `CollectionState` for data, a `ToolbarCollectionState` for the toolbar, and tracks grid-specific UI state like size presets and sections. Created by `useGridCollection`.",
|
|
1105
|
-
"bundle": "types/GridState.d.ts",
|
|
1106
|
-
"propsTotal": 3,
|
|
1107
|
-
"propsTypeName": "GridStatePublicAPI"
|
|
1108
|
-
},
|
|
1109
|
-
"MoreActionsItem": {
|
|
1110
|
-
"file": "MoreActionsItem.md",
|
|
1111
|
-
"category": "Common/Types",
|
|
1112
|
-
"summary": "Defines an action item in the `MoreActions` dropdown menu. Each item has a `text` label, an `onClick` handler, and optional properties like `prefixIcon`, `skin` (`dark` or `destructive`), `disabled`, `subtitle`, and `dataHook`.",
|
|
1113
|
-
"bundle": "types/MoreActionsItem.d.ts",
|
|
1114
|
-
"propsTotal": 10,
|
|
1115
|
-
"propsTypeName": "MoreActionsItem"
|
|
1116
|
-
},
|
|
1117
|
-
"MultiBulkActionToolbar": {
|
|
1118
|
-
"file": "MultiBulkActionToolbar.md",
|
|
1119
|
-
"category": "Features/Actions/Bulk Actions",
|
|
1120
|
-
"summary": "Provides the ability to perform multiple operations on multiple items.",
|
|
1121
|
-
"importPath": "@wix/patterns",
|
|
1122
|
-
"bundle": "components/MultiBulkActionToolbar.d.ts",
|
|
1123
|
-
"propsTotal": 5,
|
|
1124
|
-
"propsTypeName": "MultiBulkActionToolbarProps",
|
|
1125
|
-
"examples": [
|
|
1126
|
-
"MultiBulkActionToolbar/bulk-action.tsx",
|
|
1127
|
-
"MultiBulkActionToolbar/popover-menu.tsx",
|
|
1128
|
-
"MultiBulkActionToolbar/basic-secondary-action.tsx",
|
|
1129
|
-
"MultiBulkActionToolbar/primary-secondary-actions-with-a-divider.tsx",
|
|
1130
|
-
"MultiBulkActionToolbar/maximum-selection.tsx",
|
|
1131
|
-
"MultiBulkActionToolbar/extend-menu-items.tsx"
|
|
1132
|
-
]
|
|
1133
|
-
},
|
|
1134
|
-
"MultiLevelSorting": {
|
|
1135
|
-
"file": "MultiLevelSorting.md",
|
|
1136
|
-
"category": "Features/Sort/Sortable Columns/MultiLevelSorting",
|
|
1137
|
-
"summary": "Allows visitors to apply sorting to multiple columns (in hierarchical order).",
|
|
1138
|
-
"importPath": "@wix/patterns",
|
|
1139
|
-
"bundle": "types/MultiLevelSorting.d.ts",
|
|
1140
|
-
"propsTotal": 4,
|
|
1141
|
-
"propsTypeName": "IMultiLevelSortingProps",
|
|
1142
|
-
"examples": [
|
|
1143
|
-
"MultiLevelSorting/basic-multi-level-sorting.tsx",
|
|
1144
|
-
"MultiLevelSorting/multi-level-sorting-with-defined-sort-directions.tsx",
|
|
1145
|
-
"MultiLevelSorting/multi-level-sorting-with-custom-sort-order.tsx"
|
|
1146
|
-
]
|
|
1147
|
-
},
|
|
1148
|
-
"NestedTableLevel": {
|
|
1149
|
-
"file": "NestedTableLevel.md",
|
|
1150
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1151
|
-
"summary": "Describes a single level in a `NestedTable` hierarchy. Each level defines how its items are fetched (`createCollection`), how they relate to parents (`parentKey`), and how they render (`columns`, `renderMainColumn`, `actionCell`). Supports expandability, breadcrumbs, drag-and-drop, and row highlighting."
|
|
1152
|
-
},
|
|
1153
|
-
"NestedTableNodeState": {
|
|
1154
|
-
"file": "NestedTableNodeState.md",
|
|
1155
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1156
|
-
"summary": "`NestedTableNodeState` represents a single node in a `NestedTable` tree. Each node has a `depth`, `expanded` state, `children` collection, `optimisticActions`, and access to its parent via `getParent()`. Use `getData()` to access the item and `toggleExpand()` to expand/collapse."
|
|
1157
|
-
},
|
|
1158
|
-
"NestedTableOptimisticActions": {
|
|
1159
|
-
"file": "NestedTableOptimisticActions.md",
|
|
1160
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1161
|
-
"summary": "Extends the standard optimistic actions API with nested-table-specific operations. Provides `updateMany`, `updateOne`, `deleteMany`, and `deleteOne` methods that accept a `propagate` parameter to cascade changes to child nodes. Access via `nodeState.optimisticActions`."
|
|
1162
|
-
},
|
|
1163
|
-
"NestedTableState": {
|
|
1164
|
-
"file": "NestedTableState.md",
|
|
1165
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1166
|
-
"summary": "`NestedTableState` manages the state for a `NestedTable` component. It handles multi-level hierarchical data with expand/collapse, flat and nested view modes, toolbar, and optimistic actions. Created by `useNestedTable`."
|
|
1167
|
-
},
|
|
1168
|
-
"operatorFilter": {
|
|
1169
|
-
"file": "operatorFilter.md",
|
|
1170
|
-
"category": "Features/Filter/Factories",
|
|
1171
|
-
"summary": "The `operatorFilter` factory creates a filter that combines an operator selection with a value input. It is ideal for advanced filtering scenarios where users need to specify how they want to filter data.",
|
|
1172
|
-
"importPath": "@wix/patterns",
|
|
1173
|
-
"bundle": "functions/operatorFilter.d.ts",
|
|
1174
|
-
"propsTotal": 11,
|
|
1175
|
-
"propsTypeName": "OperatorFilterStateParams"
|
|
1176
|
-
},
|
|
1177
|
-
"SettingsPageState": {
|
|
1178
|
-
"file": "SettingsPageState.md",
|
|
1179
|
-
"category": "Base Components/Pages/Settings Page/State",
|
|
1180
|
-
"summary": "`SettingsPageState` is the state object that drives a `SettingsPage`. It is created by the `useSettingsPage` hook and manages: - **Settings fetching** — loads the current settings from the server via `fetch` - **Form state** — integrates with `react-hook-form` for editing - **Save / cancel flow** — calls `onSave` and `onCancel` with success/error toasts - **Dirty-form protection** — warns on `befo…"
|
|
1181
|
-
},
|
|
1182
|
-
"TableColumn": {
|
|
1183
|
-
"file": "TableColumn.md",
|
|
1184
|
-
"category": "Common/Types",
|
|
1185
|
-
"summary": "Defines a column in a `Table` component. Extends the Wix Design System table column with Patterns-specific features: `sortable` / `defaultSortOrder`, `searchable`, `hideable` (for `CustomColumns`), and `mobile` layout configuration.",
|
|
1186
|
-
"bundle": "types/TableColumn.d.ts",
|
|
1187
|
-
"propsTotal": 19,
|
|
1188
|
-
"propsTypeName": "Column"
|
|
1189
|
-
},
|
|
1190
|
-
"TableDragAndDrop": {
|
|
1191
|
-
"file": "TableDragAndDrop.md",
|
|
1192
|
-
"category": "Features/Sort/Drag and Drop",
|
|
1193
|
-
"summary": "Enables drag and drop functionality on a `Table` component.",
|
|
1194
|
-
"importPath": "@wix/patterns",
|
|
1195
|
-
"examples": [
|
|
1196
|
-
"TableDragAndDrop/table.tsx",
|
|
1197
|
-
"TableDragAndDrop/specific-tabs.tsx",
|
|
1198
|
-
"TableDragAndDrop/specific-filters.tsx",
|
|
1199
|
-
"TableDragAndDrop/save-order-mode.tsx"
|
|
1200
|
-
]
|
|
1201
|
-
},
|
|
1202
|
-
"TableFoldersState": {
|
|
1203
|
-
"file": "TableFoldersState.md",
|
|
1204
|
-
"category": "Base Components/Collections/TableFolders/TableFoldersState",
|
|
1205
|
-
"summary": "`TableFoldersState` manages the state for a `TableFolders` component, which displays folders and items in a table layout. Holds separate `CollectionState` instances for folders and items, plus a shared `TableState` and toolbar. Created by `useTableCollection` with a folders configuration.",
|
|
1206
|
-
"bundle": "types/TableFoldersState.d.ts",
|
|
1207
|
-
"propsTotal": 3,
|
|
1208
|
-
"propsTypeName": "TableFoldersStatePublicAPI"
|
|
1209
|
-
},
|
|
1210
|
-
"TableGridSwitchDragAndDrop": {
|
|
1211
|
-
"file": "TableGridSwitchDragAndDrop.md",
|
|
1212
|
-
"category": "Features/Sort/Drag and Drop",
|
|
1213
|
-
"summary": "Enables drag and drop functionality on a `TableGridSwitch` component.",
|
|
1214
|
-
"importPath": "@wix/patterns"
|
|
1215
|
-
},
|
|
1216
|
-
"TableGridSwitchFoldersState": {
|
|
1217
|
-
"file": "TableGridSwitchFoldersState.md",
|
|
1218
|
-
"category": "Base Components/Collections/TableGridSwitchFolders/TableGridSwitchFoldersState",
|
|
1219
|
-
"summary": "`TableGridSwitchFoldersState` manages the state for a `TableGridSwitchFolders` component — a collection that supports switching between table and grid views while also displaying folders. Holds a `GridFoldersState`, a `TableFoldersState`, and a `viewTypeState` for toggling layouts."
|
|
1220
|
-
},
|
|
1221
|
-
"TableGridSwitchState": {
|
|
1222
|
-
"file": "TableGridSwitchState.md",
|
|
1223
|
-
"category": "Base Components/Collections/TableGridSwitch/TableGridSwitchState",
|
|
1224
|
-
"summary": "`TableGridSwitchState` manages the state for a `TableGridSwitch` component, which lets users switch between table and grid views. Wraps a `GridState` and a `TableState` with a shared `viewTypeState`. Created by `useTableGridSwitchCollection`.",
|
|
1225
|
-
"bundle": "types/TableGridSwitchState.d.ts",
|
|
1226
|
-
"propsTotal": 4,
|
|
1227
|
-
"propsTypeName": "_TableGridSwitchState"
|
|
1228
|
-
},
|
|
1229
|
-
"TableState": {
|
|
1230
|
-
"file": "TableState.md",
|
|
1231
|
-
"category": "Base Components/Collections/Table/TableState",
|
|
1232
|
-
"summary": "`TableState` manages the state for a `Table` component. It wraps a `CollectionState` for data, a `ToolbarCollectionState` for the toolbar, tracks visible columns and sorting, and supports virtual scrolling and drag-and-drop. Created by `useTableCollection`.",
|
|
1233
|
-
"bundle": "types/TableState.d.ts",
|
|
1234
|
-
"propsTotal": 5,
|
|
1235
|
-
"propsTypeName": "TableStatePublicAPI"
|
|
1236
|
-
},
|
|
1237
|
-
"ToolbarCollectionState": {
|
|
1238
|
-
"file": "ToolbarCollectionState.md",
|
|
1239
|
-
"category": "Common/State",
|
|
1240
|
-
"summary": "`ToolbarCollectionState` manages the toolbar state for collection components. It handles filter panel visibility, custom columns selection, data capsule persistence, fedops reporting, and responsive layout calculations. You typically do not create this directly — it is managed internally by `TableState`, `GridState`, and similar component states."
|
|
1241
|
-
},
|
|
1242
|
-
"View": {
|
|
1243
|
-
"file": "View.md",
|
|
1244
|
-
"category": "Common/Types",
|
|
1245
|
-
"summary": "Defines a saved view in the `Views` dropdown. A view captures a snapshot of filters, visible columns, column order, sort directions, and layout type (table or grid). Use `isDefaultView` to set the initial view when the collection loads."
|
|
1246
|
-
},
|
|
1247
|
-
"arrayFilter": {
|
|
1248
|
-
"file": "arrayFilter.md",
|
|
1249
|
-
"category": "Features/Filter/Factories",
|
|
1250
|
-
"summary": "A generic filter factory that can be used with the `filters` property of the `useCollection` hook, for selecting one or multiple values from a fixed or dynamic list of items.",
|
|
1251
|
-
"importPath": "@wix/patterns",
|
|
1252
|
-
"bundle": "functions/arrayFilter.d.ts",
|
|
1253
|
-
"propsTotal": 10,
|
|
1254
|
-
"propsTypeName": "ArrayFilterStateParams"
|
|
1255
|
-
},
|
|
1256
|
-
"createNestedTableLevel": {
|
|
1257
|
-
"file": "createNestedTableLevel.md",
|
|
1258
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1259
|
-
"summary": "A helper function that creates a `NestedTableLevel` descriptor without specifying `depth` (depth is assigned automatically based on array position). Pass the result to the `levels` array in `useNestedTable`."
|
|
1260
|
-
},
|
|
1261
|
-
"createNestedTableSingleEntityLevels": {
|
|
1262
|
-
"file": "createNestedTableSingleEntityLevels.md",
|
|
1263
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1264
|
-
"summary": "A helper function to create multiple nested table levels out of the same configurations for a single entity type."
|
|
1265
|
-
},
|
|
1266
|
-
"dateRangeFilter": {
|
|
1267
|
-
"file": "dateRangeFilter.Factories.md",
|
|
1268
|
-
"category": "Features/Filter/Factories",
|
|
1269
|
-
"summary": "The filter is used together with DateRangeFilter component. Check the component examples section to see all possibilities for this filter.",
|
|
1270
|
-
"importPath": "@wix/patterns",
|
|
1271
|
-
"bundle": "functions/dateRangeFilter.d.ts",
|
|
1272
|
-
"propsTotal": 11,
|
|
1273
|
-
"propsTypeName": "Partial"
|
|
1274
|
-
},
|
|
1275
|
-
"idNameArrayFilter": {
|
|
1276
|
-
"file": "idNameArrayFilter.md",
|
|
1277
|
-
"category": "Features/Filter/Factories",
|
|
1278
|
-
"summary": "This filter is often used for complex objects and types that do not have official support in Wix Patterns.",
|
|
1279
|
-
"importPath": "@wix/patterns",
|
|
1280
|
-
"bundle": "functions/idNameArrayFilter.d.ts",
|
|
1281
|
-
"propsTotal": 10,
|
|
1282
|
-
"propsTypeName": "ArrayFilterStateParams"
|
|
1283
|
-
},
|
|
1284
|
-
"stringFilter": {
|
|
1285
|
-
"file": "stringFilter.md",
|
|
1286
|
-
"category": "Features/Filter/Factories",
|
|
1287
|
-
"summary": "This filter was primarily designed to be used in conjunction with the search functionality within the WixPatterns collection. It is not typically necessary to use this filter instead of the other available filters.",
|
|
1288
|
-
"importPath": "@wix/patterns",
|
|
1289
|
-
"bundle": "functions/stringFilter.d.ts",
|
|
1290
|
-
"propsTotal": 2,
|
|
1291
|
-
"propsTypeName": "Partial"
|
|
1292
|
-
},
|
|
1293
|
-
"stringsArrayFilter": {
|
|
1294
|
-
"file": "stringsArrayFilter.md",
|
|
1295
|
-
"category": "Features/Filter/Factories",
|
|
1296
|
-
"summary": "The filter is used to manage an array of strings. The string value can be a simple string that is displayed to the user, an enum value that is translated using `itemName` prop, or even an array of IDs that is not used with UI component but rather as an internal filter for querying data.",
|
|
1297
|
-
"importPath": "@wix/patterns",
|
|
1298
|
-
"bundle": "functions/stringsArrayFilter.d.ts",
|
|
1299
|
-
"propsTotal": 10,
|
|
1300
|
-
"propsTypeName": "ArrayFilterStateParams"
|
|
1301
|
-
},
|
|
1302
|
-
"useAmbassadorCollection": {
|
|
1303
|
-
"file": "useAmbassadorCollection.md",
|
|
1304
|
-
"category": "Common/Hooks",
|
|
1305
|
-
"summary": "A React hook that initializes a collection state using an Ambassador SDK package. The ambassador package should implement the `crud.ts` module. This is a higher-level alternative to `useCollection` that auto-generates `fetchData`, `queryName`, and `itemKey` from the Ambassador SDK.",
|
|
1306
|
-
"importPath": "@wix/patterns"
|
|
1307
|
-
},
|
|
1308
|
-
"useCollection": {
|
|
1309
|
-
"file": "useCollection.md",
|
|
1310
|
-
"category": "Common/Hooks",
|
|
1311
|
-
"summary": "The base React hook for creating a `CollectionState`. All other collection hooks (`useTableCollection`, `useGridCollection`, etc.) build on top of `useCollection`. Use this hook directly when you need a collection state that is not tied to a specific component, or when building custom collection components.",
|
|
1312
|
-
"importPath": "@wix/patterns",
|
|
1313
|
-
"bundle": "hooks/useCollection.d.ts",
|
|
1314
|
-
"propsTotal": 17,
|
|
1315
|
-
"propsTypeName": "CollectionConfig"
|
|
1316
|
-
},
|
|
1317
|
-
"useCreateCollection": {
|
|
1318
|
-
"file": "useCreateCollection.md",
|
|
1319
|
-
"category": "Common/Hooks",
|
|
1320
|
-
"summary": "React hook that that retuns a function that initializes a collection state. Similiar to useCollection, but it returns a function that initializes a collection state instead of the collection state itself.",
|
|
1321
|
-
"bundle": "hooks/useCreateCollection.d.ts",
|
|
1322
|
-
"propsTotal": 17,
|
|
1323
|
-
"propsTypeName": "CollectionConfig"
|
|
1324
|
-
},
|
|
1325
|
-
"useCreateNestedOptimisticActions": {
|
|
1326
|
-
"file": "useCreateNestedOptimisticActions.md",
|
|
1327
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1328
|
-
"summary": "A React hook that returns a function to create OptimisticActions instance for a nested table collection created in the `levels.createCollection` prop of useNestedTable."
|
|
1329
|
-
},
|
|
1330
|
-
"useFilterCollection": {
|
|
1331
|
-
"file": "useFilterCollection.md",
|
|
1332
|
-
"category": "Features/Filter/Hooks",
|
|
1333
|
-
"summary": "React hook that connects a filter to a collection state.",
|
|
1334
|
-
"importPath": "@wix/patterns",
|
|
1335
|
-
"bundle": "hooks/useFilterCollection.d.ts",
|
|
1336
|
-
"propsTotal": 11,
|
|
1337
|
-
"propsTypeName": "FilterCollectionConfig"
|
|
1338
|
-
},
|
|
1339
|
-
"useGridCollection": {
|
|
1340
|
-
"file": "useGridCollection.md",
|
|
1341
|
-
"category": "Base Components/Collections/Grid/useGridCollection",
|
|
1342
|
-
"summary": "`useGridCollection` is a React hook designed to facilitate the management of the `Grid` component.It returns a `GridState` to pass to the `state` prop of the `Grid` component.",
|
|
1343
|
-
"importPath": "@wix/patterns",
|
|
1344
|
-
"bundle": "hooks/useGridCollection.d.ts",
|
|
1345
|
-
"propsTotal": 17,
|
|
1346
|
-
"propsTypeName": "CollectionConfig"
|
|
1347
|
-
},
|
|
1348
|
-
"useGridFolders": {
|
|
1349
|
-
"file": "useGridFolders.md",
|
|
1350
|
-
"category": "Base Components/Collections/GridFolders/useGridFolders",
|
|
1351
|
-
"summary": "`useGridFolders` is a React hook designed to facilitate the management of the `GridFolders` component.It returns a `GridFoldersState` to pass to the `state` prop of the `GridFolders` component.",
|
|
1352
|
-
"importPath": "@wix/patterns",
|
|
1353
|
-
"bundle": "hooks/useGridFolders.d.ts",
|
|
1354
|
-
"propsTotal": 2,
|
|
1355
|
-
"propsTypeName": "GridFoldersConfig"
|
|
1356
|
-
},
|
|
1357
|
-
"useNestedTable": {
|
|
1358
|
-
"file": "useNestedTable.md",
|
|
1359
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1360
|
-
"summary": "`useNestedTable` is a React hook that creates the state for a `NestedTable` component — a table that displays hierarchical data with expand/collapse, flat and nested view modes, and multi-level optimistic actions. You define the hierarchy through `levels`, where each level describes how to fetch its items, how they relate to their parent, and how to render columns.",
|
|
1361
|
-
"importPath": "@wix/patterns"
|
|
1362
|
-
},
|
|
1363
|
-
"usePickerContent": {
|
|
1364
|
-
"file": "usePickerContent.md",
|
|
1365
|
-
"category": "Base Components/Collections/Picker/Hooks",
|
|
1366
|
-
"summary": "`usePickerContent` is a React hook that creates the collection state for the content displayed inside a `PickerModal`. It extends the collection config (like `filters`, `itemName`) and adds picker-specific options such as `modalState`, `events`, and `initialSelect`.",
|
|
1367
|
-
"importPath": "@wix/patterns"
|
|
1368
|
-
},
|
|
1369
|
-
"useStaticListFilterCollection": {
|
|
1370
|
-
"file": "useStaticListFilterCollection.md",
|
|
1371
|
-
"category": "Features/Filter/Hooks",
|
|
1372
|
-
"summary": "`useStaticListFilterCollection` is a hook that connects a filter (ArrayFilter, usually), to a CollectionState created from a static list of items. It also providers search functionality (search term, will be matched against the itemName function configured on the `filter` object).",
|
|
1373
|
-
"importPath": "@wix/patterns",
|
|
1374
|
-
"bundle": "hooks/useStaticListFilterCollection.d.ts",
|
|
1375
|
-
"propsTotal": 2,
|
|
1376
|
-
"propsTypeName": "UseStaticListFilterCollectionProps"
|
|
1377
|
-
},
|
|
1378
|
-
"useTableCollection": {
|
|
1379
|
-
"file": "useTableCollection.md",
|
|
1380
|
-
"category": "Base Components/Collections/Table/useTableCollection",
|
|
1381
|
-
"summary": "`useTableCollection` is a React hook designed to facilitate the management of the `Table` component.It returns a `TableState` to pass to the `state` prop of the `Table` component.",
|
|
1382
|
-
"importPath": "@wix/patterns",
|
|
1383
|
-
"bundle": "hooks/useTableCollection.d.ts",
|
|
1384
|
-
"propsTotal": 17,
|
|
1385
|
-
"propsTypeName": "CollectionConfig"
|
|
1386
|
-
},
|
|
1387
|
-
"useTableFolders": {
|
|
1388
|
-
"file": "useTableFolders.md",
|
|
1389
|
-
"category": "Base Components/Collections/TableFolders/useTableFolders",
|
|
1390
|
-
"summary": "`useTableFolders` is a React hook designed to facilitate the management of the `TableFolders` component.It returns a `TableFoldersState` to pass to the `state` prop of the `TableFolders` component.",
|
|
1391
|
-
"importPath": "@wix/patterns",
|
|
1392
|
-
"bundle": "hooks/useTableFolders.d.ts",
|
|
1393
|
-
"propsTotal": 2,
|
|
1394
|
-
"propsTypeName": "TableFoldersConfig"
|
|
1395
|
-
},
|
|
1396
|
-
"useTableGridSwitchCollection": {
|
|
1397
|
-
"file": "useTableGridSwitchCollection.md",
|
|
1398
|
-
"category": "Base Components/Collections/TableGridSwitch/useTableGridSwitchCollection",
|
|
1399
|
-
"summary": "`useTableGridSwitchCollection` is a React hook designed to facilitate the management of the `TableGridSwitch` component.It returns a `TableGridSwitchState` to pass to the `state` prop of the `TableGridSwitch` component.",
|
|
1400
|
-
"importPath": "@wix/patterns",
|
|
1401
|
-
"bundle": "hooks/useTableGridSwitchCollection.d.ts",
|
|
1402
|
-
"propsTotal": 17,
|
|
1403
|
-
"propsTypeName": "CollectionConfig"
|
|
1548
|
+
"propsTypeName": "CollectionConfig"
|
|
1404
1549
|
},
|
|
1405
1550
|
"useTableGridSwitchFolders": {
|
|
1406
1551
|
"file": "useTableGridSwitchFolders.md",
|
|
@@ -1419,150 +1564,5 @@
|
|
|
1419
1564
|
"summary": "`withDashboard` is the higher-order component that renders bex-core's dashboard context around a page. Patterns components read the current page location out of that context, so wrapping the page is not optional for any of them that route.",
|
|
1420
1565
|
"importPath": "@wix/patterns",
|
|
1421
1566
|
"bundle": "functions/withDashboard.d.ts"
|
|
1422
|
-
},
|
|
1423
|
-
"InMemoryBackend": {
|
|
1424
|
-
"file": "InMemoryBackend.md",
|
|
1425
|
-
"category": "Guides",
|
|
1426
|
-
"summary": "A mocking utility which acts as a collection server API.",
|
|
1427
|
-
"importPath": "@wix/patterns/testkit/backend"
|
|
1428
|
-
},
|
|
1429
|
-
"Tags Overview": {
|
|
1430
|
-
"file": "Tags Overview.md",
|
|
1431
|
-
"category": "Features/Enrich/Tags",
|
|
1432
|
-
"summary": "### Introduction"
|
|
1433
|
-
},
|
|
1434
|
-
"Working with Cache": {
|
|
1435
|
-
"file": "Working with Cache.md",
|
|
1436
|
-
"category": "Guides",
|
|
1437
|
-
"summary": "Wix Patterns uses cache to optimize the request time, more specifically it uses the \"in-memory\" cache strategy which means that the cache persists only during the browser session. Once the browser tab is closed all cache is cleared."
|
|
1438
|
-
},
|
|
1439
|
-
"Collection to Entity Flow": {
|
|
1440
|
-
"file": "Collection to Entity Flow.md",
|
|
1441
|
-
"category": "Guides",
|
|
1442
|
-
"summary": "A collection page and the form for one of its items are **two patterns pages**, not a page plus a modal. That holds for creating a record as much as editing one: an \"add new\" form writes the record, so it is an `EntityPage` however small it is.",
|
|
1443
|
-
"relatedComponents": [
|
|
1444
|
-
"CollectionPage",
|
|
1445
|
-
"EntityPage",
|
|
1446
|
-
"EntityPageState",
|
|
1447
|
-
"useEntityPage",
|
|
1448
|
-
"useEntity",
|
|
1449
|
-
"useCreateCollection",
|
|
1450
|
-
"usePatternsNavigate",
|
|
1451
|
-
"PatternsReactRouter",
|
|
1452
|
-
"PatternsReactRoute"
|
|
1453
|
-
]
|
|
1454
|
-
},
|
|
1455
|
-
"Collection Toolkit": {
|
|
1456
|
-
"file": "Collection Toolkit.md",
|
|
1457
|
-
"category": "Guides",
|
|
1458
|
-
"summary": "Which component to reach for, arranged by what the person using the dashboard is trying to do: understand the situation, narrow it, open one record, act, and be told what happened.",
|
|
1459
|
-
"relatedComponents": [
|
|
1460
|
-
"SummaryBar",
|
|
1461
|
-
"CollectionSearch",
|
|
1462
|
-
"CollectionToolbarFilters",
|
|
1463
|
-
"MultiSelectCheckboxFilter",
|
|
1464
|
-
"MultiInlineCheckboxFilter",
|
|
1465
|
-
"MultiAutoInlineCheckboxFilter",
|
|
1466
|
-
"SingleSelectFilter",
|
|
1467
|
-
"RadioGroupFilter",
|
|
1468
|
-
"TabsFilter",
|
|
1469
|
-
"MultiSelectCollectionFilter",
|
|
1470
|
-
"useFilterCollection",
|
|
1471
|
-
"AutoCompleteFilter",
|
|
1472
|
-
"DateRangeFilter",
|
|
1473
|
-
"NumberRangeFilter",
|
|
1474
|
-
"OperatorFilterPicker",
|
|
1475
|
-
"operatorFilter",
|
|
1476
|
-
"idNameArrayFilter",
|
|
1477
|
-
"stringFilter",
|
|
1478
|
-
"stringsArrayFilter",
|
|
1479
|
-
"arrayFilter",
|
|
1480
|
-
"dateRangeFilter",
|
|
1481
|
-
"customFilter",
|
|
1482
|
-
"useStaticListFilterCollection",
|
|
1483
|
-
"Sortable Columns",
|
|
1484
|
-
"MultiLevelSorting",
|
|
1485
|
-
"EntityPage",
|
|
1486
|
-
"useEntityPage",
|
|
1487
|
-
"usePatternsNavigate",
|
|
1488
|
-
"PickerModal",
|
|
1489
|
-
"usePickerModal",
|
|
1490
|
-
"bulkActionModal",
|
|
1491
|
-
"PrimaryActions",
|
|
1492
|
-
"SecondaryActions",
|
|
1493
|
-
"More Actions",
|
|
1494
|
-
"deleteSecondaryAction",
|
|
1495
|
-
"PrimaryActionButton",
|
|
1496
|
-
"MultiBulkActionToolbar",
|
|
1497
|
-
"useOptimisticActions",
|
|
1498
|
-
"CollectionOptimisticActions",
|
|
1499
|
-
"TableTopNotification",
|
|
1500
|
-
"CollectionEmptyState",
|
|
1501
|
-
"CollectionNoResultsState",
|
|
1502
|
-
"CollectionPremiumEmptyState",
|
|
1503
|
-
"ExportButton"
|
|
1504
|
-
]
|
|
1505
|
-
},
|
|
1506
|
-
"Composition and Providers": {
|
|
1507
|
-
"file": "Composition and Providers.md",
|
|
1508
|
-
"category": "Guides",
|
|
1509
|
-
"summary": "Every patterns page is four nested layers. Getting the nesting wrong is the most common way a page that looks right throws at runtime.",
|
|
1510
|
-
"relatedComponents": [
|
|
1511
|
-
"WixPatternsProvider",
|
|
1512
|
-
"WixPatternsBMProvider",
|
|
1513
|
-
"WixPatternsGizaProvider",
|
|
1514
|
-
"WixPatternsEssentialsProvider",
|
|
1515
|
-
"WixPatternsBaseProvider",
|
|
1516
|
-
"CollectionPage",
|
|
1517
|
-
"EntityPage",
|
|
1518
|
-
"SettingsPage",
|
|
1519
|
-
"Table",
|
|
1520
|
-
"Grid",
|
|
1521
|
-
"TableGridSwitch",
|
|
1522
|
-
"TableFolders",
|
|
1523
|
-
"GridFolders",
|
|
1524
|
-
"TableState",
|
|
1525
|
-
"GridState",
|
|
1526
|
-
"TableGridSwitchState",
|
|
1527
|
-
"TableFoldersState",
|
|
1528
|
-
"GridFoldersState",
|
|
1529
|
-
"useTableCollection",
|
|
1530
|
-
"useGridCollection",
|
|
1531
|
-
"useTableGridSwitchCollection",
|
|
1532
|
-
"useTableFolders",
|
|
1533
|
-
"useGridFolders",
|
|
1534
|
-
"PatternsReactRouter",
|
|
1535
|
-
"PatternsReactRoute",
|
|
1536
|
-
"usePatternsNavigate",
|
|
1537
|
-
"withDashboard"
|
|
1538
|
-
]
|
|
1539
|
-
},
|
|
1540
|
-
"Filter Overview": {
|
|
1541
|
-
"file": "Filter Overview.md",
|
|
1542
|
-
"category": "Features/Filter",
|
|
1543
|
-
"summary": "To better understand the use and configuration of filters in Wix Patterns and especially in Tabs Filter, Toolbar Filters and Views it is important to know the difference between the Filter Components and the `Filter` object including all the built-in factories Wix Patterns provides.",
|
|
1544
|
-
"examples": [
|
|
1545
|
-
"Filter Overview/interactive-example.tsx"
|
|
1546
|
-
]
|
|
1547
|
-
},
|
|
1548
|
-
"Next.js": {
|
|
1549
|
-
"file": "Next.js.md",
|
|
1550
|
-
"category": "Guides",
|
|
1551
|
-
"summary": "**Next.js** is replacing the Yoshi fullstack flow. It's not yet officially supported by the infra team, however early adopters can try it out using the WIX Next.js template."
|
|
1552
|
-
},
|
|
1553
|
-
"Reading the Doc Indices": {
|
|
1554
|
-
"file": "Reading the Doc Indices.md",
|
|
1555
|
-
"category": "Guides",
|
|
1556
|
-
"summary": "`@wix/patterns` ships two machine-readable indices under `dist/`, and they answer different questions. This is what their conventions mean, so a consumer reading them does not mistake a deliberate stub for a truncated file."
|
|
1557
|
-
},
|
|
1558
|
-
"Component Tests": {
|
|
1559
|
-
"file": "Component Tests.md",
|
|
1560
|
-
"category": "Guides/Component Tests",
|
|
1561
|
-
"summary": "`Wix Patterns` provides uni driver testkits, similarly to `@wix/design-system` testing"
|
|
1562
|
-
},
|
|
1563
|
-
"Sled Tests": {
|
|
1564
|
-
"file": "Sled Tests.md",
|
|
1565
|
-
"category": "Guides/Sled Tests",
|
|
1566
|
-
"summary": "The power of uni drivers provided by `Wix Patterns` is that we can use them also in `puppeteer` environment."
|
|
1567
1567
|
}
|
|
1568
1568
|
}
|