@shopify/ui-extensions 2026.1.2 → 2026.1.3
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/build/cjs/surfaces/checkout/shared.js +1 -10
- package/build/cjs/surfaces/customer-account/preact/metafield.js +1 -0
- package/build/cjs/surfaces/customer-account/preact/metafields.js +1 -0
- package/build/esm/surfaces/checkout/shared.mjs +1 -10
- package/build/esm/surfaces/customer-account/preact/metafield.mjs +1 -0
- package/build/esm/surfaces/customer-account/preact/metafields.mjs +1 -0
- package/build/esnext/surfaces/checkout/shared.esnext +1 -10
- package/build/esnext/surfaces/customer-account/preact/metafield.esnext +1 -0
- package/build/esnext/surfaces/customer-account/preact/metafields.esnext +1 -0
- package/build/ts/docs/shared/component-definitions.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Avatar.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Badge.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Banner.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Box.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Button.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ButtonGroup.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Checkbox.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Chip.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Choice.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ChoiceList.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Clickable.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ClickableChip.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ColorField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ColorPicker.d.ts.map +1 -1
- package/build/ts/docs/shared/components/DateField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/DatePicker.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Divider.d.ts.map +1 -1
- package/build/ts/docs/shared/components/EmailField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Form.d.ts.map +1 -1
- package/build/ts/docs/shared/components/FunctionSettings.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Grid.d.ts.map +1 -1
- package/build/ts/docs/shared/components/GridItem.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Heading.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Icon.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Image.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Link.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ListItem.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Menu.d.ts.map +1 -1
- package/build/ts/docs/shared/components/MoneyField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/NumberField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/OrderedList.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Paragraph.d.ts.map +1 -1
- package/build/ts/docs/shared/components/PasswordField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/QueryContainer.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Section.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Select.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Spinner.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Stack.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Switch.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Table.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableBody.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableCell.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableHeader.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableHeaderRow.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableRow.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Text.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TextArea.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TextField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Thumbnail.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Tooltip.d.ts.map +1 -1
- package/build/ts/docs/shared/components/URLField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/UnorderedList.d.ts.map +1 -1
- package/build/ts/shared.d.ts +6 -4
- package/build/ts/shared.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts +1 -8
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ActionExtensionComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/AdminAction/AdminAction.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminAction.d.ts +113 -12
- package/build/ts/surfaces/admin/components/AdminBlock/AdminBlock.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminBlock.d.ts +109 -9
- package/build/ts/surfaces/admin/components/AdminPrintAction/AdminPrintAction.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminPrintAction.d.ts +105 -9
- package/build/ts/surfaces/admin/components/Avatar/Avatar.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Avatar.d.ts +165 -13
- package/build/ts/surfaces/admin/components/Badge/Badge.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Badge.d.ts +195 -24
- package/build/ts/surfaces/admin/components/Banner/Banner.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Banner.d.ts +161 -19
- package/build/ts/surfaces/admin/components/BlockExtensionComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/Box/Box.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Box.d.ts +260 -78
- package/build/ts/surfaces/admin/components/Button/Button.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Button.d.ts +316 -56
- package/build/ts/surfaces/admin/components/ButtonGroup/ButtonGroup.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ButtonGroup.d.ts +138 -28
- package/build/ts/surfaces/admin/components/Checkbox/Checkbox.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Checkbox.d.ts +193 -9
- package/build/ts/surfaces/admin/components/Chip/Chip.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Chip.d.ts +2 -4
- package/build/ts/surfaces/admin/components/Choice.d.ts +129 -27
- package/build/ts/surfaces/admin/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ChoiceList.d.ts +162 -15
- package/build/ts/surfaces/admin/components/Clickable/Clickable.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Clickable.d.ts +202 -48
- package/build/ts/surfaces/admin/components/ClickableChip/ClickableChip.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ClickableChip.d.ts +176 -30
- package/build/ts/surfaces/admin/components/ColorField/ColorField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ColorField.d.ts +237 -23
- package/build/ts/surfaces/admin/components/ColorPicker/ColorPicker.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ColorPicker.d.ts +160 -13
- package/build/ts/surfaces/admin/components/DateField/DateField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/DateField.d.ts +255 -27
- package/build/ts/surfaces/admin/components/DatePicker/DatePicker.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/DatePicker.d.ts +201 -12
- package/build/ts/surfaces/admin/components/Divider/Divider.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Divider.d.ts +147 -13
- package/build/ts/surfaces/admin/components/DropZone/DropZone.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/EmailField/EmailField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/EmailField.d.ts +219 -12
- package/build/ts/surfaces/admin/components/Form/Form.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Form.d.ts +125 -10
- package/build/ts/surfaces/admin/components/FormExtensionComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/FunctionSettings/FunctionSettings.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/FunctionSettings.d.ts +139 -9
- package/build/ts/surfaces/admin/components/FunctionSettingsComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/Grid/Grid.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Grid.d.ts +307 -73
- package/build/ts/surfaces/admin/components/GridItem.d.ts +270 -37
- package/build/ts/surfaces/admin/components/Heading/Heading.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Heading.d.ts +128 -29
- package/build/ts/surfaces/admin/components/Icon/Icon.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Icon.d.ts +150 -27
- package/build/ts/surfaces/admin/components/Image/Image.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Image.d.ts +290 -36
- package/build/ts/surfaces/admin/components/Link/Link.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Link.d.ts +141 -39
- package/build/ts/surfaces/admin/components/ListItem.d.ts +119 -16
- package/build/ts/surfaces/admin/components/Menu/Menu.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Menu.d.ts +160 -29
- package/build/ts/surfaces/admin/components/Modal/Modal.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/MoneyField/MoneyField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/MoneyField.d.ts +218 -12
- package/build/ts/surfaces/admin/components/NumberField/NumberField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/NumberField.d.ts +230 -12
- package/build/ts/surfaces/admin/components/Option.d.ts +122 -14
- package/build/ts/surfaces/admin/components/OptionGroup.d.ts +116 -16
- package/build/ts/surfaces/admin/components/OrderedList/OrderedList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/OrderedList.d.ts +117 -18
- package/build/ts/surfaces/admin/components/Page/Page.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Paragraph/Paragraph.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Paragraph.d.ts +162 -38
- package/build/ts/surfaces/admin/components/PasswordField/PasswordField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/PasswordField.d.ts +226 -19
- package/build/ts/surfaces/admin/components/Popover/Popover.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/PrintActionExtensionComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/QueryContainer/QueryContainer.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/QueryContainer.d.ts +127 -18
- package/build/ts/surfaces/admin/components/SearchField/SearchField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/SearchField.d.ts +212 -18
- package/build/ts/surfaces/admin/components/Section/Section.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Section.d.ts +143 -26
- package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Select.d.ts +209 -33
- package/build/ts/surfaces/admin/components/Spinner/Spinner.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Spinner.d.ts +127 -13
- package/build/ts/surfaces/admin/components/Stack/Stack.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Stack.d.ts +297 -65
- package/build/ts/surfaces/admin/components/Switch/Switch.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Switch.d.ts +185 -17
- package/build/ts/surfaces/admin/components/Table/Table.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Table.d.ts +237 -18
- package/build/ts/surfaces/admin/components/TableBody.d.ts +122 -16
- package/build/ts/surfaces/admin/components/TableCell.d.ts +125 -12
- package/build/ts/surfaces/admin/components/TableHeader.d.ts +137 -16
- package/build/ts/surfaces/admin/components/TableHeaderRow.d.ts +122 -16
- package/build/ts/surfaces/admin/components/TableRow.d.ts +125 -16
- package/build/ts/surfaces/admin/components/Text/Text.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Text.d.ts +192 -38
- package/build/ts/surfaces/admin/components/TextArea/TextArea.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/TextArea.d.ts +217 -12
- package/build/ts/surfaces/admin/components/TextField/TextField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/TextField.d.ts +232 -38
- package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Thumbnail.d.ts +158 -13
- package/build/ts/surfaces/admin/components/Tooltip/Tooltip.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Tooltip.d.ts +157 -29
- package/build/ts/surfaces/admin/components/URLField/URLField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/URLField.d.ts +231 -19
- package/build/ts/surfaces/admin/components/UnorderedList/UnorderedList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/UnorderedList.d.ts +117 -18
- package/build/ts/surfaces/admin/components/patterns/accountConnection.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/accountConnection.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/appCard.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/appCard.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/calloutCard.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/calloutCard.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/details.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/details.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/emptyState.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/emptyState.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/footerHelp.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/footerHelp.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/homepage.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/homepage.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/index.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/index.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/indexTable.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/interstitialNav.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/interstitialNav.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/mediaCard.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/mediaCard.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/metricsCard.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/metricsCard.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/resourceList.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/resourceList.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/settings.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/settings.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/setupGuide.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/setupGuide.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/shared.d.ts +845 -931
- package/build/ts/surfaces/admin/docs-types.d.ts +7 -1
- package/build/ts/surfaces/admin/docs-types.d.ts.map +1 -1
- package/build/ts/surfaces/admin/extension-targets.d.ts +6 -6
- package/build/ts/surfaces/checkout/api/docs.d.ts +0 -2
- package/build/ts/surfaces/checkout/api/docs.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +0 -18
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/shared.d.ts +8 -11
- package/build/ts/surfaces/checkout/shared.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +356 -317
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/shared.d.ts +84 -97
- package/build/ts/surfaces/customer-account/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts +8 -10
- package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Abbreviation/Abbreviation.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Abbreviation/Abbreviation.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Announcement/Announcement.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Announcement/Announcement.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Badge/Badge.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Badge/Badge.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Banner/Banner.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Banner/Banner.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Box/Box.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Box/Box.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Button/Button.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Button/Button.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ButtonGroup.d.ts +2 -2
- package/build/ts/surfaces/customer-account/components/Checkbox/Checkbox.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Checkbox/Checkbox.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Chip/Chip.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Chip/Chip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ChoiceList/ChoiceList.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Clickable/Clickable.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Clickable/Clickable.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ClickableChip/ClickableChip.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ClickableChip/ClickableChip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ClipboardItem/ClipboardItem.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ClipboardItem/ClipboardItem.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ConsentCheckbox/ConsentCheckbox.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ConsentCheckbox/ConsentCheckbox.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ConsentPhoneField/ConsentPhoneField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ConsentPhoneField/ConsentPhoneField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/DateField/DateField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/DateField/DateField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/DatePicker/DatePicker.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/DatePicker/DatePicker.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Details/Details.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Details/Details.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Divider/Divider.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Divider/Divider.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/DropZone/DropZone.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/DropZone/DropZone.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/EmailField/EmailField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/EmailField/EmailField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Form/Form.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Form/Form.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Grid/Grid.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Grid/Grid.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Heading/Heading.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Heading/Heading.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Icon/Icon.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Icon/Icon.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Image/Image.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Image/Image.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Link/Link.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Link/Link.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Map/Map.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Map/Map.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Modal/Modal.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Modal/Modal.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/MoneyField/MoneyField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/MoneyField/MoneyField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/NumberField/NumberField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/NumberField/NumberField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/OrderedList/OrderedList.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/OrderedList/OrderedList.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Paragraph/Paragraph.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Paragraph/Paragraph.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/PasswordField/PasswordField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/PasswordField/PasswordField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/PaymentIcon/PaymentIcon.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/PaymentIcon/PaymentIcon.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/PhoneField/PhoneField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/PhoneField/PhoneField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Popover/Popover.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Popover/Popover.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/PressButton/PressButton.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/PressButton/PressButton.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ProductThumbnail/ProductThumbnail.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ProductThumbnail/ProductThumbnail.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Progress/Progress.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Progress/Progress.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/QRCode/QRCode.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/QRCode/QRCode.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/QueryContainer/QueryContainer.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/QueryContainer/QueryContainer.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ScrollBox/ScrollBox.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ScrollBox/ScrollBox.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Select/Select.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Select/Select.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Sheet/Sheet.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Sheet/Sheet.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/SkeletonParagraph/SkeletonParagraph.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/SkeletonParagraph/SkeletonParagraph.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Spinner/Spinner.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Spinner/Spinner.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Stack/Stack.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Stack/Stack.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Switch/Switch.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Switch/Switch.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Text/Text.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Text/Text.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/TextArea/TextArea.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/TextArea/TextArea.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/TextField/TextField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/TextField/TextField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Time/Time.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Time/Time.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Tooltip/Tooltip.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Tooltip/Tooltip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/URLField/URLField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/URLField/URLField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/UnorderedList/UnorderedList.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/UnorderedList/UnorderedList.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/preact/metafield.d.ts +1 -0
- package/build/ts/surfaces/customer-account/preact/metafield.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/preact/metafields.d.ts +1 -0
- package/build/ts/surfaces/customer-account/preact/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/Button.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/EmptyState.d.ts +2 -2
- package/build/ts/surfaces/point-of-sale/components/Link.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +10 -10
- package/build/ts/surfaces/point-of-sale/components/Text.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +55 -55
- package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +2 -2
- package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +23 -2
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/docs/shared/component-definitions.ts +15 -5
- package/src/docs/shared/components/Abbreviation.ts +2 -2
- package/src/docs/shared/components/Announcement.ts +2 -2
- package/src/docs/shared/components/Avatar.ts +3 -2
- package/src/docs/shared/components/Badge.ts +3 -2
- package/src/docs/shared/components/Banner.ts +3 -2
- package/src/docs/shared/components/Box.ts +3 -2
- package/src/docs/shared/components/Button.ts +3 -2
- package/src/docs/shared/components/ButtonGroup.ts +5 -3
- package/src/docs/shared/components/Checkbox.ts +3 -2
- package/src/docs/shared/components/Chip.ts +3 -2
- package/src/docs/shared/components/Choice.ts +3 -2
- package/src/docs/shared/components/ChoiceList.ts +4 -3
- package/src/docs/shared/components/Clickable.ts +3 -2
- package/src/docs/shared/components/ClickableChip.ts +4 -3
- package/src/docs/shared/components/ClipboardItem.ts +3 -3
- package/src/docs/shared/components/ColorField.ts +4 -3
- package/src/docs/shared/components/ColorPicker.ts +5 -3
- package/src/docs/shared/components/ConsentCheckbox.ts +2 -2
- package/src/docs/shared/components/ConsentPhoneField.ts +2 -2
- package/src/docs/shared/components/DateField.ts +5 -3
- package/src/docs/shared/components/DatePicker.ts +5 -3
- package/src/docs/shared/components/Details.ts +2 -2
- package/src/docs/shared/components/Divider.ts +3 -2
- package/src/docs/shared/components/DropZone.ts +3 -3
- package/src/docs/shared/components/EmailField.ts +4 -3
- package/src/docs/shared/components/Form.ts +3 -2
- package/src/docs/shared/components/FunctionSettings.ts +5 -20
- package/src/docs/shared/components/Grid.ts +3 -2
- package/src/docs/shared/components/GridItem.ts +6 -4
- package/src/docs/shared/components/Heading.ts +3 -2
- package/src/docs/shared/components/Icon.ts +3 -2
- package/src/docs/shared/components/Image.ts +3 -2
- package/src/docs/shared/components/Link.ts +3 -2
- package/src/docs/shared/components/ListItem.ts +5 -4
- package/src/docs/shared/components/Map.ts +2 -2
- package/src/docs/shared/components/MapMarker.ts +3 -3
- package/src/docs/shared/components/Menu.ts +3 -2
- package/src/docs/shared/components/Modal.ts +2 -2
- package/src/docs/shared/components/MoneyField.ts +4 -3
- package/src/docs/shared/components/NumberField.ts +4 -3
- package/src/docs/shared/components/Option.ts +1 -1
- package/src/docs/shared/components/OptionGroup.ts +2 -2
- package/src/docs/shared/components/OrderedList.ts +4 -3
- package/src/docs/shared/components/Page.ts +3 -3
- package/src/docs/shared/components/Paragraph.ts +3 -2
- package/src/docs/shared/components/PasswordField.ts +5 -3
- package/src/docs/shared/components/PaymentIcon.ts +3 -3
- package/src/docs/shared/components/PhoneField.ts +2 -2
- package/src/docs/shared/components/Popover.ts +2 -2
- package/src/docs/shared/components/PressButton.ts +2 -2
- package/src/docs/shared/components/ProductThumbnail.ts +3 -3
- package/src/docs/shared/components/Progress.ts +2 -2
- package/src/docs/shared/components/QRCode.ts +3 -3
- package/src/docs/shared/components/QueryContainer.ts +4 -3
- package/src/docs/shared/components/ScrollBox.ts +3 -3
- package/src/docs/shared/components/SearchField.ts +3 -3
- package/src/docs/shared/components/Section.ts +3 -2
- package/src/docs/shared/components/Select.ts +3 -2
- package/src/docs/shared/components/Sheet.ts +1 -1
- package/src/docs/shared/components/SkeletonParagraph.ts +3 -3
- package/src/docs/shared/components/Spinner.ts +3 -2
- package/src/docs/shared/components/Stack.ts +3 -2
- package/src/docs/shared/components/Summary.ts +2 -2
- package/src/docs/shared/components/Switch.ts +4 -2
- package/src/docs/shared/components/Table.ts +3 -2
- package/src/docs/shared/components/TableBody.ts +4 -3
- package/src/docs/shared/components/TableCell.ts +5 -3
- package/src/docs/shared/components/TableHeader.ts +5 -3
- package/src/docs/shared/components/TableHeaderRow.ts +4 -3
- package/src/docs/shared/components/TableRow.ts +5 -3
- package/src/docs/shared/components/Text.ts +3 -2
- package/src/docs/shared/components/TextArea.ts +4 -3
- package/src/docs/shared/components/TextField.ts +4 -3
- package/src/docs/shared/components/Thumbnail.ts +3 -2
- package/src/docs/shared/components/Time.ts +2 -2
- package/src/docs/shared/components/Tooltip.ts +3 -2
- package/src/docs/shared/components/URLField.ts +4 -3
- package/src/docs/shared/components/UnorderedList.ts +4 -3
- package/src/shared.ts +6 -4
- package/src/surfaces/admin/api/discount-function-settings/launch-options.ts +1 -8
- package/src/surfaces/admin/api/print-action/examples/custom-product-labels.jsx +17 -14
- package/src/surfaces/admin/api/print-action/examples/generate-packing-slip.jsx +18 -12
- package/src/surfaces/admin/api/print-action/examples/shipping-manifest.jsx +11 -12
- package/src/surfaces/admin/components/ActionExtensionComponents.ts +1 -1
- package/src/surfaces/admin/components/{ButtonGroup/examples/default.jsx → AdminAction/examples/default.html} +3 -2
- package/src/surfaces/admin/components/AdminAction/examples/destructive-action.html +10 -0
- package/src/surfaces/admin/components/AdminAction/examples/loading-state.html +5 -0
- package/src/surfaces/admin/components/AdminAction/examples/with-form-content.html +8 -0
- package/src/surfaces/admin/components/AdminAction/examples/with-resource-details.html +15 -0
- package/src/surfaces/admin/components/AdminAction.d.ts +113 -12
- package/src/surfaces/admin/components/AdminBlock/examples/default.html +3 -0
- package/src/surfaces/admin/components/AdminBlock/examples/with-actions.html +14 -0
- package/src/surfaces/admin/components/AdminBlock/examples/with-badges.html +14 -0
- package/src/surfaces/admin/components/AdminBlock/examples/with-collapsed-summary.html +7 -0
- package/src/surfaces/admin/components/AdminBlock/examples/with-data-table.html +21 -0
- package/src/surfaces/admin/components/AdminBlock.d.ts +109 -9
- package/src/surfaces/admin/components/AdminPrintAction/examples/default.html +1 -0
- package/src/surfaces/admin/components/AdminPrintAction/examples/dynamic-url.html +1 -0
- package/src/surfaces/admin/components/AdminPrintAction/examples/pdf-source.html +1 -0
- package/src/surfaces/admin/components/AdminPrintAction.d.ts +105 -9
- package/src/surfaces/admin/components/Avatar.d.ts +165 -13
- package/src/surfaces/admin/components/Badge.d.ts +195 -24
- package/src/surfaces/admin/components/Banner.d.ts +161 -19
- package/src/surfaces/admin/components/BlockExtensionComponents.ts +1 -1
- package/src/surfaces/admin/components/Box/examples/accessible-status-messages.html +8 -14
- package/src/surfaces/admin/components/Box/examples/screen-reader-only-content.html +3 -0
- package/src/surfaces/admin/components/Box.d.ts +260 -78
- package/src/surfaces/admin/components/Button/examples/component-interactions.html +8 -6
- package/src/surfaces/admin/components/Button/examples/icon-only-button.html +17 -1
- package/src/surfaces/admin/components/Button.d.ts +316 -56
- package/src/surfaces/admin/components/ButtonGroup.d.ts +138 -28
- package/src/surfaces/admin/components/Checkbox/examples/indeterminate-state.html +10 -0
- package/src/surfaces/admin/components/Checkbox/examples/validation-example.html +9 -0
- package/src/surfaces/admin/components/Checkbox.d.ts +193 -9
- package/src/surfaces/admin/components/Chip/examples/default.html +1 -1
- package/src/surfaces/admin/components/Chip.d.ts +2 -4
- package/src/surfaces/admin/components/Choice.d.ts +129 -27
- package/src/surfaces/admin/components/ChoiceList/examples/disabled-state.html +5 -0
- package/src/surfaces/admin/components/ChoiceList/examples/with-error-state.html +2 -3
- package/src/surfaces/admin/components/ChoiceList.d.ts +162 -15
- package/src/surfaces/admin/components/Clickable.d.ts +202 -48
- package/src/surfaces/admin/components/ClickableChip.d.ts +176 -30
- package/src/surfaces/admin/components/ColorField/examples/default.html +4 -1
- package/src/surfaces/admin/components/ColorField/examples/validation-example.html +12 -0
- package/src/surfaces/admin/components/ColorField.d.ts +237 -23
- package/src/surfaces/admin/components/ColorPicker/examples/default.html +1 -1
- package/src/surfaces/admin/components/ColorPicker.d.ts +160 -13
- package/src/surfaces/admin/components/DateField.d.ts +255 -27
- package/src/surfaces/admin/components/DatePicker.d.ts +201 -12
- package/src/surfaces/admin/components/Divider.d.ts +147 -13
- package/src/surfaces/admin/components/DropZone/examples/upload-with-validation.html +42 -0
- package/src/surfaces/admin/components/EmailField/examples/disabled-state.html +5 -0
- package/src/surfaces/admin/components/EmailField.d.ts +219 -12
- package/src/surfaces/admin/components/Form/examples/default.html +1 -1
- package/src/surfaces/admin/components/Form/examples/with-choice-fields.html +12 -0
- package/src/surfaces/admin/components/Form/examples/with-multiple-fields.html +12 -0
- package/src/surfaces/admin/components/Form/examples/with-sections.html +21 -0
- package/src/surfaces/admin/components/Form/examples/with-validation.html +7 -0
- package/src/surfaces/admin/components/Form.d.ts +125 -10
- package/src/surfaces/admin/components/FormExtensionComponents.ts +1 -1
- package/src/surfaces/admin/components/FunctionSettings/examples/default.html +9 -0
- package/src/surfaces/admin/components/FunctionSettings/examples/with-multiple-settings.html +16 -0
- package/src/surfaces/admin/components/FunctionSettings/examples/with-select-options.html +10 -0
- package/src/surfaces/admin/components/FunctionSettings/examples/with-toggle.html +13 -0
- package/src/surfaces/admin/components/FunctionSettings/examples/with-validation.html +23 -0
- package/src/surfaces/admin/components/FunctionSettings.d.ts +139 -9
- package/src/surfaces/admin/components/FunctionSettingsComponents.ts +1 -1
- package/src/surfaces/admin/components/Grid.d.ts +307 -73
- package/src/surfaces/admin/components/GridItem.d.ts +270 -37
- package/src/surfaces/admin/components/Heading.d.ts +128 -29
- package/src/surfaces/admin/components/Icon.d.ts +150 -27
- package/src/surfaces/admin/components/Image/examples/basic-usage.html +15 -4
- package/src/surfaces/admin/components/Image.d.ts +290 -36
- package/src/surfaces/admin/components/Link/examples/default.html +1 -1
- package/src/surfaces/admin/components/Link.d.ts +141 -39
- package/src/surfaces/admin/components/ListItem.d.ts +119 -16
- package/src/surfaces/admin/components/Menu/examples/{menu-with-icons.html → icon-only-trigger.html} +7 -2
- package/src/surfaces/admin/components/Menu.d.ts +160 -29
- package/src/surfaces/admin/components/Modal/examples/delete-with-async-handling.html +28 -0
- package/src/surfaces/admin/components/MoneyField/examples/basic-field.html +0 -1
- package/src/surfaces/admin/components/MoneyField.d.ts +218 -12
- package/src/surfaces/admin/components/NumberField/examples/disabled-and-read-only.html +15 -0
- package/src/surfaces/admin/components/NumberField/examples/{basic-usage.html → with-error-state.html} +3 -1
- package/src/surfaces/admin/components/NumberField.d.ts +230 -12
- package/src/surfaces/admin/components/Option.d.ts +122 -14
- package/src/surfaces/admin/components/OptionGroup.d.ts +116 -16
- package/src/surfaces/admin/components/OrderedList/examples/default.html +3 -3
- package/src/surfaces/admin/components/OrderedList.d.ts +117 -18
- package/src/surfaces/admin/components/Page/examples/edit-page-with-all-slots.html +36 -0
- package/src/surfaces/admin/components/Paragraph/examples/subdued-color.html +3 -0
- package/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.html +13 -1
- package/src/surfaces/admin/components/Paragraph.d.ts +162 -38
- package/src/surfaces/admin/components/PasswordField.d.ts +226 -19
- package/src/surfaces/admin/components/Popover/examples/filter-with-apply-and-clear.html +35 -0
- package/src/surfaces/admin/components/PrintActionExtensionComponents.ts +1 -1
- package/src/surfaces/admin/components/QueryContainer.d.ts +127 -18
- package/src/surfaces/admin/components/SearchField.d.ts +212 -18
- package/src/surfaces/admin/components/Section.d.ts +143 -26
- package/src/surfaces/admin/components/Select/examples/with-error-state.html +2 -2
- package/src/surfaces/admin/components/Select/examples/with-option-groups.html +4 -4
- package/src/surfaces/admin/components/Select.d.ts +209 -33
- package/src/surfaces/admin/components/Spinner/examples/spinner-sizes.html +5 -0
- package/src/surfaces/admin/components/Spinner.d.ts +127 -13
- package/src/surfaces/admin/components/Stack.d.ts +297 -65
- package/src/surfaces/admin/components/Switch/examples/disabled-switch.html +2 -2
- package/src/surfaces/admin/components/Switch/examples/form-integration.html +15 -12
- package/src/surfaces/admin/components/Switch/examples/hidden-label-for-accessibility.html +1 -1
- package/src/surfaces/admin/components/Switch/examples/settings-panel-with-stack.html +1 -1
- package/src/surfaces/admin/components/Switch/examples/with-details-and-error.html +1 -1
- package/src/surfaces/admin/components/Switch.d.ts +185 -17
- package/src/surfaces/admin/components/Table/examples/{basic-usage.jsx → with-filters.html} +2 -13
- package/src/surfaces/admin/components/Table.d.ts +237 -18
- package/src/surfaces/admin/components/TableBody.d.ts +122 -16
- package/src/surfaces/admin/components/TableCell.d.ts +125 -12
- package/src/surfaces/admin/components/TableHeader.d.ts +137 -16
- package/src/surfaces/admin/components/TableHeaderRow.d.ts +122 -16
- package/src/surfaces/admin/components/TableRow.d.ts +125 -16
- package/src/surfaces/admin/components/Text.d.ts +192 -38
- package/src/surfaces/admin/components/TextArea/examples/disabled-and-read-only.html +15 -0
- package/src/surfaces/admin/components/TextArea.d.ts +217 -12
- package/src/surfaces/admin/components/TextField/examples/disabled-and-read-only.html +13 -0
- package/src/surfaces/admin/components/TextField.d.ts +232 -38
- package/src/surfaces/admin/components/Thumbnail/examples/default.html +1 -1
- package/src/surfaces/admin/components/Thumbnail/examples/different-sizes.html +3 -3
- package/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.html +22 -9
- package/src/surfaces/admin/components/Thumbnail.d.ts +158 -13
- package/src/surfaces/admin/components/Tooltip/examples/basic-usage.html +2 -4
- package/src/surfaces/admin/components/Tooltip/examples/keyboard-shortcut.html +2 -0
- package/src/surfaces/admin/components/Tooltip/examples/with-icon-button.html +3 -5
- package/src/surfaces/admin/components/Tooltip.d.ts +157 -29
- package/src/surfaces/admin/components/URLField/examples/default.html +2 -2
- package/src/surfaces/admin/components/URLField/examples/with-default-value.html +5 -7
- package/src/surfaces/admin/components/URLField.d.ts +231 -19
- package/src/surfaces/admin/components/UnorderedList.d.ts +117 -18
- package/src/surfaces/admin/components/patterns/examples/accountConnection-modal.html +54 -0
- package/src/surfaces/admin/components/patterns/examples/accountConnection-modal.jsx +54 -0
- package/src/surfaces/admin/components/patterns/examples/accountConnection-toast.html +25 -0
- package/src/surfaces/admin/components/patterns/examples/accountConnection-toast.jsx +27 -0
- package/src/surfaces/admin/components/patterns/examples/appCard-nav.html +29 -0
- package/src/surfaces/admin/components/patterns/examples/appCard-nav.jsx +29 -0
- package/src/surfaces/admin/components/patterns/examples/calloutCard-nav.html +35 -0
- package/src/surfaces/admin/components/patterns/examples/calloutCard-nav.jsx +37 -0
- package/src/surfaces/admin/components/patterns/examples/calloutCard-toast.html +41 -0
- package/src/surfaces/admin/components/patterns/examples/calloutCard-toast.jsx +41 -0
- package/src/surfaces/admin/components/patterns/examples/details-modal.html +36 -0
- package/src/surfaces/admin/components/patterns/examples/details-modal.jsx +39 -0
- package/src/surfaces/admin/components/patterns/examples/details-save-bar.html +21 -0
- package/src/surfaces/admin/components/patterns/examples/details-save-bar.jsx +31 -0
- package/src/surfaces/admin/components/patterns/examples/details.html +8 -3
- package/src/surfaces/admin/components/patterns/examples/details.jsx +238 -242
- package/src/surfaces/admin/components/patterns/examples/emptyState-intents.html +39 -0
- package/src/surfaces/admin/components/patterns/examples/emptyState-intents.jsx +41 -0
- package/src/surfaces/admin/components/patterns/examples/emptyState-nav.html +16 -0
- package/src/surfaces/admin/components/patterns/examples/emptyState-nav.jsx +16 -0
- package/src/surfaces/admin/components/patterns/examples/homepage.html +6 -1
- package/src/surfaces/admin/components/patterns/examples/homepage.jsx +7 -0
- package/src/surfaces/admin/components/patterns/examples/index-intents.html +39 -0
- package/src/surfaces/admin/components/patterns/examples/index-intents.jsx +41 -0
- package/src/surfaces/admin/components/patterns/examples/index.html +12 -7
- package/src/surfaces/admin/components/patterns/examples/index.jsx +13 -6
- package/src/surfaces/admin/components/patterns/examples/indexTable-bulk-selection.html +109 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-bulk-selection.jsx +131 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-nav.html +85 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-nav.jsx +85 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-pagination.html +74 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-pagination.jsx +85 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-toast.html +119 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-toast.jsx +126 -0
- package/src/surfaces/admin/components/patterns/examples/interstitialNav.html +8 -8
- package/src/surfaces/admin/components/patterns/examples/interstitialNav.jsx +7 -7
- package/src/surfaces/admin/components/patterns/examples/mediaCard-intents.html +31 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-intents.jsx +33 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-modal.html +56 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-modal.jsx +62 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-share.html +43 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-share.jsx +43 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-toast.html +36 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-toast.jsx +36 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard.html +25 -23
- package/src/surfaces/admin/components/patterns/examples/mediaCard.jsx +29 -27
- package/src/surfaces/admin/components/patterns/examples/metricsCard-nav.html +51 -0
- package/src/surfaces/admin/components/patterns/examples/metricsCard-nav.jsx +51 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-modal.html +78 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-modal.jsx +82 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-nav.html +54 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-nav.jsx +54 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-picker.html +58 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-picker.jsx +59 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-toast.html +67 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-toast.jsx +77 -0
- package/src/surfaces/admin/components/patterns/examples/settings-modal.html +45 -0
- package/src/surfaces/admin/components/patterns/examples/settings-modal.jsx +53 -0
- package/src/surfaces/admin/components/patterns/examples/settings-toast.html +37 -0
- package/src/surfaces/admin/components/patterns/examples/settings-toast.jsx +33 -0
- package/src/surfaces/admin/components/patterns/examples/settings.html +31 -1
- package/src/surfaces/admin/components/patterns/examples/settings.jsx +31 -0
- package/src/surfaces/admin/components/patterns/examples/setupGuide-nav.html +89 -0
- package/src/surfaces/admin/components/patterns/examples/setupGuide-nav.jsx +93 -0
- package/src/surfaces/admin/components/patterns/examples/setupGuide-toast.html +94 -0
- package/src/surfaces/admin/components/patterns/examples/setupGuide-toast.jsx +103 -0
- package/src/surfaces/admin/components/patterns/examples/setupGuide.html +90 -40
- package/src/surfaces/admin/components/patterns/examples/setupGuide.jsx +81 -9
- package/src/surfaces/admin/components/patterns/index.ab.doc.ts +75 -52
- package/src/surfaces/admin/components/shared.d.ts +845 -931
- package/src/surfaces/admin/components.d.ts +3256 -2272
- package/src/surfaces/admin/docs-types.ts +10 -1
- package/src/surfaces/admin/extension-targets.ts +6 -6
- package/src/surfaces/checkout/api/docs.ts +0 -2
- package/src/surfaces/checkout/api/standard/standard.ts +0 -21
- package/src/surfaces/checkout/shared.ts +8 -11
- package/src/surfaces/customer-account/api/order-status/order-status.ts +363 -317
- package/src/surfaces/customer-account/api/shared.ts +84 -97
- package/src/surfaces/customer-account/api/standard-api/standard-api.ts +8 -10
- package/src/surfaces/customer-account/components/Abbreviation/examples/basic-abbreviation.example.html +1 -0
- package/src/surfaces/customer-account/components/Announcement/examples/basic-announcement.example.html +16 -0
- package/src/surfaces/customer-account/components/Badge/examples/basic-badge.example.html +3 -0
- package/src/surfaces/customer-account/components/Banner/examples/basic-banner.example.html +1 -0
- package/src/surfaces/customer-account/components/Box/examples/basic-box.example.html +11 -0
- package/src/surfaces/customer-account/components/Button/examples/basic-button.example.html +2 -0
- package/src/surfaces/customer-account/components/ButtonGroup.d.ts +2 -2
- package/src/surfaces/customer-account/components/Checkbox/examples/basic-checkbox.example.html +1 -0
- package/src/surfaces/customer-account/components/Chip/examples/basic-chip.example.html +1 -0
- package/src/surfaces/customer-account/components/ChoiceList/examples/basic-choice-list.example.html +7 -0
- package/src/surfaces/customer-account/components/ChoiceList/examples/block-choice-variant.example.html +47 -0
- package/src/surfaces/customer-account/components/ChoiceList/examples/grid-choice-variant.example.html +5 -0
- package/src/surfaces/customer-account/components/ChoiceList/examples/inline-choice-variant.example.html +6 -0
- package/src/surfaces/customer-account/components/ChoiceList/examples/list-choice-variant.example.html +5 -0
- package/src/surfaces/customer-account/components/Clickable/examples/basic-clickable.example.html +3 -0
- package/src/surfaces/customer-account/components/ClickableChip/examples/basic-clickable-chip.example.html +1 -0
- package/src/surfaces/customer-account/components/ClipboardItem/examples/basic-clipboard-item.example.html +2 -0
- package/src/surfaces/customer-account/components/ConsentCheckbox/examples/basic-consent-checkbox.example.html +5 -0
- package/src/surfaces/customer-account/components/ConsentPhoneField/examples/basic-consent-phone-field.example.html +5 -0
- package/src/surfaces/customer-account/components/DateField/examples/basic-date-field.example.html +1 -0
- package/src/surfaces/customer-account/components/DatePicker/examples/basic-date-picker.example.html +1 -0
- package/src/surfaces/customer-account/components/Details/examples/basic-details.example.html +6 -0
- package/src/surfaces/customer-account/components/DropZone/examples/basic-drop-zone.example.html +1 -0
- package/src/surfaces/customer-account/components/EmailField/examples/basic-email-field.example.html +1 -0
- package/src/surfaces/customer-account/components/Form/examples/basic-form.example.html +4 -0
- package/src/surfaces/customer-account/components/Grid/examples/basic-grid.example.html +11 -0
- package/src/surfaces/customer-account/components/Heading/examples/basic-heading.example.html +1 -0
- package/src/surfaces/customer-account/components/Icon/examples/basic-icon.example.html +4 -0
- package/src/surfaces/customer-account/components/Image/examples/basic-image.example.html +1 -0
- package/src/surfaces/customer-account/components/Link/examples/basic-link.example.html +1 -0
- package/src/surfaces/customer-account/components/Map/examples/basic-map.example.html +3 -0
- package/src/surfaces/customer-account/components/Map/examples/map-marker-graphic.example.html +14 -0
- package/src/surfaces/customer-account/components/Map/examples/map-marker-popover.example.html +14 -0
- package/src/surfaces/customer-account/components/Modal/examples/basic-modal.example.html +20 -0
- package/src/surfaces/customer-account/components/MoneyField/examples/basic-money-field.example.html +1 -0
- package/src/surfaces/customer-account/components/NumberField/examples/basic-number-field.example.html +8 -0
- package/src/surfaces/customer-account/components/OrderedList/examples/basic-ordered-list.example.html +5 -0
- package/src/surfaces/customer-account/components/Paragraph/examples/basic-paragraph.example.html +1 -0
- package/src/surfaces/customer-account/components/PasswordField/examples/basic-password-field.example.html +1 -0
- package/src/surfaces/customer-account/components/PaymentIcon/examples/basic-payment-icon.example.html +7 -0
- package/src/surfaces/customer-account/components/PhoneField/examples/basic-phone-field.example.html +2 -0
- package/src/surfaces/customer-account/components/Popover/examples/basic-popover.example.html +7 -0
- package/src/surfaces/customer-account/components/PressButton/examples/basic-press-button.example.html +1 -0
- package/src/surfaces/customer-account/components/ProductThumbnail/examples/basic-product-thumbnail.example.html +4 -0
- package/src/surfaces/customer-account/components/Progress/examples/basic-progress.example.html +1 -0
- package/src/surfaces/customer-account/components/QRCode/examples/basic-qr-code.example.html +4 -0
- package/src/surfaces/{admin/components/QueryContainer/examples/default.jsx → customer-account/components/QueryContainer/examples/basic-query-container.example.html} +3 -3
- package/src/surfaces/customer-account/components/ScrollBox/examples/basic-scroll-box.example.html +5 -0
- package/src/surfaces/customer-account/components/Section.d.ts +2 -2
- package/src/surfaces/customer-account/components/Select/examples/basic-select.example.html +5 -0
- package/src/surfaces/customer-account/components/Sheet/examples/basic-sheet.example.html +5 -0
- package/src/surfaces/customer-account/components/SkeletonParagraph/examples/basic-skeleton-paragraph.example.html +2 -0
- package/src/surfaces/customer-account/components/Spinner/examples/basic-spinner.example.html +1 -0
- package/src/surfaces/customer-account/components/Stack/examples/basic-stack.example.html +22 -0
- package/src/surfaces/customer-account/components/Switch/examples/basic-switch.example.html +1 -0
- package/src/surfaces/customer-account/components/Text/examples/basic-text.example.html +3 -0
- package/src/surfaces/customer-account/components/TextArea/examples/basic-text-area.example.html +5 -0
- package/src/surfaces/customer-account/components/TextField/examples/basic-text-field.example.html +4 -0
- package/src/surfaces/customer-account/components/Time/examples/basic-time.example.html +1 -0
- package/src/surfaces/customer-account/components/Tooltip/examples/basic-tooltip.example.html +9 -0
- package/src/surfaces/customer-account/components/URLField/examples/basic-url-field.example.html +1 -0
- package/src/surfaces/customer-account/components/UnorderedList/examples/basic-unordered-list.example.html +5 -0
- package/src/surfaces/customer-account/preact/metafield.ts +1 -0
- package/src/surfaces/customer-account/preact/metafields.ts +1 -0
- package/src/surfaces/point-of-sale/api/pin-pad-api.ts +1 -1
- package/src/surfaces/point-of-sale/components/Button.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/EmptyState.d.ts +2 -2
- package/src/surfaces/point-of-sale/components/Link.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/Stack.d.ts +10 -10
- package/src/surfaces/point-of-sale/components/Text.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/TextField.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/components-shared.d.ts +55 -55
- package/src/surfaces/point-of-sale/components.d.ts +110 -110
- package/src/surfaces/point-of-sale/event/data/BaseData.ts +6 -2
- package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +23 -2
- package/src/surfaces/admin/components/AdminAction/examples/default.tsx +0 -15
- package/src/surfaces/admin/components/AdminBlock/examples/default.tsx +0 -1
- package/src/surfaces/admin/components/AdminPrintAction/examples/default.tsx +0 -9
- package/src/surfaces/admin/components/Avatar/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/Avatar/examples/color-consistency-demo.jsx +0 -7
- package/src/surfaces/admin/components/Avatar/examples/default-avatar-no-props.jsx +0 -1
- package/src/surfaces/admin/components/Avatar/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Avatar/examples/error-handling-example.jsx +0 -5
- package/src/surfaces/admin/components/Avatar/examples/fulfillment-partner-avatars.jsx +0 -14
- package/src/surfaces/admin/components/Avatar/examples/in-customer-list-context.jsx +0 -24
- package/src/surfaces/admin/components/Avatar/examples/long-initials-handling.jsx +0 -5
- package/src/surfaces/admin/components/Avatar/examples/size-variations.jsx +0 -7
- package/src/surfaces/admin/components/Avatar/examples/staff-member-profiles.jsx +0 -10
- package/src/surfaces/admin/components/Avatar/examples/with-image-source-and-fallback.jsx +0 -6
- package/src/surfaces/admin/components/Avatar/examples/with-section-component.jsx +0 -17
- package/src/surfaces/admin/components/Badge/examples/default.jsx +0 -8
- package/src/surfaces/admin/components/Badge/examples/different-sizes-for-emphasis.jsx +0 -4
- package/src/surfaces/admin/components/Badge/examples/order-status-badges.html +0 -6
- package/src/surfaces/admin/components/Badge/examples/order-status-badges.jsx +0 -6
- package/src/surfaces/admin/components/Badge/examples/status-indicators-with-icons.jsx +0 -21
- package/src/surfaces/admin/components/Badge/examples/within-table-context.jsx +0 -18
- package/src/surfaces/admin/components/Banner/examples/basic-information-banner.html +0 -3
- package/src/surfaces/admin/components/Banner/examples/basic-information-banner.jsx +0 -3
- package/src/surfaces/admin/components/Banner/examples/critical-banner-with-clear-next-steps.jsx +0 -18
- package/src/surfaces/admin/components/Banner/examples/default.jsx +0 -3
- package/src/surfaces/admin/components/Banner/examples/dismissible-success-banner.jsx +0 -3
- package/src/surfaces/admin/components/Banner/examples/info-banner-with-clear-value-proposition.html +0 -14
- package/src/surfaces/admin/components/Banner/examples/info-banner-with-clear-value-proposition.jsx +0 -14
- package/src/surfaces/admin/components/Banner/examples/warning-banner-with-specific-actions.jsx +0 -18
- package/src/surfaces/admin/components/Box/examples/accessible-status-messages.jsx +0 -14
- package/src/surfaces/admin/components/Box/examples/basic-container.html +0 -9
- package/src/surfaces/admin/components/Box/examples/basic-container.jsx +0 -9
- package/src/surfaces/admin/components/Box/examples/complex-merchant-dashboard-layout.jsx +0 -34
- package/src/surfaces/admin/components/Box/examples/default.jsx +0 -7
- package/src/surfaces/admin/components/Box/examples/responsive-shipping-notice.jsx +0 -10
- package/src/surfaces/admin/components/Button/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/Button/examples/bulk-actions.html +0 -4
- package/src/surfaces/admin/components/Button/examples/bulk-actions.jsx +0 -6
- package/src/surfaces/admin/components/Button/examples/component-interactions.jsx +0 -7
- package/src/surfaces/admin/components/Button/examples/default.jsx +0 -4
- package/src/surfaces/admin/components/Button/examples/delete-confirmation.jsx +0 -6
- package/src/surfaces/admin/components/Button/examples/form-states.jsx +0 -6
- package/src/surfaces/admin/components/Button/examples/icon-only-button.jsx +0 -1
- package/src/surfaces/admin/components/Button/examples/link-buttons.jsx +0 -9
- package/src/surfaces/admin/components/Button/examples/loading-state-for-merchant-actions.jsx +0 -11
- package/src/surfaces/admin/components/Button/examples/navigation-to-admin-sections.html +0 -2
- package/src/surfaces/admin/components/Button/examples/navigation-to-admin-sections.jsx +0 -3
- package/src/surfaces/admin/components/Button/examples/product-save-form.html +0 -4
- package/src/surfaces/admin/components/Button/examples/product-save-form.jsx +0 -6
- package/src/surfaces/admin/components/Button/examples/tones.jsx +0 -5
- package/src/surfaces/admin/components/Button/examples/toolbar-icon-buttons.html +0 -17
- package/src/surfaces/admin/components/Button/examples/toolbar-icon-buttons.jsx +0 -17
- package/src/surfaces/admin/components/Button/examples/variants.jsx +0 -6
- package/src/surfaces/admin/components/Button/examples/with-icon.jsx +0 -1
- package/src/surfaces/admin/components/ButtonGroup/examples/basic-usage.html +0 -4
- package/src/surfaces/admin/components/ButtonGroup/examples/basic-usage.jsx +0 -6
- package/src/surfaces/admin/components/ButtonGroup/examples/bulk-actions-in-data-tables.jsx +0 -7
- package/src/surfaces/admin/components/ButtonGroup/examples/destructive-actions-pattern.jsx +0 -6
- package/src/surfaces/admin/components/ButtonGroup/examples/form-action-buttons.html +0 -4
- package/src/surfaces/admin/components/ButtonGroup/examples/form-action-buttons.jsx +0 -6
- package/src/surfaces/admin/components/ButtonGroup/examples/segmented-appearance.jsx +0 -5
- package/src/surfaces/admin/components/ButtonGroup/examples/toolbar-buttons-with-icons.jsx +0 -11
- package/src/surfaces/admin/components/Checkbox/examples/default.jsx +0 -4
- package/src/surfaces/admin/components/Checkbox/examples/disabled-state.jsx +0 -5
- package/src/surfaces/admin/components/Checkbox/examples/error-state.jsx +0 -4
- package/src/surfaces/admin/components/Checkbox/examples/help-text.html +0 -4
- package/src/surfaces/admin/components/Checkbox/examples/help-text.jsx +0 -4
- package/src/surfaces/admin/components/Checkbox/examples/indeterminate-state.jsx +0 -21
- package/src/surfaces/admin/components/Checkbox/examples/settings-group.jsx +0 -12
- package/src/surfaces/admin/components/Checkbox/examples/validation-example.jsx +0 -20
- package/src/surfaces/admin/components/Chip/examples/basic-usage.html +0 -3
- package/src/surfaces/admin/components/Chip/examples/basic-usage.jsx +0 -3
- package/src/surfaces/admin/components/Chip/examples/color-variants.jsx +0 -12
- package/src/surfaces/admin/components/Chip/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Chip/examples/product-status.html +0 -8
- package/src/surfaces/admin/components/Chip/examples/product-status.jsx +0 -12
- package/src/surfaces/admin/components/Chip/examples/text-truncation.jsx +0 -12
- package/src/surfaces/admin/components/Chip/examples/with-icon-graphic.jsx +0 -4
- package/src/surfaces/admin/components/ChoiceList/examples/basic-usage.jsx +0 -7
- package/src/surfaces/admin/components/ChoiceList/examples/default.jsx +0 -16
- package/src/surfaces/admin/components/ChoiceList/examples/multiple-choices-with-details.html +0 -18
- package/src/surfaces/admin/components/ChoiceList/examples/multiple-choices-with-details.jsx +0 -18
- package/src/surfaces/admin/components/ChoiceList/examples/multiple-selections.jsx +0 -15
- package/src/surfaces/admin/components/ChoiceList/examples/validation-example.jsx +0 -20
- package/src/surfaces/admin/components/ChoiceList/examples/with-error-state.jsx +0 -8
- package/src/surfaces/admin/components/Clickable/examples/accessibility-with-aria-attributes.jsx +0 -8
- package/src/surfaces/admin/components/Clickable/examples/basic-button-usage.html +0 -1
- package/src/surfaces/admin/components/Clickable/examples/basic-button-usage.jsx +0 -3
- package/src/surfaces/admin/components/Clickable/examples/default.jsx +0 -12
- package/src/surfaces/admin/components/Clickable/examples/disabled-link-with-aria.jsx +0 -7
- package/src/surfaces/admin/components/Clickable/examples/form-submit-button.jsx +0 -3
- package/src/surfaces/admin/components/Clickable/examples/link-mode.jsx +0 -3
- package/src/surfaces/admin/components/Clickable/examples/section-with-clickable-action.jsx +0 -9
- package/src/surfaces/admin/components/ClickableChip/examples/as-a-link.jsx +0 -8
- package/src/surfaces/admin/components/ClickableChip/examples/basic-usage.jsx +0 -17
- package/src/surfaces/admin/components/ClickableChip/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/ClickableChip/examples/disabled-state.jsx +0 -7
- package/src/surfaces/admin/components/ClickableChip/examples/multiple-chips-with-proper-spacing.html +0 -17
- package/src/surfaces/admin/components/ClickableChip/examples/multiple-chips-with-proper-spacing.jsx +0 -17
- package/src/surfaces/admin/components/ClickableChip/examples/with-icon-and-remove-button.jsx +0 -8
- package/src/surfaces/admin/components/ColorField/examples/basic-usage-required.jsx +0 -3
- package/src/surfaces/admin/components/ColorField/examples/basic-usage-web-component.jsx +0 -3
- package/src/surfaces/admin/components/ColorField/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/ColorField/examples/form-integration.jsx +0 -28
- package/src/surfaces/admin/components/ColorField/examples/read-only-state.jsx +0 -3
- package/src/surfaces/admin/components/ColorField/examples/validation-example.jsx +0 -21
- package/src/surfaces/admin/components/ColorField/examples/with-alpha-transparency.jsx +0 -7
- package/src/surfaces/admin/components/ColorField/examples/with-error-state.jsx +0 -9
- package/src/surfaces/admin/components/ColorField/examples/with-help-text.jsx +0 -7
- package/src/surfaces/admin/components/ColorField/examples/with-placeholder.html +0 -7
- package/src/surfaces/admin/components/ColorField/examples/with-placeholder.jsx +0 -7
- package/src/surfaces/admin/components/ColorPicker/examples/basic-usage.html +0 -3
- package/src/surfaces/admin/components/ColorPicker/examples/basic-usage.jsx +0 -3
- package/src/surfaces/admin/components/ColorPicker/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/ColorPicker/examples/with-alpha-transparency.jsx +0 -7
- package/src/surfaces/admin/components/DateField/examples/basic-usage.jsx +0 -5
- package/src/surfaces/admin/components/DateField/examples/date-fields-with-validation.html +0 -29
- package/src/surfaces/admin/components/DateField/examples/date-fields-with-validation.jsx +0 -29
- package/src/surfaces/admin/components/DateField/examples/date-range-selection.jsx +0 -19
- package/src/surfaces/admin/components/DateField/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/DateField/examples/disabled-and-read-only-states.jsx +0 -15
- package/src/surfaces/admin/components/DateField/examples/form-integration.jsx +0 -27
- package/src/surfaces/admin/components/DateField/examples/validation-example.jsx +0 -20
- package/src/surfaces/admin/components/DateField/examples/with-date-restrictions.jsx +0 -6
- package/src/surfaces/admin/components/DateField/examples/with-default-value.jsx +0 -5
- package/src/surfaces/admin/components/DateField/examples/with-error-state.jsx +0 -5
- package/src/surfaces/admin/components/DateField/examples/with-specific-allowed-dates.jsx +0 -6
- package/src/surfaces/admin/components/DatePicker/examples/analytics-dashboard.jsx +0 -35
- package/src/surfaces/admin/components/DatePicker/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/DatePicker/examples/form-integration.jsx +0 -28
- package/src/surfaces/admin/components/DatePicker/examples/single-date-selection.jsx +0 -6
- package/src/surfaces/admin/components/DatePicker/examples/with-date-restrictions.jsx +0 -7
- package/src/surfaces/admin/components/Divider/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/Divider/examples/custom-color.jsx +0 -1
- package/src/surfaces/admin/components/Divider/examples/custom-direction.jsx +0 -5
- package/src/surfaces/admin/components/Divider/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Divider/examples/organizing-settings-panels.html +0 -9
- package/src/surfaces/admin/components/Divider/examples/organizing-settings-panels.jsx +0 -9
- package/src/surfaces/admin/components/Divider/examples/separating-content-sections.html +0 -13
- package/src/surfaces/admin/components/Divider/examples/separating-content-sections.jsx +0 -13
- package/src/surfaces/admin/components/Divider/examples/separating-form-sections.jsx +0 -7
- package/src/surfaces/admin/components/Divider/examples/visual-breaks-in-section-layouts.html +0 -12
- package/src/surfaces/admin/components/Divider/examples/visual-breaks-in-section-layouts.jsx +0 -12
- package/src/surfaces/admin/components/DropZone/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/DropZone/examples/default.jsx +0 -9
- package/src/surfaces/admin/components/DropZone/examples/disabled-state.jsx +0 -1
- package/src/surfaces/admin/components/DropZone/examples/file-type-restrictions.jsx +0 -5
- package/src/surfaces/admin/components/DropZone/examples/image-upload.jsx +0 -1
- package/src/surfaces/admin/components/DropZone/examples/required-field.jsx +0 -1
- package/src/surfaces/admin/components/DropZone/examples/with-accessibility-options.jsx +0 -6
- package/src/surfaces/admin/components/DropZone/examples/with-error-state.jsx +0 -4
- package/src/surfaces/admin/components/EmailField/examples/basic-usage.html +0 -3
- package/src/surfaces/admin/components/EmailField/examples/basic-usage.jsx +0 -3
- package/src/surfaces/admin/components/EmailField/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/EmailField/examples/optional-field-with-placeholder.html +0 -7
- package/src/surfaces/admin/components/EmailField/examples/optional-field-with-placeholder.jsx +0 -7
- package/src/surfaces/admin/components/EmailField/examples/read-only-display.jsx +0 -7
- package/src/surfaces/admin/components/EmailField/examples/validation-example.jsx +0 -21
- package/src/surfaces/admin/components/EmailField/examples/with-error-and-help-text.jsx +0 -8
- package/src/surfaces/admin/components/EmailField/examples/with-length-constraints.jsx +0 -8
- package/src/surfaces/admin/components/Form/examples/default.jsx +0 -6
- package/src/surfaces/admin/components/FunctionSettings/examples/default.tsx +0 -38
- package/src/surfaces/admin/components/Grid/examples/basic-two-column-layout.jsx +0 -12
- package/src/surfaces/admin/components/Grid/examples/col-span-layouts.jsx +0 -34
- package/src/surfaces/admin/components/Grid/examples/default.jsx +0 -15
- package/src/surfaces/admin/components/Grid/examples/mobile-first-responsive-grid.jsx +0 -53
- package/src/surfaces/admin/components/Heading/examples/basic-heading.html +0 -1
- package/src/surfaces/admin/components/Heading/examples/basic-heading.jsx +0 -1
- package/src/surfaces/admin/components/Heading/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Heading/examples/heading-with-custom-accessibility.jsx +0 -3
- package/src/surfaces/admin/components/Heading/examples/heading-with-line-clamping.jsx +0 -5
- package/src/surfaces/admin/components/Heading/examples/heading-within-section-hierarchy.jsx +0 -12
- package/src/surfaces/admin/components/Icon/examples/basic-usage.jsx +0 -7
- package/src/surfaces/admin/components/Icon/examples/default.jsx +0 -6
- package/src/surfaces/admin/components/Icon/examples/in-badge-components.jsx +0 -8
- package/src/surfaces/admin/components/Icon/examples/in-button-components.jsx +0 -8
- package/src/surfaces/admin/components/Icon/examples/small-size.jsx +0 -1
- package/src/surfaces/admin/components/Icon/examples/subdued-color.jsx +0 -1
- package/src/surfaces/admin/components/Icon/examples/with-id-property.jsx +0 -1
- package/src/surfaces/admin/components/Icon/examples/with-interest-relationship.jsx +0 -6
- package/src/surfaces/admin/components/Icon/examples/with-semantic-tone.jsx +0 -6
- package/src/surfaces/admin/components/Image/examples/auto-sized-image.html +0 -5
- package/src/surfaces/admin/components/Image/examples/auto-sized-image.jsx +0 -5
- package/src/surfaces/admin/components/Image/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/Image/examples/decorative-image.jsx +0 -6
- package/src/surfaces/admin/components/Image/examples/default.jsx +0 -6
- package/src/surfaces/admin/components/Image/examples/responsive-images-with-srcset.jsx +0 -9
- package/src/surfaces/admin/components/Image/examples/responsive-layout-with-aspect-ratio.jsx +0 -7
- package/src/surfaces/admin/components/Image/examples/with-border-styling.jsx +0 -12
- package/src/surfaces/admin/components/Image/examples/within-layout-components.jsx +0 -26
- package/src/surfaces/admin/components/Link/examples/basic-links-in-paragraph.jsx +0 -3
- package/src/surfaces/admin/components/Link/examples/critical-context-links.html +0 -3
- package/src/surfaces/admin/components/Link/examples/critical-context-links.jsx +0 -3
- package/src/surfaces/admin/components/Link/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Link/examples/download-links.jsx +0 -3
- package/src/surfaces/admin/components/Link/examples/external-links.jsx +0 -5
- package/src/surfaces/admin/components/Link/examples/links-in-banner-context.html +0 -5
- package/src/surfaces/admin/components/Link/examples/links-in-banner-context.jsx +0 -5
- package/src/surfaces/admin/components/Link/examples/links-in-banner.jsx +0 -5
- package/src/surfaces/admin/components/Link/examples/links-in-box-container.jsx +0 -5
- package/src/surfaces/admin/components/Link/examples/links-in-subdued-paragraph.html +0 -3
- package/src/surfaces/admin/components/Link/examples/links-in-subdued-paragraph.jsx +0 -3
- package/src/surfaces/admin/components/Link/examples/links-with-auto-tone.html +0 -3
- package/src/surfaces/admin/components/Link/examples/links-with-auto-tone.jsx +0 -3
- package/src/surfaces/admin/components/Link/examples/links-with-different-tones.jsx +0 -25
- package/src/surfaces/admin/components/Link/examples/links-with-language-attribute.jsx +0 -3
- package/src/surfaces/admin/components/Menu/examples/basic-menu.html +0 -7
- package/src/surfaces/admin/components/Menu/examples/basic-menu.jsx +0 -9
- package/src/surfaces/admin/components/Menu/examples/customer-actions-menu.jsx +0 -18
- package/src/surfaces/admin/components/Menu/examples/default.jsx +0 -11
- package/src/surfaces/admin/components/Menu/examples/menu-with-icons.jsx +0 -14
- package/src/surfaces/admin/components/Menu/examples/menu-with-links-and-disabled-items.jsx +0 -13
- package/src/surfaces/admin/components/Menu/examples/menu-with-sections.jsx +0 -15
- package/src/surfaces/admin/components/Menu/examples/settings-menu.jsx +0 -19
- package/src/surfaces/admin/components/Modal/examples/basic-modal.jsx +0 -15
- package/src/surfaces/admin/components/Modal/examples/confirmation-modal-with-actions.jsx +0 -30
- package/src/surfaces/admin/components/Modal/examples/default.jsx +0 -19
- package/src/surfaces/admin/components/Modal/examples/different-modal-sizes.jsx +0 -65
- package/src/surfaces/admin/components/Modal/examples/form-modal.jsx +0 -52
- package/src/surfaces/admin/components/Modal/examples/modal-without-padding.jsx +0 -20
- package/src/surfaces/admin/components/NumberField/examples/basic-usage.jsx +0 -7
- package/src/surfaces/admin/components/NumberField/examples/default.jsx +0 -8
- package/src/surfaces/admin/components/NumberField/examples/multiple-examples.html +0 -29
- package/src/surfaces/admin/components/NumberField/examples/multiple-examples.jsx +0 -29
- package/src/surfaces/admin/components/NumberField/examples/with-prefix-and-suffix.jsx +0 -9
- package/src/surfaces/admin/components/OrderedList/examples/basic-usage.html +0 -5
- package/src/surfaces/admin/components/OrderedList/examples/basic-usage.jsx +0 -5
- package/src/surfaces/admin/components/OrderedList/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/OrderedList/examples/fulfillment-process.html +0 -18
- package/src/surfaces/admin/components/OrderedList/examples/fulfillment-process.jsx +0 -18
- package/src/surfaces/admin/components/OrderedList/examples/order-processing-steps.html +0 -8
- package/src/surfaces/admin/components/OrderedList/examples/order-processing-steps.jsx +0 -8
- package/src/surfaces/admin/components/OrderedList/examples/product-setup-instructions.jsx +0 -13
- package/src/surfaces/admin/components/Page/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/Page/examples/large-inline-size-for-wide-content.jsx +0 -33
- package/src/surfaces/admin/components/Page/examples/page-with-breadcrumbs-and-title.jsx +0 -7
- package/src/surfaces/admin/components/Page/examples/page-with-heading.jsx +0 -5
- package/src/surfaces/admin/components/Page/examples/page-with-secondary-actions.jsx +0 -8
- package/src/surfaces/admin/components/Page/examples/small-inline-size-for-focused-content.jsx +0 -9
- package/src/surfaces/admin/components/Paragraph/examples/admin-ui-patterns.html +0 -21
- package/src/surfaces/admin/components/Paragraph/examples/admin-ui-patterns.jsx +0 -21
- package/src/surfaces/admin/components/Paragraph/examples/basic-usage.html +0 -3
- package/src/surfaces/admin/components/Paragraph/examples/basic-usage.jsx +0 -3
- package/src/surfaces/admin/components/Paragraph/examples/default.jsx +0 -4
- package/src/surfaces/admin/components/Paragraph/examples/line-clamping.jsx +0 -8
- package/src/surfaces/admin/components/Paragraph/examples/rtl-support.jsx +0 -3
- package/src/surfaces/admin/components/Paragraph/examples/screen-reader-text.jsx +0 -3
- package/src/surfaces/admin/components/Paragraph/examples/tabular-numbers.jsx +0 -3
- package/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.jsx +0 -9
- package/src/surfaces/admin/components/Popover/examples/default.jsx +0 -10
- package/src/surfaces/admin/components/Popover/examples/inventory-stock-details.jsx +0 -37
- package/src/surfaces/admin/components/Popover/examples/notifications.jsx +0 -30
- package/src/surfaces/admin/components/Popover/examples/table-display-options.jsx +0 -29
- package/src/surfaces/admin/components/QueryContainer/examples/basic-usage.jsx +0 -17
- package/src/surfaces/admin/components/SearchField/examples/basic-usage.html +0 -5
- package/src/surfaces/admin/components/SearchField/examples/basic-usage.jsx +0 -5
- package/src/surfaces/admin/components/SearchField/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/SearchField/examples/disabled-state.jsx +0 -6
- package/src/surfaces/admin/components/SearchField/examples/with-character-limits.jsx +0 -7
- package/src/surfaces/admin/components/SearchField/examples/with-error-state.jsx +0 -6
- package/src/surfaces/admin/components/Section/examples/default.jsx +0 -3
- package/src/surfaces/admin/components/Section/examples/full-width-content-layout.jsx +0 -18
- package/src/surfaces/admin/components/Section/examples/nested-sections-with-visual-level-differences.jsx +0 -23
- package/src/surfaces/admin/components/Section/examples/section-with-accessibility-label.jsx +0 -13
- package/src/surfaces/admin/components/Section/examples/top-level-section-with-form-elements.jsx +0 -5
- package/src/surfaces/admin/components/Spinner/examples/basic-usage.html +0 -1
- package/src/surfaces/admin/components/Spinner/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/Spinner/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Spinner/examples/inline-loading-with-text.jsx +0 -4
- package/src/surfaces/admin/components/Spinner/examples/loading-state-in-section.jsx +0 -4
- package/src/surfaces/admin/components/Stack/examples/basic-block-stack-vertical.html +0 -5
- package/src/surfaces/admin/components/Stack/examples/basic-block-stack-vertical.jsx +0 -5
- package/src/surfaces/admin/components/Stack/examples/custom-alignment.jsx +0 -5
- package/src/surfaces/admin/components/Stack/examples/custom-spacing.jsx +0 -18
- package/src/surfaces/admin/components/Stack/examples/default.jsx +0 -6
- package/src/surfaces/admin/components/Stack/examples/inline-stack-horizontal.jsx +0 -5
- package/src/surfaces/admin/components/Stack/examples/responsive-stack-with-container-queries.jsx +0 -23
- package/src/surfaces/admin/components/Table/examples/default.jsx +0 -30
- package/src/surfaces/admin/components/Table/examples/full-width-product-inventory-table.html +0 -65
- package/src/surfaces/admin/components/Table/examples/full-width-product-inventory-table.jsx +0 -65
- package/src/surfaces/admin/components/Table/examples/list-variant.jsx +0 -44
- package/src/surfaces/admin/components/Table/examples/with-loading-state.jsx +0 -40
- package/src/surfaces/admin/components/Table/examples/with-pagination.jsx +0 -27
- package/src/surfaces/admin/components/Text/examples/accessibility-hidden-text.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/basic-usage.html +0 -3
- package/src/surfaces/admin/components/Text/examples/basic-usage.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/default.jsx +0 -4
- package/src/surfaces/admin/components/Text/examples/interest-for-association.jsx +0 -8
- package/src/surfaces/admin/components/Text/examples/right-to-left-text.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/semantic-address.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/status-tones.jsx +0 -5
- package/src/surfaces/admin/components/Text/examples/strong-text.html +0 -3
- package/src/surfaces/admin/components/Text/examples/strong-text.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/subdued-color.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/tabular-numbers.jsx +0 -3
- package/src/surfaces/admin/components/TextArea/examples/basic-usage.jsx +0 -5
- package/src/surfaces/admin/components/TextArea/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/TextArea/examples/error-state.jsx +0 -8
- package/src/surfaces/admin/components/TextArea/examples/product-care-instructions.html +0 -7
- package/src/surfaces/admin/components/TextArea/examples/product-care-instructions.jsx +0 -7
- package/src/surfaces/admin/components/TextArea/examples/seo-meta-description-with-character-limit.jsx +0 -8
- package/src/surfaces/admin/components/TextField/examples/basic-usage.html +0 -1
- package/src/surfaces/admin/components/TextField/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/TextField/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/TextField/examples/required-field-with-validation.html +0 -1
- package/src/surfaces/admin/components/TextField/examples/required-field-with-validation.jsx +0 -1
- package/src/surfaces/admin/components/TextField/examples/specific-error-messages-for-merchant-context.jsx +0 -16
- package/src/surfaces/admin/components/TextField/examples/with-accessory.jsx +0 -6
- package/src/surfaces/admin/components/TextField/examples/with-icon.jsx +0 -5
- package/src/surfaces/admin/components/TextField/examples/with-prefix-and-suffix.jsx +0 -11
- package/src/surfaces/admin/components/Thumbnail/examples/basic-usage.html +0 -5
- package/src/surfaces/admin/components/Thumbnail/examples/basic-usage.jsx +0 -5
- package/src/surfaces/admin/components/Thumbnail/examples/default.jsx +0 -4
- package/src/surfaces/admin/components/Thumbnail/examples/different-sizes.jsx +0 -17
- package/src/surfaces/admin/components/Thumbnail/examples/empty-state.jsx +0 -1
- package/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.jsx +0 -13
- package/src/surfaces/admin/components/Tooltip/examples/basic-usage.jsx +0 -6
- package/src/surfaces/admin/components/Tooltip/examples/default.jsx +0 -6
- package/src/surfaces/admin/components/Tooltip/examples/with-icon-button.jsx +0 -8
- package/src/surfaces/admin/components/UnorderedList/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/UnorderedList/examples/store-setup-checklist.jsx +0 -24
- /package/src/surfaces/admin/components/Button/examples/{basic-usage.html → basic-button.html} +0 -0
- /package/src/surfaces/{admin/components/Divider/examples/basic-usage.html → customer-account/components/Divider/examples/basic-divider.example.html} +0 -0
package/package.json
CHANGED
|
@@ -32,6 +32,13 @@ interface ComponentDoc {
|
|
|
32
32
|
extraExamples?: ReferenceEntityTemplateSchema['examples'];
|
|
33
33
|
}
|
|
34
34
|
|
|
35
|
+
function toPascalCase(name: string) {
|
|
36
|
+
return name
|
|
37
|
+
.split(' ')
|
|
38
|
+
.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
|
|
39
|
+
.join('');
|
|
40
|
+
}
|
|
41
|
+
|
|
35
42
|
function buildDefinitions({
|
|
36
43
|
name,
|
|
37
44
|
description,
|
|
@@ -41,13 +48,15 @@ function buildDefinitions({
|
|
|
41
48
|
description?: string;
|
|
42
49
|
definitions: DefinitionsConfiguration;
|
|
43
50
|
}) {
|
|
51
|
+
const typeName = toPascalCase(name);
|
|
52
|
+
|
|
44
53
|
return [
|
|
45
54
|
...(description
|
|
46
55
|
? [
|
|
47
56
|
{
|
|
48
57
|
title: `${name}`,
|
|
49
58
|
description,
|
|
50
|
-
type: `${
|
|
59
|
+
type: `${typeName}ElementProps`,
|
|
51
60
|
},
|
|
52
61
|
]
|
|
53
62
|
: []),
|
|
@@ -57,7 +66,7 @@ function buildDefinitions({
|
|
|
57
66
|
{
|
|
58
67
|
title: 'Properties',
|
|
59
68
|
description: '',
|
|
60
|
-
type: `${
|
|
69
|
+
type: `${typeName}ElementProps`,
|
|
61
70
|
},
|
|
62
71
|
]
|
|
63
72
|
: []),
|
|
@@ -67,7 +76,7 @@ function buildDefinitions({
|
|
|
67
76
|
{
|
|
68
77
|
title: 'Events',
|
|
69
78
|
description: `Learn more about [registering events](${CHECKOUT_PATH}#event-handling).`,
|
|
70
|
-
type: `${
|
|
79
|
+
type: `${typeName}ElementEvents`,
|
|
71
80
|
},
|
|
72
81
|
]
|
|
73
82
|
: []),
|
|
@@ -77,7 +86,7 @@ function buildDefinitions({
|
|
|
77
86
|
{
|
|
78
87
|
title: 'Slots',
|
|
79
88
|
description: `Learn more about [component slots](${CHECKOUT_PATH}#slots).`,
|
|
80
|
-
type: `${
|
|
89
|
+
type: `${typeName}ElementSlots`,
|
|
81
90
|
},
|
|
82
91
|
]
|
|
83
92
|
: []),
|
|
@@ -87,7 +96,7 @@ function buildDefinitions({
|
|
|
87
96
|
{
|
|
88
97
|
title: 'Methods',
|
|
89
98
|
description: `Learn more about [component methods](${CHECKOUT_PATH}#methods).`,
|
|
90
|
-
type: `${
|
|
99
|
+
type: `${typeName}ElementMethods`,
|
|
91
100
|
},
|
|
92
101
|
]
|
|
93
102
|
: []),
|
|
@@ -114,6 +123,7 @@ export function createComponentDoc({
|
|
|
114
123
|
const kebabCasedName = name
|
|
115
124
|
.replace(/([A-Z]+)([A-Z][a-z])/g, '$1-$2')
|
|
116
125
|
.replace(/([a-z])([A-Z])/g, '$1-$2')
|
|
126
|
+
.replace(/\s+/g, '-')
|
|
117
127
|
.toLowerCase();
|
|
118
128
|
|
|
119
129
|
return {
|
|
@@ -4,8 +4,8 @@ const data: SharedReferenceEntityTemplateSchema = {
|
|
|
4
4
|
name: 'Abbreviation',
|
|
5
5
|
description:
|
|
6
6
|
'Displays abbreviated text or acronyms, revealing their full meaning or additional context through a tooltip on hover or focus. Use to clarify shortened terms, initialisms, or technical language without interrupting the reading flow.',
|
|
7
|
-
category: '
|
|
8
|
-
subCategory: '
|
|
7
|
+
category: 'Web components',
|
|
8
|
+
subCategory: 'Typography and content',
|
|
9
9
|
related: [],
|
|
10
10
|
};
|
|
11
11
|
|
|
@@ -4,8 +4,8 @@ const data: SharedReferenceEntityTemplateSchema = {
|
|
|
4
4
|
name: 'Announcement',
|
|
5
5
|
description:
|
|
6
6
|
'The Announcement component provides a less disruptive alternative to auto-open modals for capturing user attention. It provides a standardized way to engage users without being too intrusive.',
|
|
7
|
-
category: '
|
|
8
|
-
subCategory: 'Feedback',
|
|
7
|
+
category: 'Web components',
|
|
8
|
+
subCategory: 'Feedback and status indicators',
|
|
9
9
|
related: [],
|
|
10
10
|
};
|
|
11
11
|
|
|
@@ -3,8 +3,9 @@ import {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Avatar',
|
|
5
5
|
description:
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
"The avatar component displays profile images or initials for users, customers, and businesses in a compact visual format. Use avatar to represent people or entities throughout the interface, with automatic fallback to initials when images aren't available." +
|
|
7
|
+
'\n\nAvatars support multiple sizes for different contexts and provide consistent color assignment for initials based on the name provided. For product or content preview images, use [thumbnail](/docs/api/{API_NAME}/{API_VERSION}/web-components/media-and-visuals/thumbnail). For full-size images, use [image](/docs/api/{API_NAME}/{API_VERSION}/web-components/media-and-visuals/image).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Media and visuals',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Badge',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The badge component displays status information or indicates completed actions through compact visual indicators. Use badge to communicate object states, order statuses, or system-generated classifications that help users quickly understand item conditions.' +
|
|
7
|
+
'\n\nBadges support multiple tones and sizes, with optional icons to reinforce status meaning and improve scannability in lists and tables. For user-created labels, categories, or tags, use [chip](/docs/api/{API_NAME}/{API_VERSION}/web-components/typography-and-content/chip) instead.',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Feedback and status indicators',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Banner',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The banner component highlights important information or required actions prominently within the interface. Use banner to communicate statuses, provide feedback, draw attention to critical updates, or guide users toward necessary actions.' +
|
|
7
|
+
'\n\nBanners support multiple tones to convey urgency levels, optional actions for next steps, and can be positioned contextually within sections or page-wide at the top. For inline status indicators on individual items, use [badge](/docs/api/{API_NAME}/{API_VERSION}/web-components/feedback-and-status-indicators/badge).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Feedback and status indicators',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Box',
|
|
5
5
|
description:
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
"The box component provides a generic, flexible container for custom designs and layouts. Use box to apply styling like backgrounds, padding, borders, or border radius when existing components don't meet your needs, or to nest and group other components." +
|
|
7
|
+
'\n\nBox contents maintain their natural size, making it especially useful within layout components that would otherwise stretch their children. For structured layouts, use [stack](/docs/api/{API_NAME}/{API_VERSION}/web-components/layout-and-structure/stack) or [grid](/docs/api/{API_NAME}/{API_VERSION}/web-components/layout-and-structure/grid).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Layout and structure',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Button',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The button component triggers actions or events, such as submitting forms, opening dialogs, or navigating to other pages. Use buttons to let users perform specific tasks or initiate interactions throughout the interface.' +
|
|
7
|
+
'\n\nButtons support various visual styles, tones, and interaction patterns to communicate intent and hierarchy. They can also function as links, guiding users to internal or external destinations. For navigation-focused interactions within text, use [link](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/link). For grouping multiple related buttons, use [button group](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button-group).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Actions',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
5
|
-
description:
|
|
6
|
-
|
|
4
|
+
name: 'Button group',
|
|
5
|
+
description:
|
|
6
|
+
'The button group component displays multiple related buttons in a structured layout. Use button group to organize action buttons together, creating clear visual hierarchies and helping users understand available options.' +
|
|
7
|
+
'\n\nButton groups support various layouts including segmented appearances for tightly related options like view switching or filter controls. For individual actions, use [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button).',
|
|
8
|
+
category: 'Web components',
|
|
7
9
|
subCategory: 'Actions',
|
|
8
10
|
related: [],
|
|
9
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Checkbox',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The checkbox component provides a clear way for users to make selections, such as agreeing to terms, enabling settings, or choosing multiple items from a list. Use checkbox to create binary on/off controls or multi-select interfaces where users can select any combination of options.' +
|
|
7
|
+
'\n\nCheckboxes support labels, help text, error states, and an indeterminate state for "select all" functionality when working with grouped selections. For settings that take effect immediately, use [switch](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/switch) instead.',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Forms',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Chip',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The chip component displays static labels, categories, or attributes that help classify and organize content. Use chip to show product tags, categories, or metadata near the items they describe, helping users identify items with similar properties.' +
|
|
7
|
+
'\n\nChips support multiple visual variants for different levels of emphasis and can include icons to provide additional visual context. For system-generated status indicators, use [badge](/docs/api/{API_NAME}/{API_VERSION}/web-components/feedback-and-status-indicators/badge). For interactive or removable chips, use [clickable chip](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/clickable-chip).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Typography and content',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Choice',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The choice component creates individual selectable options within a choice list. Use choice to define each option that merchants can select, supporting both single selection (radio buttons) and multiple selection (checkboxes) modes.' +
|
|
7
|
+
'\n\nChoice components support labels, help text, and custom content through slots, providing flexible option presentation within choice lists.',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Forms',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
4
|
+
name: 'Choice list',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The choice list component presents multiple options for single or multiple selections. Use it when merchants need to choose from a defined set of options, such as filtering results or collecting preferences.' +
|
|
7
|
+
'\n\nThe component supports both single selection (radio button behavior) and multiple selection (checkbox behavior) modes. It includes configurable labels, help text, and validation. For compact dropdown selection with four or more options, use [select](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/select).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Forms',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Clickable',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The clickable component wraps content to make it interactive and clickable. Use it when you need more styling control than [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) or [link](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/link) provide, such as custom backgrounds, padding, or borders around your clickable content.' +
|
|
7
|
+
'\n\nClickable supports button, link, and submit modes with built-in accessibility properties for keyboard navigation and screen reader support.',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Actions',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
4
|
+
name: 'Clickable chip',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The clickable chip component displays interactive labels or categories that users can click or remove. Use clickable chip to show filter tags, selected options, or merchant-created labels that users need to interact with or dismiss.' +
|
|
7
|
+
'\n\nClickable chips support multiple visual variants, optional icons, and can function as both clickable buttons and removable tags for flexible interaction patterns. For non-interactive labels, use [chip](/docs/api/{API_NAME}/{API_VERSION}/web-components/typography-and-content/chip).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Actions',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
4
|
+
name: 'Clipboard item',
|
|
5
5
|
description:
|
|
6
6
|
'Enables copying text to the user’s clipboard. Use alongside Button or Link components to let users easily copy content. `<s-clipboard-item>` doesn’t render visually.',
|
|
7
|
-
category: '
|
|
8
|
-
subCategory: '
|
|
7
|
+
category: 'Web components',
|
|
8
|
+
subCategory: 'Actions',
|
|
9
9
|
related: [],
|
|
10
10
|
};
|
|
11
11
|
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
4
|
+
name: 'Color field',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The color field component allows users to select colors through an integrated color picker or direct text input. Use color field for theme colors, brand colors, or any color selection to provide both visual and text-based color input methods.' +
|
|
7
|
+
'\n\nColor fields support hex color codes, color preview swatches, and validation to ensure users select or enter valid color values. For a standalone visual color palette interface without text input, use [color picker](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/color-picker).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Forms',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
5
|
-
description:
|
|
6
|
-
|
|
4
|
+
name: 'Color picker',
|
|
5
|
+
description:
|
|
6
|
+
'The color picker component allows users to select colors from a visual color palette interface. Use color picker to provide an intuitive, visual way for users to choose colors for themes, branding, or design customization.' +
|
|
7
|
+
'\n\nColor pickers support multiple color formats, predefined color swatches, and interactive selection to make color choice easy and accurate. For combined visual and text-based color input with validation, use [color field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/color-field).',
|
|
8
|
+
category: 'Web components',
|
|
7
9
|
subCategory: 'Forms',
|
|
8
10
|
related: [],
|
|
9
11
|
};
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
4
|
+
name: 'Consent checkbox',
|
|
5
5
|
description:
|
|
6
6
|
'Use buyer consent checkboxes for collecting the buyer’s approval for a given policy.',
|
|
7
|
-
category: '
|
|
7
|
+
category: 'Web components',
|
|
8
8
|
subCategory: 'Forms',
|
|
9
9
|
related: [],
|
|
10
10
|
};
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
4
|
+
name: 'Consent phone field',
|
|
5
5
|
description:
|
|
6
6
|
'Display a phone field for customers to sign up for text message marketing, noting that the phone field value will be automatically saved during checkout.',
|
|
7
|
-
category: '
|
|
7
|
+
category: 'Web components',
|
|
8
8
|
subCategory: 'Forms',
|
|
9
9
|
related: [],
|
|
10
10
|
};
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
5
|
-
description:
|
|
6
|
-
|
|
4
|
+
name: 'Date field',
|
|
5
|
+
description:
|
|
6
|
+
'The date field component captures date input with a consistent interface for date selection and proper validation. Use it to collect date information in forms, scheduling interfaces, or data entry workflows.' +
|
|
7
|
+
'\n\nThe component supports manual text entry. For visual calendar-based selection, consider using [date picker](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/date-picker).',
|
|
8
|
+
category: 'Web components',
|
|
7
9
|
subCategory: 'Forms',
|
|
8
10
|
related: [],
|
|
9
11
|
};
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
5
|
-
description:
|
|
6
|
-
|
|
4
|
+
name: 'Date picker',
|
|
5
|
+
description:
|
|
6
|
+
'The date picker component allows merchants to select dates using a calendar interface. Use it when merchants benefit from seeing dates in context of the full month, such as selecting dates relative to today or needing weekday context.' +
|
|
7
|
+
'\n\nThe component supports single dates, multiple dates, and date ranges. For text date entry, use [date field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/date-field).',
|
|
8
|
+
category: 'Web components',
|
|
7
9
|
subCategory: 'Forms',
|
|
8
10
|
related: [],
|
|
9
11
|
};
|
|
@@ -4,8 +4,8 @@ const data: SharedReferenceEntityTemplateSchema = {
|
|
|
4
4
|
name: 'Details',
|
|
5
5
|
description:
|
|
6
6
|
'Creates a collapsible content area that can be expanded or collapsed by users. Use with Summary to provide expandable sections for additional information or settings.',
|
|
7
|
-
category: '
|
|
8
|
-
subCategory: '
|
|
7
|
+
category: 'Web components',
|
|
8
|
+
subCategory: 'Typography and content',
|
|
9
9
|
related: [],
|
|
10
10
|
};
|
|
11
11
|
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Divider',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The divider component creates clear visual separation between elements in the interface. Use divider to separate distinct content groups in forms, settings panels, lists, or page sections, helping users scan and understand content organization.' +
|
|
7
|
+
'\n\nDividers support both horizontal and vertical orientations, along with different visual strengths for varying levels of emphasis. For more structured content grouping with headings, use [section](/docs/api/{API_NAME}/{API_VERSION}/web-components/layout-and-structure/section).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Layout and structure',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
4
|
+
name: 'Drop zone',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
category: '
|
|
6
|
+
'The drop zone component lets users upload files through drag-and-drop or by clicking to browse. Use for file uploads such as images, documents, or CSV imports.\n\nThe component provides visual feedback during drag operations and supports file type validation through the `accept` property. Rejected files trigger the `droprejected` event for custom error handling.',
|
|
7
|
+
category: 'Web components',
|
|
8
8
|
subCategory: 'Forms',
|
|
9
9
|
related: [],
|
|
10
10
|
};
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
4
|
+
name: 'Email field',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The email field component captures email address input. Use it to collect email information in forms, customer profiles, or contact workflows.' +
|
|
7
|
+
"\n\nEmail field doesn't perform automatic email validation. Implement your own validation logic, and use the `error` property to display validation results. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/text-field).",
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Forms',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Form',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The form component wraps form controls and enables implicit submission, allowing users to submit from any input by pressing **Enter**. Use form to group related input fields and handle form submission through JavaScript event handlers.' +
|
|
7
|
+
"\n\nUnlike HTML forms, form doesn't automatically submit data using HTTP—you must register a `submit` event to process form data programmatically. For Shopify Functions configuration forms, use [function settings](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/function-settings).",
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Forms',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -1,28 +1,13 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
4
|
+
name: 'Function settings',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The function settings component configures metafield settings for [Shopify Functions](/docs/api/functions). Use function settings to create configuration interfaces that allow merchants to customize function behavior through structured input fields and controls.' +
|
|
7
|
+
'\n\nThis component provides a standardized layout for settings forms and integrates with the native save bar to handle form submission and reset actions automatically. For general form submission, use [form](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/form).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Forms',
|
|
9
|
-
related: [
|
|
10
|
-
{
|
|
11
|
-
type: 'component',
|
|
12
|
-
name: 'TextField',
|
|
13
|
-
url: '/docs/api/admin-extensions/components/forms/textfield',
|
|
14
|
-
},
|
|
15
|
-
{
|
|
16
|
-
type: 'component',
|
|
17
|
-
name: 'NumberField',
|
|
18
|
-
url: '/docs/api/admin-extensions/components/forms/numberfield',
|
|
19
|
-
},
|
|
20
|
-
{
|
|
21
|
-
type: 'component',
|
|
22
|
-
name: 'ChoiceList',
|
|
23
|
-
url: '/docs/api/admin-extensions/components/forms/choicelist',
|
|
24
|
-
},
|
|
25
|
-
],
|
|
10
|
+
related: [],
|
|
26
11
|
};
|
|
27
12
|
|
|
28
13
|
export default data;
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Grid',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The grid component organizes content in a matrix of rows and columns to create responsive page layouts. Use grid to build complex, multi-column layouts that adapt to different screen sizes and maintain consistent alignment.' +
|
|
7
|
+
'\n\nGrid follows the CSS grid layout pattern and supports flexible column configurations, gap spacing, and alignment properties for precise layout control. For simpler linear layouts (horizontal or vertical), use [stack](/docs/api/{API_NAME}/{API_VERSION}/web-components/layout-and-structure/stack).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Layout and structure',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
2
2
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
|
-
name: '
|
|
5
|
-
description:
|
|
6
|
-
|
|
7
|
-
|
|
4
|
+
name: 'Grid item',
|
|
5
|
+
description:
|
|
6
|
+
'The grid item component represents a single cell within a grid layout, allowing you to control how content is positioned and sized within the grid. Use grid item as a child of grid to specify column span, row span, and positioning for individual content areas.' +
|
|
7
|
+
'\n\nGrid item supports precise placement control through column and row properties, enabling you to create complex layouts where different items occupy varying amounts of space or appear in specific grid positions.',
|
|
8
|
+
category: 'Web components',
|
|
9
|
+
subCategory: 'Layout and structure',
|
|
8
10
|
related: [],
|
|
9
11
|
};
|
|
10
12
|
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Heading',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The heading component renders hierarchical titles to communicate the structure and organization of page content. Use heading to create section titles and content headers that help users understand information hierarchy and navigate content.' +
|
|
7
|
+
'\n\nHeading levels adjust automatically based on nesting within parent [section](/docs/api/{API_NAME}/{API_VERSION}/web-components/layout-and-structure/section) components, ensuring meaningful and accessible page outlines without manual level management.',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Typography and content',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Icon',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The icon component renders graphic symbols to visually communicate actions, status, and navigation throughout the interface. Use icon to reinforce button actions, indicate status states, or provide wayfinding cues that help users understand available functionality.' +
|
|
7
|
+
'\n\nIcons support multiple sizes, tones for semantic meaning, and can be integrated with other components like [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button), [badge](/docs/api/{API_NAME}/{API_VERSION}/web-components/feedback-and-status-indicators/badge), and [chip](/docs/api/{API_NAME}/{API_VERSION}/web-components/typography-and-content/chip) to enhance visual communication.',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Media and visuals',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Image',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The image component embeds images within the interface with control over presentation and loading behavior. Use image to visually illustrate concepts, showcase products, display user content, or support tasks and interactions with visual context.' +
|
|
7
|
+
'\n\nImages support responsive sizing, alt text for accessibility, aspect ratio control, and loading states for progressive enhancement. For small preview images in lists or tables, use [thumbnail](/docs/api/{API_NAME}/{API_VERSION}/web-components/media-and-visuals/thumbnail). For profile images, use [avatar](/docs/api/{API_NAME}/{API_VERSION}/web-components/media-and-visuals/avatar).',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Media and visuals',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|
|
@@ -3,8 +3,9 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
|
|
|
3
3
|
const data: SharedReferenceEntityTemplateSchema = {
|
|
4
4
|
name: 'Link',
|
|
5
5
|
description:
|
|
6
|
-
'
|
|
7
|
-
|
|
6
|
+
'The link component makes text interactive, allowing users to navigate to other pages or perform specific actions. Use link for navigation, external references, or triggering actions while maintaining standard link semantics and accessibility.' +
|
|
7
|
+
'\n\nLinks support standard URLs, custom protocols, navigation within Shopify admin pages, and can open in new windows for external destinations. For prominent actions or form submissions, use [button](/docs/api/{API_NAME}/{API_VERSION}/web-components/actions/button) instead.',
|
|
8
|
+
category: 'Web components',
|
|
8
9
|
subCategory: 'Actions',
|
|
9
10
|
related: [],
|
|
10
11
|
};
|