@wix/patterns 1.473.0 → 1.475.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.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.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/FormPageHeader/FormPageHeader.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/CollectionPageActionsBar.js +9 -12
- package/dist/cjs/state/CollectionPage/CollectionPageActionsBar.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/EntityPage.Header.md +1 -1
- package/dist/docs/ImportButton.md +1 -1
- package/dist/docs/PickerContent.md +3 -3
- package/dist/docs/SettingsPage.Header.md +1 -1
- package/dist/docs/TableGridSwitchFolders.md +2 -2
- package/dist/docs/index.json +914 -903
- package/dist/docs/useSchemaSource.md +149 -0
- package/dist/dts-bundle/components/EntityPage.d.ts +1 -1
- package/dist/dts-bundle/components/SettingsPage.d.ts +1 -1
- package/dist/dts-bundle/index.json +2 -2
- package/dist/dts-bundle/index.txt +2 -2
- package/dist/esm/components/CardContainer/CardContainer.st.css.js +2 -2
- 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/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/CollectionPageNew/CollectionPage.st.css.js.map +1 -1
- package/dist/esm/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js +2 -2
- package/dist/esm/components/CollectionSectionHeader/CollectionSectionHeader.st.css.js.map +1 -1
- 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/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/DragHandle/DragHandle.st.css.js +2 -2
- package/dist/esm/components/EditableTable/EditableCell.st.css.js +2 -2
- package/dist/esm/components/EditableTable/HeaderActionsPopover.st.css.js +2 -2
- package/dist/esm/components/EditableTable/HeaderActionsPopover.st.css.js.map +1 -1
- 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/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/date/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/date/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/date/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/date/View.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/datetime/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/datetime/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/datetime/View.st.css.js.map +1 -1
- 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/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/number/View.st.css.js.map +1 -1
- 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/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/Edit.st.css.js.map +1 -1
- 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/FormPageHeader/FormPageHeader.js.map +1 -1
- package/dist/esm/components/Heading/Heading.st.css.js +2 -2
- package/dist/esm/components/Heading/Heading.st.css.js.map +1 -1
- 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/InputOverflow/InputOverflow.st.css.js.map +1 -1
- package/dist/esm/components/LoadingRow/LoadingRow.st.css.js +3 -3
- package/dist/esm/components/MaxHeightText/MaxHeightText.st.css.js +2 -2
- package/dist/esm/components/MaxLines/MaxLines.st.css.js +2 -2
- 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/MultipleDragOverlayEffect.st.css.js.map +1 -1
- 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/PickerContent.st.css.js.map +1 -1
- 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/ScrollableContent/ScrollableContent.st.css.js.map +1 -1
- 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/SkeletonCard/SkeletonCard.st.css.js.map +1 -1
- 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/ToolbarItem/ToolbarItem.st.css.js +2 -2
- package/dist/esm/components/ToolbarItem/ToolbarItem.st.css.js.map +1 -1
- 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/CollectionPageActionsBar.js +1 -1
- package/dist/esm/state/CollectionPage/CollectionPageActionsBar.js.map +1 -1
- package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css.js +2 -2
- package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css.js.map +1 -1
- package/dist/esm/state/CollectionPage/TitleBadges.st.css.js +2 -2
- 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/examples/useSchemaSource/cms-collection.tsx +40 -0
- package/dist/examples/useSchemaSource/extra-columns-and-data.tsx +73 -0
- package/dist/examples/useSchemaSource/your-own-source.tsx +173 -0
- package/dist/types/components/CmsFieldManagement/CmsFieldForm.st.css.d.ts.map +1 -1
- package/dist/types/components/CollectionPageNew/CollectionPage.st.css.d.ts.map +1 -1
- package/dist/types/components/CollectionSectionHeader/CollectionSectionHeader.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/CollectionViewsDropdown/AutoCompleteReadonly.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/HeaderActionsPopover.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/date/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/date/View.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/datetime/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/number/View.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/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/EditableTable/cellTypes/url/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/FormPageHeader/FormPageHeader.d.ts +1 -1
- package/dist/types/components/FormPageHeader/FormPageHeader.d.ts.map +1 -1
- package/dist/types/components/Heading/Heading.st.css.d.ts.map +1 -1
- package/dist/types/components/InputOverflow/InputOverflow.st.css.d.ts.map +1 -1
- package/dist/types/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.d.ts.map +1 -1
- package/dist/types/components/NestedTableDragAndDrop/NestedTableDragAndDropRow.st.css.d.ts.map +1 -1
- package/dist/types/components/PickerContent/PickerContent.st.css.d.ts.map +1 -1
- package/dist/types/components/ScrollableContent/ScrollableContent.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/SkeletonCard/SkeletonCard.st.css.d.ts.map +1 -1
- package/dist/types/components/ToolbarItem/ToolbarItem.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/CollectionPageActionsBar.d.ts.map +1 -1
- package/dist/types/state/CollectionPage/CollectionPageHeader.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/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/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/FormPageHeader/FormPageHeader.tsx +4 -1
- 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/CollectionPageActionsBar.tsx +1 -8
- 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,12 @@
|
|
|
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
|
+
},
|
|
2
10
|
"ActionSubItem": {
|
|
3
11
|
"file": "ActionSubItem.md",
|
|
4
12
|
"category": "Common/Types",
|
|
@@ -22,6 +30,24 @@
|
|
|
22
30
|
"propsTotal": 122,
|
|
23
31
|
"propsTypeName": "Omit"
|
|
24
32
|
},
|
|
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",
|
|
43
|
+
"category": "Common/State",
|
|
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."
|
|
50
|
+
},
|
|
25
51
|
"CollectionEmptyState": {
|
|
26
52
|
"file": "CollectionEmptyState.md",
|
|
27
53
|
"category": "Features/Display/Empty States",
|
|
@@ -122,6 +148,15 @@
|
|
|
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
|
+
},
|
|
125
160
|
"CollectionSubToolbar": {
|
|
126
161
|
"file": "CollectionSubToolbar.md",
|
|
127
162
|
"category": "Common/Components",
|
|
@@ -154,6 +189,19 @@
|
|
|
154
189
|
"ToolbarFilters/mini-toolbar-with-filters.tsx"
|
|
155
190
|
]
|
|
156
191
|
},
|
|
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"
|
|
199
|
+
},
|
|
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."
|
|
204
|
+
},
|
|
157
205
|
"CustomColumns": {
|
|
158
206
|
"file": "CustomColumns.md",
|
|
159
207
|
"category": "Features/Display/Custom Columns",
|
|
@@ -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",
|
|
@@ -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,862 +449,595 @@
|
|
|
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": "
|
|
322
|
-
"summary": "
|
|
323
|
-
"importPath": "@wix/patterns"
|
|
324
|
-
"examples": [
|
|
325
|
-
"ImportButton/cms-import.tsx",
|
|
326
|
-
"ImportButton/platformized-import-fields-inline.tsx",
|
|
327
|
-
"ImportButton/platformized-import-from-a-source.tsx",
|
|
328
|
-
"ImportButton/required-fields.tsx",
|
|
329
|
-
"ImportButton/create-new-field.tsx",
|
|
330
|
-
"ImportButton/update-or-skip-by-id.tsx",
|
|
331
|
-
"ImportButton/backup-error-handling.tsx"
|
|
332
|
-
]
|
|
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"
|
|
333
465
|
},
|
|
334
|
-
"
|
|
335
|
-
"file": "
|
|
336
|
-
"category": "Features/
|
|
337
|
-
"summary": "
|
|
338
|
-
"examples": [
|
|
339
|
-
"Internal Scroll/full-width-section.tsx",
|
|
340
|
-
"Internal Scroll/narrow-side-section.tsx"
|
|
341
|
-
]
|
|
466
|
+
"Tags Overview": {
|
|
467
|
+
"file": "Tags Overview.md",
|
|
468
|
+
"category": "Features/Enrich/Tags",
|
|
469
|
+
"summary": "### Introduction"
|
|
342
470
|
},
|
|
343
|
-
"
|
|
344
|
-
"file": "
|
|
345
|
-
"category": "
|
|
346
|
-
"summary": "
|
|
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."
|
|
347
475
|
},
|
|
348
|
-
"
|
|
349
|
-
"file": "
|
|
350
|
-
"category": "
|
|
351
|
-
"summary": "
|
|
352
|
-
"
|
|
353
|
-
"
|
|
354
|
-
"
|
|
355
|
-
"
|
|
356
|
-
"
|
|
357
|
-
"
|
|
358
|
-
"
|
|
359
|
-
"
|
|
360
|
-
"
|
|
361
|
-
"
|
|
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"
|
|
362
490
|
]
|
|
363
491
|
},
|
|
364
|
-
"
|
|
365
|
-
"file": "
|
|
366
|
-
"category": "
|
|
367
|
-
"summary": "
|
|
368
|
-
"
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
"
|
|
407
|
-
"
|
|
408
|
-
"
|
|
409
|
-
"
|
|
410
|
-
"
|
|
411
|
-
"
|
|
412
|
-
|
|
413
|
-
},
|
|
414
|
-
"NumberRangeFilter": {
|
|
415
|
-
"file": "NumberRangeFilter.md",
|
|
416
|
-
"category": "Features/Filter/Components",
|
|
417
|
-
"summary": "# NumberRangeFilter Component",
|
|
418
|
-
"importPath": "@wix/patterns",
|
|
419
|
-
"bundle": "components/NumberRangeFilter.d.ts",
|
|
420
|
-
"propsTotal": 11,
|
|
421
|
-
"propsTypeName": "NumberRangeFilterProps"
|
|
422
|
-
},
|
|
423
|
-
"OperatorFilterPicker": {
|
|
424
|
-
"file": "OperatorFilterPicker.md",
|
|
425
|
-
"category": "Features/Filter/Components",
|
|
426
|
-
"summary": "The `OperatorFilterPicker` component provides a UI for users to select a filter operator and input a value. It renders a dropdown for operator selection and an input field for the filter value.",
|
|
427
|
-
"importPath": "@wix/patterns",
|
|
428
|
-
"bundle": "components/OperatorFilterPicker.d.ts",
|
|
429
|
-
"propsTotal": 11,
|
|
430
|
-
"propsTypeName": "OperatorPickerProps"
|
|
431
|
-
},
|
|
432
|
-
"PageWrapper": {
|
|
433
|
-
"file": "PageWrapper.md",
|
|
434
|
-
"category": "Base Components/Pages/Custom/PageWrapper",
|
|
435
|
-
"summary": "`PageWrapper` is designed to wrap `<Page/>` from `@wix/design-system`.",
|
|
436
|
-
"importPath": "@wix/patterns"
|
|
437
|
-
},
|
|
438
|
-
"PickerContent": {
|
|
439
|
-
"file": "PickerContent.md",
|
|
440
|
-
"category": "Base Components/Collections/Picker",
|
|
441
|
-
"summary": "`PickerContent` displays the content of a picker (list of selectable items). It is used inside `PickerModal` and `PickerStandalone`. Configure it via the `usePickerContent` hook.",
|
|
442
|
-
"importPath": "@wix/patterns"
|
|
443
|
-
},
|
|
444
|
-
"PickerModal": {
|
|
445
|
-
"file": "PickerModal.md",
|
|
446
|
-
"category": "Base Components/Collections/Picker",
|
|
447
|
-
"summary": "`PickerModal` allows rendering a modal that (dynamically) renders a SelectorList powered by Wix Patterns collection state.",
|
|
448
|
-
"importPath": "@wix/patterns",
|
|
449
|
-
"bundle": "components/PickerModal.d.ts",
|
|
450
|
-
"propsTotal": 36,
|
|
451
|
-
"propsTypeName": "PickerModalProps",
|
|
452
|
-
"examples": [
|
|
453
|
-
"PickerModal/multi-select.tsx",
|
|
454
|
-
"PickerModal/single-selection.tsx",
|
|
455
|
-
"PickerModal/pre-selected-item.tsx",
|
|
456
|
-
"PickerModal/with-filter-dropdown.tsx",
|
|
457
|
-
"PickerModal/search-override.tsx"
|
|
458
|
-
]
|
|
459
|
-
},
|
|
460
|
-
"Indeterminate": {
|
|
461
|
-
"file": "Indeterminate.md",
|
|
462
|
-
"category": "Base Components/Collections/Picker",
|
|
463
|
-
"examples": [
|
|
464
|
-
"Indeterminate/items-indeterminate-status.tsx",
|
|
465
|
-
"Indeterminate/all-indeterminate.tsx"
|
|
466
|
-
]
|
|
467
|
-
},
|
|
468
|
-
"PickerStandalone": {
|
|
469
|
-
"file": "PickerStandalone.md",
|
|
470
|
-
"category": "Base Components/Collections/Picker",
|
|
471
|
-
"summary": "`PickerStandalone` allows rendering a Standalone TableListItem, powered by Wix Patterns `CollectionState`. This is a component to render an item picker that adds dynamic support for:",
|
|
472
|
-
"importPath": "@wix/patterns",
|
|
473
|
-
"examples": [
|
|
474
|
-
"PickerStandalone/basic.tsx",
|
|
475
|
-
"PickerStandalone/custom-empty-state.tsx",
|
|
476
|
-
"PickerStandalone/custom-items.tsx",
|
|
477
|
-
"PickerStandalone/createnew.tsx"
|
|
478
|
-
]
|
|
479
|
-
},
|
|
480
|
-
"PrimaryActionButton": {
|
|
481
|
-
"file": "PrimaryActionButton.md",
|
|
482
|
-
"category": "Features/Actions/PrimaryActions",
|
|
483
|
-
"summary": "The `PrimaryActionButton` component displays a primary action button in the table toolbar. Use this component when you want to add a primary action button to a table.",
|
|
484
|
-
"importPath": "@wix/patterns",
|
|
485
|
-
"bundle": "components/PrimaryActionButton.d.ts",
|
|
486
|
-
"propsTotal": 11
|
|
487
|
-
},
|
|
488
|
-
"PrimaryActions": {
|
|
489
|
-
"file": "PrimaryActions.md",
|
|
490
|
-
"category": "Features/Actions/PrimaryActions",
|
|
491
|
-
"summary": "The `PrimaryActions` component displays a primary action button in a collection page header. Each action can be a single button or a button with a dropdown menu that shows additional actions.",
|
|
492
|
-
"importPath": "@wix/patterns",
|
|
493
|
-
"bundle": "components/PrimaryActions.d.ts",
|
|
494
|
-
"propsTotal": 12,
|
|
495
|
-
"propsTypeName": "ActionSubitem"
|
|
496
|
-
},
|
|
497
|
-
"PrimaryPageButton": {
|
|
498
|
-
"file": "PrimaryPageButton.md",
|
|
499
|
-
"category": "Features/Actions/PrimaryPageButton",
|
|
500
|
-
"summary": "A primary button that should be use on CollectionPage.Header component. It has the same API as the Button component, excluding the `size` and `skin` props, and with a `text` prop that is replacing the `children` prop.",
|
|
501
|
-
"importPath": "@wix/patterns",
|
|
502
|
-
"bundle": "components/PrimaryPageButton.d.ts",
|
|
503
|
-
"propsTotal": 13,
|
|
504
|
-
"propsTypeName": "PrimaryPageButtonProps",
|
|
505
|
-
"status": "deprecated",
|
|
506
|
-
"statusMessage": "Use `PrimaryActions` component instead."
|
|
507
|
-
},
|
|
508
|
-
"RadioGroupFilter": {
|
|
509
|
-
"file": "RadioGroupFilter.md",
|
|
510
|
-
"category": "Features/Filter/Components",
|
|
511
|
-
"summary": "`RadioGroupFilter` is based on `RadioGroup` component of `@wix/design-system`. Use `RadioGroupFilter` for rendering a filter that shows a list of items and allow users to choose a single item from the list. Render it by providing ArrayFilter to the filter prop and a list of options via the data props.",
|
|
512
|
-
"importPath": "@wix/patterns",
|
|
513
|
-
"bundle": "components/RadioGroupFilter.d.ts",
|
|
514
|
-
"propsTotal": 13,
|
|
515
|
-
"propsTypeName": "RadioGroupFilterProps"
|
|
516
|
-
},
|
|
517
|
-
"RequestId": {
|
|
518
|
-
"file": "RequestId.md",
|
|
519
|
-
"category": "Features/Display/Errors/RequestId",
|
|
520
|
-
"summary": "Use this component to help customer care and users communicate and investigate bugs faster Expose requestID on every error that is based on a server request.",
|
|
521
|
-
"importPath": "@wix/patterns/components"
|
|
522
|
-
},
|
|
523
|
-
"PatternsReactRoute": {
|
|
524
|
-
"file": "PatternsReactRoute.md",
|
|
525
|
-
"category": "Base Components/Pages/Router",
|
|
526
|
-
"summary": "The `PatternsReactRoute` component defines a route for a Patterns element.",
|
|
527
|
-
"importPath": "@wix/patterns/router",
|
|
528
|
-
"bundle": "components/PatternsReactRoute.d.ts",
|
|
529
|
-
"propsTotal": 1,
|
|
530
|
-
"propsTypeName": "PatternsReactProps"
|
|
531
|
-
},
|
|
532
|
-
"PatternsReactRouter": {
|
|
533
|
-
"file": "PatternsReactRouter.md",
|
|
534
|
-
"category": "Base Components/Pages/Router",
|
|
535
|
-
"summary": "The `PatternsReactRouter` component wraps `PatternsReactRoute` components and defines the base path for those routes.",
|
|
536
|
-
"importPath": "@wix/patterns/router",
|
|
537
|
-
"bundle": "components/PatternsReactRouter.d.ts"
|
|
538
|
-
},
|
|
539
|
-
"usePatternsNavigate": {
|
|
540
|
-
"file": "usePatternsNavigate.md",
|
|
541
|
-
"category": "Base Components/Pages/Router/Hooks/usePatternsNavigate",
|
|
542
|
-
"summary": "The `usePatternsNavigate` hook provides functions to navigate between pages in a Patterns React application.",
|
|
543
|
-
"importPath": "@wix/patterns/router",
|
|
544
|
-
"bundle": "hooks/usePatternsNavigate.d.ts"
|
|
545
|
-
},
|
|
546
|
-
"SecondaryActions": {
|
|
547
|
-
"file": "SecondaryActions.md",
|
|
548
|
-
"category": "Features/Actions/SecondaryActions",
|
|
549
|
-
"summary": "The `SecondaryActions` component displays a secondary action button in a collection page header. Each action can be a single button or a button with a dropdown menu that shows additional actions.",
|
|
550
|
-
"importPath": "@wix/patterns",
|
|
551
|
-
"bundle": "components/SecondaryActions.d.ts",
|
|
552
|
-
"propsTotal": 12,
|
|
553
|
-
"propsTypeName": "ActionSubitem"
|
|
554
|
-
},
|
|
555
|
-
"SettingsPage": {
|
|
556
|
-
"file": "SettingsPage.md",
|
|
557
|
-
"category": "Base Components/Pages/Settings Page",
|
|
558
|
-
"summary": "The `SettingsPage` component serves as a container that encapsulates the logic and layout structure for rendering an settings page. It provides a structured and organized way to display and manage information related to a specific settings.",
|
|
559
|
-
"importPath": "@wix/patterns",
|
|
560
|
-
"bundle": "components/SettingsPage.d.ts",
|
|
561
|
-
"propsTotal": 14,
|
|
562
|
-
"propsTypeName": "SettingsPageProps",
|
|
563
|
-
"examples": [
|
|
564
|
-
"SettingsPage/basic.tsx",
|
|
565
|
-
"SettingsPage/2-columns.tsx",
|
|
566
|
-
"SettingsPage/loading.tsx",
|
|
567
|
-
"SettingsPage/error-on-fetch.tsx",
|
|
568
|
-
"SettingsPage/error-on-save.tsx",
|
|
569
|
-
"SettingsPage/input-initialization-with-usecontroller.tsx",
|
|
570
|
-
"SettingsPage/input-initialization-with-controller.tsx"
|
|
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"
|
|
571
541
|
]
|
|
572
542
|
},
|
|
573
|
-
"
|
|
574
|
-
"file": "
|
|
575
|
-
"category": "
|
|
576
|
-
"summary": "
|
|
577
|
-
"
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
"category": "Features/Filter/Components",
|
|
606
|
-
"summary": "Renders a Dropdown filter that shows a list of items fetched from a server.",
|
|
607
|
-
"importPath": "@wix/patterns",
|
|
608
|
-
"bundle": "components/SingleSelectFilter.d.ts",
|
|
609
|
-
"propsTotal": 121,
|
|
610
|
-
"propsTypeName": "SingleSelectFilterProps",
|
|
611
|
-
"examples": [
|
|
612
|
-
"SingleSelectFilter/server-data.tsx",
|
|
613
|
-
"SingleSelectFilter/static-data.tsx",
|
|
614
|
-
"SingleSelectFilter/empty-state.tsx",
|
|
615
|
-
"SingleSelectFilter/sections.tsx",
|
|
616
|
-
"SingleSelectFilter/custom-render-items.tsx"
|
|
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"
|
|
617
575
|
]
|
|
618
576
|
},
|
|
619
|
-
"
|
|
620
|
-
"file": "
|
|
621
|
-
"category": "Features/
|
|
622
|
-
"summary": "
|
|
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.",
|
|
623
581
|
"examples": [
|
|
624
|
-
"
|
|
625
|
-
"Sortable Columns/custom-sort-order.tsx"
|
|
582
|
+
"Filter Overview/interactive-example.tsx"
|
|
626
583
|
]
|
|
627
584
|
},
|
|
628
|
-
"
|
|
629
|
-
"file": "
|
|
630
|
-
"category": "
|
|
631
|
-
"summary": "
|
|
632
|
-
"importPath": "@wix/patterns",
|
|
633
|
-
"examples": [
|
|
634
|
-
"Suggestions/with-transform-function.tsx",
|
|
635
|
-
"Suggestions/custom-card-rendering.tsx",
|
|
636
|
-
"Suggestions/carousel-vs-container-layout.tsx",
|
|
637
|
-
"Suggestions/carousel-customization.tsx"
|
|
638
|
-
]
|
|
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."
|
|
639
589
|
},
|
|
640
|
-
"
|
|
641
|
-
"file": "
|
|
642
|
-
"category": "
|
|
643
|
-
"summary": "
|
|
644
|
-
"importPath": "@wix/patterns",
|
|
645
|
-
"bundle": "components/SummaryBar.d.ts",
|
|
646
|
-
"propsTotal": 3,
|
|
647
|
-
"propsTypeName": "SummaryBarProps",
|
|
648
|
-
"examples": [
|
|
649
|
-
"SummaryBar/success.tsx",
|
|
650
|
-
"SummaryBar/loading.tsx",
|
|
651
|
-
"SummaryBar/error.tsx",
|
|
652
|
-
"SummaryBar/loading-with-success.tsx",
|
|
653
|
-
"SummaryBar/loading-with-error.tsx"
|
|
654
|
-
]
|
|
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."
|
|
655
594
|
},
|
|
656
|
-
"
|
|
657
|
-
"file": "
|
|
658
|
-
"category": "
|
|
659
|
-
"summary": "The
|
|
660
|
-
"importPath": "@wix/patterns",
|
|
661
|
-
"bundle": "components/Table.d.ts",
|
|
662
|
-
"propsTotal": 63,
|
|
663
|
-
"propsTypeName": "TableProps",
|
|
664
|
-
"examples": [
|
|
665
|
-
"Table/basic-table.tsx",
|
|
666
|
-
"Table/horizontal-scroll.tsx",
|
|
667
|
-
"Table/filters.tsx",
|
|
668
|
-
"Table/cursor-pagination.tsx",
|
|
669
|
-
"Table/header.tsx",
|
|
670
|
-
"Table/table-disabled-rows.tsx",
|
|
671
|
-
"Table/virtual.tsx",
|
|
672
|
-
"Table/fetch-total-async.tsx",
|
|
673
|
-
"Table/using-ambassador.tsx",
|
|
674
|
-
"Table/using-with-external-data-source.tsx"
|
|
675
|
-
]
|
|
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."
|
|
676
599
|
},
|
|
677
|
-
"
|
|
678
|
-
"file": "
|
|
679
|
-
"category": "
|
|
680
|
-
"summary": "The `
|
|
600
|
+
"ImportButton": {
|
|
601
|
+
"file": "ImportButton.md",
|
|
602
|
+
"category": "Features/Import",
|
|
603
|
+
"summary": "The `ImportButton` is the platformized solution for importing a CSV file into a collection.",
|
|
681
604
|
"importPath": "@wix/patterns",
|
|
682
|
-
"bundle": "components/TableFolders.d.ts",
|
|
683
|
-
"propsTotal": 57,
|
|
684
|
-
"propsTypeName": "TableFoldersProps",
|
|
685
605
|
"examples": [
|
|
686
|
-
"
|
|
687
|
-
"
|
|
688
|
-
"
|
|
606
|
+
"ImportButton/cms-import.tsx",
|
|
607
|
+
"ImportButton/platformized-import-fields-inline.tsx",
|
|
608
|
+
"ImportButton/platformized-import-from-a-source.tsx",
|
|
609
|
+
"ImportButton/required-fields.tsx",
|
|
610
|
+
"ImportButton/create-new-field.tsx",
|
|
611
|
+
"ImportButton/update-or-skip-by-id.tsx",
|
|
612
|
+
"ImportButton/backup-error-handling.tsx"
|
|
689
613
|
]
|
|
690
614
|
},
|
|
691
|
-
"
|
|
692
|
-
"file": "
|
|
693
|
-
"category": "
|
|
694
|
-
"summary": "The
|
|
695
|
-
"importPath": "@wix/patterns",
|
|
696
|
-
"bundle": "components/TableGridSwitch.d.ts",
|
|
697
|
-
"propsTotal": 64,
|
|
698
|
-
"propsTypeName": "TableGridSwitchBaseProps",
|
|
615
|
+
"Internal Scroll": {
|
|
616
|
+
"file": "Internal Scroll.md",
|
|
617
|
+
"category": "Features/Display/Internal Scroll",
|
|
618
|
+
"summary": "The \"internalScroll\" prop enables internal scrolling within the component itself, by wrapping it inside a limited height container.",
|
|
699
619
|
"examples": [
|
|
700
|
-
"
|
|
701
|
-
"
|
|
620
|
+
"Internal Scroll/full-width-section.tsx",
|
|
621
|
+
"Internal Scroll/narrow-side-section.tsx"
|
|
702
622
|
]
|
|
703
623
|
},
|
|
704
|
-
"
|
|
705
|
-
"file": "
|
|
706
|
-
"category": "
|
|
707
|
-
"summary": "
|
|
708
|
-
"importPath": "@wix/patterns",
|
|
709
|
-
"examples": [
|
|
710
|
-
"TableGridSwitchFolders/demo.tsx",
|
|
711
|
-
"TableGridSwitchFolders/tablegridswitchfolders.tsx",
|
|
712
|
-
"TableGridSwitchFolders/with-tags.tsx"
|
|
713
|
-
]
|
|
624
|
+
"Explore Apps": {
|
|
625
|
+
"file": "Explore Apps.md",
|
|
626
|
+
"category": "Integrations/ExploreApps",
|
|
627
|
+
"summary": "Enable users to explore third-party apps that may provide additional business solutions for them. This is an integration with App Market’s solution, allowing users to explore and install apps while staying within context."
|
|
714
628
|
},
|
|
715
|
-
"
|
|
716
|
-
"file": "
|
|
717
|
-
"category": "Features/
|
|
718
|
-
"summary": "
|
|
629
|
+
"More Actions": {
|
|
630
|
+
"file": "More Actions.md",
|
|
631
|
+
"category": "Features/Actions/ More Actions",
|
|
632
|
+
"summary": "Displays a menu of more actions on a page component.",
|
|
719
633
|
"examples": [
|
|
720
|
-
"
|
|
721
|
-
"
|
|
722
|
-
"
|
|
723
|
-
"
|
|
634
|
+
"More Actions/collection-page.tsx",
|
|
635
|
+
"More Actions/collection-page-2.tsx",
|
|
636
|
+
"More Actions/more-actions-with-a-divider.tsx",
|
|
637
|
+
"More Actions/more-actions-in-the-toolbar.tsx",
|
|
638
|
+
"More Actions/explore-related-apps.tsx",
|
|
639
|
+
"More Actions/integrate-with-extension.tsx",
|
|
640
|
+
"More Actions/featured-more-actions.tsx",
|
|
641
|
+
"More Actions/featured-more-actions-opt-out.tsx",
|
|
642
|
+
"More Actions/featured-more-actions-custom-position.tsx"
|
|
724
643
|
]
|
|
725
644
|
},
|
|
726
|
-
"
|
|
727
|
-
"file": "
|
|
645
|
+
"MoreActionsItem": {
|
|
646
|
+
"file": "MoreActionsItem.md",
|
|
728
647
|
"category": "Common/Types",
|
|
729
|
-
"summary": "
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
"
|
|
733
|
-
"category": "Features/Display/TableTopNotification",
|
|
734
|
-
"summary": "`TableTopNotification` allows showing a message that appears between the table header and the table rows.",
|
|
735
|
-
"importPath": "@wix/patterns",
|
|
736
|
-
"bundle": "components/TableTopNotification.d.ts",
|
|
737
|
-
"propsTotal": 19,
|
|
738
|
-
"propsTypeName": "TableTopNotificationProps",
|
|
739
|
-
"examples": [
|
|
740
|
-
"TableTopNotification/base.tsx",
|
|
741
|
-
"TableTopNotification/nested-table.tsx"
|
|
742
|
-
]
|
|
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"
|
|
743
652
|
},
|
|
744
|
-
"
|
|
745
|
-
"file": "
|
|
653
|
+
"MultiAutoInlineCheckboxFilter": {
|
|
654
|
+
"file": "MultiAutoInlineCheckboxFilter.md",
|
|
746
655
|
"category": "Features/Filter/Components",
|
|
747
|
-
"summary": "
|
|
748
|
-
"importPath": "@wix/patterns",
|
|
749
|
-
"bundle": "components/TabsFilter.d.ts",
|
|
750
|
-
"propsTotal": 7,
|
|
751
|
-
"propsTypeName": "TabsFilterProps",
|
|
752
|
-
"examples": [
|
|
753
|
-
"TabsFilter/basic-tabs.tsx",
|
|
754
|
-
"TabsFilter/tabs-with-a-basic-counter.tsx",
|
|
755
|
-
"TabsFilter/tabs-with-a-counter-badge.tsx",
|
|
756
|
-
"TabsFilter/disabled-tabs.tsx"
|
|
757
|
-
]
|
|
758
|
-
},
|
|
759
|
-
"Tags": {
|
|
760
|
-
"file": "Tags.md",
|
|
761
|
-
"category": "Features/Enrich/Tags",
|
|
762
|
-
"summary": "Tags allow users a flexible way to categorize and manage their data.",
|
|
656
|
+
"summary": "`MultiAutoInlineCheckboxFilter` is based on MultiInlineCheckboxFilter and MultiSelectCheckboxFilter.",
|
|
763
657
|
"importPath": "@wix/patterns",
|
|
764
|
-
"
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
"Tags/custom-config-for-tags-column.tsx",
|
|
768
|
-
"Tags/customized-filter-position.tsx",
|
|
769
|
-
"Tags/on-table-with-folders.tsx"
|
|
770
|
-
]
|
|
771
|
-
},
|
|
772
|
-
"TagsWidget": {
|
|
773
|
-
"file": "TagsWidget.md",
|
|
774
|
-
"category": "Features/Enrich/Tags",
|
|
775
|
-
"summary": "The `TagsWidget` component enhances the entity page by displaying the tags that are associated with the entity. It also enables to add new tags to the entity, and remove existing tags from it.",
|
|
776
|
-
"importPath": "@wix/patterns"
|
|
658
|
+
"bundle": "components/MultiAutoInlineCheckboxFilter.d.ts",
|
|
659
|
+
"propsTotal": 50,
|
|
660
|
+
"propsTypeName": "MultiAutoInlineCheckboxFilterProps"
|
|
777
661
|
},
|
|
778
|
-
"
|
|
779
|
-
"file": "
|
|
780
|
-
"category": "Features/Actions/
|
|
781
|
-
"summary": "
|
|
662
|
+
"MultiBulkActionToolbar": {
|
|
663
|
+
"file": "MultiBulkActionToolbar.md",
|
|
664
|
+
"category": "Features/Actions/Bulk Actions",
|
|
665
|
+
"summary": "Provides the ability to perform multiple operations on multiple items.",
|
|
782
666
|
"importPath": "@wix/patterns",
|
|
667
|
+
"bundle": "components/MultiBulkActionToolbar.d.ts",
|
|
668
|
+
"propsTotal": 5,
|
|
669
|
+
"propsTypeName": "MultiBulkActionToolbarProps",
|
|
783
670
|
"examples": [
|
|
784
|
-
"
|
|
785
|
-
"
|
|
786
|
-
"
|
|
787
|
-
"
|
|
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"
|
|
788
677
|
]
|
|
789
678
|
},
|
|
790
|
-
"
|
|
791
|
-
"file": "
|
|
792
|
-
"category": "Features/
|
|
793
|
-
"summary": "
|
|
679
|
+
"MultiInlineCheckboxFilter": {
|
|
680
|
+
"file": "MultiInlineCheckboxFilter.md",
|
|
681
|
+
"category": "Features/Filter/Components",
|
|
682
|
+
"summary": "Use `MultiInlineCheckboxFilter` for rendering an inline list of known number of items, with checkboxes.",
|
|
794
683
|
"importPath": "@wix/patterns",
|
|
795
|
-
"
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
"ToolbarTitle/title-and-count.tsx",
|
|
799
|
-
"ToolbarTitle/title-count-and-the-collection-s-item-limit.tsx"
|
|
800
|
-
]
|
|
684
|
+
"bundle": "components/MultiInlineCheckboxFilter.d.ts",
|
|
685
|
+
"propsTotal": 49,
|
|
686
|
+
"propsTypeName": "MultiInlineCheckboxFilterProps"
|
|
801
687
|
},
|
|
802
|
-
"
|
|
803
|
-
"file": "
|
|
804
|
-
"category": "Features/
|
|
805
|
-
"summary": "
|
|
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).",
|
|
806
692
|
"importPath": "@wix/patterns",
|
|
693
|
+
"bundle": "types/MultiLevelSorting.d.ts",
|
|
694
|
+
"propsTotal": 4,
|
|
695
|
+
"propsTypeName": "IMultiLevelSortingProps",
|
|
807
696
|
"examples": [
|
|
808
|
-
"
|
|
809
|
-
"
|
|
810
|
-
"
|
|
811
|
-
"Views/views-separated-by-category-in-the-dropdown.tsx"
|
|
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"
|
|
812
700
|
]
|
|
813
701
|
},
|
|
814
|
-
"
|
|
815
|
-
"file": "
|
|
816
|
-
"category": "
|
|
817
|
-
"summary": "
|
|
818
|
-
"importPath": "@wix/patterns
|
|
819
|
-
"bundle": "components/
|
|
702
|
+
"MultiSelectCheckboxFilter": {
|
|
703
|
+
"file": "MultiSelectCheckboxFilter.md",
|
|
704
|
+
"category": "Features/Filter/Components",
|
|
705
|
+
"summary": "Use `MultiSelectCheckboxFilter` for rendering a list of items in a dropdown, with checkboxes.",
|
|
706
|
+
"importPath": "@wix/patterns",
|
|
707
|
+
"bundle": "components/MultiSelectCheckboxFilter.d.ts",
|
|
708
|
+
"propsTotal": 127,
|
|
709
|
+
"propsTypeName": "MultiSelectCheckboxFilterProps"
|
|
820
710
|
},
|
|
821
|
-
"
|
|
822
|
-
"file": "
|
|
823
|
-
"category": "
|
|
824
|
-
"summary": "`
|
|
825
|
-
"importPath": "@wix/patterns
|
|
826
|
-
"bundle": "components/
|
|
711
|
+
"MultiSelectCollectionFilter": {
|
|
712
|
+
"file": "MultiSelectCollectionFilter.md",
|
|
713
|
+
"category": "Features/Filter/Components",
|
|
714
|
+
"summary": "`MultiSelectCollectionFilter` is based on MultiSelect.",
|
|
715
|
+
"importPath": "@wix/patterns",
|
|
716
|
+
"bundle": "components/MultiSelectCollectionFilter.d.ts",
|
|
717
|
+
"propsTotal": 132,
|
|
718
|
+
"propsTypeName": "MultiSelectCollectionFilterProps"
|
|
827
719
|
},
|
|
828
|
-
"
|
|
829
|
-
"file": "
|
|
830
|
-
"category": "Base Components/
|
|
831
|
-
"summary": "
|
|
832
|
-
"importPath": "@wix/patterns
|
|
833
|
-
"
|
|
834
|
-
|
|
835
|
-
|
|
720
|
+
"NestedTable": {
|
|
721
|
+
"file": "NestedTable.md",
|
|
722
|
+
"category": "Base Components/Collections/NestedTable",
|
|
723
|
+
"summary": "The Nested Table component handles hierarchical data with multiple levels of nesting, allowing users to easily navigate through parent-child relationships. It is ideal for displaying information that requires multiple levels of nesting, such as a file system or a product catalog.",
|
|
724
|
+
"importPath": "@wix/patterns",
|
|
725
|
+
"examples": [
|
|
726
|
+
"NestedTable/single-entity.tsx",
|
|
727
|
+
"NestedTable/various-entities.tsx",
|
|
728
|
+
"NestedTable/flat-mode-search.tsx",
|
|
729
|
+
"NestedTable/filters.tsx",
|
|
730
|
+
"NestedTable/node-api-usage.tsx",
|
|
731
|
+
"NestedTable/drag-and-drop.tsx"
|
|
732
|
+
]
|
|
836
733
|
},
|
|
837
|
-
"
|
|
838
|
-
"file": "
|
|
839
|
-
"category": "Base Components/
|
|
840
|
-
"summary": "`
|
|
841
|
-
"importPath": "@wix/patterns/essentials",
|
|
842
|
-
"bundle": "components/WixPatternsEssentialsProvider.d.ts"
|
|
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."
|
|
843
738
|
},
|
|
844
|
-
"
|
|
845
|
-
"file": "
|
|
846
|
-
"category": "Base Components/
|
|
847
|
-
"summary": "`
|
|
848
|
-
"importPath": "@wix/patterns/giza",
|
|
849
|
-
"bundle": "components/WixPatternsGizaProvider.d.ts"
|
|
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."
|
|
850
743
|
},
|
|
851
|
-
"
|
|
852
|
-
"file": "
|
|
853
|
-
"category": "Base Components/
|
|
854
|
-
"summary": "
|
|
855
|
-
"importPath": "@wix/patterns/provider",
|
|
856
|
-
"bundle": "components/WixPatternsProvider.d.ts"
|
|
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`."
|
|
857
748
|
},
|
|
858
|
-
"
|
|
859
|
-
"file": "
|
|
860
|
-
"category": "
|
|
861
|
-
"summary": "`
|
|
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`."
|
|
862
753
|
},
|
|
863
|
-
"
|
|
864
|
-
"file": "
|
|
865
|
-
"category": "Features/
|
|
754
|
+
"NumberRangeFilter": {
|
|
755
|
+
"file": "NumberRangeFilter.md",
|
|
756
|
+
"category": "Features/Filter/Components",
|
|
757
|
+
"summary": "# NumberRangeFilter Component",
|
|
866
758
|
"importPath": "@wix/patterns",
|
|
867
|
-
"bundle": "
|
|
759
|
+
"bundle": "components/NumberRangeFilter.d.ts",
|
|
868
760
|
"propsTotal": 11,
|
|
869
|
-
"propsTypeName": "
|
|
761
|
+
"propsTypeName": "NumberRangeFilterProps"
|
|
870
762
|
},
|
|
871
|
-
"
|
|
872
|
-
"file": "
|
|
873
|
-
"category": "
|
|
874
|
-
"summary": "
|
|
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.",
|
|
875
767
|
"importPath": "@wix/patterns",
|
|
876
|
-
"bundle": "
|
|
877
|
-
"propsTotal":
|
|
878
|
-
"propsTypeName": "
|
|
768
|
+
"bundle": "functions/operatorFilter.d.ts",
|
|
769
|
+
"propsTotal": 11,
|
|
770
|
+
"propsTypeName": "OperatorFilterStateParams"
|
|
879
771
|
},
|
|
880
|
-
"
|
|
881
|
-
"file": "
|
|
882
|
-
"category": "
|
|
883
|
-
"summary": "
|
|
772
|
+
"OperatorFilterPicker": {
|
|
773
|
+
"file": "OperatorFilterPicker.md",
|
|
774
|
+
"category": "Features/Filter/Components",
|
|
775
|
+
"summary": "The `OperatorFilterPicker` component provides a UI for users to select a filter operator and input a value. It renders a dropdown for operator selection and an input field for the filter value.",
|
|
884
776
|
"importPath": "@wix/patterns",
|
|
885
|
-
"bundle": "
|
|
777
|
+
"bundle": "components/OperatorFilterPicker.d.ts",
|
|
886
778
|
"propsTotal": 11,
|
|
887
|
-
"propsTypeName": "
|
|
779
|
+
"propsTypeName": "OperatorPickerProps"
|
|
888
780
|
},
|
|
889
|
-
"
|
|
890
|
-
"file": "
|
|
891
|
-
"category": "Base Components/Pages/
|
|
892
|
-
"summary": "
|
|
893
|
-
"importPath": "@wix/patterns"
|
|
894
|
-
"bundle": "hooks/useEntityPageContext.d.ts"
|
|
781
|
+
"PageWrapper": {
|
|
782
|
+
"file": "PageWrapper.md",
|
|
783
|
+
"category": "Base Components/Pages/Custom/PageWrapper",
|
|
784
|
+
"summary": "`PageWrapper` is designed to wrap `<Page/>` from `@wix/design-system`.",
|
|
785
|
+
"importPath": "@wix/patterns"
|
|
895
786
|
},
|
|
896
|
-
"
|
|
897
|
-
"file": "
|
|
898
|
-
"category": "
|
|
899
|
-
"summary": "
|
|
787
|
+
"PickerContent": {
|
|
788
|
+
"file": "PickerContent.md",
|
|
789
|
+
"category": "Base Components/Collections/Picker",
|
|
790
|
+
"summary": "`PickerContent` displays the content of a picker (list of selectable items). It is used inside `PickerModal` and `PickerStandalone`. Configure it via the `usePickerContent` hook.",
|
|
900
791
|
"importPath": "@wix/patterns"
|
|
901
792
|
},
|
|
902
|
-
"
|
|
903
|
-
"file": "
|
|
904
|
-
"category": "
|
|
905
|
-
"summary": "
|
|
793
|
+
"PickerModal": {
|
|
794
|
+
"file": "PickerModal.md",
|
|
795
|
+
"category": "Base Components/Collections/Picker",
|
|
796
|
+
"summary": "`PickerModal` allows rendering a modal that (dynamically) renders a SelectorList powered by Wix Patterns collection state.",
|
|
906
797
|
"importPath": "@wix/patterns",
|
|
907
|
-
"bundle": "
|
|
908
|
-
"propsTotal":
|
|
798
|
+
"bundle": "components/PickerModal.d.ts",
|
|
799
|
+
"propsTotal": 36,
|
|
800
|
+
"propsTypeName": "PickerModalProps",
|
|
909
801
|
"examples": [
|
|
910
|
-
"
|
|
911
|
-
"
|
|
912
|
-
"
|
|
913
|
-
"
|
|
914
|
-
"
|
|
915
|
-
"useOptimisticActions/revision-handling.tsx",
|
|
916
|
-
"useOptimisticActions/custom-error-handling.tsx"
|
|
802
|
+
"PickerModal/multi-select.tsx",
|
|
803
|
+
"PickerModal/single-selection.tsx",
|
|
804
|
+
"PickerModal/pre-selected-item.tsx",
|
|
805
|
+
"PickerModal/with-filter-dropdown.tsx",
|
|
806
|
+
"PickerModal/search-override.tsx"
|
|
917
807
|
]
|
|
918
808
|
},
|
|
919
|
-
"
|
|
920
|
-
"file": "
|
|
921
|
-
"category": "Base Components/Collections/Picker
|
|
922
|
-
"
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
"propsTypeName": "UsePickerModalParamsBase"
|
|
927
|
-
},
|
|
928
|
-
"usePickerStandalone": {
|
|
929
|
-
"file": "usePickerStandalone.md",
|
|
930
|
-
"category": "Base Components/Collections/Picker/Hooks",
|
|
931
|
-
"summary": "`usePickerStandalone` is a React hook that creates the state for a `PickerStandalone` component — a full-page picker for selecting an item and navigating to a destination URL. It extends `useCollection` with picker-specific options like `defaultDestinationUrl` and `initialSelect`.",
|
|
932
|
-
"importPath": "@wix/patterns"
|
|
933
|
-
},
|
|
934
|
-
"useSelector": {
|
|
935
|
-
"file": "useSelector.md",
|
|
936
|
-
"category": "Common/Hooks",
|
|
937
|
-
"summary": "`useSelector` is a custom hook designed for React applications that doesn't use MobX for state management. Its primary purpose is to simplify the process of getting updated values from the MobX state within functional components.",
|
|
938
|
-
"importPath": "@wix/patterns"
|
|
939
|
-
},
|
|
940
|
-
"useSettingsPage": {
|
|
941
|
-
"file": "useSettingsPage.md",
|
|
942
|
-
"category": "Base Components/Pages/Settings Page/Hooks/useSettingsPage",
|
|
943
|
-
"summary": "A React hook that creates the state for a `SettingsPage`. Configure settings fetching, save/cancel flow, form integration, and toasts. The returned `SettingsPageState` is passed to `<SettingsPage state={state}>`.",
|
|
944
|
-
"importPath": "@wix/patterns"
|
|
945
|
-
},
|
|
946
|
-
"useSettingsPageContext": {
|
|
947
|
-
"file": "useSettingsPageContext.md",
|
|
948
|
-
"category": "Base Components/Pages/Settings Page/Hooks/useSettingsPageContext",
|
|
949
|
-
"summary": "A React hook that retrieves `SettingsPageState` from React context. Use it in any child component rendered within `SettingsPage` to access the page state without prop-drilling.",
|
|
950
|
-
"importPath": "@wix/patterns"
|
|
951
|
-
},
|
|
952
|
-
"ActionCellProps": {
|
|
953
|
-
"file": "ActionCellProps.md",
|
|
954
|
-
"category": "Features/Actions/Action Cell",
|
|
955
|
-
"summary": "TableActionCellProps",
|
|
956
|
-
"bundle": "types/ActionCellProps.d.ts",
|
|
957
|
-
"propsTotal": 15,
|
|
958
|
-
"propsTypeName": "ActionCellProps"
|
|
959
|
-
},
|
|
960
|
-
"BulkActionModalRenderProp": {
|
|
961
|
-
"file": "BulkActionModalRenderProp.md",
|
|
962
|
-
"category": "Common/Types",
|
|
963
|
-
"summary": "A render-prop type for the `bulkActionModal` prop on collection components (`Table`, `Grid`, etc.). The render function receives selection state (`selectedValues`, `uncheckedValues`, `allSelected`), a `query` object, and modal controls (`openModal`, `closeModal`). Return a React element for the modal content.",
|
|
964
|
-
"bundle": "types/BulkActionModalRenderPropParams.d.ts",
|
|
965
|
-
"propsTotal": 7,
|
|
966
|
-
"propsTypeName": "BulkActionModalRenderPropParams"
|
|
967
|
-
},
|
|
968
|
-
"BulkSelectState": {
|
|
969
|
-
"file": "BulkSelectState.md",
|
|
970
|
-
"category": "Common/State",
|
|
971
|
-
"summary": "`BulkSelectState` manages the selection state for bulk actions in collection components. It tracks which items are selected, supports \"Select All\", and provides `allSelected`, `selectedValues`, and `uncheckedValues` properties. Created internally by `CollectionState` — you typically access it via `state.collection.bulkSelect`."
|
|
809
|
+
"Indeterminate": {
|
|
810
|
+
"file": "Indeterminate.md",
|
|
811
|
+
"category": "Base Components/Collections/Picker",
|
|
812
|
+
"examples": [
|
|
813
|
+
"Indeterminate/items-indeterminate-status.tsx",
|
|
814
|
+
"Indeterminate/all-indeterminate.tsx"
|
|
815
|
+
]
|
|
972
816
|
},
|
|
973
|
-
"
|
|
974
|
-
"file": "
|
|
975
|
-
"category": "
|
|
976
|
-
"summary": "
|
|
817
|
+
"PickerStandalone": {
|
|
818
|
+
"file": "PickerStandalone.md",
|
|
819
|
+
"category": "Base Components/Collections/Picker",
|
|
820
|
+
"summary": "`PickerStandalone` allows rendering a Standalone TableListItem, powered by Wix Patterns `CollectionState`. This is a component to render an item picker that adds dynamic support for:",
|
|
821
|
+
"importPath": "@wix/patterns",
|
|
822
|
+
"examples": [
|
|
823
|
+
"PickerStandalone/basic.tsx",
|
|
824
|
+
"PickerStandalone/custom-empty-state.tsx",
|
|
825
|
+
"PickerStandalone/custom-items.tsx",
|
|
826
|
+
"PickerStandalone/createnew.tsx"
|
|
827
|
+
]
|
|
977
828
|
},
|
|
978
|
-
"
|
|
979
|
-
"file": "
|
|
980
|
-
"category": "
|
|
829
|
+
"PrimaryActionButton": {
|
|
830
|
+
"file": "PrimaryActionButton.md",
|
|
831
|
+
"category": "Features/Actions/PrimaryActions",
|
|
832
|
+
"summary": "The `PrimaryActionButton` component displays a primary action button in the table toolbar. Use this component when you want to add a primary action button to a table.",
|
|
833
|
+
"importPath": "@wix/patterns",
|
|
834
|
+
"bundle": "components/PrimaryActionButton.d.ts",
|
|
835
|
+
"propsTotal": 11
|
|
981
836
|
},
|
|
982
|
-
"
|
|
983
|
-
"file": "
|
|
984
|
-
"category": "
|
|
985
|
-
"summary": "`
|
|
837
|
+
"PrimaryActions": {
|
|
838
|
+
"file": "PrimaryActions.md",
|
|
839
|
+
"category": "Features/Actions/PrimaryActions",
|
|
840
|
+
"summary": "The `PrimaryActions` component displays a primary action button in a collection page header. Each action can be a single button or a button with a dropdown menu that shows additional actions.",
|
|
841
|
+
"importPath": "@wix/patterns",
|
|
842
|
+
"bundle": "components/PrimaryActions.d.ts",
|
|
843
|
+
"propsTotal": 12,
|
|
844
|
+
"propsTypeName": "ActionSubitem"
|
|
986
845
|
},
|
|
987
|
-
"
|
|
988
|
-
"file": "
|
|
989
|
-
"category": "
|
|
990
|
-
"summary": "
|
|
991
|
-
"
|
|
846
|
+
"PrimaryPageButton": {
|
|
847
|
+
"file": "PrimaryPageButton.md",
|
|
848
|
+
"category": "Features/Actions/PrimaryPageButton",
|
|
849
|
+
"summary": "A primary button that should be use on CollectionPage.Header component. It has the same API as the Button component, excluding the `size` and `skin` props, and with a `text` prop that is replacing the `children` prop.",
|
|
850
|
+
"importPath": "@wix/patterns",
|
|
851
|
+
"bundle": "components/PrimaryPageButton.d.ts",
|
|
992
852
|
"propsTotal": 13,
|
|
993
|
-
"propsTypeName": "
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
"file": "CtaBaseProps.md",
|
|
997
|
-
"category": "Common/Types",
|
|
998
|
-
"summary": "Base props for call-to-action buttons used in section headers, toolbar actions, and other action triggers. Defines the common `id`, `onClick`, `label`, and `prefixIcon` properties."
|
|
853
|
+
"propsTypeName": "PrimaryPageButtonProps",
|
|
854
|
+
"status": "deprecated",
|
|
855
|
+
"statusMessage": "Use `PrimaryActions` component instead."
|
|
999
856
|
},
|
|
1000
|
-
"
|
|
1001
|
-
"file": "
|
|
1002
|
-
"category": "Features/Filter/
|
|
1003
|
-
"summary": "
|
|
857
|
+
"RadioGroupFilter": {
|
|
858
|
+
"file": "RadioGroupFilter.md",
|
|
859
|
+
"category": "Features/Filter/Components",
|
|
860
|
+
"summary": "`RadioGroupFilter` is based on `RadioGroup` component of `@wix/design-system`. Use `RadioGroupFilter` for rendering a filter that shows a list of items and allow users to choose a single item from the list. Render it by providing ArrayFilter to the filter prop and a list of options via the data props.",
|
|
1004
861
|
"importPath": "@wix/patterns",
|
|
1005
|
-
"bundle": "
|
|
1006
|
-
"propsTotal":
|
|
1007
|
-
"propsTypeName": "
|
|
862
|
+
"bundle": "components/RadioGroupFilter.d.ts",
|
|
863
|
+
"propsTotal": 13,
|
|
864
|
+
"propsTypeName": "RadioGroupFilterProps"
|
|
1008
865
|
},
|
|
1009
|
-
"
|
|
1010
|
-
"file": "
|
|
1011
|
-
"category": "
|
|
1012
|
-
"summary": "
|
|
1013
|
-
"
|
|
1014
|
-
"propsTotal": 5,
|
|
1015
|
-
"propsTypeName": "DataResultRaw"
|
|
866
|
+
"RequestId": {
|
|
867
|
+
"file": "RequestId.md",
|
|
868
|
+
"category": "Features/Display/Errors/RequestId",
|
|
869
|
+
"summary": "Use this component to help customer care and users communicate and investigate bugs faster Expose requestID on every error that is based on a server request.",
|
|
870
|
+
"importPath": "@wix/patterns/components"
|
|
1016
871
|
},
|
|
1017
|
-
"
|
|
1018
|
-
"file": "
|
|
1019
|
-
"category": "
|
|
1020
|
-
"summary": "
|
|
872
|
+
"PatternsReactRoute": {
|
|
873
|
+
"file": "PatternsReactRoute.md",
|
|
874
|
+
"category": "Base Components/Pages/Router",
|
|
875
|
+
"summary": "The `PatternsReactRoute` component defines a route for a Patterns element.",
|
|
876
|
+
"importPath": "@wix/patterns/router",
|
|
877
|
+
"bundle": "components/PatternsReactRoute.d.ts",
|
|
878
|
+
"propsTotal": 1,
|
|
879
|
+
"propsTypeName": "PatternsReactProps"
|
|
1021
880
|
},
|
|
1022
|
-
"
|
|
1023
|
-
"file": "
|
|
1024
|
-
"category": "
|
|
1025
|
-
"summary": "
|
|
881
|
+
"PatternsReactRouter": {
|
|
882
|
+
"file": "PatternsReactRouter.md",
|
|
883
|
+
"category": "Base Components/Pages/Router",
|
|
884
|
+
"summary": "The `PatternsReactRouter` component wraps `PatternsReactRoute` components and defines the base path for those routes.",
|
|
885
|
+
"importPath": "@wix/patterns/router",
|
|
886
|
+
"bundle": "components/PatternsReactRouter.d.ts"
|
|
1026
887
|
},
|
|
1027
|
-
"
|
|
1028
|
-
"file": "
|
|
1029
|
-
"category": "
|
|
1030
|
-
"summary": "
|
|
888
|
+
"usePatternsNavigate": {
|
|
889
|
+
"file": "usePatternsNavigate.md",
|
|
890
|
+
"category": "Base Components/Pages/Router/Hooks/usePatternsNavigate",
|
|
891
|
+
"summary": "The `usePatternsNavigate` hook provides functions to navigate between pages in a Patterns React application.",
|
|
892
|
+
"importPath": "@wix/patterns/router",
|
|
893
|
+
"bundle": "hooks/usePatternsNavigate.d.ts"
|
|
1031
894
|
},
|
|
1032
|
-
"
|
|
1033
|
-
"file": "
|
|
1034
|
-
"category": "
|
|
1035
|
-
"summary": "
|
|
895
|
+
"useSchemaSource": {
|
|
896
|
+
"file": "useSchemaSource.md",
|
|
897
|
+
"category": "Base Components/Schema Source",
|
|
898
|
+
"summary": "A **schema source** describes a collection once: its fields, how to read and write its items, and, optionally, how to add, edit and delete fields. The `@wix/patterns/schema` entry builds the page from it. Columns, filters, grid cards, entity-page forms and field management all come from the source, so you don't list them by hand.",
|
|
899
|
+
"importPath": "@wix/patterns/schema",
|
|
900
|
+
"examples": [
|
|
901
|
+
"useSchemaSource/cms-collection.tsx",
|
|
902
|
+
"useSchemaSource/extra-columns-and-data.tsx",
|
|
903
|
+
"useSchemaSource/your-own-source.tsx"
|
|
904
|
+
]
|
|
1036
905
|
},
|
|
1037
|
-
"
|
|
1038
|
-
"file": "
|
|
1039
|
-
"category": "Features/
|
|
1040
|
-
"summary": "The
|
|
906
|
+
"SecondaryActions": {
|
|
907
|
+
"file": "SecondaryActions.md",
|
|
908
|
+
"category": "Features/Actions/SecondaryActions",
|
|
909
|
+
"summary": "The `SecondaryActions` component displays a secondary action button in a collection page header. Each action can be a single button or a button with a dropdown menu that shows additional actions.",
|
|
1041
910
|
"importPath": "@wix/patterns",
|
|
1042
|
-
"bundle": "components/
|
|
911
|
+
"bundle": "components/SecondaryActions.d.ts",
|
|
1043
912
|
"propsTotal": 12,
|
|
1044
|
-
"propsTypeName": "
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
913
|
+
"propsTypeName": "ActionSubitem"
|
|
914
|
+
},
|
|
915
|
+
"SettingsPage": {
|
|
916
|
+
"file": "SettingsPage.md",
|
|
917
|
+
"category": "Base Components/Pages/Settings Page",
|
|
918
|
+
"summary": "The `SettingsPage` component serves as a container that encapsulates the logic and layout structure for rendering an settings page. It provides a structured and organized way to display and manage information related to a specific settings.",
|
|
919
|
+
"importPath": "@wix/patterns",
|
|
920
|
+
"bundle": "components/SettingsPage.d.ts",
|
|
921
|
+
"propsTotal": 14,
|
|
922
|
+
"propsTypeName": "SettingsPageProps",
|
|
1048
923
|
"examples": [
|
|
1049
|
-
"
|
|
1050
|
-
"
|
|
1051
|
-
"
|
|
1052
|
-
"
|
|
924
|
+
"SettingsPage/basic.tsx",
|
|
925
|
+
"SettingsPage/2-columns.tsx",
|
|
926
|
+
"SettingsPage/loading.tsx",
|
|
927
|
+
"SettingsPage/error-on-fetch.tsx",
|
|
928
|
+
"SettingsPage/error-on-save.tsx",
|
|
929
|
+
"SettingsPage/input-initialization-with-usecontroller.tsx",
|
|
930
|
+
"SettingsPage/input-initialization-with-controller.tsx"
|
|
1053
931
|
]
|
|
1054
932
|
},
|
|
1055
|
-
"
|
|
1056
|
-
"file": "
|
|
1057
|
-
"category": "Base Components/Pages/
|
|
1058
|
-
"summary": "
|
|
1059
|
-
"
|
|
1060
|
-
"propsTotal": 4,
|
|
1061
|
-
"propsTypeName": "EntityPageState"
|
|
1062
|
-
},
|
|
1063
|
-
"FilterProps": {
|
|
1064
|
-
"file": "FilterProps.md",
|
|
1065
|
-
"category": "Features/Filter/Props",
|
|
1066
|
-
"summary": "The base filter component interface used by all filter types in Wix Patterns. Each filter defines how it renders in the toolbar, its value type, and how it maps to query parameters. See specific filter implementations like `SingleSelectFilter`, `MultiSelectCheckboxFilter`, and `DateRangeFilter`.",
|
|
1067
|
-
"bundle": "types/FilterProps.d.ts",
|
|
1068
|
-
"propsTotal": 11,
|
|
1069
|
-
"propsTypeName": "FilterProps"
|
|
933
|
+
"SettingsPage.AdditionalContent": {
|
|
934
|
+
"file": "SettingsPage.AdditionalContent.md",
|
|
935
|
+
"category": "Base Components/Pages/Settings Page",
|
|
936
|
+
"summary": "A slot component for the side panel of a `SettingsPage`. Place it inside `<SettingsPage.Content>` alongside `<SettingsPage.MainContent>`. Supports an optional `sticky` prop to keep the content fixed while scrolling.",
|
|
937
|
+
"importPath": "@wix/patterns"
|
|
1070
938
|
},
|
|
1071
|
-
"
|
|
1072
|
-
"file": "
|
|
1073
|
-
"category": "
|
|
1074
|
-
"summary": "
|
|
939
|
+
"SettingsPage.Card": {
|
|
940
|
+
"file": "SettingsPage.Card.md",
|
|
941
|
+
"category": "Base Components/Pages/Settings Page",
|
|
942
|
+
"summary": "A card container used inside `SettingsPage.MainContent` or `SettingsPage.AdditionalContent`. It wraps form fields and content sections with a card layout, and supports loading/error/success states for async content.",
|
|
943
|
+
"importPath": "@wix/patterns"
|
|
1075
944
|
},
|
|
1076
|
-
"
|
|
1077
|
-
"file": "
|
|
1078
|
-
"category": "
|
|
1079
|
-
"summary": "
|
|
945
|
+
"SettingsPage.Content": {
|
|
946
|
+
"file": "SettingsPage.Content.md",
|
|
947
|
+
"category": "Base Components/Pages/Settings Page",
|
|
948
|
+
"summary": "A layout slot for the body of a `SettingsPage`. Wraps `<SettingsPage.MainContent>` and optionally `<SettingsPage.AdditionalContent>` to create the two-column layout.",
|
|
1080
949
|
"importPath": "@wix/patterns"
|
|
1081
950
|
},
|
|
1082
|
-
"
|
|
1083
|
-
"file": "
|
|
1084
|
-
"category": "Base Components/
|
|
1085
|
-
"summary": "
|
|
1086
|
-
"
|
|
1087
|
-
"propsTotal": 1,
|
|
1088
|
-
"propsTypeName": "GridFoldersStatePublicAPI"
|
|
951
|
+
"SettingsPage.Header": {
|
|
952
|
+
"file": "SettingsPage.Header.md",
|
|
953
|
+
"category": "Base Components/Pages/Settings Page",
|
|
954
|
+
"summary": "The header component for a `SettingsPage`. Renders the page title, optional subtitle, and a more-actions menu. Place it as a direct child of `<SettingsPage>`.",
|
|
955
|
+
"importPath": "@wix/patterns"
|
|
1089
956
|
},
|
|
1090
|
-
"
|
|
1091
|
-
"file": "
|
|
1092
|
-
"category": "Base Components/
|
|
1093
|
-
"summary": "
|
|
1094
|
-
"
|
|
1095
|
-
"propsTotal": 3,
|
|
1096
|
-
"propsTypeName": "GridStatePublicAPI"
|
|
957
|
+
"SettingsPage.MainContent": {
|
|
958
|
+
"file": "SettingsPage.MainContent.md",
|
|
959
|
+
"category": "Base Components/Pages/Settings Page",
|
|
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.",
|
|
961
|
+
"importPath": "@wix/patterns"
|
|
1097
962
|
},
|
|
1098
|
-
"
|
|
1099
|
-
"file": "
|
|
1100
|
-
"category": "
|
|
1101
|
-
"summary": "
|
|
1102
|
-
"bundle": "types/MoreActionsItem.d.ts",
|
|
1103
|
-
"propsTotal": 10,
|
|
1104
|
-
"propsTypeName": "MoreActionsItem"
|
|
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…"
|
|
1105
967
|
},
|
|
1106
|
-
"
|
|
1107
|
-
"file": "
|
|
1108
|
-
"category": "Features/
|
|
1109
|
-
"summary": "
|
|
968
|
+
"SingleSelectFilter": {
|
|
969
|
+
"file": "SingleSelectFilter.md",
|
|
970
|
+
"category": "Features/Filter/Components",
|
|
971
|
+
"summary": "Renders a Dropdown filter that shows a list of items fetched from a server.",
|
|
1110
972
|
"importPath": "@wix/patterns",
|
|
1111
|
-
"bundle": "components/
|
|
1112
|
-
"propsTotal":
|
|
1113
|
-
"propsTypeName": "
|
|
973
|
+
"bundle": "components/SingleSelectFilter.d.ts",
|
|
974
|
+
"propsTotal": 121,
|
|
975
|
+
"propsTypeName": "SingleSelectFilterProps",
|
|
1114
976
|
"examples": [
|
|
1115
|
-
"
|
|
1116
|
-
"
|
|
1117
|
-
"
|
|
1118
|
-
"
|
|
1119
|
-
"
|
|
1120
|
-
|
|
977
|
+
"SingleSelectFilter/server-data.tsx",
|
|
978
|
+
"SingleSelectFilter/static-data.tsx",
|
|
979
|
+
"SingleSelectFilter/empty-state.tsx",
|
|
980
|
+
"SingleSelectFilter/sections.tsx",
|
|
981
|
+
"SingleSelectFilter/custom-render-items.tsx"
|
|
982
|
+
]
|
|
983
|
+
},
|
|
984
|
+
"Sortable Columns": {
|
|
985
|
+
"file": "Sortable Columns.md",
|
|
986
|
+
"category": "Features/Sort/Sortable Columns/Sortable Columns",
|
|
987
|
+
"summary": "The sortable columns feature allows users to sort a table by clicking on a column header, sorting the table based on the values in that column.",
|
|
988
|
+
"examples": [
|
|
989
|
+
"Sortable Columns/basic-sortable-column.tsx",
|
|
990
|
+
"Sortable Columns/custom-sort-order.tsx"
|
|
991
|
+
]
|
|
992
|
+
},
|
|
993
|
+
"Suggestions": {
|
|
994
|
+
"file": "Suggestions.md",
|
|
995
|
+
"category": "Features/Display/Suggestions",
|
|
996
|
+
"summary": "Displays marketing offers from the Wix Dealer service. For more information, see Suggestions Overview.",
|
|
997
|
+
"importPath": "@wix/patterns",
|
|
998
|
+
"examples": [
|
|
999
|
+
"Suggestions/with-transform-function.tsx",
|
|
1000
|
+
"Suggestions/custom-card-rendering.tsx",
|
|
1001
|
+
"Suggestions/carousel-vs-container-layout.tsx",
|
|
1002
|
+
"Suggestions/carousel-customization.tsx"
|
|
1121
1003
|
]
|
|
1122
1004
|
},
|
|
1123
|
-
"
|
|
1124
|
-
"file": "
|
|
1125
|
-
"category": "Features/
|
|
1126
|
-
"summary": "
|
|
1005
|
+
"SummaryBar": {
|
|
1006
|
+
"file": "SummaryBar.md",
|
|
1007
|
+
"category": "Features/Display/Toolbar",
|
|
1008
|
+
"summary": "Displays summary information.",
|
|
1127
1009
|
"importPath": "@wix/patterns",
|
|
1128
|
-
"bundle": "
|
|
1129
|
-
"propsTotal":
|
|
1130
|
-
"propsTypeName": "
|
|
1010
|
+
"bundle": "components/SummaryBar.d.ts",
|
|
1011
|
+
"propsTotal": 3,
|
|
1012
|
+
"propsTypeName": "SummaryBarProps",
|
|
1131
1013
|
"examples": [
|
|
1132
|
-
"
|
|
1133
|
-
"
|
|
1134
|
-
"
|
|
1014
|
+
"SummaryBar/success.tsx",
|
|
1015
|
+
"SummaryBar/loading.tsx",
|
|
1016
|
+
"SummaryBar/error.tsx",
|
|
1017
|
+
"SummaryBar/loading-with-success.tsx",
|
|
1018
|
+
"SummaryBar/loading-with-error.tsx"
|
|
1135
1019
|
]
|
|
1136
1020
|
},
|
|
1137
|
-
"
|
|
1138
|
-
"file": "
|
|
1139
|
-
"category": "Base Components/Collections/
|
|
1140
|
-
"summary": "
|
|
1141
|
-
},
|
|
1142
|
-
"NestedTableNodeState": {
|
|
1143
|
-
"file": "NestedTableNodeState.md",
|
|
1144
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1145
|
-
"summary": "`NestedTableNodeState` represents a single node in a `NestedTable` tree. Each node has a `depth`, `expanded` state, `children` collection, `optimisticActions`, and access to its parent via `getParent()`. Use `getData()` to access the item and `toggleExpand()` to expand/collapse."
|
|
1146
|
-
},
|
|
1147
|
-
"NestedTableOptimisticActions": {
|
|
1148
|
-
"file": "NestedTableOptimisticActions.md",
|
|
1149
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1150
|
-
"summary": "Extends the standard optimistic actions API with nested-table-specific operations. Provides `updateMany`, `updateOne`, `deleteMany`, and `deleteOne` methods that accept a `propagate` parameter to cascade changes to child nodes. Access via `nodeState.optimisticActions`."
|
|
1151
|
-
},
|
|
1152
|
-
"NestedTableState": {
|
|
1153
|
-
"file": "NestedTableState.md",
|
|
1154
|
-
"category": "Base Components/Collections/NestedTable",
|
|
1155
|
-
"summary": "`NestedTableState` manages the state for a `NestedTable` component. It handles multi-level hierarchical data with expand/collapse, flat and nested view modes, toolbar, and optimistic actions. Created by `useNestedTable`."
|
|
1156
|
-
},
|
|
1157
|
-
"operatorFilter": {
|
|
1158
|
-
"file": "operatorFilter.md",
|
|
1159
|
-
"category": "Features/Filter/Factories",
|
|
1160
|
-
"summary": "The `operatorFilter` factory creates a filter that combines an operator selection with a value input. It is ideal for advanced filtering scenarios where users need to specify how they want to filter data.",
|
|
1021
|
+
"Table": {
|
|
1022
|
+
"file": "Table.md",
|
|
1023
|
+
"category": "Base Components/Collections/Table/Table",
|
|
1024
|
+
"summary": "The `Table` component displays data in rows and columns, allowing you to organize information in an easy-to-scan format. This component extends the standard Wix Design System `Table` to offer additional advanced features like infinite scroll, search, and filters.",
|
|
1161
1025
|
"importPath": "@wix/patterns",
|
|
1162
|
-
"bundle": "
|
|
1163
|
-
"propsTotal":
|
|
1164
|
-
"propsTypeName": "
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1026
|
+
"bundle": "components/Table.d.ts",
|
|
1027
|
+
"propsTotal": 63,
|
|
1028
|
+
"propsTypeName": "TableProps",
|
|
1029
|
+
"examples": [
|
|
1030
|
+
"Table/basic-table.tsx",
|
|
1031
|
+
"Table/horizontal-scroll.tsx",
|
|
1032
|
+
"Table/filters.tsx",
|
|
1033
|
+
"Table/cursor-pagination.tsx",
|
|
1034
|
+
"Table/header.tsx",
|
|
1035
|
+
"Table/table-disabled-rows.tsx",
|
|
1036
|
+
"Table/virtual.tsx",
|
|
1037
|
+
"Table/fetch-total-async.tsx",
|
|
1038
|
+
"Table/using-ambassador.tsx",
|
|
1039
|
+
"Table/using-with-external-data-source.tsx"
|
|
1040
|
+
]
|
|
1170
1041
|
},
|
|
1171
1042
|
"TableColumn": {
|
|
1172
1043
|
"file": "TableColumn.md",
|
|
@@ -1188,6 +1059,20 @@
|
|
|
1188
1059
|
"TableDragAndDrop/save-order-mode.tsx"
|
|
1189
1060
|
]
|
|
1190
1061
|
},
|
|
1062
|
+
"TableFolders": {
|
|
1063
|
+
"file": "TableFolders.md",
|
|
1064
|
+
"category": "Base Components/Collections/TableFolders/TableFolders",
|
|
1065
|
+
"summary": "The `TableFolders` component displays a table-like view of folders and items.",
|
|
1066
|
+
"importPath": "@wix/patterns",
|
|
1067
|
+
"bundle": "components/TableFolders.d.ts",
|
|
1068
|
+
"propsTotal": 57,
|
|
1069
|
+
"propsTypeName": "TableFoldersProps",
|
|
1070
|
+
"examples": [
|
|
1071
|
+
"TableFolders/demo.tsx",
|
|
1072
|
+
"TableFolders/table-folders.tsx",
|
|
1073
|
+
"TableFolders/with-tags.tsx"
|
|
1074
|
+
]
|
|
1075
|
+
},
|
|
1191
1076
|
"TableFoldersState": {
|
|
1192
1077
|
"file": "TableFoldersState.md",
|
|
1193
1078
|
"category": "Base Components/Collections/TableFolders/TableFoldersState",
|
|
@@ -1196,12 +1081,36 @@
|
|
|
1196
1081
|
"propsTotal": 3,
|
|
1197
1082
|
"propsTypeName": "TableFoldersStatePublicAPI"
|
|
1198
1083
|
},
|
|
1084
|
+
"TableGridSwitch": {
|
|
1085
|
+
"file": "TableGridSwitch.md",
|
|
1086
|
+
"category": "Base Components/Collections/TableGridSwitch/TableGridSwitch",
|
|
1087
|
+
"summary": "The `TableGridSwitch` component provides a pair of icons in the toolbar for toggling between `Grid` and `Table` views. The icon order is fixed: `Table` view is on the left, and `Grid` view is on the right.",
|
|
1088
|
+
"importPath": "@wix/patterns",
|
|
1089
|
+
"bundle": "components/TableGridSwitch.d.ts",
|
|
1090
|
+
"propsTotal": 64,
|
|
1091
|
+
"propsTypeName": "TableGridSwitchBaseProps",
|
|
1092
|
+
"examples": [
|
|
1093
|
+
"TableGridSwitch/basic-table-grid-switch.tsx",
|
|
1094
|
+
"TableGridSwitch/custom-columns.tsx"
|
|
1095
|
+
]
|
|
1096
|
+
},
|
|
1199
1097
|
"TableGridSwitchDragAndDrop": {
|
|
1200
1098
|
"file": "TableGridSwitchDragAndDrop.md",
|
|
1201
1099
|
"category": "Features/Sort/Drag and Drop",
|
|
1202
1100
|
"summary": "Enables drag and drop functionality on a `TableGridSwitch` component.",
|
|
1203
1101
|
"importPath": "@wix/patterns"
|
|
1204
1102
|
},
|
|
1103
|
+
"TableGridSwitchFolders": {
|
|
1104
|
+
"file": "TableGridSwitchFolders.md",
|
|
1105
|
+
"category": "Base Components/Collections/TableGridSwitchFolders/TableGridSwitchFolders",
|
|
1106
|
+
"summary": "The `TableGridSwitchFolders` component obtains the state of two collections initialized by the `useCollection()` hook: `collection` and `foldersCollection`. These collections are responsible for fetching and managing data related to items and folders. The component also accepts specific parameters to define how each item in the collections should be rendered within the table grid.",
|
|
1107
|
+
"importPath": "@wix/patterns",
|
|
1108
|
+
"examples": [
|
|
1109
|
+
"TableGridSwitchFolders/demo.tsx",
|
|
1110
|
+
"TableGridSwitchFolders/tablegridswitchfolders.tsx",
|
|
1111
|
+
"TableGridSwitchFolders/with-tags.tsx"
|
|
1112
|
+
]
|
|
1113
|
+
},
|
|
1205
1114
|
"TableGridSwitchFoldersState": {
|
|
1206
1115
|
"file": "TableGridSwitchFoldersState.md",
|
|
1207
1116
|
"category": "Base Components/Collections/TableGridSwitchFolders/TableGridSwitchFoldersState",
|
|
@@ -1215,6 +1124,22 @@
|
|
|
1215
1124
|
"propsTotal": 4,
|
|
1216
1125
|
"propsTypeName": "_TableGridSwitchState"
|
|
1217
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",
|
|
1133
|
+
"Table Sections/with-badge.tsx",
|
|
1134
|
+
"Table Sections/with-summary.tsx",
|
|
1135
|
+
"Table Sections/with-collapse.tsx"
|
|
1136
|
+
]
|
|
1137
|
+
},
|
|
1138
|
+
"TableSectionsProp": {
|
|
1139
|
+
"file": "TableSectionsProp.md",
|
|
1140
|
+
"category": "Common/Types",
|
|
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."
|
|
1142
|
+
},
|
|
1218
1143
|
"TableState": {
|
|
1219
1144
|
"file": "TableState.md",
|
|
1220
1145
|
"category": "Base Components/Collections/Table/TableState",
|
|
@@ -1223,16 +1148,143 @@
|
|
|
1223
1148
|
"propsTotal": 5,
|
|
1224
1149
|
"propsTypeName": "TableStatePublicAPI"
|
|
1225
1150
|
},
|
|
1151
|
+
"TableTopNotification": {
|
|
1152
|
+
"file": "TableTopNotification.md",
|
|
1153
|
+
"category": "Features/Display/TableTopNotification",
|
|
1154
|
+
"summary": "`TableTopNotification` allows showing a message that appears between the table header and the table rows.",
|
|
1155
|
+
"importPath": "@wix/patterns",
|
|
1156
|
+
"bundle": "components/TableTopNotification.d.ts",
|
|
1157
|
+
"propsTotal": 19,
|
|
1158
|
+
"propsTypeName": "TableTopNotificationProps",
|
|
1159
|
+
"examples": [
|
|
1160
|
+
"TableTopNotification/base.tsx",
|
|
1161
|
+
"TableTopNotification/nested-table.tsx"
|
|
1162
|
+
]
|
|
1163
|
+
},
|
|
1164
|
+
"TabsFilter": {
|
|
1165
|
+
"file": "TabsFilter.md",
|
|
1166
|
+
"category": "Features/Filter/Components",
|
|
1167
|
+
"summary": "Filter component that always renders in the toolbar.",
|
|
1168
|
+
"importPath": "@wix/patterns",
|
|
1169
|
+
"bundle": "components/TabsFilter.d.ts",
|
|
1170
|
+
"propsTotal": 7,
|
|
1171
|
+
"propsTypeName": "TabsFilterProps",
|
|
1172
|
+
"examples": [
|
|
1173
|
+
"TabsFilter/basic-tabs.tsx",
|
|
1174
|
+
"TabsFilter/tabs-with-a-basic-counter.tsx",
|
|
1175
|
+
"TabsFilter/tabs-with-a-counter-badge.tsx",
|
|
1176
|
+
"TabsFilter/disabled-tabs.tsx"
|
|
1177
|
+
]
|
|
1178
|
+
},
|
|
1179
|
+
"Tags": {
|
|
1180
|
+
"file": "Tags.md",
|
|
1181
|
+
"category": "Features/Enrich/Tags",
|
|
1182
|
+
"summary": "Tags allow users a flexible way to categorize and manage their data.",
|
|
1183
|
+
"importPath": "@wix/patterns",
|
|
1184
|
+
"examples": [
|
|
1185
|
+
"Tags/basic.tsx",
|
|
1186
|
+
"Tags/customized-tags-column-position.tsx",
|
|
1187
|
+
"Tags/custom-config-for-tags-column.tsx",
|
|
1188
|
+
"Tags/customized-filter-position.tsx",
|
|
1189
|
+
"Tags/on-table-with-folders.tsx"
|
|
1190
|
+
]
|
|
1191
|
+
},
|
|
1192
|
+
"TagsWidget": {
|
|
1193
|
+
"file": "TagsWidget.md",
|
|
1194
|
+
"category": "Features/Enrich/Tags",
|
|
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.",
|
|
1196
|
+
"importPath": "@wix/patterns"
|
|
1197
|
+
},
|
|
1226
1198
|
"ToolbarCollectionState": {
|
|
1227
1199
|
"file": "ToolbarCollectionState.md",
|
|
1228
1200
|
"category": "Common/State",
|
|
1229
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."
|
|
1230
1202
|
},
|
|
1203
|
+
"ToolbarSecondaryActions": {
|
|
1204
|
+
"file": "ToolbarSecondaryActions.md",
|
|
1205
|
+
"category": "Features/Actions/SecondaryActions",
|
|
1206
|
+
"summary": "The `ToolbarSecondaryActions` component displays multiple secondary action buttons in a collection toolbar. Each action can be a single button or a button with a dropdown menu that shows additional actions.",
|
|
1207
|
+
"importPath": "@wix/patterns",
|
|
1208
|
+
"examples": [
|
|
1209
|
+
"ToolbarSecondaryActions/multiple-secondary-action-buttons.tsx",
|
|
1210
|
+
"ToolbarSecondaryActions/multiple-actions-with-dropdown-menus.tsx",
|
|
1211
|
+
"ToolbarSecondaryActions/mixed-buttons-and-dropdown-menus.tsx",
|
|
1212
|
+
"ToolbarSecondaryActions/grouped-actions-with-dividers.tsx"
|
|
1213
|
+
]
|
|
1214
|
+
},
|
|
1215
|
+
"ToolbarTitle": {
|
|
1216
|
+
"file": "ToolbarTitle.md",
|
|
1217
|
+
"category": "Features/Display/Toolbar",
|
|
1218
|
+
"summary": "The card title located on the left hand side of the toolbar to provide visitors with information about the collection.",
|
|
1219
|
+
"importPath": "@wix/patterns",
|
|
1220
|
+
"examples": [
|
|
1221
|
+
"ToolbarTitle/title.tsx",
|
|
1222
|
+
"ToolbarTitle/title-subtitle-and-learn-more.tsx",
|
|
1223
|
+
"ToolbarTitle/title-and-count.tsx",
|
|
1224
|
+
"ToolbarTitle/title-count-and-the-collection-s-item-limit.tsx"
|
|
1225
|
+
]
|
|
1226
|
+
},
|
|
1231
1227
|
"View": {
|
|
1232
1228
|
"file": "View.md",
|
|
1233
1229
|
"category": "Common/Types",
|
|
1234
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."
|
|
1235
1231
|
},
|
|
1232
|
+
"Views": {
|
|
1233
|
+
"file": "Views.md",
|
|
1234
|
+
"category": "Features/Display/Views",
|
|
1235
|
+
"summary": "Collections of table states. A table state includes the filters, column sorts, and custom columns that are applied to the table.",
|
|
1236
|
+
"importPath": "@wix/patterns",
|
|
1237
|
+
"examples": [
|
|
1238
|
+
"Views/basic-view.tsx",
|
|
1239
|
+
"Views/basic-view-that-can-be-chosen.tsx",
|
|
1240
|
+
"Views/view-with-selected-columns.tsx",
|
|
1241
|
+
"Views/views-separated-by-category-in-the-dropdown.tsx"
|
|
1242
|
+
]
|
|
1243
|
+
},
|
|
1244
|
+
"WidgetsFormProvider": {
|
|
1245
|
+
"file": "WidgetsFormProvider.md",
|
|
1246
|
+
"category": "Base Components/Providers",
|
|
1247
|
+
"summary": "`WidgetsFormProvider` wraps form content in Entity/Settings pages to provide widget-level form context. It enables custom form widgets (like `CustomFieldsWidget`) to register with the page form and participate in validation and submission. Place it inside `<EntityPage.Card>` or `<SettingsPage.Card>` content.",
|
|
1248
|
+
"importPath": "@wix/patterns/page",
|
|
1249
|
+
"bundle": "components/WidgetsFormProvider.d.ts"
|
|
1250
|
+
},
|
|
1251
|
+
"WixPatternsBMProvider": {
|
|
1252
|
+
"file": "WixPatternsBMProvider.md",
|
|
1253
|
+
"category": "Base Components/Providers",
|
|
1254
|
+
"summary": "`WixPatternsBMProvider` is the top-level provider for Wix Patterns applications running inside Wix Business Manager. It wraps your app with the necessary context (BI, fedops, translations, HTTP client, etc.). Use this as the outermost provider in your BM module entry point.",
|
|
1255
|
+
"importPath": "@wix/patterns/bm",
|
|
1256
|
+
"bundle": "components/WixPatternsBMProvider.d.ts"
|
|
1257
|
+
},
|
|
1258
|
+
"WixPatternsBaseProvider": {
|
|
1259
|
+
"file": "WixPatternsBaseProvider.md",
|
|
1260
|
+
"category": "Base Components/Providers",
|
|
1261
|
+
"summary": "`WixPatternsBaseProvider` is the minimal provider for Wix Patterns. It supplies the core container context without platform-specific integrations. Use this when building standalone applications or testing outside of Business Manager or Essentials.",
|
|
1262
|
+
"importPath": "@wix/patterns/essentials",
|
|
1263
|
+
"bundle": "components/WixPatternsBaseProvider.d.ts",
|
|
1264
|
+
"propsTotal": 1,
|
|
1265
|
+
"propsTypeName": "WixPatternsBaseProviderProps"
|
|
1266
|
+
},
|
|
1267
|
+
"WixPatternsEssentialsProvider": {
|
|
1268
|
+
"file": "WixPatternsEssentialsProvider.md",
|
|
1269
|
+
"category": "Base Components/Providers",
|
|
1270
|
+
"summary": "`WixPatternsEssentialsProvider` is the provider for Wix Patterns applications running with Wix Essentials (the modern SDK). It wraps your app with container context derived from the Essentials SDK modules.",
|
|
1271
|
+
"importPath": "@wix/patterns/essentials",
|
|
1272
|
+
"bundle": "components/WixPatternsEssentialsProvider.d.ts"
|
|
1273
|
+
},
|
|
1274
|
+
"WixPatternsGizaProvider": {
|
|
1275
|
+
"file": "WixPatternsGizaProvider.md",
|
|
1276
|
+
"category": "Base Components/Providers",
|
|
1277
|
+
"summary": "`WixPatternsGizaProvider` is the provider for Wix Patterns applications running in the Giza (Editor) environment. It supplies the container context for editor-based applications.",
|
|
1278
|
+
"importPath": "@wix/patterns/giza",
|
|
1279
|
+
"bundle": "components/WixPatternsGizaProvider.d.ts"
|
|
1280
|
+
},
|
|
1281
|
+
"WixPatternsProvider": {
|
|
1282
|
+
"file": "WixPatternsProvider.md",
|
|
1283
|
+
"category": "Base Components/Providers",
|
|
1284
|
+
"summary": "`WixPatternsProvider` is the recommended top-level provider for most Wix Patterns applications. It auto-detects the environment (BM, Essentials, Giza) and supplies the appropriate context. Wrap your entire app with this provider.",
|
|
1285
|
+
"importPath": "@wix/patterns/provider",
|
|
1286
|
+
"bundle": "components/WixPatternsProvider.d.ts"
|
|
1287
|
+
},
|
|
1236
1288
|
"arrayFilter": {
|
|
1237
1289
|
"file": "arrayFilter.md",
|
|
1238
1290
|
"category": "Features/Filter/Factories",
|
|
@@ -1242,6 +1294,11 @@
|
|
|
1242
1294
|
"propsTotal": 10,
|
|
1243
1295
|
"propsTypeName": "ArrayFilterStateParams"
|
|
1244
1296
|
},
|
|
1297
|
+
"bulkActionModal": {
|
|
1298
|
+
"file": "bulkActionModal.md",
|
|
1299
|
+
"category": "Features/Actions/Bulk Actions",
|
|
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`…"
|
|
1301
|
+
},
|
|
1245
1302
|
"createNestedTableLevel": {
|
|
1246
1303
|
"file": "createNestedTableLevel.md",
|
|
1247
1304
|
"category": "Base Components/Collections/NestedTable",
|
|
@@ -1261,6 +1318,14 @@
|
|
|
1261
1318
|
"propsTotal": 11,
|
|
1262
1319
|
"propsTypeName": "Partial"
|
|
1263
1320
|
},
|
|
1321
|
+
"deleteSecondaryAction": {
|
|
1322
|
+
"file": "deleteSecondaryAction.md",
|
|
1323
|
+
"category": "Features/Actions/Action Cell",
|
|
1324
|
+
"importPath": "@wix/patterns",
|
|
1325
|
+
"bundle": "functions/deleteSecondaryAction.d.ts",
|
|
1326
|
+
"propsTotal": 11,
|
|
1327
|
+
"propsTypeName": "DeleteSecondaryActionProps"
|
|
1328
|
+
},
|
|
1264
1329
|
"idNameArrayFilter": {
|
|
1265
1330
|
"file": "idNameArrayFilter.md",
|
|
1266
1331
|
"category": "Features/Filter/Factories",
|
|
@@ -1288,6 +1353,16 @@
|
|
|
1288
1353
|
"propsTotal": 10,
|
|
1289
1354
|
"propsTypeName": "ArrayFilterStateParams"
|
|
1290
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
|
+
},
|
|
1291
1366
|
"useAmbassadorCollection": {
|
|
1292
1367
|
"file": "useAmbassadorCollection.md",
|
|
1293
1368
|
"category": "Common/Hooks",
|
|
@@ -1316,6 +1391,31 @@
|
|
|
1316
1391
|
"category": "Base Components/Collections/NestedTable",
|
|
1317
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."
|
|
1318
1393
|
},
|
|
1394
|
+
"useEntity": {
|
|
1395
|
+
"file": "useEntity.md",
|
|
1396
|
+
"category": "Base Components/Pages/Entity Page/Hooks/useEntity",
|
|
1397
|
+
"summary": "A React hook that subscribes to the entity from `EntityPageState` and returns it reactively. Use this when you need to access the entity outside of `Card.Content`, such as in the page header (title, subtitle, breadcrumbs, etc.). **Important:** During the first render the entity will be `undefined` while data is being fetched. Do not rely on the initial value — always handle the `undefined` case.",
|
|
1398
|
+
"importPath": "@wix/patterns",
|
|
1399
|
+
"bundle": "hooks/useEntity.d.ts",
|
|
1400
|
+
"propsTotal": 4,
|
|
1401
|
+
"propsTypeName": "EntityPageState"
|
|
1402
|
+
},
|
|
1403
|
+
"useEntityPage": {
|
|
1404
|
+
"file": "useEntityPage.md",
|
|
1405
|
+
"category": "Base Components/Pages/Entity Page/Hooks/useEntityPage",
|
|
1406
|
+
"summary": "A React hook that creates the state for an `EntityPage`. Configure entity fetching, save flow, form integration, toasts, and navigation. The returned `EntityPageState` is passed to `<EntityPage state={state}>`.",
|
|
1407
|
+
"importPath": "@wix/patterns",
|
|
1408
|
+
"bundle": "hooks/useEntityPage.d.ts",
|
|
1409
|
+
"propsTotal": 11,
|
|
1410
|
+
"propsTypeName": "UseEntityPageParams"
|
|
1411
|
+
},
|
|
1412
|
+
"useEntityPageContext": {
|
|
1413
|
+
"file": "useEntityPageContext.md",
|
|
1414
|
+
"category": "Base Components/Pages/Entity Page/Hooks/useEntityPageContext",
|
|
1415
|
+
"summary": "A React hook that retrieves `EntityPageState` from React context. Use it in any child component rendered within `EntityPage` to access the page state without prop-drilling.",
|
|
1416
|
+
"importPath": "@wix/patterns",
|
|
1417
|
+
"bundle": "hooks/useEntityPageContext.d.ts"
|
|
1418
|
+
},
|
|
1319
1419
|
"useFilterCollection": {
|
|
1320
1420
|
"file": "useFilterCollection.md",
|
|
1321
1421
|
"category": "Features/Filter/Hooks",
|
|
@@ -1343,18 +1443,74 @@
|
|
|
1343
1443
|
"propsTotal": 2,
|
|
1344
1444
|
"propsTypeName": "GridFoldersConfig"
|
|
1345
1445
|
},
|
|
1446
|
+
"useItemsSelectionFilter": {
|
|
1447
|
+
"file": "useItemsSelectionFilter.md",
|
|
1448
|
+
"category": "Common/hooks",
|
|
1449
|
+
"summary": "The `useItemsSelectionFilter` hook creates a filter that fetches and displays items from a specific provider.",
|
|
1450
|
+
"importPath": "@wix/patterns"
|
|
1451
|
+
},
|
|
1346
1452
|
"useNestedTable": {
|
|
1347
1453
|
"file": "useNestedTable.md",
|
|
1348
1454
|
"category": "Base Components/Collections/NestedTable",
|
|
1349
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.",
|
|
1350
1456
|
"importPath": "@wix/patterns"
|
|
1351
1457
|
},
|
|
1458
|
+
"useOptimisticActions": {
|
|
1459
|
+
"file": "useOptimisticActions.md",
|
|
1460
|
+
"category": "Features/Actions/Updates",
|
|
1461
|
+
"summary": "The `useOptimisticActions` is a hook used to manage optimistic actions for a collection. It provides functionality to perform optimistic CRUD operations on a collection of items, such as creating, updating, and deleting items, while awaiting confirmation from the server.",
|
|
1462
|
+
"importPath": "@wix/patterns",
|
|
1463
|
+
"bundle": "hooks/useOptimisticActions.d.ts",
|
|
1464
|
+
"propsTotal": 7,
|
|
1465
|
+
"examples": [
|
|
1466
|
+
"useOptimisticActions/default-behaviour.tsx",
|
|
1467
|
+
"useOptimisticActions/success-toast-with-undo.tsx",
|
|
1468
|
+
"useOptimisticActions/error-handling-and-retries.tsx",
|
|
1469
|
+
"useOptimisticActions/items-orders.tsx",
|
|
1470
|
+
"useOptimisticActions/update-with-query.tsx",
|
|
1471
|
+
"useOptimisticActions/revision-handling.tsx",
|
|
1472
|
+
"useOptimisticActions/custom-error-handling.tsx"
|
|
1473
|
+
]
|
|
1474
|
+
},
|
|
1352
1475
|
"usePickerContent": {
|
|
1353
1476
|
"file": "usePickerContent.md",
|
|
1354
1477
|
"category": "Base Components/Collections/Picker/Hooks",
|
|
1355
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`.",
|
|
1356
1479
|
"importPath": "@wix/patterns"
|
|
1357
1480
|
},
|
|
1481
|
+
"usePickerModal": {
|
|
1482
|
+
"file": "usePickerModal.md",
|
|
1483
|
+
"category": "Base Components/Collections/Picker/Hooks",
|
|
1484
|
+
"summary": "`usePickerModal` is a React hook that creates the state for a `PickerModal`. It accepts picker configuration (query name, fetch data, filters, pagination, selection callback) and a lazy-loaded `pickerContentComponent`. Import from the entry point that matches your environment.",
|
|
1485
|
+
"importPath": "@wix/patterns/bm",
|
|
1486
|
+
"bundle": "hooks/usePickerModal.d.ts",
|
|
1487
|
+
"propsTotal": 14,
|
|
1488
|
+
"propsTypeName": "UsePickerModalParamsBase"
|
|
1489
|
+
},
|
|
1490
|
+
"usePickerStandalone": {
|
|
1491
|
+
"file": "usePickerStandalone.md",
|
|
1492
|
+
"category": "Base Components/Collections/Picker/Hooks",
|
|
1493
|
+
"summary": "`usePickerStandalone` is a React hook that creates the state for a `PickerStandalone` component — a full-page picker for selecting an item and navigating to a destination URL. It extends `useCollection` with picker-specific options like `defaultDestinationUrl` and `initialSelect`.",
|
|
1494
|
+
"importPath": "@wix/patterns"
|
|
1495
|
+
},
|
|
1496
|
+
"useSelector": {
|
|
1497
|
+
"file": "useSelector.md",
|
|
1498
|
+
"category": "Common/Hooks",
|
|
1499
|
+
"summary": "`useSelector` is a custom hook designed for React applications that doesn't use MobX for state management. Its primary purpose is to simplify the process of getting updated values from the MobX state within functional components.",
|
|
1500
|
+
"importPath": "@wix/patterns"
|
|
1501
|
+
},
|
|
1502
|
+
"useSettingsPage": {
|
|
1503
|
+
"file": "useSettingsPage.md",
|
|
1504
|
+
"category": "Base Components/Pages/Settings Page/Hooks/useSettingsPage",
|
|
1505
|
+
"summary": "A React hook that creates the state for a `SettingsPage`. Configure settings fetching, save/cancel flow, form integration, and toasts. The returned `SettingsPageState` is passed to `<SettingsPage state={state}>`.",
|
|
1506
|
+
"importPath": "@wix/patterns"
|
|
1507
|
+
},
|
|
1508
|
+
"useSettingsPageContext": {
|
|
1509
|
+
"file": "useSettingsPageContext.md",
|
|
1510
|
+
"category": "Base Components/Pages/Settings Page/Hooks/useSettingsPageContext",
|
|
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.",
|
|
1512
|
+
"importPath": "@wix/patterns"
|
|
1513
|
+
},
|
|
1358
1514
|
"useStaticListFilterCollection": {
|
|
1359
1515
|
"file": "useStaticListFilterCollection.md",
|
|
1360
1516
|
"category": "Features/Filter/Hooks",
|
|
@@ -1408,150 +1564,5 @@
|
|
|
1408
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.",
|
|
1409
1565
|
"importPath": "@wix/patterns",
|
|
1410
1566
|
"bundle": "functions/withDashboard.d.ts"
|
|
1411
|
-
},
|
|
1412
|
-
"InMemoryBackend": {
|
|
1413
|
-
"file": "InMemoryBackend.md",
|
|
1414
|
-
"category": "Guides",
|
|
1415
|
-
"summary": "A mocking utility which acts as a collection server API.",
|
|
1416
|
-
"importPath": "@wix/patterns/testkit/backend"
|
|
1417
|
-
},
|
|
1418
|
-
"Tags Overview": {
|
|
1419
|
-
"file": "Tags Overview.md",
|
|
1420
|
-
"category": "Features/Enrich/Tags",
|
|
1421
|
-
"summary": "### Introduction"
|
|
1422
|
-
},
|
|
1423
|
-
"Working with Cache": {
|
|
1424
|
-
"file": "Working with Cache.md",
|
|
1425
|
-
"category": "Guides",
|
|
1426
|
-
"summary": "Wix Patterns uses cache to optimize the request time, more specifically it uses the \"in-memory\" cache strategy which means that the cache persists only during the browser session. Once the browser tab is closed all cache is cleared."
|
|
1427
|
-
},
|
|
1428
|
-
"Collection to Entity Flow": {
|
|
1429
|
-
"file": "Collection to Entity Flow.md",
|
|
1430
|
-
"category": "Guides",
|
|
1431
|
-
"summary": "A collection page and the form for one of its items are **two patterns pages**, not a page plus a modal. That holds for creating a record as much as editing one: an \"add new\" form writes the record, so it is an `EntityPage` however small it is.",
|
|
1432
|
-
"relatedComponents": [
|
|
1433
|
-
"CollectionPage",
|
|
1434
|
-
"EntityPage",
|
|
1435
|
-
"EntityPageState",
|
|
1436
|
-
"useEntityPage",
|
|
1437
|
-
"useEntity",
|
|
1438
|
-
"useCreateCollection",
|
|
1439
|
-
"usePatternsNavigate",
|
|
1440
|
-
"PatternsReactRouter",
|
|
1441
|
-
"PatternsReactRoute"
|
|
1442
|
-
]
|
|
1443
|
-
},
|
|
1444
|
-
"Collection Toolkit": {
|
|
1445
|
-
"file": "Collection Toolkit.md",
|
|
1446
|
-
"category": "Guides",
|
|
1447
|
-
"summary": "Which component to reach for, arranged by what the person using the dashboard is trying to do: understand the situation, narrow it, open one record, act, and be told what happened.",
|
|
1448
|
-
"relatedComponents": [
|
|
1449
|
-
"SummaryBar",
|
|
1450
|
-
"CollectionSearch",
|
|
1451
|
-
"CollectionToolbarFilters",
|
|
1452
|
-
"MultiSelectCheckboxFilter",
|
|
1453
|
-
"MultiInlineCheckboxFilter",
|
|
1454
|
-
"MultiAutoInlineCheckboxFilter",
|
|
1455
|
-
"SingleSelectFilter",
|
|
1456
|
-
"RadioGroupFilter",
|
|
1457
|
-
"TabsFilter",
|
|
1458
|
-
"MultiSelectCollectionFilter",
|
|
1459
|
-
"useFilterCollection",
|
|
1460
|
-
"AutoCompleteFilter",
|
|
1461
|
-
"DateRangeFilter",
|
|
1462
|
-
"NumberRangeFilter",
|
|
1463
|
-
"OperatorFilterPicker",
|
|
1464
|
-
"operatorFilter",
|
|
1465
|
-
"idNameArrayFilter",
|
|
1466
|
-
"stringFilter",
|
|
1467
|
-
"stringsArrayFilter",
|
|
1468
|
-
"arrayFilter",
|
|
1469
|
-
"dateRangeFilter",
|
|
1470
|
-
"customFilter",
|
|
1471
|
-
"useStaticListFilterCollection",
|
|
1472
|
-
"Sortable Columns",
|
|
1473
|
-
"MultiLevelSorting",
|
|
1474
|
-
"EntityPage",
|
|
1475
|
-
"useEntityPage",
|
|
1476
|
-
"usePatternsNavigate",
|
|
1477
|
-
"PickerModal",
|
|
1478
|
-
"usePickerModal",
|
|
1479
|
-
"bulkActionModal",
|
|
1480
|
-
"PrimaryActions",
|
|
1481
|
-
"SecondaryActions",
|
|
1482
|
-
"More Actions",
|
|
1483
|
-
"deleteSecondaryAction",
|
|
1484
|
-
"PrimaryActionButton",
|
|
1485
|
-
"MultiBulkActionToolbar",
|
|
1486
|
-
"useOptimisticActions",
|
|
1487
|
-
"CollectionOptimisticActions",
|
|
1488
|
-
"TableTopNotification",
|
|
1489
|
-
"CollectionEmptyState",
|
|
1490
|
-
"CollectionNoResultsState",
|
|
1491
|
-
"CollectionPremiumEmptyState",
|
|
1492
|
-
"ExportButton"
|
|
1493
|
-
]
|
|
1494
|
-
},
|
|
1495
|
-
"Composition and Providers": {
|
|
1496
|
-
"file": "Composition and Providers.md",
|
|
1497
|
-
"category": "Guides",
|
|
1498
|
-
"summary": "Every patterns page is four nested layers. Getting the nesting wrong is the most common way a page that looks right throws at runtime.",
|
|
1499
|
-
"relatedComponents": [
|
|
1500
|
-
"WixPatternsProvider",
|
|
1501
|
-
"WixPatternsBMProvider",
|
|
1502
|
-
"WixPatternsGizaProvider",
|
|
1503
|
-
"WixPatternsEssentialsProvider",
|
|
1504
|
-
"WixPatternsBaseProvider",
|
|
1505
|
-
"CollectionPage",
|
|
1506
|
-
"EntityPage",
|
|
1507
|
-
"SettingsPage",
|
|
1508
|
-
"Table",
|
|
1509
|
-
"Grid",
|
|
1510
|
-
"TableGridSwitch",
|
|
1511
|
-
"TableFolders",
|
|
1512
|
-
"GridFolders",
|
|
1513
|
-
"TableState",
|
|
1514
|
-
"GridState",
|
|
1515
|
-
"TableGridSwitchState",
|
|
1516
|
-
"TableFoldersState",
|
|
1517
|
-
"GridFoldersState",
|
|
1518
|
-
"useTableCollection",
|
|
1519
|
-
"useGridCollection",
|
|
1520
|
-
"useTableGridSwitchCollection",
|
|
1521
|
-
"useTableFolders",
|
|
1522
|
-
"useGridFolders",
|
|
1523
|
-
"PatternsReactRouter",
|
|
1524
|
-
"PatternsReactRoute",
|
|
1525
|
-
"usePatternsNavigate",
|
|
1526
|
-
"withDashboard"
|
|
1527
|
-
]
|
|
1528
|
-
},
|
|
1529
|
-
"Filter Overview": {
|
|
1530
|
-
"file": "Filter Overview.md",
|
|
1531
|
-
"category": "Features/Filter",
|
|
1532
|
-
"summary": "To better understand the use and configuration of filters in Wix Patterns and especially in Tabs Filter, Toolbar Filters and Views it is important to know the difference between the Filter Components and the `Filter` object including all the built-in factories Wix Patterns provides.",
|
|
1533
|
-
"examples": [
|
|
1534
|
-
"Filter Overview/interactive-example.tsx"
|
|
1535
|
-
]
|
|
1536
|
-
},
|
|
1537
|
-
"Next.js": {
|
|
1538
|
-
"file": "Next.js.md",
|
|
1539
|
-
"category": "Guides",
|
|
1540
|
-
"summary": "**Next.js** is replacing the Yoshi fullstack flow. It's not yet officially supported by the infra team, however early adopters can try it out using the WIX Next.js template."
|
|
1541
|
-
},
|
|
1542
|
-
"Reading the Doc Indices": {
|
|
1543
|
-
"file": "Reading the Doc Indices.md",
|
|
1544
|
-
"category": "Guides",
|
|
1545
|
-
"summary": "`@wix/patterns` ships two machine-readable indices under `dist/`, and they answer different questions. This is what their conventions mean, so a consumer reading them does not mistake a deliberate stub for a truncated file."
|
|
1546
|
-
},
|
|
1547
|
-
"Component Tests": {
|
|
1548
|
-
"file": "Component Tests.md",
|
|
1549
|
-
"category": "Guides/Component Tests",
|
|
1550
|
-
"summary": "`Wix Patterns` provides uni driver testkits, similarly to `@wix/design-system` testing"
|
|
1551
|
-
},
|
|
1552
|
-
"Sled Tests": {
|
|
1553
|
-
"file": "Sled Tests.md",
|
|
1554
|
-
"category": "Guides/Sled Tests",
|
|
1555
|
-
"summary": "The power of uni drivers provided by `Wix Patterns` is that we can use them also in `puppeteer` environment."
|
|
1556
1567
|
}
|
|
1557
1568
|
}
|