@wix/patterns 1.476.0 → 1.477.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/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/SetupWidget.st.css.js +10 -10
- package/dist/cjs/components/SetupWidget/SetupWidget.st.css.js.map +1 -1
- package/dist/cjs/components/SkeletonCard/SkeletonCard.st.css.js +3 -3
- package/dist/cjs/components/SkeletonCard/SkeletonCard.st.css.js.map +1 -1
- package/dist/cjs/components/SlidingModal/SlidingModal.st.css.js +2 -2
- package/dist/cjs/components/SlidingModal/SlidingModal.st.css.js.map +1 -1
- package/dist/cjs/components/Table/AddFieldColumnHeader.st.css.js +6 -6
- package/dist/cjs/components/Table/AddFieldColumnHeader.st.css.js.map +1 -1
- package/dist/cjs/components/TabsFilter/TabsFilter.st.css.js +3 -3
- package/dist/cjs/components/TabsFilter/TabsFilter.st.css.js.map +1 -1
- package/dist/cjs/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js +2 -2
- package/dist/cjs/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js.map +1 -1
- package/dist/cjs/components/ToolbarItem/ToolbarItem.st.css.js +2 -2
- package/dist/cjs/components/ToolbarItem/ToolbarItem.st.css.js.map +1 -1
- package/dist/cjs/components/ToolbarItemBox/ToolbarItemBox.st.css.js +2 -2
- package/dist/cjs/components/ToolbarItemBox/ToolbarItemBox.st.css.js.map +1 -1
- package/dist/cjs/components/common.st.css.js +4 -4
- package/dist/cjs/components/common.st.css.js.map +1 -1
- package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css.js +2 -2
- package/dist/cjs/state/CollectionPage/CollectionPageHeader.st.css.js.map +1 -1
- package/dist/cjs/state/CollectionPage/TitleBadges.st.css.js +4 -4
- package/dist/cjs/state/CollectionPage/TitleBadges.st.css.js.map +1 -1
- package/dist/cjs/state/EntityPage/EntityPageState.js +2 -1
- package/dist/cjs/state/EntityPage/EntityPageState.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/test-utils/index.js +6 -0
- package/dist/cjs/test-utils/index.js.map +1 -1
- package/dist/cjs/test-utils/scrollUntilRendered.js +45 -0
- package/dist/cjs/test-utils/scrollUntilRendered.js.map +1 -0
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/version.js.map +1 -1
- package/dist/docs/Collection Toolkit.md +16 -1
- package/dist/docs/Collection to Entity Flow.md +8 -1
- package/dist/docs/Composition and Providers.md +16 -1
- package/dist/docs/CustomFieldType.md +10 -1
- package/dist/docs/ImportButton.md +5 -24
- package/dist/docs/Reading the Doc Indices.md +21 -0
- package/dist/docs/index.json +62 -6
- package/dist/docs/useSchemaSource.md +22 -82
- package/dist/dts-bundle/components/EditableTable.d.ts +551 -0
- package/dist/dts-bundle/components/EntityPageFieldsCard.d.ts +100 -0
- package/dist/dts-bundle/components/LayoutSwitch.d.ts +931 -0
- package/dist/dts-bundle/components/schema/EntityPage.d.ts +317 -0
- package/dist/dts-bundle/components/schema/Grid.d.ts +467 -0
- package/dist/dts-bundle/components/schema/Table.d.ts +360 -0
- package/dist/dts-bundle/exports/core.d.ts +1 -0
- package/dist/dts-bundle/exports/essentials.d.ts +0 -1
- package/dist/dts-bundle/exports/giza.d.ts +0 -1
- package/dist/dts-bundle/exports/index.d.ts +1 -2
- package/dist/dts-bundle/exports/schema.d.ts +14 -7
- package/dist/dts-bundle/functions/listCmsCollections.d.ts +12 -0
- package/dist/dts-bundle/hooks/schema/useCollection.d.ts +341 -0
- package/dist/dts-bundle/hooks/schema/useEntityPage.d.ts +244 -0
- package/dist/dts-bundle/hooks/schema/useGridCollection.d.ts +338 -0
- package/dist/dts-bundle/hooks/schema/useTableCollection.d.ts +338 -0
- package/dist/dts-bundle/hooks/useCmsSchemaSource.d.ts +439 -0
- package/dist/dts-bundle/hooks/useEditableTableCollection.d.ts +422 -0
- package/dist/dts-bundle/hooks/useLayoutSwitchCollection.d.ts +414 -0
- package/dist/dts-bundle/hooks/useSchemaSource.d.ts +59 -0
- package/dist/dts-bundle/index.json +328 -18
- package/dist/dts-bundle/index.txt +23 -2
- package/dist/dts-bundle/types/CellType.d.ts +839 -0
- package/dist/dts-bundle/types/CmsCollectionSummary.d.ts +9 -0
- package/dist/dts-bundle/types/EntityPageState.d.ts +1 -1
- package/dist/dts-bundle/types/SchemaSource.d.ts +6 -48
- package/dist/dts-bundle/types/SchemaSourceInput.d.ts +814 -0
- package/dist/dts-bundle/types/UseCmsSchemaSourceDeps.d.ts +919 -0
- 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/CmsFieldModal.st.css.js.map +1 -1
- package/dist/esm/components/CmsFieldManagement/Sections/ValidationAndDefaultsSection.st.css.js +2 -2
- package/dist/esm/components/Collapse/Collapse.st.css.js +2 -2
- package/dist/esm/components/CollectionPageNew/CollectionPage.st.css.js +2 -2
- package/dist/esm/components/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/CollectionToolbar/CollectionToolbar.st.css.js +2 -2
- package/dist/esm/components/CollectionToolbar/CollectionToolbar.st.css.js.map +1 -1
- package/dist/esm/components/CollectionToolbar/SearchOrCustomFilter.st.css.js +2 -2
- package/dist/esm/components/CollectionToolbar/SearchOrCustomFilter.st.css.js.map +1 -1
- package/dist/esm/components/CollectionViewsDropdown/AutoCompleteReadonly.st.css.js +2 -2
- package/dist/esm/components/CollectionViewsDropdown/ViewsDropdown.st.css.js +2 -2
- package/dist/esm/components/DragHandle/DragHandle.st.css.js +2 -2
- package/dist/esm/components/DragHandle/DragHandle.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/EditableCell.st.css.js +2 -2
- package/dist/esm/components/EditableTable/EditableCell.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/HeaderActionsPopover.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/CellViewLayout.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/CellViewLayout.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/address/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/address/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/array/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/boolean/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/boolean/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/boolean/View.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/color/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/color/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/date/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/date/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/datetime/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/datetime/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/datetime/View.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/object/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/object/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/object/View.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/select/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/text/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/text/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/text/View.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/text/View.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/time/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/time/Edit.st.css.js.map +1 -1
- package/dist/esm/components/EditableTable/cellTypes/url/Edit.st.css.js +2 -2
- package/dist/esm/components/EditableTable/cellTypes/url/View.st.css.js +2 -2
- package/dist/esm/components/EmptyState/EmptyStateBase.st.css.js +2 -2
- package/dist/esm/components/EntityPage/EntityPagePlain.st.css.js +2 -2
- package/dist/esm/components/Fade/Fade.st.css.js +2 -2
- package/dist/esm/components/Fade/Fade.st.css.js.map +1 -1
- package/dist/esm/components/Heading/Heading.st.css.js +2 -2
- package/dist/esm/components/ImportButton/ImportStepUpload.st.css.js +2 -2
- package/dist/esm/components/InputOverflow/InputOverflow.st.css.js +2 -2
- package/dist/esm/components/LoadingRow/LoadingRow.st.css.js +3 -3
- package/dist/esm/components/LoadingRow/LoadingRow.st.css.js.map +1 -1
- package/dist/esm/components/MaxHeightText/MaxHeightText.st.css.js +2 -2
- package/dist/esm/components/MaxLines/MaxLines.st.css.js +2 -2
- package/dist/esm/components/MaxLines/MaxLines.st.css.js.map +1 -1
- package/dist/esm/components/MultiBulkActionToolbar/MultiBulkActionToolbar.st.css.js +2 -2
- package/dist/esm/components/NestedTable/NestedTablePlaceholderStatesRow.st.css.js +2 -2
- package/dist/esm/components/NestedTable/NestedTableRow.st.css.js +2 -2
- package/dist/esm/components/NestedTableDragAndDrop/MultipleDragOverlayEffect.st.css.js +2 -2
- package/dist/esm/components/NestedTableDragAndDrop/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/SetupWidget/SetupWidget.st.css.js +2 -2
- 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/Table/AddFieldColumnHeader.st.css.js.map +1 -1
- package/dist/esm/components/TabsFilter/TabsFilter.st.css.js +2 -2
- package/dist/esm/components/TabsFilter/TabsFilter.st.css.js.map +1 -1
- package/dist/esm/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js +2 -2
- package/dist/esm/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.js.map +1 -1
- package/dist/esm/components/ToolbarItem/ToolbarItem.st.css.js +2 -2
- package/dist/esm/components/ToolbarItemBox/ToolbarItemBox.st.css.js +2 -2
- package/dist/esm/components/common.st.css.js +2 -2
- package/dist/esm/state/CollectionPage/CollectionPageHeader.st.css.js +2 -2
- package/dist/esm/state/CollectionPage/TitleBadges.st.css.js +2 -2
- package/dist/esm/state/CollectionPage/TitleBadges.st.css.js.map +1 -1
- package/dist/esm/state/EntityPage/EntityPageState.js +2 -0
- package/dist/esm/state/EntityPage/EntityPageState.js.map +1 -1
- package/dist/esm/state/FormPage/FormPageHeader.st.css.js +2 -2
- package/dist/esm/state/FormPage/FormPageHeader.st.css.js.map +1 -1
- package/dist/esm/styles.global.css +2 -2
- package/dist/esm/test-utils/index.js +1 -0
- package/dist/esm/test-utils/index.js.map +1 -1
- package/dist/esm/test-utils/scrollUntilRendered.js +32 -0
- package/dist/esm/test-utils/scrollUntilRendered.js.map +1 -0
- package/dist/esm/version.js +1 -1
- package/dist/examples/useSchemaSource/cms-collection.tsx +1 -1
- package/dist/examples/useSchemaSource/extra-columns-and-data.tsx +1 -1
- package/dist/types/components/CmsFieldManagement/CmsFieldForm.st.css.d.ts.map +1 -1
- package/dist/types/components/CmsFieldManagement/CmsFieldModal.st.css.d.ts.map +1 -1
- package/dist/types/components/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/CollectionToolbar/CollectionToolbar.st.css.d.ts.map +1 -1
- package/dist/types/components/CollectionToolbar/SearchOrCustomFilter.st.css.d.ts.map +1 -1
- package/dist/types/components/DragHandle/DragHandle.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/EditableCell.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/CellViewLayout.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/address/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/boolean/View.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/color/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/datetime/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/datetime/View.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/number/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/object/View.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/text/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/text/View.st.css.d.ts.map +1 -1
- package/dist/types/components/EditableTable/cellTypes/time/Edit.st.css.d.ts.map +1 -1
- package/dist/types/components/Fade/Fade.st.css.d.ts.map +1 -1
- package/dist/types/components/LoadingRow/LoadingRow.st.css.d.ts.map +1 -1
- package/dist/types/components/MaxLines/MaxLines.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/SkeletonCard/SkeletonCard.st.css.d.ts.map +1 -1
- package/dist/types/components/Table/AddFieldColumnHeader.st.css.d.ts.map +1 -1
- package/dist/types/components/TabsFilter/TabsFilter.st.css.d.ts.map +1 -1
- package/dist/types/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.d.ts.map +1 -1
- package/dist/types/state/CollectionPage/TitleBadges.st.css.d.ts.map +1 -1
- package/dist/types/state/EntityPage/EntityPageState.d.ts +1 -1
- package/dist/types/state/EntityPage/EntityPageState.d.ts.map +1 -1
- package/dist/types/state/FormPage/FormPageHeader.st.css.d.ts.map +1 -1
- package/dist/types/test-utils/index.d.ts +1 -0
- package/dist/types/test-utils/index.d.ts.map +1 -1
- package/dist/types/test-utils/scrollUntilRendered.d.ts +24 -0
- package/dist/types/test-utils/scrollUntilRendered.d.ts.map +1 -0
- package/dist/types/version.d.ts +1 -1
- package/package.json +8 -8
- 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/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/SetupWidget.st.css.ts +2 -2
- package/src/components/SkeletonCard/SkeletonCard.st.css.ts +2 -2
- package/src/components/SlidingModal/SlidingModal.st.css.ts +2 -2
- package/src/components/Table/AddFieldColumnHeader.st.css.ts +2 -2
- package/src/components/TabsFilter/TabsFilter.st.css.ts +2 -2
- package/src/components/Tags/ManageTags/ManageTagsModal/ManageTagsModal.st.css.ts +2 -2
- package/src/components/ToolbarItem/ToolbarItem.st.css.ts +2 -2
- package/src/components/ToolbarItemBox/ToolbarItemBox.st.css.ts +2 -2
- package/src/components/common.st.css.ts +2 -2
- package/src/state/CollectionPage/CollectionPageHeader.st.css.ts +2 -2
- package/src/state/CollectionPage/TitleBadges.st.css.ts +2 -2
- package/src/state/EntityPage/EntityPageState.ts +2 -1
- package/src/state/FormPage/FormPageHeader.st.css.ts +2 -2
- package/src/styles.global.css +2 -2
- package/src/test-utils/index.ts +1 -0
- package/src/test-utils/scrollUntilRendered.ts +98 -0
- package/src/version.ts +1 -1
- package/dist/examples/ImportButton/platformized-import-from-a-source.tsx +0 -56
- package/dist/examples/useSchemaSource/your-own-source.tsx +0 -173
- /package/dist/examples/ImportButton/{platformized-import-fields-inline.tsx → platformized-import.tsx} +0 -0
|
@@ -28,7 +28,7 @@ Like `ExportTo`, the feature has two parts:
|
|
|
28
28
|
|
|
29
29
|
#### Configuring it
|
|
30
30
|
|
|
31
|
-
`<ImportButton>` reads what it needs off the table's source when the modal opens; the optional `config` (`ImportConfig`) fills in what the source can't supply. Two
|
|
31
|
+
`<ImportButton>` reads what it needs off the table's source when the modal opens; the optional `config` (`ImportConfig`) fills in what the source can't supply. Two setups, by **where the rows are written**:
|
|
32
32
|
|
|
33
33
|
- **CMS (Wix Data) — schema-based, no `config`.** `useCmsSchemaSource` → `useTableCollection(source)`; the source supplies the collection, its fields, and create-new-field, and the CMS create/edit-field modal loads on demand. `<ImportButton />` takes no props.
|
|
34
34
|
|
|
@@ -37,18 +37,7 @@ Like `ExportTo`, the feature has two parts:
|
|
|
37
37
|
<Table state={state} importButton={<ImportButton />} />;
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
- **Platformized
|
|
41
|
-
|
|
42
|
-
```jsx
|
|
43
|
-
const source = usePlatformizedSource({ fqdn, backend, itemKey, itemName });
|
|
44
|
-
const state = useTableCollection(source);
|
|
45
|
-
<Table
|
|
46
|
-
state={state}
|
|
47
|
-
importButton={<ImportButton config={{ destination: { storesCatalogProducts: {} } }} />}
|
|
48
|
-
/>;
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
- **Platformized, fields listed inline — non-schema, `config` names the destination and the fields.** No source; you list the `fields` to map onto (see `ProductsTable` in `example-bm`).
|
|
40
|
+
- **Platformized — `config` names the destination and the fields.** No source; you list the `fields` to map onto (see `ProductsTable` in `example-bm`).
|
|
52
41
|
|
|
53
42
|
```jsx
|
|
54
43
|
<Table
|
|
@@ -64,7 +53,7 @@ Like `ExportTo`, the feature has two parts:
|
|
|
64
53
|
/>;
|
|
65
54
|
```
|
|
66
55
|
|
|
67
|
-
`ImportConfig`: `destination` (the platformized target; omit for CMS), `fields` (list to map onto; unneeded
|
|
56
|
+
`ImportConfig`: `destination` (the platformized target; omit for CMS), `fields` (list to map onto; unneeded for CMS, where the source supplies them), plus optional `backup`, `idFieldKey`, and `jobApplicationErrorMap` — see the examples below. **Create-new-field is a CMS (Wix Data) capability**; platformized imports map onto existing fields only.
|
|
68
57
|
|
|
69
58
|
#### data-hub infrastructure
|
|
70
59
|
|
|
@@ -96,19 +85,11 @@ Example code: read `dist/examples/ImportButton/cms-import.tsx`
|
|
|
96
85
|
|
|
97
86
|
---
|
|
98
87
|
|
|
99
|
-
### Platformized import
|
|
88
|
+
### Platformized import
|
|
100
89
|
|
|
101
90
|
A non–Wix-Data destination (here the stores catalog) with no declared schema: pass a `config` naming the `destination` and listing the `fields` to map onto.
|
|
102
91
|
|
|
103
|
-
Example code: read `dist/examples/ImportButton/platformized-import
|
|
104
|
-
|
|
105
|
-
---
|
|
106
|
-
|
|
107
|
-
### Platformized import (from a source)
|
|
108
|
-
|
|
109
|
-
A non–Wix-Data destination whose fields come from a source (`usePlatformizedSource`) instead of an inline list — like the CMS case, but you still name the `destination` in `config`.
|
|
110
|
-
|
|
111
|
-
Example code: read `dist/examples/ImportButton/platformized-import-from-a-source.tsx`
|
|
92
|
+
Example code: read `dist/examples/ImportButton/platformized-import.tsx`
|
|
112
93
|
|
|
113
94
|
---
|
|
114
95
|
|
|
@@ -30,6 +30,7 @@ undocumented — look it up in the docs index.
|
|
|
30
30
|
| `symbols` | export names that resolve to this entry, where the doc's title is not the export |
|
|
31
31
|
| `examples` | worked examples for this name, relative to `dist/examples/` |
|
|
32
32
|
| `relatedComponents` | on a guide: the components it recommends |
|
|
33
|
+
| `variants` | the same name exported from another entry point with a different declaration — see below |
|
|
33
34
|
| `status`, `statusMessage` | see *Lifecycle*, below |
|
|
34
35
|
|
|
35
36
|
**The three fields above answer three different questions, and one entry rarely needs all
|
|
@@ -50,6 +51,26 @@ disagree.
|
|
|
50
51
|
documents `ExportButton`; `ToolbarFilters` is the entry for `CollectionToolbarFilters`. That
|
|
51
52
|
is what `symbols` is for — resolve a name against the keys *and* the aliases.
|
|
52
53
|
|
|
54
|
+
**One name can have more than one declaration.** `Table`, `Grid`, `EntityPage`,
|
|
55
|
+
`useCollection`, `useTableCollection`, `useGridCollection` and `useEntityPage` are exported
|
|
56
|
+
from both `@wix/patterns` and `@wix/patterns/schema`, and the schema versions take a source
|
|
57
|
+
as their first argument. The entry under the name is the root version. `variants` lists the
|
|
58
|
+
others, each with its `importPath`, its declaration (`bundle` in the docs index, `file` in the
|
|
59
|
+
bundle index) and the page that documents it (`doc`). In `dist/dts-bundle/index.txt` each
|
|
60
|
+
variant is a line of its own, so a grep for the name returns every version. Choose by
|
|
61
|
+
`importPath`, and take the hook and the component from the same entry point.
|
|
62
|
+
`EditableTable`, `LayoutSwitch` and their hooks are curated only in their schema versions, so
|
|
63
|
+
their entries are those versions.
|
|
64
|
+
|
|
65
|
+
**A name can come from another package.** `useCmsSchemaSource`, `UseCmsSchemaSourceDeps`,
|
|
66
|
+
`listCmsCollections` and `CmsCollectionSummary` are `@wix/patterns-cms` exports, in the bundle
|
|
67
|
+
index because a CMS page needs them. Their entries carry `package` and
|
|
68
|
+
`importPath: "@wix/patterns-cms"`, and `packageVersion`: the `@wix/patterns-cms` release that
|
|
69
|
+
depends on exactly this `@wix/patterns` version. Install that one. A release that pins another
|
|
70
|
+
`@wix/patterns` version installs a second copy of it, and the page ends up split across two
|
|
71
|
+
React contexts, which neither `tsc` nor a build reports. An entry's `doc` names the page that
|
|
72
|
+
documents a name with no page of its own.
|
|
73
|
+
|
|
53
74
|
**Where a name's props live is stated, not guessed.** An entry with a `bundle` field has no
|
|
54
75
|
props table in its doc: its `### Props` section points at that bundle on purpose, and the
|
|
55
76
|
bundle is the better source because it keeps the `extends` clause with its exclusions. An
|
package/dist/docs/index.json
CHANGED
|
@@ -222,7 +222,7 @@
|
|
|
222
222
|
"CustomFieldType": {
|
|
223
223
|
"file": "CustomFieldType.md",
|
|
224
224
|
"category": "Features/Enrich/Custom Field Types",
|
|
225
|
-
"summary": "A **custom field type** is a consumer-defined field that plugs into every schema-driven surface. Define it once with `defineFieldType<V>()` and register it on
|
|
225
|
+
"summary": "A **custom field type** is a consumer-defined field that plugs into every schema-driven surface. Define it once with `defineFieldType<V>()` and register it on `useCmsSchemaSource` via `fieldTypes` — the page wires nothing per surface. Each surface resolves its own slot from the definition:",
|
|
226
226
|
"examples": [
|
|
227
227
|
"CustomFieldType/table-cell-and-filter.tsx",
|
|
228
228
|
"CustomFieldType/editable-cell.tsx",
|
|
@@ -302,6 +302,13 @@
|
|
|
302
302
|
"category": "Base Components/Pages/Entity Page",
|
|
303
303
|
"summary": "The `EntityPage` component serves as a container that encapsulates the logic and layout structure for rendering an entity page. It provides a structured and organized way to display and manage information related to a specific entity.",
|
|
304
304
|
"importPath": "@wix/patterns",
|
|
305
|
+
"variants": [
|
|
306
|
+
{
|
|
307
|
+
"importPath": "@wix/patterns/schema",
|
|
308
|
+
"bundle": "components/schema/EntityPage.d.ts",
|
|
309
|
+
"doc": "useSchemaSource.md"
|
|
310
|
+
}
|
|
311
|
+
],
|
|
305
312
|
"bundle": "components/EntityPage.d.ts",
|
|
306
313
|
"propsTotal": 15,
|
|
307
314
|
"propsTypeName": "EntityPageProps",
|
|
@@ -399,6 +406,13 @@
|
|
|
399
406
|
"category": "Base Components/Collections/Grid/Grid",
|
|
400
407
|
"summary": "The `Grid` component displays cards in rows and columns as an alternative to tables. It is responsive, adjusting the number of cards per row based on the viewport width, and includes built-in virtualization for efficient rendering of many items without impacting performance.",
|
|
401
408
|
"importPath": "@wix/patterns",
|
|
409
|
+
"variants": [
|
|
410
|
+
{
|
|
411
|
+
"importPath": "@wix/patterns/schema",
|
|
412
|
+
"bundle": "components/schema/Grid.d.ts",
|
|
413
|
+
"doc": "useSchemaSource.md"
|
|
414
|
+
}
|
|
415
|
+
],
|
|
402
416
|
"bundle": "components/Grid.d.ts",
|
|
403
417
|
"propsTotal": 39,
|
|
404
418
|
"propsTypeName": "GridProps",
|
|
@@ -479,6 +493,7 @@
|
|
|
479
493
|
"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
494
|
"relatedComponents": [
|
|
481
495
|
"CollectionPage",
|
|
496
|
+
"useSchemaSource",
|
|
482
497
|
"EntityPage",
|
|
483
498
|
"EntityPageState",
|
|
484
499
|
"useEntityPage",
|
|
@@ -495,6 +510,7 @@
|
|
|
495
510
|
"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
511
|
"relatedComponents": [
|
|
497
512
|
"SummaryBar",
|
|
513
|
+
"useSchemaSource",
|
|
498
514
|
"CollectionSearch",
|
|
499
515
|
"CollectionToolbarFilters",
|
|
500
516
|
"MultiSelectCheckboxFilter",
|
|
@@ -546,6 +562,7 @@
|
|
|
546
562
|
"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
563
|
"relatedComponents": [
|
|
548
564
|
"WixPatternsProvider",
|
|
565
|
+
"useSchemaSource",
|
|
549
566
|
"WixPatternsBMProvider",
|
|
550
567
|
"WixPatternsGizaProvider",
|
|
551
568
|
"WixPatternsEssentialsProvider",
|
|
@@ -604,8 +621,7 @@
|
|
|
604
621
|
"importPath": "@wix/patterns",
|
|
605
622
|
"examples": [
|
|
606
623
|
"ImportButton/cms-import.tsx",
|
|
607
|
-
"ImportButton/platformized-import
|
|
608
|
-
"ImportButton/platformized-import-from-a-source.tsx",
|
|
624
|
+
"ImportButton/platformized-import.tsx",
|
|
609
625
|
"ImportButton/required-fields.tsx",
|
|
610
626
|
"ImportButton/create-new-field.tsx",
|
|
611
627
|
"ImportButton/update-or-skip-by-id.tsx",
|
|
@@ -895,12 +911,17 @@
|
|
|
895
911
|
"useSchemaSource": {
|
|
896
912
|
"file": "useSchemaSource.md",
|
|
897
913
|
"category": "Base Components/Schema Source",
|
|
898
|
-
"summary": "
|
|
914
|
+
"summary": "The `@wix/patterns/schema` entry builds a page from a **Wix Data (CMS) collection**. Its source, `useCmsSchemaSource` from `@wix/patterns-cms`, describes the collection once: its fields, how to read and write its items, and how to add, edit and delete fields. Columns, filters, grid cards, entity-page forms and field management all come from the source, so you don't list them by hand.",
|
|
899
915
|
"importPath": "@wix/patterns/schema",
|
|
916
|
+
"bundle": "hooks/useSchemaSource.d.ts",
|
|
917
|
+
"propsTotal": 16,
|
|
918
|
+
"propsTypeName": "SchemaSourceInput",
|
|
919
|
+
"symbols": [
|
|
920
|
+
"EntityPageFieldsCard"
|
|
921
|
+
],
|
|
900
922
|
"examples": [
|
|
901
923
|
"useSchemaSource/cms-collection.tsx",
|
|
902
|
-
"useSchemaSource/extra-columns-and-data.tsx"
|
|
903
|
-
"useSchemaSource/your-own-source.tsx"
|
|
924
|
+
"useSchemaSource/extra-columns-and-data.tsx"
|
|
904
925
|
]
|
|
905
926
|
},
|
|
906
927
|
"SecondaryActions": {
|
|
@@ -1023,6 +1044,13 @@
|
|
|
1023
1044
|
"category": "Base Components/Collections/Table/Table",
|
|
1024
1045
|
"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.",
|
|
1025
1046
|
"importPath": "@wix/patterns",
|
|
1047
|
+
"variants": [
|
|
1048
|
+
{
|
|
1049
|
+
"importPath": "@wix/patterns/schema",
|
|
1050
|
+
"bundle": "components/schema/Table.d.ts",
|
|
1051
|
+
"doc": "useSchemaSource.md"
|
|
1052
|
+
}
|
|
1053
|
+
],
|
|
1026
1054
|
"bundle": "components/Table.d.ts",
|
|
1027
1055
|
"propsTotal": 63,
|
|
1028
1056
|
"propsTypeName": "TableProps",
|
|
@@ -1374,6 +1402,13 @@
|
|
|
1374
1402
|
"category": "Common/Hooks",
|
|
1375
1403
|
"summary": "The base React hook for creating a `CollectionState`. All other collection hooks (`useTableCollection`, `useGridCollection`, etc.) build on top of `useCollection`. Use this hook directly when you need a collection state that is not tied to a specific component, or when building custom collection components.",
|
|
1376
1404
|
"importPath": "@wix/patterns",
|
|
1405
|
+
"variants": [
|
|
1406
|
+
{
|
|
1407
|
+
"importPath": "@wix/patterns/schema",
|
|
1408
|
+
"bundle": "hooks/schema/useCollection.d.ts",
|
|
1409
|
+
"doc": "useSchemaSource.md"
|
|
1410
|
+
}
|
|
1411
|
+
],
|
|
1377
1412
|
"bundle": "hooks/useCollection.d.ts",
|
|
1378
1413
|
"propsTotal": 17,
|
|
1379
1414
|
"propsTypeName": "CollectionConfig"
|
|
@@ -1405,6 +1440,13 @@
|
|
|
1405
1440
|
"category": "Base Components/Pages/Entity Page/Hooks/useEntityPage",
|
|
1406
1441
|
"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
1442
|
"importPath": "@wix/patterns",
|
|
1443
|
+
"variants": [
|
|
1444
|
+
{
|
|
1445
|
+
"importPath": "@wix/patterns/schema",
|
|
1446
|
+
"bundle": "hooks/schema/useEntityPage.d.ts",
|
|
1447
|
+
"doc": "useSchemaSource.md"
|
|
1448
|
+
}
|
|
1449
|
+
],
|
|
1408
1450
|
"bundle": "hooks/useEntityPage.d.ts",
|
|
1409
1451
|
"propsTotal": 11,
|
|
1410
1452
|
"propsTypeName": "UseEntityPageParams"
|
|
@@ -1430,6 +1472,13 @@
|
|
|
1430
1472
|
"category": "Base Components/Collections/Grid/useGridCollection",
|
|
1431
1473
|
"summary": "`useGridCollection` is a React hook designed to facilitate the management of the `Grid` component.It returns a `GridState` to pass to the `state` prop of the `Grid` component.",
|
|
1432
1474
|
"importPath": "@wix/patterns",
|
|
1475
|
+
"variants": [
|
|
1476
|
+
{
|
|
1477
|
+
"importPath": "@wix/patterns/schema",
|
|
1478
|
+
"bundle": "hooks/schema/useGridCollection.d.ts",
|
|
1479
|
+
"doc": "useSchemaSource.md"
|
|
1480
|
+
}
|
|
1481
|
+
],
|
|
1433
1482
|
"bundle": "hooks/useGridCollection.d.ts",
|
|
1434
1483
|
"propsTotal": 17,
|
|
1435
1484
|
"propsTypeName": "CollectionConfig"
|
|
@@ -1525,6 +1574,13 @@
|
|
|
1525
1574
|
"category": "Base Components/Collections/Table/useTableCollection",
|
|
1526
1575
|
"summary": "`useTableCollection` is a React hook designed to facilitate the management of the `Table` component.It returns a `TableState` to pass to the `state` prop of the `Table` component.",
|
|
1527
1576
|
"importPath": "@wix/patterns",
|
|
1577
|
+
"variants": [
|
|
1578
|
+
{
|
|
1579
|
+
"importPath": "@wix/patterns/schema",
|
|
1580
|
+
"bundle": "hooks/schema/useTableCollection.d.ts",
|
|
1581
|
+
"doc": "useSchemaSource.md"
|
|
1582
|
+
}
|
|
1583
|
+
],
|
|
1528
1584
|
"bundle": "hooks/useTableCollection.d.ts",
|
|
1529
1585
|
"propsTotal": 17,
|
|
1530
1586
|
"propsTypeName": "CollectionConfig"
|
|
@@ -12,82 +12,44 @@ Some of that scaffolding is environment-scoped and is **not** needed to use this
|
|
|
12
12
|
|
|
13
13
|
### Description
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
The `@wix/patterns/schema` entry builds a page from a **Wix Data (CMS) collection**. Its source, `useCmsSchemaSource` from `@wix/patterns-cms`, describes the collection once: its fields, how to read and write its items, and how to add, edit and delete fields. Columns, filters, grid cards, entity-page forms and field management all come from the source, so you don't list them by hand.
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
**For any other data, don't use this entry or `@wix/patterns-cms`.** Use the `@wix/patterns` hooks (`useTableCollection` and the rest) with your own `fetchData` and `columns`.
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Every CMS page follows the same three steps:
|
|
20
|
+
|
|
21
|
+
1. **Create the source** with `useCmsSchemaSource`.
|
|
20
22
|
2. **Pass it to a collection hook** — `useTableCollection(source)`, `useGridCollection(source)`, `useEditableTableCollection(source)`, `useLayoutSwitchCollection(source, …)`, or `useEntityPage(source, …)` for a single item.
|
|
21
23
|
3. **Render the state** with the component of the same name from `@wix/patterns/schema` — `Table`, `Grid`, `EditableTable`, `LayoutSwitch`, `EntityPage` (with `EntityPageFieldsCard` for the fields).
|
|
22
24
|
|
|
23
25
|
```ts
|
|
24
|
-
import {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
const source = useSchemaSource<Task>({
|
|
31
|
-
collectionId: 'tasks',
|
|
32
|
-
loadSchema: loadTasksSchema,
|
|
33
|
-
});
|
|
34
|
-
const state = useTableCollection<Task>(source);
|
|
26
|
+
import { useTableCollection, Table } from '@wix/patterns/schema';
|
|
27
|
+
import { useCmsSchemaSource } from '@wix/patterns-cms';
|
|
28
|
+
|
|
29
|
+
const source = useCmsSchemaSource<Item>({ collectionId: 'Products' });
|
|
30
|
+
const state = useTableCollection<Item>(source);
|
|
35
31
|
|
|
36
32
|
<Table state={state} />;
|
|
37
33
|
```
|
|
38
34
|
|
|
39
35
|
Take the component from `@wix/patterns/schema`, not from `@wix/patterns`. Fields such as dates, media and references render components that need the source in React context, and only the schema-entry components provide it.
|
|
40
36
|
|
|
41
|
-
####
|
|
42
|
-
|
|
43
|
-
- **A Wix Data (CMS) collection — `useCmsSchemaSource`** from `@wix/patterns-cms`. Loads the collection's fields and items, and brings the CMS add/edit field modal. The field changes (the "+" header button, edit, delete) need the user's permissions: pass `includeUserPermissions: true` and the site's `metasiteId`. Without them, fields can't be changed.
|
|
44
|
-
|
|
45
|
-
```ts
|
|
46
|
-
import { useCmsSchemaSource } from '@wix/patterns-cms';
|
|
47
|
-
|
|
48
|
-
const source = useCmsSchemaSource<Item>({ collectionId: 'Products' });
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
- **A platformized entity — `usePlatformizedSource`**. You keep your own item access (`backend.find`, plus optional writes). The source lets users add fields on top of your entity. Your entity's own fields are not part of it, so you still write their columns.
|
|
52
|
-
|
|
53
|
-
```ts
|
|
54
|
-
import { usePlatformizedSource } from '@wix/patterns/schema';
|
|
37
|
+
#### The source
|
|
55
38
|
|
|
56
|
-
|
|
57
|
-
fqdn: 'stores.catalog.product',
|
|
58
|
-
backend: { find: queryProducts },
|
|
59
|
-
});
|
|
60
|
-
```
|
|
39
|
+
`useCmsSchemaSource` loads the collection's fields, items and permissions, wires reference fields to the collections they point at, and brings the add/edit field modal with the types Wix Data can create. Don't write your own source for a CMS collection: you would lose all of that.
|
|
61
40
|
|
|
62
|
-
- **
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
import { useSchemaSource } from '@wix/patterns/schema';
|
|
66
|
-
|
|
67
|
-
const source = useSchemaSource<Task>({
|
|
68
|
-
collectionId: 'tasks',
|
|
69
|
-
loadSchema: async () => ({
|
|
70
|
-
schema: tasksSchema,
|
|
71
|
-
backend: tasksBackend,
|
|
72
|
-
fieldActions: tasksFieldActions,
|
|
73
|
-
}),
|
|
74
|
-
});
|
|
75
|
-
```
|
|
41
|
+
- **Field changes** (the "+" header button, edit, delete) need the user's permissions: pass `includeUserPermissions: true`. They are loaded for the site the patterns container runs in (`environment.msid`); pass `metasiteId` only to load them for another site. Without them, fields can't be changed.
|
|
42
|
+
- **Custom field types** are registered with `fieldTypes` — see **Custom Field Types**.
|
|
43
|
+
- **Install** `@wix/patterns-cms` at the version that depends on your exact `@wix/patterns` version. Any other version installs a second copy of `@wix/patterns`, and the page splits across two React contexts, which neither `tsc` nor a build reports.
|
|
76
44
|
|
|
77
45
|
A source is created once per `collectionId`. Changing its other options on a later render has no effect. To switch collections, render the page again with a React `key` that includes the new id.
|
|
78
46
|
|
|
79
|
-
#### What `loadSchema` returns
|
|
80
|
-
|
|
81
|
-
- `schema` (`Schema`) — the fields keyed by id, plus `idField`, `displayField`, and `schemaPermissions` (which field changes the user may make). Without `schemaPermissions`, the fields can't be edited.
|
|
82
|
-
- `backend` (`CollectionBackend`) — `find` is required. It receives the query's `search`, `filters`, `sort` and paging, and must apply all of them. A control that the backend ignores will show but do nothing. `get`, `create`, `update`, `delete`, `bulkDelete` and `bulkInsert` are optional. Each one you provide turns on the matching UI (for example, row edits in `EditableTable`).
|
|
83
|
-
- `fieldActions` (`FieldActions`) — optional. `addField`, `editField`, `deleteField` and the other field changes. Each one except `renameField` returns the collection's updated fields, and the page applies them without loading the schema again. `renameField` returns nothing.
|
|
84
|
-
|
|
85
47
|
#### Compared with the classic hooks
|
|
86
48
|
|
|
87
49
|
| | Classic (`@wix/patterns`) | Schema (`@wix/patterns/schema`) |
|
|
88
50
|
| ---------------------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
89
|
-
| Data | `fetchData` on the hook options | the
|
|
90
|
-
| `queryName`, `itemKey`, `itemName` | required on the hook | from the source (
|
|
51
|
+
| Data | `fetchData` on the hook options | the collection, through `useCmsSchemaSource` |
|
|
52
|
+
| `queryName`, `itemKey`, `itemName` | required on the hook | from the source (the collection id, `_id`, the display field) |
|
|
91
53
|
| Table columns | `columns` required | from the fields. `columns` is optional: its columns come first, and one with a field's id replaces that field's column |
|
|
92
54
|
| Changing the fetch | replace `fetchData` | `wrapFetchData(next)` wraps the source's fetch |
|
|
93
55
|
| Field management | `fieldsSource` / `dataExtension` props | always on, from the source |
|
|
@@ -99,12 +61,13 @@ A source is created once per `collectionId`. Changing its other options on a lat
|
|
|
99
61
|
|
|
100
62
|
|
|
101
63
|
```tsx
|
|
102
|
-
import {
|
|
64
|
+
import { useTableCollection, Table } from '@wix/patterns/schema';
|
|
65
|
+
import { useCmsSchemaSource } from '@wix/patterns-cms';
|
|
103
66
|
```
|
|
104
67
|
|
|
105
68
|
### CMS collection
|
|
106
69
|
|
|
107
|
-
What you get: a table over a Wix Data collection with no columns written by hand. `useCmsSchemaSource` loads the fields and the items. Every field becomes a column with its type icon, and the "+" header button adds a field once user permissions are loaded (`includeUserPermissions
|
|
70
|
+
What you get: a table over a Wix Data collection with no columns written by hand. `useCmsSchemaSource` loads the fields and the items. Every field becomes a column with its type icon, and the "+" header button adds a field once user permissions are loaded (`includeUserPermissions: true`). (In these docs `useCmsSchemaSource` uses in-memory data so it runs with no backend.)
|
|
108
71
|
|
|
109
72
|
Example code: read `dist/examples/useSchemaSource/cms-collection.tsx`
|
|
110
73
|
|
|
@@ -114,36 +77,13 @@ What you get: the columns from the fields, plus one you add. `columns` adds colu
|
|
|
114
77
|
|
|
115
78
|
Example code: read `dist/examples/useSchemaSource/extra-columns-and-data.tsx`
|
|
116
79
|
|
|
117
|
-
### Your own source
|
|
118
|
-
|
|
119
|
-
What you get: a source over any data. `loadSchema` returns the fields (`schema`), the item access (`backend`), and optionally the field changes (`fieldActions`). `find` receives search, filters and sort and must apply them. Try it: search, sort by a column, or add a field with the "+" header button. The new field is stored in memory, so it resets on refresh.
|
|
120
|
-
|
|
121
|
-
Example code: read `dist/examples/useSchemaSource/your-own-source.tsx`
|
|
122
|
-
|
|
123
80
|
## API
|
|
124
81
|
|
|
125
82
|
### Overview
|
|
126
83
|
|
|
127
|
-
Options of `useSchemaSource`
|
|
84
|
+
Options of `useSchemaSource`, which `useCmsSchemaSource` builds on. A CMS page passes `useCmsSchemaSource` its own options (`collectionId`, `includeUserPermissions`, `metasiteId`, `fieldTypes`, …) instead — see `UseCmsSchemaSourceDeps` in the type index.
|
|
128
85
|
|
|
129
86
|
### Props
|
|
130
87
|
|
|
131
|
-
|
|
132
|
-
|------|------|----------|---------|-------------|
|
|
133
|
-
| `references` | `Record<string, SchemaSource<any>>` | No | - | Sources for collections this one references, keyed by the referenced collection id. A renderer resolves a reference field through the matching entry — its `loadSchema` gives the referenced schema and `sourceFetchData` queries the referenced items. Default: none. |
|
|
134
|
-
| `getReferencedCollectionSource` | `((collectionId: string) => SchemaSource<any>)` | No | - | Lazy source lookup for a referenced collection that is not in `references`. Is used when a reference field is created in the add field modal. The returned source owns its own async schema/item loading. |
|
|
135
|
-
| `itemKey` | `((item: T) => string)` | No | - | Stable row identity. Default: `row[idField]`. |
|
|
136
|
-
| `itemName` | `((item: T) => string)` | No | - | Row display label. Default: `row[displayField]`. |
|
|
137
|
-
| `searchableFieldIds` | `((schema: Schema) => string[])` | No | - | Fields free-text search runs against. Default: `[displayField]`. |
|
|
138
|
-
| `fieldModal` | `FieldModalInput` | No | - | What the add/edit field modal shows. Default: no types, generic titles. |
|
|
139
|
-
| `fieldTypes` | `FieldTypeDefinition<unknown>[]` | No | - | Consumer-defined field types: how a field of that type renders, filters and validates wherever it appears. A field with `type: 'CUSTOM'` resolves its definition here by `customType`. The add/edit field modal never reads this — see `fieldModal`. Default: none. |
|
|
140
|
-
| `getFieldPresentation` | `((field: Field) => FieldPresentation)` | No | - | Overrides one existing field's type label, icons and collection-picker label. Does not change its type, values or add-field options. |
|
|
141
|
-
| `canAddFields` | `((schema: Schema) => boolean)` | No | - | Default: `schemaPermissions.createField`. |
|
|
142
|
-
| `canEditField` | `((field: Field, schema: Schema) => boolean)` | No | - | Default: `schemaPermissions.updateField`, except for system fields and the id field. |
|
|
143
|
-
| `canDeleteField` | `((field: Field, schema: Schema) => boolean)` | No | - | Default: `schemaPermissions.deleteField`, except for system fields and the id field. |
|
|
144
|
-
| `getDeleteFieldConfirmation` | `((field: Field, schema: Schema) => DeleteFieldConfirmation)` | No | - | Resolved when deletion is requested. Undefined keeps the default dialog. |
|
|
145
|
-
| `fieldPermissions` | `FieldPermissions` | No | - | Permission defaults shown in the modal. Absent ⇒ no permissions section. |
|
|
146
|
-
| `supportsPii` | `boolean` | No | - | Default: `false`. |
|
|
147
|
-
| `getFieldValue` | `((item: T, field: Field) => unknown)` | No | - | The value of a field on an item. Default: `item[field.id]`. |
|
|
148
|
-
| `setFieldValue` | `((item: T, field: Field, value: unknown) => T)` | No | - | Writes a field's value on an item, returning the updated item. Default: `{ ...item, [field.id]: value }`. |
|
|
88
|
+
Read `dist/dts-bundle/hooks/useSchemaSource.d.ts` for `useSchemaSource`'s props. Shared shapes cut to a one-line stub there hold 16 of them: `dist/dts-bundle/types/SchemaSourceInput.d.ts` (16).
|
|
149
89
|
|