@shopify/ui-extensions 2025.10.0-rc.9 → 2025.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/surfaces/checkout/preact/api.js +5 -1
- package/build/cjs/surfaces/checkout/preact/attributes.js +1 -1
- package/build/cjs/surfaces/checkout/preact/subscription.js +6 -5
- package/build/cjs/surfaces/checkout/shared.js +35 -0
- package/build/cjs/surfaces/checkout.js +2 -0
- package/build/cjs/surfaces/customer-account/preact/live-navigation.js +0 -2
- package/build/cjs/surfaces/customer-account/preact/navigation.js +1 -3
- package/build/cjs/surfaces/customer-account/preact/subscription.js +3 -3
- package/build/cjs/surfaces/point-of-sale/types/storage.js +13 -0
- package/build/cjs/surfaces/point-of-sale.js +9 -0
- package/build/esm/surfaces/checkout/preact/api.mjs +5 -1
- package/build/esm/surfaces/checkout/preact/attributes.mjs +1 -1
- package/build/esm/surfaces/checkout/preact/subscription.mjs +6 -5
- package/build/esm/surfaces/checkout/shared.mjs +31 -0
- package/build/esm/surfaces/checkout.mjs +1 -0
- package/build/esm/surfaces/customer-account/preact/live-navigation.mjs +0 -2
- package/build/esm/surfaces/customer-account/preact/navigation.mjs +1 -3
- package/build/esm/surfaces/customer-account/preact/subscription.mjs +3 -3
- package/build/esm/surfaces/point-of-sale/types/storage.mjs +9 -0
- package/build/esm/surfaces/point-of-sale.mjs +1 -0
- package/build/esnext/surfaces/checkout/preact/api.esnext +5 -1
- package/build/esnext/surfaces/checkout/preact/attributes.esnext +1 -1
- package/build/esnext/surfaces/checkout/preact/subscription.esnext +6 -5
- package/build/esnext/surfaces/checkout/shared.esnext +31 -0
- package/build/esnext/surfaces/checkout.esnext +1 -0
- package/build/esnext/surfaces/customer-account/preact/live-navigation.esnext +0 -2
- package/build/esnext/surfaces/customer-account/preact/navigation.esnext +1 -3
- package/build/esnext/surfaces/customer-account/preact/subscription.esnext +3 -3
- package/build/esnext/surfaces/point-of-sale/types/storage.esnext +9 -0
- package/build/esnext/surfaces/point-of-sale.esnext +1 -0
- package/build/ts/docs/shared/components/Announcement.d.ts +4 -0
- package/build/ts/docs/shared/components/Announcement.d.ts.map +1 -0
- package/build/ts/docs/shared/components/Avatar.d.ts +4 -0
- package/build/ts/docs/shared/components/Avatar.d.ts.map +1 -0
- package/build/ts/docs/shared/components/Badge.d.ts +1 -1
- package/build/ts/docs/shared/components/Badge.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Banner.d.ts +1 -1
- package/build/ts/docs/shared/components/Banner.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ButtonGroup.d.ts +4 -0
- package/build/ts/docs/shared/components/ButtonGroup.d.ts.map +1 -0
- package/build/ts/docs/shared/components/Checkbox.d.ts +1 -1
- package/build/ts/docs/shared/components/Checkbox.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Chip.d.ts +4 -0
- package/build/ts/docs/shared/components/Chip.d.ts.map +1 -0
- package/build/ts/docs/shared/components/Choice.d.ts +1 -1
- package/build/ts/docs/shared/components/Choice.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ChoiceList.d.ts +1 -1
- package/build/ts/docs/shared/components/ChoiceList.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Clickable.d.ts +1 -1
- package/build/ts/docs/shared/components/Clickable.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ClickableChip.d.ts +4 -0
- package/build/ts/docs/shared/components/ClickableChip.d.ts.map +1 -0
- package/build/ts/docs/shared/components/ColorField.d.ts +4 -0
- package/build/ts/docs/shared/components/ColorField.d.ts.map +1 -0
- package/build/ts/docs/shared/components/ColorPicker.d.ts +4 -0
- package/build/ts/docs/shared/components/ColorPicker.d.ts.map +1 -0
- package/build/ts/docs/shared/components/ConsentCheckbox.d.ts +4 -0
- package/build/ts/docs/shared/components/ConsentCheckbox.d.ts.map +1 -0
- package/build/ts/docs/shared/components/ConsentPhoneField.d.ts +4 -0
- package/build/ts/docs/shared/components/ConsentPhoneField.d.ts.map +1 -0
- package/build/ts/docs/shared/components/DateField.d.ts +4 -0
- package/build/ts/docs/shared/components/DateField.d.ts.map +1 -0
- package/build/ts/docs/shared/components/DatePicker.d.ts +1 -1
- package/build/ts/docs/shared/components/DatePicker.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Details.d.ts +4 -0
- package/build/ts/docs/shared/components/Details.d.ts.map +1 -0
- package/build/ts/docs/shared/components/Divider.d.ts +1 -1
- package/build/ts/docs/shared/components/Divider.d.ts.map +1 -1
- package/build/ts/docs/shared/components/EmailField.d.ts +1 -1
- package/build/ts/docs/shared/components/EmailField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/FunctionSettings.d.ts +4 -0
- package/build/ts/docs/shared/components/FunctionSettings.d.ts.map +1 -0
- package/build/ts/docs/shared/components/Grid.d.ts +1 -1
- package/build/ts/docs/shared/components/Grid.d.ts.map +1 -1
- package/build/ts/docs/shared/components/GridItem.d.ts +1 -1
- package/build/ts/docs/shared/components/GridItem.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Menu.d.ts +4 -0
- package/build/ts/docs/shared/components/Menu.d.ts.map +1 -0
- package/build/ts/docs/shared/components/MoneyField.d.ts +1 -1
- package/build/ts/docs/shared/components/MoneyField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/NumberField.d.ts +1 -1
- package/build/ts/docs/shared/components/NumberField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/OptionGroup.d.ts +4 -0
- package/build/ts/docs/shared/components/OptionGroup.d.ts.map +1 -0
- package/build/ts/docs/shared/components/PasswordField.d.ts +1 -1
- package/build/ts/docs/shared/components/PasswordField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Popover.d.ts +4 -0
- package/build/ts/docs/shared/components/Popover.d.ts.map +1 -0
- package/build/ts/docs/shared/components/PressButton.d.ts +4 -0
- package/build/ts/docs/shared/components/PressButton.d.ts.map +1 -0
- package/build/ts/docs/shared/components/ScrollBox.d.ts +4 -0
- package/build/ts/docs/shared/components/ScrollBox.d.ts.map +1 -0
- package/build/ts/docs/shared/components/SearchField.d.ts +1 -1
- package/build/ts/docs/shared/components/SearchField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Section.d.ts +1 -1
- package/build/ts/docs/shared/components/Section.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Select.d.ts +1 -1
- package/build/ts/docs/shared/components/Select.d.ts.map +1 -1
- package/build/ts/docs/shared/components/SkeletonParagraph.d.ts +4 -0
- package/build/ts/docs/shared/components/SkeletonParagraph.d.ts.map +1 -0
- package/build/ts/docs/shared/components/Summary.d.ts +4 -0
- package/build/ts/docs/shared/components/Summary.d.ts.map +1 -0
- package/build/ts/docs/shared/components/Switch.d.ts +1 -1
- package/build/ts/docs/shared/components/Switch.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Table.d.ts +1 -1
- package/build/ts/docs/shared/components/Table.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableBody.d.ts +1 -1
- package/build/ts/docs/shared/components/TableBody.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableCell.d.ts +1 -1
- package/build/ts/docs/shared/components/TableCell.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableHeader.d.ts +1 -1
- package/build/ts/docs/shared/components/TableHeader.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableHeaderRow.d.ts +1 -1
- package/build/ts/docs/shared/components/TableHeaderRow.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableRow.d.ts +1 -1
- package/build/ts/docs/shared/components/TableRow.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TextArea.d.ts +1 -1
- package/build/ts/docs/shared/components/TextArea.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Thumbnail.d.ts +4 -0
- package/build/ts/docs/shared/components/Thumbnail.d.ts.map +1 -0
- package/build/ts/docs/shared/components/Tooltip.d.ts +4 -0
- package/build/ts/docs/shared/components/Tooltip.d.ts.map +1 -0
- package/build/ts/docs/shared/components/URLField.d.ts +1 -1
- package/build/ts/docs/shared/components/URLField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/index.d.ts +12 -0
- package/build/ts/docs/shared/components/index.d.ts.map +1 -1
- package/build/ts/docs/shared/docs-type.d.ts +3 -2
- package/build/ts/docs/shared/docs-type.d.ts.map +1 -1
- package/build/ts/shared.d.ts +14 -1
- package/build/ts/shared.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts +30 -0
- package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/intents/intents.d.ts +132 -0
- package/build/ts/surfaces/admin/api/intents/intents.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/intents/intents.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/api/intents/intents.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/standard/standard.d.ts +8 -8
- package/build/ts/surfaces/admin/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/standard/storage.d.ts +70 -0
- package/build/ts/surfaces/admin/api/standard/storage.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api.d.ts +1 -1
- package/build/ts/surfaces/admin/api.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminAction.d.ts +5 -5
- package/build/ts/surfaces/admin/components/AdminBlock/AdminBlock.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminBlock.d.ts +3 -3
- package/build/ts/surfaces/admin/components/AdminPrintAction.d.ts +3 -3
- package/build/ts/surfaces/admin/components/Avatar/Avatar.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/Avatar/Avatar.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/Avatar.d.ts +9 -20
- package/build/ts/surfaces/admin/components/Badge/Badge.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Badge.d.ts +8 -5
- package/build/ts/surfaces/admin/components/Banner.d.ts +22 -28
- package/build/ts/surfaces/admin/components/Box/Box.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Box.d.ts +76 -24
- package/build/ts/surfaces/admin/components/Button/Button.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Button.d.ts +41 -36
- package/build/ts/surfaces/admin/components/ButtonGroup/ButtonGroup.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/ButtonGroup/ButtonGroup.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/ButtonGroup.d.ts +132 -0
- package/build/ts/surfaces/admin/components/Checkbox.d.ts +23 -34
- package/build/ts/surfaces/admin/components/Chip/Chip.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/Chip/Chip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/Chip.d.ts +121 -0
- package/build/ts/surfaces/admin/components/Choice.d.ts +10 -9
- package/build/ts/surfaces/admin/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ChoiceList.d.ts +22 -28
- package/build/ts/surfaces/admin/components/Clickable/Clickable.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Clickable.d.ts +109 -56
- package/build/ts/surfaces/admin/components/ClickableChip/ClickableChip.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/ClickableChip/ClickableChip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/ClickableChip.d.ts +152 -0
- package/build/ts/surfaces/admin/components/ColorField/ColorField.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/ColorField/ColorField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/ColorField.d.ts +240 -0
- package/build/ts/surfaces/admin/components/ColorPicker/ColorPicker.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/ColorPicker/ColorPicker.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/ColorPicker.d.ts +128 -0
- package/build/ts/surfaces/admin/components/DateField/DateField.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/DateField/DateField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/DateField.d.ts +242 -0
- package/build/ts/surfaces/admin/components/DatePicker.d.ts +10 -33
- package/build/ts/surfaces/admin/components/Divider.d.ts +3 -3
- package/build/ts/surfaces/admin/components/DropZone/DropZone.ab.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/DropZone/DropZone.ab.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/EmailField.d.ts +27 -33
- package/build/ts/surfaces/admin/components/Form/Form.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Form.d.ts +48 -36
- package/build/ts/surfaces/admin/components/FormExtensionComponents.d.ts +4 -0
- package/build/ts/surfaces/admin/components/FormExtensionComponents.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/FunctionSettings/FunctionSettings.ext.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/FunctionSettings/FunctionSettings.ext.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/FunctionSettings.d.ts +183 -0
- package/build/ts/surfaces/admin/components/FunctionSettingsComponents.d.ts +4 -0
- package/build/ts/surfaces/admin/components/FunctionSettingsComponents.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/Grid/Grid.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Grid.d.ts +148 -34
- package/build/ts/surfaces/admin/components/GridItem.d.ts +76 -24
- package/build/ts/surfaces/admin/components/Heading/Heading.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Heading.d.ts +3 -3
- package/build/ts/surfaces/admin/components/Icon.d.ts +8 -4
- package/build/ts/surfaces/admin/components/Image.d.ts +95 -55
- package/build/ts/surfaces/admin/components/Link/Link.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Link.d.ts +35 -39
- package/build/ts/surfaces/admin/components/ListItem.d.ts +3 -3
- package/build/ts/surfaces/admin/components/Menu/Menu.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/Menu/Menu.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/Menu.d.ts +139 -0
- package/build/ts/surfaces/admin/components/Modal/Modal.ab.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/Modal/Modal.ab.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/Modal.d.ts +227 -0
- package/build/ts/surfaces/admin/components/MoneyField.d.ts +30 -38
- package/build/ts/surfaces/admin/components/NumberField.d.ts +27 -33
- package/build/ts/surfaces/admin/components/Option.d.ts +6 -4
- package/build/ts/surfaces/admin/components/OptionGroup.d.ts +6 -4
- package/build/ts/surfaces/admin/components/OrderedList/OrderedList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/OrderedList.d.ts +3 -3
- package/build/ts/surfaces/admin/components/Page.d.ts +33 -7
- package/build/ts/surfaces/admin/components/Paragraph/Paragraph.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Paragraph.d.ts +3 -3
- package/build/ts/surfaces/admin/components/PasswordField.d.ts +27 -33
- package/build/ts/surfaces/admin/components/Popover/Popover.ab.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/Popover/Popover.ab.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/QueryContainer/QueryContainer.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/QueryContainer.d.ts +4 -8
- package/build/ts/surfaces/admin/components/SearchField.d.ts +27 -33
- package/build/ts/surfaces/admin/components/Section/Section.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Section.d.ts +3 -3
- package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Select.d.ts +49 -33
- package/build/ts/surfaces/admin/components/Spinner.d.ts +3 -3
- package/build/ts/surfaces/admin/components/Stack/Stack.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Stack.d.ts +117 -41
- package/build/ts/surfaces/admin/components/StandardComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/StandardComponents.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Switch.d.ts +22 -27
- package/build/ts/surfaces/admin/components/Table/Table.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Table.d.ts +16 -15
- package/build/ts/surfaces/admin/components/TableBody.d.ts +3 -3
- package/build/ts/surfaces/admin/components/TableCell.d.ts +18 -3
- package/build/ts/surfaces/admin/components/TableHeader.d.ts +11 -4
- package/build/ts/surfaces/admin/components/TableHeaderRow.d.ts +4 -3
- package/build/ts/surfaces/admin/components/TableRow.d.ts +6 -4
- package/build/ts/surfaces/admin/components/Text/Text.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Text.d.ts +5 -3
- package/build/ts/surfaces/admin/components/TextArea.d.ts +27 -33
- package/build/ts/surfaces/admin/components/TextField.d.ts +28 -34
- package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/Thumbnail.d.ts +15 -21
- package/build/ts/surfaces/admin/components/Tooltip/Tooltip.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/Tooltip/Tooltip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/Tooltip.d.ts +148 -0
- package/build/ts/surfaces/admin/components/URLField.d.ts +27 -33
- package/build/ts/surfaces/admin/components/UnorderedList/UnorderedList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/UnorderedList.d.ts +3 -3
- package/build/ts/surfaces/admin/components/patterns/accountConnection.ab.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/patterns/accountConnection.ab.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/patterns/appCard.ab.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/patterns/appCard.ab.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/patterns/calloutCard.ab.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/patterns/calloutCard.ab.doc.d.ts.map +1 -0
- 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 +4 -0
- package/build/ts/surfaces/admin/components/patterns/emptyState.ab.doc.d.ts.map +1 -0
- 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.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/indexTable.ab.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/patterns/indexTable.ab.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/patterns/interstitialNav.ab.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/patterns/interstitialNav.ab.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/patterns/mediaCard.ab.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/patterns/mediaCard.ab.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/patterns/metricsCard.ab.doc.d.ts +4 -0
- package/build/ts/surfaces/admin/components/patterns/metricsCard.ab.doc.d.ts.map +1 -0
- 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 +4 -0
- package/build/ts/surfaces/admin/components/patterns/setupGuide.ab.doc.d.ts.map +1 -0
- package/build/ts/surfaces/admin/components/shared.d.ts +1034 -594
- package/build/ts/surfaces/admin/docs-types.d.ts +4 -0
- package/build/ts/surfaces/admin/docs-types.d.ts.map +1 -1
- package/build/ts/surfaces/admin/extension-targets.d.ts +10 -8
- package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.catalog-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.catalog-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.catalog-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.collection-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.collection-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.collection-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.collection-index.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.collection-index.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.company-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.company-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.company-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.company-location-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.customer-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.customer-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.customer-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.customer-index.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.customer-index.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.customer-index.selection-action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.customer-index.selection-action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.customer-segment-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.customer-segment-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.customers.segmentation-templates.data.d.ts +6 -0
- package/build/ts/surfaces/admin/targets/admin.discount-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.discount-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.discount-details.function-settings.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.discount-index.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.discount-index.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.draft-order-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.draft-order-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.draft-order-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.draft-order-index.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.draft-order-index.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.draft-order-index.selection-action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.draft-order-index.selection-action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.gift-card-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.gift-card-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.gift-card-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.order-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.order-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.order-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.order-details.print-action.render.d.ts +53 -3594
- package/build/ts/surfaces/admin/targets/admin.order-details.print-action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.order-fulfilled-card.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.order-fulfilled-card.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.order-index.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.order-index.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.order-index.selection-action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.order-index.selection-action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.order-index.selection-print-action.render.d.ts +53 -3594
- package/build/ts/surfaces/admin/targets/admin.order-index.selection-print-action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.product-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.product-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.product-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.product-details.configuration.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.product-details.print-action.render.d.ts +53 -3594
- package/build/ts/surfaces/admin/targets/admin.product-details.print-action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.product-details.reorder.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.product-index.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.product-index.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.product-index.selection-action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.product-index.selection-action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.product-index.selection-print-action.render.d.ts +53 -3594
- package/build/ts/surfaces/admin/targets/admin.product-index.selection-print-action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.product-purchase-option.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.product-variant-details.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.product-variant-details.action.should-render.d.ts +1 -3
- package/build/ts/surfaces/admin/targets/admin.product-variant-details.block.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.product-variant-details.configuration.render.d.ts +54 -3647
- package/build/ts/surfaces/admin/targets/admin.product-variant-purchase-option.action.render.d.ts +53 -3605
- package/build/ts/surfaces/admin/targets/admin.settings.internal-order-routing-rule.render.d.ts +54 -3554
- package/build/ts/surfaces/admin/targets/admin.settings.order-routing-rule.render.d.ts +54 -3554
- package/build/ts/surfaces/admin/targets/admin.settings.validation.render.d.ts +54 -3554
- package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts +1 -1
- package/build/ts/surfaces/checkout/api/announcement/announcement.d.ts +8 -0
- package/build/ts/surfaces/checkout/api/announcement/announcement.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts +3 -3
- package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts +20 -4
- package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/order-confirmation/order-confirmation.d.ts +2 -2
- package/build/ts/surfaces/checkout/api/order-confirmation/order-confirmation.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts +3 -3
- package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-item.d.ts +3 -3
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts +2 -2
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts +2 -2
- package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/shared.d.ts +4 -0
- package/build/ts/surfaces/checkout/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts +3 -3
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts +3 -3
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +63 -40
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Abbreviation/Abbreviation.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Abbreviation.d.ts +1 -1
- package/build/ts/surfaces/checkout/components/Announcement/Announcement.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Announcement/Announcement.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Announcement.d.ts +95 -0
- package/build/ts/surfaces/checkout/components/Badge/Badge.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Badge/Badge.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Badge.d.ts +57 -0
- package/build/ts/surfaces/checkout/components/Banner.d.ts +9 -6
- package/build/ts/surfaces/checkout/components/Box/Box.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Button.d.ts +10 -5
- package/build/ts/surfaces/checkout/components/Checkbox.d.ts +11 -5
- package/build/ts/surfaces/checkout/components/Chip/Chip.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Chip/Chip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Chip.d.ts +56 -0
- package/build/ts/surfaces/checkout/components/Choice.d.ts +67 -0
- package/build/ts/surfaces/checkout/components/ChoiceList/ChoiceList.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/ChoiceList.d.ts +65 -0
- package/build/ts/surfaces/checkout/components/Clickable/Clickable.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Clickable/Clickable.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Clickable.d.ts +89 -0
- package/build/ts/surfaces/checkout/components/ClickableChip/ClickableChip.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/ClickableChip/ClickableChip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/ClickableChip.d.ts +83 -0
- package/build/ts/surfaces/checkout/components/ClipboardItem/ClipboardItem.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/ClipboardItem.d.ts +9 -6
- package/build/ts/surfaces/checkout/components/ConsentCheckbox/ConsentCheckbox.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/ConsentCheckbox/ConsentCheckbox.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/ConsentCheckbox.d.ts +84 -0
- package/build/ts/surfaces/checkout/components/ConsentPhoneField/ConsentPhoneField.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/ConsentPhoneField/ConsentPhoneField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/ConsentPhoneField.d.ts +129 -0
- package/build/ts/surfaces/checkout/components/DateField/DateField.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/DateField/DateField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/DateField.d.ts +87 -0
- package/build/ts/surfaces/checkout/components/DatePicker/DatePicker.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/DatePicker/DatePicker.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/DatePicker.d.ts +77 -0
- package/build/ts/surfaces/checkout/components/Details/Details.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Details/Details.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Details.d.ts +85 -0
- package/build/ts/surfaces/checkout/components/Divider/Divider.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Divider/Divider.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Divider.d.ts +46 -0
- package/build/ts/surfaces/checkout/components/DropZone.d.ts +15 -7
- package/build/ts/surfaces/checkout/components/EmailField.d.ts +31 -8
- package/build/ts/surfaces/checkout/components/Form/Form.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Form.d.ts +11 -8
- package/build/ts/surfaces/checkout/components/Grid/Grid.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Grid/Grid.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Grid.d.ts +64 -0
- package/build/ts/surfaces/checkout/components/GridItem.d.ts +54 -0
- package/build/ts/surfaces/checkout/components/Heading/Heading.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Icon/Icon.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Icon.d.ts +4 -3
- package/build/ts/surfaces/checkout/components/Image/Image.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Link.d.ts +10 -5
- package/build/ts/surfaces/checkout/components/Map.d.ts +11 -8
- package/build/ts/surfaces/checkout/components/MapMarker.d.ts +16 -15
- package/build/ts/surfaces/checkout/components/Modal/Modal.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Modal.d.ts +22 -18
- package/build/ts/surfaces/checkout/components/MoneyField/MoneyField.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/MoneyField/MoneyField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/MoneyField.d.ts +80 -0
- package/build/ts/surfaces/checkout/components/NumberField/NumberField.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/NumberField/NumberField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/NumberField.d.ts +98 -0
- package/build/ts/surfaces/checkout/components/Option.d.ts +46 -0
- package/build/ts/surfaces/checkout/components/OrderedList/OrderedList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Paragraph/Paragraph.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/PasswordField/PasswordField.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/PasswordField/PasswordField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/PasswordField.d.ts +93 -0
- package/build/ts/surfaces/checkout/components/PaymentIcon/PaymentIcon.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/PhoneField.d.ts +31 -17
- package/build/ts/surfaces/checkout/components/Popover/Popover.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Popover/Popover.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Popover.d.ts +116 -0
- package/build/ts/surfaces/checkout/components/PressButton/PressButton.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/PressButton/PressButton.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/PressButton.d.ts +79 -0
- package/build/ts/surfaces/checkout/components/ProductThumbnail.d.ts +41 -0
- package/build/ts/surfaces/checkout/components/Progress/Progress.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/QRCode.d.ts +8 -5
- package/build/ts/surfaces/checkout/components/QueryContainer/QueryContainer.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/QueryContainer/QueryContainer.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/QueryContainer.d.ts +48 -0
- package/build/ts/surfaces/checkout/components/ScrollBox/ScrollBox.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/ScrollBox/ScrollBox.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/ScrollBox.d.ts +54 -0
- package/build/ts/surfaces/checkout/components/Section/Section.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Select/Select.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Select/Select.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Select.d.ts +79 -0
- package/build/ts/surfaces/checkout/components/Sheet/Sheet.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Sheet/Sheet.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Sheet.d.ts +100 -0
- package/build/ts/surfaces/checkout/components/SkeletonParagraph/SkeletonParagraph.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/SkeletonParagraph/SkeletonParagraph.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/SkeletonParagraph.d.ts +40 -0
- package/build/ts/surfaces/checkout/components/Spinner/Spinner.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Stack/Stack.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Stack.d.ts +4 -4
- package/build/ts/surfaces/checkout/components/Summary.d.ts +35 -0
- package/build/ts/surfaces/checkout/components/Switch/Switch.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Switch/Switch.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Switch.d.ts +60 -0
- package/build/ts/surfaces/checkout/components/Text/Text.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/TextArea.d.ts +24 -8
- package/build/ts/surfaces/checkout/components/TextField.d.ts +35 -20
- package/build/ts/surfaces/checkout/components/Time/Time.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Time.d.ts +1 -1
- package/build/ts/surfaces/checkout/components/Tooltip/Tooltip.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Tooltip/Tooltip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/Tooltip.d.ts +48 -0
- package/build/ts/surfaces/checkout/components/UnorderedList/UnorderedList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/UrlField/UrlField.doc.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/UrlField/UrlField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/checkout/components/UrlField.d.ts +93 -0
- package/build/ts/surfaces/checkout/components/components-shared.d.ts +1034 -288
- package/build/ts/surfaces/checkout/components/components.d.ts +1947 -530
- package/build/ts/surfaces/checkout/extension-targets.d.ts +64 -60
- package/build/ts/surfaces/checkout/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/api.d.ts +4 -0
- package/build/ts/surfaces/checkout/preact/api.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/attributes.d.ts +1 -1
- package/build/ts/surfaces/checkout/preact/attributes.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/subscription.d.ts +5 -4
- package/build/ts/surfaces/checkout/preact/subscription.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/shared.d.ts +36 -5
- package/build/ts/surfaces/checkout/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/targets/Checkout::Actions::RenderBefore.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::CartLineDetails::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::CartLineDetails::RenderLineComponents.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::CartLines::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::Contact::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::CustomerInformation::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::DeliveryAddress::RenderBefore.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::Dynamic::Render.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::GiftCard::Render.d.ts +60 -1304
- package/build/ts/surfaces/checkout/targets/Checkout::PaymentMethod::HostedFields::RenderAfter.d.ts +60 -1304
- package/build/ts/surfaces/checkout/targets/Checkout::PaymentMethod::Render.d.ts +60 -1304
- package/build/ts/surfaces/checkout/targets/Checkout::PaymentMethod::RenderRequiredAction.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::PickupLocations::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::PickupLocations::RenderBefore.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::PickupPoints::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::PickupPoints::RenderBefore.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::Reductions::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::Reductions::RenderBefore.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethodDetails::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethodDetails::RenderExpanded.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethods::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethods::RenderBefore.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::CartLineDetails::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::CartLines::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::CustomerInformation::RenderAfter.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::Dynamic::Render.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.address-autocomplete.format-suggestion.d.ts +1 -3
- package/build/ts/surfaces/checkout/targets/purchase.address-autocomplete.suggest.d.ts +1 -3
- package/build/ts/surfaces/checkout/targets/purchase.cart-line-item.line-components.render.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.actions.render-before.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.block.render.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-item.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-list.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.chat.render.d.ts +1 -3
- package/build/ts/surfaces/checkout/targets/purchase.checkout.contact.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-before.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.footer.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.gift-card.render.d.ts +60 -1304
- package/build/ts/surfaces/checkout/targets/purchase.checkout.header.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-before.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.action-required.render.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.details.render.d.ts +60 -1304
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.hosted-fields.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-before.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-option-item.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-before.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-before.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.details.render.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-before.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.announcement.render.d.ts +68 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.block.render.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-item.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-list.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.chat.render.d.ts +1 -3
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.customer-information.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.footer.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.header.render-after.d.ts +62 -1397
- package/build/ts/surfaces/checkout.d.ts +3 -1
- package/build/ts/surfaces/checkout.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts +2 -2
- package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/docs.d.ts +46 -17
- package/build/ts/surfaces/customer-account/api/docs.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +29 -42
- 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 +54 -40
- 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 +38 -23
- package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api.d.ts +2 -2
- package/build/ts/surfaces/customer-account/api.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Abbreviation.d.ts +1 -1
- package/build/ts/surfaces/customer-account/components/Announcement.d.ts +95 -0
- package/build/ts/surfaces/customer-account/components/Avatar/Avatar.doc.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Avatar.d.ts +46 -20
- package/build/ts/surfaces/customer-account/components/Badge.d.ts +57 -0
- package/build/ts/surfaces/customer-account/components/Banner.d.ts +9 -6
- package/build/ts/surfaces/customer-account/components/Button.d.ts +10 -5
- package/build/ts/surfaces/customer-account/components/ButtonGroup/ButtonGroup.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ButtonGroup/ButtonGroup.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ButtonGroup.d.ts +39 -0
- package/build/ts/surfaces/customer-account/components/Checkbox.d.ts +11 -5
- package/build/ts/surfaces/customer-account/components/Chip.d.ts +56 -0
- package/build/ts/surfaces/customer-account/components/Choice.d.ts +67 -0
- package/build/ts/surfaces/customer-account/components/ChoiceList.d.ts +65 -0
- package/build/ts/surfaces/customer-account/components/Clickable.d.ts +89 -0
- package/build/ts/surfaces/customer-account/components/ClickableChip.d.ts +83 -0
- package/build/ts/surfaces/customer-account/components/ClipboardItem.d.ts +9 -6
- package/build/ts/surfaces/customer-account/components/ConsentCheckbox.d.ts +84 -0
- package/build/ts/surfaces/customer-account/components/ConsentPhoneField.d.ts +129 -0
- package/build/ts/surfaces/customer-account/components/CustomerAccountAction/CustomerAccountAction.doc.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/CustomerAccountAction.d.ts +14 -3
- package/build/ts/surfaces/customer-account/components/DateField.d.ts +87 -0
- package/build/ts/surfaces/customer-account/components/DatePicker.d.ts +77 -0
- package/build/ts/surfaces/customer-account/components/Details.d.ts +85 -0
- package/build/ts/surfaces/customer-account/components/Divider.d.ts +46 -0
- package/build/ts/surfaces/customer-account/components/DropZone.d.ts +15 -7
- package/build/ts/surfaces/customer-account/components/EmailField.d.ts +31 -8
- package/build/ts/surfaces/customer-account/components/Form.d.ts +11 -8
- package/build/ts/surfaces/customer-account/components/Grid.d.ts +64 -0
- package/build/ts/surfaces/customer-account/components/GridItem.d.ts +54 -0
- package/build/ts/surfaces/customer-account/components/Icon.d.ts +4 -3
- package/build/ts/surfaces/customer-account/components/ImageGroup.d.ts +2 -2
- package/build/ts/surfaces/customer-account/components/Link.d.ts +10 -5
- package/build/ts/surfaces/customer-account/components/Map.d.ts +11 -8
- package/build/ts/surfaces/customer-account/components/MapMarker.d.ts +16 -15
- package/build/ts/surfaces/customer-account/components/Menu/Menu.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Menu/Menu.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Menu.d.ts +25 -0
- package/build/ts/surfaces/customer-account/components/Modal.d.ts +22 -18
- package/build/ts/surfaces/customer-account/components/MoneyField.d.ts +80 -0
- package/build/ts/surfaces/customer-account/components/NumberField.d.ts +98 -0
- package/build/ts/surfaces/customer-account/components/Option.d.ts +46 -0
- package/build/ts/surfaces/customer-account/components/Page/Page.doc.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Page.d.ts +17 -2
- package/build/ts/surfaces/customer-account/components/PasswordField.d.ts +93 -0
- package/build/ts/surfaces/customer-account/components/PhoneField.d.ts +31 -17
- package/build/ts/surfaces/customer-account/components/Popover.d.ts +116 -0
- package/build/ts/surfaces/customer-account/components/PressButton.d.ts +79 -0
- package/build/ts/surfaces/customer-account/components/ProductThumbnail.d.ts +41 -0
- package/build/ts/surfaces/customer-account/components/QRCode.d.ts +8 -5
- package/build/ts/surfaces/customer-account/components/QueryContainer.d.ts +48 -0
- package/build/ts/surfaces/customer-account/components/ScrollBox.d.ts +54 -0
- package/build/ts/surfaces/customer-account/components/Section/Section.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Section/Section.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Select.d.ts +79 -0
- package/build/ts/surfaces/customer-account/components/Sheet.d.ts +100 -0
- package/build/ts/surfaces/customer-account/components/SkeletonParagraph.d.ts +40 -0
- package/build/ts/surfaces/customer-account/components/Stack.d.ts +4 -4
- package/build/ts/surfaces/customer-account/components/StandardComponents.d.ts +1 -1
- package/build/ts/surfaces/customer-account/components/StandardComponents.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Summary.d.ts +35 -0
- package/build/ts/surfaces/customer-account/components/Switch.d.ts +60 -0
- package/build/ts/surfaces/customer-account/components/TextArea.d.ts +24 -8
- package/build/ts/surfaces/customer-account/components/TextField.d.ts +35 -20
- package/build/ts/surfaces/customer-account/components/Time.d.ts +1 -1
- package/build/ts/surfaces/customer-account/components/Tooltip.d.ts +48 -0
- package/build/ts/surfaces/customer-account/components/UrlField.d.ts +93 -0
- package/build/ts/surfaces/customer-account/components/components-shared.d.ts +1034 -288
- package/build/ts/surfaces/customer-account/components/components.d.ts +1947 -530
- package/build/ts/surfaces/customer-account/components/shared.d.ts +2 -2
- package/build/ts/surfaces/customer-account/components/shared.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/shared.ts +12 -5
- package/build/ts/surfaces/customer-account/extension-targets.d.ts +6 -6
- package/build/ts/surfaces/customer-account/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/globals.d.ts +2 -1
- package/build/ts/surfaces/customer-account/globals.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/preact/live-navigation.d.ts +1 -2
- package/build/ts/surfaces/customer-account/preact/live-navigation.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/preact/navigation.d.ts +2 -2
- package/build/ts/surfaces/customer-account/preact/navigation.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/preact/subscription.d.ts +2 -2
- package/build/ts/surfaces/customer-account/preact/subscription.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.footer.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order-index.announcement.render.d.ts +75 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-index.block.render.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.announcement.render.d.ts +75 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.block.render.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-item.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-list.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.customer-information.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.fulfillment-details.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.payment-details.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.return-details.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.unfulfilled-items.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order.action.menu-item.render.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order.action.render.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.order.page.render.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.page.render.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.addresses.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.announcement.render.d.ts +75 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.block.render.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-details.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-addresses.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-payment.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-staff.render-after.d.ts +70 -1537
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.payment.render-after.d.ts +70 -1537
- package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts +15 -0
- package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +182 -0
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts +11 -0
- package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts +22 -0
- package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts +10 -0
- package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts +21 -0
- package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts +18 -0
- package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts +15 -0
- package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts +47 -0
- package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts +24 -0
- package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts +17 -0
- package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts +29 -0
- package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts +14 -0
- package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts +67 -0
- package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts +37 -0
- package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts +21 -0
- package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts +15 -0
- package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts +15 -0
- package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Badge/Badge.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Badge/Badge.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Badge.d.ts +61 -0
- package/build/ts/surfaces/point-of-sale/components/Banner/Banner.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Banner/Banner.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Banner.d.ts +77 -0
- package/build/ts/surfaces/point-of-sale/components/Box/Box.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Box/Box.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Box.d.ts +175 -0
- package/build/ts/surfaces/point-of-sale/components/Button/Button.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Button/Button.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Button.d.ts +102 -0
- package/build/ts/surfaces/point-of-sale/components/Choice.d.ts +50 -0
- package/build/ts/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +70 -0
- package/build/ts/surfaces/point-of-sale/components/Clickable/Clickable.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Clickable/Clickable.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Clickable.d.ts +66 -0
- package/build/ts/surfaces/point-of-sale/components/DateField/DateField.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/DateField/DateField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/DateField.d.ts +78 -0
- package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts +74 -0
- package/build/ts/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts +74 -0
- package/build/ts/surfaces/point-of-sale/components/Divider/Divider.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Divider/Divider.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Divider.d.ts +48 -0
- package/build/ts/surfaces/point-of-sale/components/EmailField/EmailField.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/EmailField/EmailField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts +95 -0
- package/build/ts/surfaces/point-of-sale/components/Heading/Heading.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Heading/Heading.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Heading.d.ts +52 -0
- package/build/ts/surfaces/point-of-sale/components/Icon/Icon.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Icon/Icon.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Icon.d.ts +183 -0
- package/build/ts/surfaces/point-of-sale/components/Image/Image.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Image/Image.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Image.d.ts +71 -0
- package/build/ts/surfaces/point-of-sale/components/Modal/Modal.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Modal/Modal.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Modal.d.ts +90 -0
- package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts +159 -0
- package/build/ts/surfaces/point-of-sale/components/Page/Page.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Page/Page.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Page.d.ts +76 -0
- package/build/ts/surfaces/point-of-sale/components/PosBlock/PosBlock.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/PosBlock/PosBlock.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/PosBlock.d.ts +63 -0
- package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +47 -0
- package/build/ts/surfaces/point-of-sale/components/ScrollBox/ScrollBox.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/ScrollBox/ScrollBox.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/ScrollBox.d.ts +172 -0
- package/build/ts/surfaces/point-of-sale/components/SearchField/SearchField.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/SearchField/SearchField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts +74 -0
- package/build/ts/surfaces/point-of-sale/components/Section/Section.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Section/Section.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Section.d.ts +68 -0
- package/build/ts/surfaces/point-of-sale/components/Stack/Stack.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Stack/Stack.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +250 -0
- package/build/ts/surfaces/point-of-sale/components/Text/Text.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Text/Text.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Text.d.ts +75 -0
- package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts +96 -0
- package/build/ts/surfaces/point-of-sale/components/TextField/TextField.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/TextField/TextField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +95 -0
- package/build/ts/surfaces/point-of-sale/components/Tile/Tile.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/Tile/Tile.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/Tile.d.ts +71 -0
- package/build/ts/surfaces/point-of-sale/components/TimeField/TimeField.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/TimeField/TimeField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/TimeField.d.ts +77 -0
- package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts +74 -0
- package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +3210 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ActionExtensionComponents.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ActionExtensionComponents.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/targets/BasicComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/BasicComponents.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/targets/BlockExtensionComponents.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/components/targets/BlockExtensionComponents.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/targets/SmartGridComponents.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/components/targets/SmartGridComponents.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +16 -0
- package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +10 -0
- package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +10 -0
- package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +13 -0
- package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/data.d.ts +9 -0
- package/build/ts/surfaces/point-of-sale/event/data.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts +9 -0
- package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/event/output.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/event/output.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +57 -0
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/globals.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/globals.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.cart-update.event.observe.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.cart.line-item-details.action.menu-item.render.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.cart.line-item-details.action.render.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-complete.event.observe.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-start.event.observe.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.customer-details.action.menu-item.render.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.customer-details.action.render.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.customer-details.block.render.d.ts +20 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.draft-order-details.action.menu-item.render.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.draft-order-details.action.render.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.draft-order-details.block.render.d.ts +20 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.exchange.post.action.menu-item.render.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.exchange.post.action.render.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.exchange.post.block.render.d.ts +20 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.home.modal.render.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.home.tile.render.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.order-details.action.menu-item.render.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.order-details.action.render.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.order-details.block.render.d.ts +20 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.product-details.action.menu-item.render.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.product-details.action.render.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.product-details.block.render.d.ts +20 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.purchase.post.action.menu-item.render.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.purchase.post.action.render.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.purchase.post.block.render.d.ts +20 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.receipt-footer.block.render.d.ts +10 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.receipt-header.block.render.d.ts +10 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.return.post.action.menu-item.render.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.return.post.action.render.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.return.post.block.render.d.ts +20 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.transaction-complete.event.observe.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +21 -0
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts +165 -0
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/country-code.d.ts +248 -0
- package/build/ts/surfaces/point-of-sale/types/country-code.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/device.d.ts +15 -0
- package/build/ts/surfaces/point-of-sale/types/device.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts +14 -0
- package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/money.d.ts +9 -0
- package/build/ts/surfaces/point-of-sale/types/money.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts +15 -0
- package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/order.d.ts +10 -0
- package/build/ts/surfaces/point-of-sale/types/order.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts +19 -0
- package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/payment.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts +64 -0
- package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/product.d.ts +61 -0
- package/build/ts/surfaces/point-of-sale/types/product.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/session.d.ts +33 -0
- package/build/ts/surfaces/point-of-sale/types/session.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts +16 -0
- package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/storage.d.ts +45 -0
- package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts +13 -0
- package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale.d.ts.map +1 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +37 -5
- package/src/docs/shared/components/Announcement.ts +12 -0
- package/src/docs/shared/components/Avatar.ts +12 -0
- package/src/docs/shared/components/Badge.ts +1 -1
- package/src/docs/shared/components/Banner.ts +1 -1
- package/src/docs/shared/components/ButtonGroup.ts +11 -0
- package/src/docs/shared/components/Checkbox.ts +1 -1
- package/src/docs/shared/components/Chip.ts +12 -0
- package/src/docs/shared/components/Choice.ts +1 -1
- package/src/docs/shared/components/ChoiceList.ts +1 -1
- package/src/docs/shared/components/Clickable.ts +1 -1
- package/src/docs/shared/components/ClickableChip.ts +12 -0
- package/src/docs/shared/components/ColorField.ts +12 -0
- package/src/docs/shared/components/ColorPicker.ts +11 -0
- package/src/docs/shared/components/ConsentCheckbox.ts +12 -0
- package/src/docs/shared/components/ConsentPhoneField.ts +12 -0
- package/src/docs/shared/components/DateField.ts +11 -0
- package/src/docs/shared/components/DatePicker.ts +1 -1
- package/src/docs/shared/components/Details.ts +12 -0
- package/src/docs/shared/components/Divider.ts +1 -1
- package/src/docs/shared/components/EmailField.ts +2 -2
- package/src/docs/shared/components/FunctionSettings.ts +28 -0
- package/src/docs/shared/components/Grid.ts +1 -1
- package/src/docs/shared/components/GridItem.ts +1 -1
- package/src/docs/shared/components/Menu.ts +12 -0
- package/src/docs/shared/components/Modal.ts +2 -2
- package/src/docs/shared/components/MoneyField.ts +1 -1
- package/src/docs/shared/components/NumberField.ts +1 -1
- package/src/docs/shared/components/OptionGroup.ts +12 -0
- package/src/docs/shared/components/Paragraph.ts +1 -1
- package/src/docs/shared/components/PasswordField.ts +1 -1
- package/src/docs/shared/components/Popover.ts +12 -0
- package/src/docs/shared/components/PressButton.ts +12 -0
- package/src/docs/shared/components/ScrollBox.ts +12 -0
- package/src/docs/shared/components/SearchField.ts +1 -1
- package/src/docs/shared/components/Section.ts +1 -1
- package/src/docs/shared/components/Select.ts +1 -1
- package/src/docs/shared/components/SkeletonParagraph.ts +12 -0
- package/src/docs/shared/components/Summary.ts +12 -0
- package/src/docs/shared/components/Switch.ts +1 -1
- package/src/docs/shared/components/Table.ts +1 -1
- package/src/docs/shared/components/TableBody.ts +1 -1
- package/src/docs/shared/components/TableCell.ts +1 -1
- package/src/docs/shared/components/TableHeader.ts +1 -1
- package/src/docs/shared/components/TableHeaderRow.ts +1 -1
- package/src/docs/shared/components/TableRow.ts +1 -1
- package/src/docs/shared/components/TextArea.ts +1 -1
- package/src/docs/shared/components/Thumbnail.ts +12 -0
- package/src/docs/shared/components/Tooltip.ts +12 -0
- package/src/docs/shared/components/URLField.ts +1 -1
- package/src/docs/shared/components/index.ts +12 -0
- package/src/docs/shared/docs-type.ts +6 -5
- package/src/shared.ts +16 -1
- package/src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts +31 -0
- package/src/surfaces/admin/api/intents/examples/create-article.js +9 -0
- package/src/surfaces/admin/api/intents/examples/create-catalog.js +9 -0
- package/src/surfaces/admin/api/intents/examples/create-collection.js +9 -0
- package/src/surfaces/admin/api/intents/examples/create-customer.js +9 -0
- package/src/surfaces/admin/api/intents/examples/create-discount.js +11 -0
- package/src/surfaces/admin/api/intents/examples/create-market.js +9 -0
- package/src/surfaces/admin/api/intents/examples/create-menu.js +9 -0
- package/src/surfaces/admin/api/intents/examples/create-metafield-definition.js +11 -0
- package/src/surfaces/admin/api/intents/examples/create-metaobject-definition.js +9 -0
- package/src/surfaces/admin/api/intents/examples/create-metaobject.js +11 -0
- package/src/surfaces/admin/api/intents/examples/create-page.js +9 -0
- package/src/surfaces/admin/api/intents/examples/create-product.js +9 -0
- package/src/surfaces/admin/api/intents/examples/create-variant.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-article.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-catalog.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-collection.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-customer.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-discount.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-market.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-menu.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-metafield-definition.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-metaobject-definition.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-metaobject.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-page.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-product.js +11 -0
- package/src/surfaces/admin/api/intents/examples/edit-variant.js +11 -0
- package/src/surfaces/admin/api/intents/intents.ts +153 -0
- package/src/surfaces/admin/api/standard/standard.ts +9 -7
- package/src/surfaces/admin/api/standard/storage.ts +110 -0
- package/src/surfaces/admin/api.ts +4 -1
- package/src/surfaces/admin/components/AdminAction.d.ts +5 -5
- package/src/surfaces/admin/components/AdminBlock.d.ts +3 -3
- package/src/surfaces/admin/components/AdminPrintAction.d.ts +3 -3
- package/src/surfaces/admin/components/Avatar/examples/default.html +4 -0
- package/src/surfaces/admin/components/Avatar.d.ts +9 -20
- package/src/surfaces/admin/components/Badge.d.ts +8 -5
- package/src/surfaces/admin/components/Banner.d.ts +22 -28
- package/src/surfaces/admin/components/Box.d.ts +76 -24
- package/src/surfaces/admin/components/Button.d.ts +41 -36
- package/src/surfaces/admin/components/ButtonGroup/examples/default.html +4 -0
- package/src/surfaces/admin/components/ButtonGroup.d.ts +132 -0
- package/src/surfaces/admin/components/Checkbox.d.ts +23 -34
- package/src/surfaces/admin/components/Chip/examples/default.html +1 -0
- package/src/surfaces/admin/components/Chip.d.ts +121 -0
- package/src/surfaces/admin/components/Choice.d.ts +10 -9
- package/src/surfaces/admin/components/ChoiceList/examples/default.html +3 -3
- package/src/surfaces/admin/components/ChoiceList.d.ts +22 -28
- package/src/surfaces/admin/components/Clickable.d.ts +109 -56
- package/src/surfaces/admin/components/ClickableChip/examples/default.html +1 -0
- package/src/surfaces/admin/components/ClickableChip.d.ts +152 -0
- package/src/surfaces/admin/components/ColorField/examples/default.html +4 -0
- package/src/surfaces/admin/components/ColorField.d.ts +240 -0
- package/src/surfaces/admin/components/ColorPicker/examples/default.html +4 -0
- package/src/surfaces/admin/components/ColorPicker.d.ts +128 -0
- package/src/surfaces/admin/components/DateField/examples/default.html +1 -0
- package/src/surfaces/admin/components/DateField.d.ts +242 -0
- package/src/surfaces/admin/components/DatePicker.d.ts +10 -33
- package/src/surfaces/admin/components/Divider.d.ts +3 -3
- package/src/surfaces/admin/components/DropZone/examples/default.html +9 -0
- package/src/surfaces/admin/components/EmailField.d.ts +27 -33
- package/src/surfaces/admin/components/Form.d.ts +48 -36
- package/src/surfaces/admin/components/FormExtensionComponents.ts +5 -0
- package/src/surfaces/admin/components/FunctionSettings/examples/default.tsx +38 -0
- package/src/surfaces/admin/components/FunctionSettings.d.ts +183 -0
- package/src/surfaces/admin/components/FunctionSettingsComponents.ts +7 -0
- package/src/surfaces/admin/components/Grid.d.ts +148 -34
- package/src/surfaces/admin/components/GridItem.d.ts +76 -24
- package/src/surfaces/admin/components/Heading.d.ts +3 -3
- package/src/surfaces/admin/components/Icon.d.ts +8 -4
- package/src/surfaces/admin/components/Image/examples/default.html +1 -1
- package/src/surfaces/admin/components/Image.d.ts +95 -55
- package/src/surfaces/admin/components/Link.d.ts +35 -39
- package/src/surfaces/admin/components/ListItem.d.ts +3 -3
- package/src/surfaces/admin/components/Menu/examples/default.html +7 -0
- package/src/surfaces/admin/components/Menu.d.ts +139 -0
- package/src/surfaces/admin/components/Modal/examples/default.html +23 -0
- package/src/surfaces/admin/components/Modal.d.ts +227 -0
- package/src/surfaces/admin/components/MoneyField/examples/default.html +0 -1
- package/src/surfaces/admin/components/MoneyField.d.ts +30 -38
- package/src/surfaces/admin/components/NumberField.d.ts +27 -33
- package/src/surfaces/admin/components/Option.d.ts +6 -4
- package/src/surfaces/admin/components/OptionGroup.d.ts +6 -4
- package/src/surfaces/admin/components/OrderedList.d.ts +3 -3
- package/src/surfaces/admin/components/Page/examples/default.html +3 -3
- package/src/surfaces/admin/components/Page.d.ts +33 -7
- package/src/surfaces/admin/components/Paragraph.d.ts +3 -3
- package/src/surfaces/admin/components/PasswordField.d.ts +27 -33
- package/src/surfaces/admin/components/Popover/examples/default.html +8 -0
- package/src/surfaces/admin/components/QueryContainer/examples/default.html +4 -1
- package/src/surfaces/admin/components/QueryContainer.d.ts +4 -8
- package/src/surfaces/admin/components/SearchField.d.ts +27 -33
- package/src/surfaces/admin/components/Section.d.ts +3 -3
- package/src/surfaces/admin/components/Select/examples/default.html +4 -0
- package/src/surfaces/admin/components/Select.d.ts +49 -33
- package/src/surfaces/admin/components/Spinner.d.ts +3 -3
- package/src/surfaces/admin/components/Stack.d.ts +117 -41
- package/src/surfaces/admin/components/StandardComponents.ts +8 -0
- package/src/surfaces/admin/components/Switch.d.ts +22 -27
- package/src/surfaces/admin/components/Table.d.ts +16 -15
- package/src/surfaces/admin/components/TableBody.d.ts +3 -3
- package/src/surfaces/admin/components/TableCell.d.ts +18 -3
- package/src/surfaces/admin/components/TableHeader.d.ts +11 -4
- package/src/surfaces/admin/components/TableHeaderRow.d.ts +4 -3
- package/src/surfaces/admin/components/TableRow.d.ts +6 -4
- package/src/surfaces/admin/components/Text.d.ts +5 -3
- package/src/surfaces/admin/components/TextArea.d.ts +27 -33
- package/src/surfaces/admin/components/TextField.d.ts +28 -34
- package/src/surfaces/admin/components/Thumbnail/examples/default.html +4 -0
- package/src/surfaces/admin/components/Thumbnail.d.ts +15 -21
- package/src/surfaces/admin/components/Tooltip/examples/default.html +2 -0
- package/src/surfaces/admin/components/Tooltip.d.ts +148 -0
- package/src/surfaces/admin/components/URLField.d.ts +27 -33
- package/src/surfaces/admin/components/UnorderedList.d.ts +3 -3
- package/src/surfaces/admin/components/patterns/examples/accountConnection.html +16 -0
- package/src/surfaces/admin/components/patterns/examples/appCard.html +30 -0
- package/src/surfaces/admin/components/patterns/examples/calloutCard.html +35 -0
- package/src/surfaces/admin/components/patterns/examples/details.html +16 -16
- package/src/surfaces/admin/components/patterns/examples/details.jsx +13 -20
- package/src/surfaces/admin/components/patterns/examples/emptyState.html +27 -0
- package/src/surfaces/admin/components/patterns/examples/homepage.html +26 -59
- package/src/surfaces/admin/components/patterns/examples/homepage.jsx +26 -63
- package/src/surfaces/admin/components/patterns/examples/index.html +26 -34
- package/src/surfaces/admin/components/patterns/examples/index.jsx +23 -35
- package/src/surfaces/admin/components/patterns/examples/indexTable.html +127 -0
- package/src/surfaces/admin/components/patterns/examples/interstitialNav.html +72 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard.html +23 -0
- package/src/surfaces/admin/components/patterns/examples/metricsCard.html +51 -0
- package/src/surfaces/admin/components/patterns/examples/settings.html +168 -215
- package/src/surfaces/admin/components/patterns/examples/settings.jsx +169 -311
- package/src/surfaces/admin/components/patterns/examples/setupGuide.html +91 -0
- package/src/surfaces/admin/components/patterns/index.ab.doc.ts +8 -10
- package/src/surfaces/admin/components/shared.d.ts +1034 -594
- package/src/surfaces/admin/components/using-polaris-web-components/examples/event-handling.jsx +1 -1
- package/src/surfaces/admin/components/using-polaris-web-components/examples/using-with-react.jsx +1 -1
- package/src/surfaces/admin/components.d.ts +3076 -1150
- package/src/surfaces/admin/docs-types.ts +8 -1
- package/src/surfaces/admin/extension-targets.ts +11 -10
- package/src/surfaces/checkout/api/address-autocomplete/standard.ts +1 -1
- package/src/surfaces/checkout/api/announcement/announcement.ts +7 -0
- package/src/surfaces/checkout/api/cart-line/cart-line-item.ts +3 -4
- package/src/surfaces/checkout/api/checkout/checkout.ts +14 -4
- package/src/surfaces/checkout/api/order-confirmation/order-confirmation.ts +2 -2
- package/src/surfaces/checkout/api/payment/payment-option-item.ts +3 -3
- package/src/surfaces/checkout/api/pickup/pickup-location-item.ts +3 -4
- package/src/surfaces/checkout/api/pickup/pickup-location-list.ts +2 -2
- package/src/surfaces/checkout/api/pickup/pickup-point-list.ts +2 -2
- package/src/surfaces/checkout/api/shared.ts +5 -0
- package/src/surfaces/checkout/api/shipping/shipping-option-item.ts +3 -4
- package/src/surfaces/checkout/api/shipping/shipping-option-list.ts +3 -4
- package/src/surfaces/checkout/api/standard/standard.ts +65 -41
- package/src/surfaces/checkout/components/Abbreviation.d.ts +1 -1
- package/src/surfaces/checkout/components/Announcement/examples/basic-announcement.example.html +16 -0
- package/src/surfaces/checkout/components/Announcement.d.ts +95 -0
- package/src/surfaces/checkout/components/Badge/examples/basic-badge.example.html +3 -0
- package/src/surfaces/checkout/components/Badge.d.ts +57 -0
- package/src/surfaces/checkout/components/Banner/examples/basic-banner.example.html +1 -2
- package/src/surfaces/checkout/components/Banner.d.ts +9 -6
- package/src/surfaces/checkout/components/Box/examples/basic-box.example.html +1 -1
- package/src/surfaces/checkout/components/Button.d.ts +10 -5
- package/src/surfaces/checkout/components/Chat/examples/app-bridge-communication.example.tsx +58 -0
- package/src/surfaces/checkout/components/Chat/examples/app-bridge-css.example.css +16 -0
- package/src/surfaces/checkout/components/Chat/examples/app-bridge-resize.example.html +48 -0
- package/src/surfaces/checkout/components/Chat/examples/app-bridge-resize.example.tsx +9 -0
- package/src/surfaces/checkout/components/Chat/examples/include-app-bridge.example.html +3 -0
- package/src/surfaces/checkout/components/Chat/examples/shopify-extension-toml.example.toml +5 -0
- package/src/surfaces/checkout/components/Checkbox/examples/basic-checkbox.example.html +1 -1
- package/src/surfaces/checkout/components/Checkbox.d.ts +11 -5
- package/src/surfaces/checkout/components/Chip/examples/basic-chip.example.html +1 -0
- package/src/surfaces/checkout/components/Chip.d.ts +56 -0
- package/src/surfaces/checkout/components/Choice.d.ts +67 -0
- package/src/surfaces/checkout/components/ChoiceList/examples/basic-choice-list.example.html +7 -0
- package/src/surfaces/checkout/components/ChoiceList.d.ts +65 -0
- package/src/surfaces/checkout/components/Clickable/examples/basic-clickable.example.html +3 -0
- package/src/surfaces/checkout/components/Clickable.d.ts +89 -0
- package/src/surfaces/checkout/components/ClickableChip/examples/basic-clickable-chip.example.html +1 -0
- package/src/surfaces/checkout/components/ClickableChip.d.ts +83 -0
- package/src/surfaces/checkout/components/ClipboardItem.d.ts +9 -6
- package/src/surfaces/checkout/components/ConsentCheckbox/examples/basic-consent-checkbox.example.html +5 -0
- package/src/surfaces/checkout/components/ConsentCheckbox.d.ts +84 -0
- package/src/surfaces/checkout/components/ConsentPhoneField/examples/basic-consent-phone-field.example.html +5 -0
- package/src/surfaces/checkout/components/ConsentPhoneField.d.ts +129 -0
- package/src/surfaces/checkout/components/DateField/examples/basic-date-field.example.html +1 -0
- package/src/surfaces/checkout/components/DateField.d.ts +87 -0
- package/src/surfaces/checkout/components/DatePicker/examples/basic-date-picker.example.html +1 -0
- package/src/surfaces/checkout/components/DatePicker.d.ts +77 -0
- package/src/surfaces/checkout/components/Details/examples/basic-details.example.html +6 -0
- package/src/surfaces/checkout/components/Details.d.ts +85 -0
- package/src/surfaces/checkout/components/Divider/examples/basic-divider.example.html +1 -0
- package/src/surfaces/checkout/components/Divider.d.ts +46 -0
- package/src/surfaces/checkout/components/DropZone/examples/basic-drop-zone.example.html +1 -0
- package/src/surfaces/checkout/components/DropZone.d.ts +15 -7
- package/src/surfaces/checkout/components/EmailField/examples/basic-email-field.example.html +1 -0
- package/src/surfaces/checkout/components/EmailField.d.ts +31 -8
- package/src/surfaces/checkout/components/Form/examples/basic-form.example.html +2 -2
- package/src/surfaces/checkout/components/Form.d.ts +11 -8
- package/src/surfaces/checkout/components/Grid/examples/basic-grid.example.html +11 -0
- package/src/surfaces/checkout/components/Grid.d.ts +64 -0
- package/src/surfaces/checkout/components/GridItem.d.ts +54 -0
- package/src/surfaces/checkout/components/Icon/examples/basic-icon.example.html +4 -4
- package/src/surfaces/checkout/components/Icon.d.ts +4 -3
- package/src/surfaces/checkout/components/Image/examples/basic-image.example.html +1 -1
- package/src/surfaces/checkout/components/Link.d.ts +10 -5
- package/src/surfaces/checkout/components/Map/examples/basic-map.example.html +2 -2
- package/src/surfaces/checkout/components/Map.d.ts +11 -8
- package/src/surfaces/checkout/components/MapMarker.d.ts +16 -15
- package/src/surfaces/checkout/components/Modal/examples/basic-modal.example.html +1 -1
- package/src/surfaces/checkout/components/Modal.d.ts +22 -18
- package/src/surfaces/checkout/components/MoneyField/examples/basic-money-field.example.html +1 -0
- package/src/surfaces/checkout/components/MoneyField.d.ts +80 -0
- package/src/surfaces/checkout/components/NumberField/examples/basic-number-field.example.html +8 -0
- package/src/surfaces/checkout/components/NumberField.d.ts +98 -0
- package/src/surfaces/checkout/components/Option.d.ts +46 -0
- package/src/surfaces/checkout/components/PasswordField/examples/basic-password-field.example.html +1 -0
- package/src/surfaces/checkout/components/PasswordField.d.ts +93 -0
- package/src/surfaces/checkout/components/PaymentIcon/examples/basic-payment-icon.example.html +7 -0
- package/src/surfaces/checkout/components/PhoneField/examples/basic-phone-field.example.html +2 -0
- package/src/surfaces/checkout/components/PhoneField.d.ts +31 -17
- package/src/surfaces/checkout/components/Popover/examples/basic-popover.example.html +7 -0
- package/src/surfaces/checkout/components/Popover.d.ts +116 -0
- package/src/surfaces/checkout/components/PressButton/examples/basic-press-button.example.html +1 -0
- package/src/surfaces/checkout/components/PressButton.d.ts +79 -0
- package/src/surfaces/checkout/components/ProductThumbnail/examples/{basic-productthumbnail.example.html → basic-product-thumbnail.example.html} +1 -1
- package/src/surfaces/checkout/components/ProductThumbnail.d.ts +41 -0
- package/src/surfaces/checkout/components/Progress/examples/basic-progress.example.html +1 -1
- package/src/surfaces/checkout/components/QRCode.d.ts +8 -5
- package/src/surfaces/checkout/components/QueryContainer/examples/basic-query-container.example.html +8 -0
- package/src/surfaces/checkout/components/QueryContainer.d.ts +48 -0
- package/src/surfaces/checkout/components/ScrollBox/examples/basic-scroll-box.example.html +5 -0
- package/src/surfaces/checkout/components/ScrollBox.d.ts +54 -0
- package/src/surfaces/checkout/components/Select/examples/basic-select.example.html +5 -0
- package/src/surfaces/checkout/components/Select.d.ts +79 -0
- package/src/surfaces/checkout/components/Sheet/examples/basic-sheet.example.html +5 -0
- package/src/surfaces/checkout/components/Sheet.d.ts +100 -0
- package/src/surfaces/checkout/components/SkeletonParagraph/examples/basic-skeleton-paragraph.example.html +2 -0
- package/src/surfaces/checkout/components/SkeletonParagraph.d.ts +40 -0
- package/src/surfaces/checkout/components/Spinner/examples/basic-spinner.example.html +1 -1
- package/src/surfaces/checkout/components/Stack/examples/basic-stack.example.html +4 -0
- package/src/surfaces/checkout/components/Stack.d.ts +4 -4
- package/src/surfaces/checkout/components/Summary.d.ts +35 -0
- package/src/surfaces/checkout/components/Switch/examples/basic-switch.example.html +1 -0
- package/src/surfaces/checkout/components/Switch.d.ts +60 -0
- package/src/surfaces/checkout/components/Text/examples/basic-text.example.html +1 -1
- package/src/surfaces/checkout/components/TextArea/examples/{basic-textarea.example.html → basic-text-area.example.html} +1 -1
- package/src/surfaces/checkout/components/TextArea.d.ts +24 -8
- package/src/surfaces/checkout/components/TextField/examples/basic-text-field.example.html +4 -0
- package/src/surfaces/checkout/components/TextField.d.ts +35 -20
- package/src/surfaces/checkout/components/Time/examples/basic-time.example.html +1 -1
- package/src/surfaces/checkout/components/Time.d.ts +1 -1
- package/src/surfaces/checkout/components/Tooltip/examples/basic-tooltip.example.html +9 -0
- package/src/surfaces/checkout/components/Tooltip.d.ts +48 -0
- package/src/surfaces/checkout/components/UrlField/examples/basic-url-field.example.html +1 -0
- package/src/surfaces/checkout/components/UrlField.d.ts +93 -0
- package/src/surfaces/checkout/components/components-shared.d.ts +1034 -288
- package/src/surfaces/checkout/components/components.d.ts +1947 -530
- package/src/surfaces/checkout/extension-targets.ts +70 -61
- package/src/surfaces/checkout/preact/api.ts +5 -1
- package/src/surfaces/checkout/preact/attributes.ts +2 -2
- package/src/surfaces/checkout/preact/subscription.ts +10 -8
- package/src/surfaces/checkout/preact/tests/api.test.tsx +22 -13
- package/src/surfaces/checkout/preact/tests/app-metafields.test.ts +52 -56
- package/src/surfaces/checkout/preact/tests/attributes.test.ts +34 -24
- package/src/surfaces/checkout/preact/tests/billing-address.test.ts +17 -7
- package/src/surfaces/checkout/preact/tests/buyer-identity-businessCustomer.test.ts +16 -9
- package/src/surfaces/checkout/preact/tests/buyer-identity.test.tsx +56 -26
- package/src/surfaces/checkout/preact/tests/buyer-journey.test.ts +71 -74
- package/src/surfaces/checkout/preact/tests/capabilities.test.ts +32 -28
- package/src/surfaces/checkout/preact/tests/cart-line-target.test.ts +31 -24
- package/src/surfaces/checkout/preact/tests/checkout-settings.test.ts +17 -9
- package/src/surfaces/checkout/preact/tests/checkout-token.test.ts +16 -6
- package/src/surfaces/checkout/preact/tests/configuration.test.ts +16 -6
- package/src/surfaces/checkout/preact/tests/country.test.tsx +18 -8
- package/src/surfaces/checkout/preact/tests/currency.test.tsx +18 -8
- package/src/surfaces/checkout/preact/tests/customer-privacy.test.ts +17 -8
- package/src/surfaces/checkout/preact/tests/delivery-group-list-target.test.ts +24 -18
- package/src/surfaces/checkout/preact/tests/delivery-group-target.test.ts +26 -20
- package/src/surfaces/checkout/preact/tests/delivery-group.test.ts +22 -16
- package/src/surfaces/checkout/preact/tests/delivery-groups.test.ts +17 -11
- package/src/surfaces/checkout/preact/tests/delivery-selection-groups.test.ts +31 -24
- package/src/surfaces/checkout/preact/tests/discounts.test.tsx +21 -14
- package/src/surfaces/checkout/preact/tests/extension-language.test.tsx +17 -8
- package/src/surfaces/checkout/preact/tests/gift-cards.test.tsx +17 -8
- package/src/surfaces/checkout/preact/tests/localized-fields.test.ts +58 -59
- package/src/surfaces/checkout/preact/tests/market.test.tsx +17 -7
- package/src/surfaces/checkout/preact/tests/metafield.test.tsx +33 -36
- package/src/surfaces/checkout/preact/tests/metafields.test.tsx +36 -53
- package/src/surfaces/checkout/preact/tests/mount.tsx +63 -20
- package/src/surfaces/checkout/preact/tests/notes.test.tsx +16 -6
- package/src/surfaces/checkout/preact/tests/payment-method.test.ts +87 -60
- package/src/surfaces/checkout/preact/tests/payment-options.test.tsx +26 -24
- package/src/surfaces/checkout/preact/tests/pickup-location-option-target.test.tsx +55 -46
- package/src/surfaces/checkout/preact/tests/redeemable.test.ts +30 -23
- package/src/surfaces/checkout/preact/tests/session-token.test.tsx +12 -6
- package/src/surfaces/checkout/preact/tests/shipping-address.test.ts +17 -7
- package/src/surfaces/checkout/preact/tests/shipping-option-target.test.ts +54 -50
- package/src/surfaces/checkout/preact/tests/shopping-address.test.tsx +18 -10
- package/src/surfaces/checkout/preact/tests/timezone.test.tsx +17 -7
- package/src/surfaces/checkout/preact/tests/translate.test.tsx +18 -13
- package/src/surfaces/checkout/preact/tests/tsconfig.json +1 -1
- package/src/surfaces/checkout/shared.ts +112 -43
- package/src/surfaces/checkout.ts +5 -1
- package/src/surfaces/customer-account/api/cart-line/cart-line-item.ts +2 -3
- package/src/surfaces/customer-account/api/docs.ts +81 -26
- package/src/surfaces/customer-account/api/order-status/order-status.ts +29 -42
- package/src/surfaces/customer-account/api/shared.ts +58 -40
- package/src/surfaces/customer-account/api/standard-api/standard-api.ts +42 -23
- package/src/surfaces/customer-account/api.ts +8 -4
- package/src/surfaces/customer-account/components/Avatar/examples/basic-Avatar.example.html +4 -0
- package/src/surfaces/customer-account/components/Avatar.d.ts +46 -20
- package/src/surfaces/customer-account/components/ButtonGroup/examples/basic-ButtonGroup.example.html +11 -0
- package/src/surfaces/customer-account/components/ButtonGroup.d.ts +39 -0
- package/src/surfaces/customer-account/components/CustomerAccountAction/examples/basic-CustomerAccountAction.example.html +9 -0
- package/src/surfaces/customer-account/components/CustomerAccountAction.d.ts +14 -3
- package/src/surfaces/customer-account/components/ImageGroup/examples/basic-ImageGroup.example.html +18 -0
- package/src/surfaces/customer-account/components/ImageGroup.d.ts +2 -2
- package/src/surfaces/customer-account/components/Menu/examples/basic-Menu.example.html +14 -0
- package/src/surfaces/customer-account/components/Menu.d.ts +25 -0
- package/src/surfaces/customer-account/components/Page/examples/basic-Page.example.html +19 -0
- package/src/surfaces/customer-account/components/Page.d.ts +17 -2
- package/src/surfaces/customer-account/components/Section/examples/basic-Section.example.html +12 -0
- package/src/surfaces/customer-account/components/Section.d.ts +46 -0
- package/src/surfaces/customer-account/components/StandardComponents.ts +5 -2
- package/src/surfaces/customer-account/components/shared.ts +12 -5
- package/src/surfaces/customer-account/components.d.ts +109 -83
- package/src/surfaces/customer-account/extension-targets.ts +15 -9
- package/src/surfaces/customer-account/globals.ts +4 -4
- package/src/surfaces/customer-account/preact/live-navigation.ts +1 -8
- package/src/surfaces/customer-account/preact/navigation.ts +3 -10
- package/src/surfaces/customer-account/preact/subscription.ts +7 -6
- package/src/surfaces/point-of-sale/api/action-api/action-api.ts +15 -0
- package/src/surfaces/point-of-sale/api/action-target-api/action-target-api.ts +7 -0
- package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +239 -0
- package/src/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.ts +11 -0
- package/src/surfaces/point-of-sale/api/connectivity-api/connectivity-api.ts +25 -0
- package/src/surfaces/point-of-sale/api/customer-api/customer-api.ts +10 -0
- package/src/surfaces/point-of-sale/api/device-api/device-api.ts +21 -0
- package/src/surfaces/point-of-sale/api/draft-order-api/draft-order-api.ts +20 -0
- package/src/surfaces/point-of-sale/api/locale-api/locale-api.ts +16 -0
- package/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts +55 -0
- package/src/surfaces/point-of-sale/api/order-api/order-api.ts +26 -0
- package/src/surfaces/point-of-sale/api/pin-pad-api.ts +23 -0
- package/src/surfaces/point-of-sale/api/print-api/print-api.ts +29 -0
- package/src/surfaces/point-of-sale/api/product-api/product-api.ts +14 -0
- package/src/surfaces/point-of-sale/api/product-search-api/product-search-api.ts +94 -0
- package/src/surfaces/point-of-sale/api/scanner-api/scanner-api.ts +42 -0
- package/src/surfaces/point-of-sale/api/session-api/session-api.ts +22 -0
- package/src/surfaces/point-of-sale/api/standard/standard-api.ts +21 -0
- package/src/surfaces/point-of-sale/api/storage-api/storage-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/toast-api/toast-api.ts +16 -0
- package/src/surfaces/point-of-sale/api.ts +128 -0
- package/src/surfaces/point-of-sale/components/Badge/examples/default.html +5 -0
- package/src/surfaces/point-of-sale/components/Badge.d.ts +61 -0
- package/src/surfaces/point-of-sale/components/Banner/examples/default.html +15 -0
- package/src/surfaces/point-of-sale/components/Banner.d.ts +77 -0
- package/src/surfaces/point-of-sale/components/Box/examples/default.html +3 -0
- package/src/surfaces/point-of-sale/components/Box.d.ts +175 -0
- package/src/surfaces/point-of-sale/components/Button/examples/default.html +2 -0
- package/src/surfaces/point-of-sale/components/Button.d.ts +102 -0
- package/src/surfaces/point-of-sale/components/Choice.d.ts +50 -0
- package/src/surfaces/point-of-sale/components/ChoiceList/examples/default.html +6 -0
- package/src/surfaces/point-of-sale/components/ChoiceList/examples/event-handling.jsx +8 -0
- package/src/surfaces/point-of-sale/components/ChoiceList/examples/multiple-selection.jsx +9 -0
- package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +70 -0
- package/src/surfaces/point-of-sale/components/Clickable/examples/default.html +6 -0
- package/src/surfaces/point-of-sale/components/Clickable.d.ts +66 -0
- package/src/surfaces/point-of-sale/components/DateField/examples/default.html +4 -0
- package/src/surfaces/point-of-sale/components/DateField/examples/event-handling.jsx +8 -0
- package/src/surfaces/point-of-sale/components/DateField.d.ts +78 -0
- package/src/surfaces/point-of-sale/components/DatePicker/examples/command-system.jsx +10 -0
- package/src/surfaces/point-of-sale/components/DatePicker/examples/default.html +7 -0
- package/src/surfaces/point-of-sale/components/DatePicker/examples/event-handling.jsx +7 -0
- package/src/surfaces/point-of-sale/components/DatePicker.d.ts +74 -0
- package/src/surfaces/point-of-sale/components/DateSpinner/examples/command-system.jsx +10 -0
- package/src/surfaces/point-of-sale/components/DateSpinner/examples/default.html +7 -0
- package/src/surfaces/point-of-sale/components/DateSpinner/examples/event-handling.jsx +7 -0
- package/src/surfaces/point-of-sale/components/DateSpinner.d.ts +74 -0
- package/src/surfaces/point-of-sale/components/Divider/examples/default.html +1 -0
- package/src/surfaces/point-of-sale/components/Divider.d.ts +48 -0
- package/src/surfaces/point-of-sale/components/EmailField/examples/accessory-slot.jsx +9 -0
- package/src/surfaces/point-of-sale/components/EmailField/examples/default.html +5 -0
- package/src/surfaces/point-of-sale/components/EmailField/examples/event-handling.jsx +8 -0
- package/src/surfaces/point-of-sale/components/EmailField.d.ts +95 -0
- package/src/surfaces/point-of-sale/components/Heading/examples/default.html +7 -0
- package/src/surfaces/point-of-sale/components/Heading.d.ts +52 -0
- package/src/surfaces/point-of-sale/components/Icon/examples/default.html +4 -0
- package/src/surfaces/point-of-sale/components/Icon.d.ts +183 -0
- package/src/surfaces/point-of-sale/components/Image/examples/default.html +1 -0
- package/src/surfaces/point-of-sale/components/Image.d.ts +71 -0
- package/src/surfaces/point-of-sale/components/Modal/examples/default.html +7 -0
- package/src/surfaces/point-of-sale/components/Modal.d.ts +90 -0
- package/src/surfaces/point-of-sale/components/NumberField/examples/controls-constraints.jsx +9 -0
- package/src/surfaces/point-of-sale/components/NumberField/examples/default.html +5 -0
- package/src/surfaces/point-of-sale/components/NumberField/examples/input-mode.jsx +15 -0
- package/src/surfaces/point-of-sale/components/NumberField.d.ts +159 -0
- package/src/surfaces/point-of-sale/components/Page/examples/default.html +5 -0
- package/src/surfaces/point-of-sale/components/Page.d.ts +76 -0
- package/src/surfaces/point-of-sale/components/PosBlock/examples/default.html +5 -0
- package/src/surfaces/point-of-sale/components/PosBlock.d.ts +63 -0
- package/src/surfaces/point-of-sale/components/QrCode.d.ts +47 -0
- package/src/surfaces/point-of-sale/components/ScrollBox/examples/default.html +8 -0
- package/src/surfaces/point-of-sale/components/ScrollBox.d.ts +172 -0
- package/src/surfaces/point-of-sale/components/SearchField/examples/default.html +1 -0
- package/src/surfaces/point-of-sale/components/SearchField/examples/event-handling.jsx +8 -0
- package/src/surfaces/point-of-sale/components/SearchField.d.ts +74 -0
- package/src/surfaces/point-of-sale/components/Section/examples/default.html +8 -0
- package/src/surfaces/point-of-sale/components/Section.d.ts +68 -0
- package/src/surfaces/point-of-sale/components/Stack/examples/default.html +4 -0
- package/src/surfaces/point-of-sale/components/Stack.d.ts +250 -0
- package/src/surfaces/point-of-sale/components/Text/examples/default.html +3 -0
- package/src/surfaces/point-of-sale/components/Text.d.ts +75 -0
- package/src/surfaces/point-of-sale/components/TextArea/examples/accessory-slot.jsx +9 -0
- package/src/surfaces/point-of-sale/components/TextArea/examples/default.html +4 -0
- package/src/surfaces/point-of-sale/components/TextArea/examples/event-handling.jsx +8 -0
- package/src/surfaces/point-of-sale/components/TextArea/examples/rows-configuration.jsx +7 -0
- package/src/surfaces/point-of-sale/components/TextArea.d.ts +96 -0
- package/src/surfaces/point-of-sale/components/TextField/examples/accessory-slot.jsx +5 -0
- package/src/surfaces/point-of-sale/components/TextField/examples/common-props.jsx +11 -0
- package/src/surfaces/point-of-sale/components/TextField/examples/default.html +5 -0
- package/src/surfaces/point-of-sale/components/TextField/examples/event-handling.jsx +17 -0
- package/src/surfaces/point-of-sale/components/TextField.d.ts +95 -0
- package/src/surfaces/point-of-sale/components/Tile/examples/default.html +2 -0
- package/src/surfaces/point-of-sale/components/Tile.d.ts +71 -0
- package/src/surfaces/point-of-sale/components/TimeField/examples/default.html +4 -0
- package/src/surfaces/point-of-sale/components/TimeField/examples/event-handling.jsx +8 -0
- package/src/surfaces/point-of-sale/components/TimeField.d.ts +77 -0
- package/src/surfaces/point-of-sale/components/TimePicker/examples/command-system.jsx +10 -0
- package/src/surfaces/point-of-sale/components/TimePicker/examples/default.html +7 -0
- package/src/surfaces/point-of-sale/components/TimePicker/examples/event-handling.jsx +7 -0
- package/src/surfaces/point-of-sale/components/TimePicker.d.ts +74 -0
- package/src/surfaces/point-of-sale/components/components-shared.d.ts +3210 -0
- package/src/surfaces/point-of-sale/components/targets/ActionExtensionComponents.ts +1 -0
- package/src/surfaces/point-of-sale/components/targets/BasicComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/BlockExtensionComponents.ts +18 -0
- package/src/surfaces/point-of-sale/components/targets/ReceiptComponents.ts +1 -0
- package/src/surfaces/point-of-sale/components/targets/SmartGridComponents.ts +1 -0
- package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +36 -0
- package/src/surfaces/point-of-sale/components.d.ts +6491 -0
- package/src/surfaces/point-of-sale/event/data/BaseApi.ts +3 -0
- package/src/surfaces/point-of-sale/event/data/BaseData.ts +8 -0
- package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +7 -0
- package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +17 -0
- package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +10 -0
- package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +7 -0
- package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +10 -0
- package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +8 -0
- package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +21 -0
- package/src/surfaces/point-of-sale/event/data.ts +16 -0
- package/src/surfaces/point-of-sale/event/output/BaseOutput.ts +8 -0
- package/src/surfaces/point-of-sale/event/output.ts +1 -0
- package/src/surfaces/point-of-sale/extension-targets.ts +202 -0
- package/src/surfaces/point-of-sale/globals.ts +6 -0
- package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +21 -0
- package/src/surfaces/point-of-sale/types/cart.ts +174 -0
- package/src/surfaces/point-of-sale/types/country-code.ts +249 -0
- package/src/surfaces/point-of-sale/types/device.ts +14 -0
- package/src/surfaces/point-of-sale/types/direct-api-request-body.ts +13 -0
- package/src/surfaces/point-of-sale/types/discount-allocation.ts +5 -0
- package/src/surfaces/point-of-sale/types/money.ts +9 -0
- package/src/surfaces/point-of-sale/types/multiple-resource-result.ts +14 -0
- package/src/surfaces/point-of-sale/types/order.ts +12 -0
- package/src/surfaces/point-of-sale/types/paginated-result.ts +20 -0
- package/src/surfaces/point-of-sale/types/payment.ts +16 -0
- package/src/surfaces/point-of-sale/types/pin-pad.ts +64 -0
- package/src/surfaces/point-of-sale/types/product.ts +64 -0
- package/src/surfaces/point-of-sale/types/session.ts +39 -0
- package/src/surfaces/point-of-sale/types/shipping-line.ts +18 -0
- package/src/surfaces/point-of-sale/types/storage.ts +73 -0
- package/src/surfaces/point-of-sale/types/tax-line.ts +10 -0
- package/src/surfaces/point-of-sale/types/transaction-type.ts +1 -0
- package/src/surfaces/point-of-sale.ts +4 -0
- package/build/ts/surfaces/admin/targets/admin.customers.segmentation-templates.render.d.ts +0 -3559
- package/build/ts/surfaces/checkout/errors.d.ts +0 -10
- package/build/ts/surfaces/checkout/errors.d.ts.map +0 -1
- package/src/surfaces/checkout/components/DropZone/examples/basic-dropzone.example.html +0 -1
- package/src/surfaces/checkout/components/EmailField/examples/basic-emailfield.example.html +0 -4
- package/src/surfaces/checkout/components/PaymentIcon/examples/basic-paymenticon.example.html +0 -7
- package/src/surfaces/checkout/components/PhoneField/examples/basic-phonefield.example.html +0 -2
- package/src/surfaces/checkout/components/TextField/examples/basic-textfield.example.html +0 -1
- package/src/surfaces/checkout/errors.ts +0 -13
- package/src/surfaces/customer-account/components/Avatar/examples/basic-Avatar-js.example.ts +0 -9
- package/src/surfaces/customer-account/components/Avatar/examples/basic-Avatar-preact.example.tsx +0 -9
- package/src/surfaces/customer-account/components/CustomerAccountAction/examples/basic-CustomerAccountAction-js.example.ts +0 -15
- package/src/surfaces/customer-account/components/CustomerAccountAction/examples/basic-CustomerAccountAction-preact.example.tsx +0 -16
- package/src/surfaces/customer-account/components/ImageGroup/examples/basic-ImageGroup-js.example.ts +0 -17
- package/src/surfaces/customer-account/components/ImageGroup/examples/basic-ImageGroup-preact.example.tsx +0 -15
- package/src/surfaces/customer-account/components/Page/examples/basic-Page-js.example.ts +0 -39
- package/src/surfaces/customer-account/components/Page/examples/basic-Page-preact.example.tsx +0 -36
- /package/src/surfaces/checkout/components/ClipboardItem/examples/{basic-clipboarditem.example.html → basic-clipboard-item.example.html} +0 -0
- /package/src/surfaces/checkout/components/OrderedList/examples/{basic-orderedlist.example.html → basic-ordered-list.example.html} +0 -0
- /package/src/surfaces/checkout/components/QRCode/examples/{basic-qrcode.example.html → basic-qr-code.example.html} +0 -0
- /package/src/surfaces/checkout/components/UnorderedList/examples/{basic-unorderedlist.example.html → basic-unordered-list.example.html} +0 -0
|
@@ -0,0 +1,3210 @@
|
|
|
1
|
+
/** VERSION: undefined **/
|
|
2
|
+
/* eslint-disable import-x/extensions */
|
|
3
|
+
/* eslint-disable @typescript-eslint/no-namespace */
|
|
4
|
+
/* eslint-disable @typescript-eslint/member-ordering */
|
|
5
|
+
/* eslint-disable line-comment-position */
|
|
6
|
+
/* eslint-disable @typescript-eslint/unified-signatures */
|
|
7
|
+
/* eslint-disable no-var */
|
|
8
|
+
/* eslint-disable import-x/namespace */
|
|
9
|
+
/**
|
|
10
|
+
* TODO: Update `any` type here after this is resolved
|
|
11
|
+
* https://github.com/Shopify/ui-api-design/issues/139
|
|
12
|
+
*/
|
|
13
|
+
export type ComponentChildren = any;
|
|
14
|
+
export type StringChildren = string;
|
|
15
|
+
export interface GlobalProps {
|
|
16
|
+
/**
|
|
17
|
+
* A unique identifier for the element.
|
|
18
|
+
*/
|
|
19
|
+
id?: string;
|
|
20
|
+
}
|
|
21
|
+
export interface ActionSlots {
|
|
22
|
+
/**
|
|
23
|
+
* The primary action to perform, provided as a button or link type element.
|
|
24
|
+
*/
|
|
25
|
+
primaryAction?: ComponentChildren;
|
|
26
|
+
/**
|
|
27
|
+
* The secondary actions to perform, provided as button or link type elements.
|
|
28
|
+
*/
|
|
29
|
+
secondaryActions?: ComponentChildren;
|
|
30
|
+
}
|
|
31
|
+
export interface BaseOverlayProps {
|
|
32
|
+
/**
|
|
33
|
+
* Callback fired after the overlay is shown.
|
|
34
|
+
*/
|
|
35
|
+
onShow?: (event: Event) => void;
|
|
36
|
+
/**
|
|
37
|
+
* Callback fired when the overlay is shown **after** any animations to show the overlay have finished.
|
|
38
|
+
*/
|
|
39
|
+
onAfterShow?: (event: Event) => void;
|
|
40
|
+
/**
|
|
41
|
+
* Callback fired after the overlay is hidden.
|
|
42
|
+
*/
|
|
43
|
+
onHide?: (event: Event) => void;
|
|
44
|
+
/**
|
|
45
|
+
* Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished.
|
|
46
|
+
*/
|
|
47
|
+
onAfterHide?: (event: Event) => void;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Shared interfaces for web component methods.
|
|
51
|
+
*
|
|
52
|
+
* Methods are required (not optional) because:
|
|
53
|
+
* - Components implementing this interface must provide all methods
|
|
54
|
+
* - Unlike props/attributes, methods are not rendered in HTML but are JavaScript APIs
|
|
55
|
+
* - Consumers expect these methods to be consistently available on all instances
|
|
56
|
+
*/
|
|
57
|
+
export interface BaseOverlayMethods {
|
|
58
|
+
/**
|
|
59
|
+
* Method to show an overlay.
|
|
60
|
+
*
|
|
61
|
+
* @implementation This is a method to be called on the element and not a callback and should hence be camelCase
|
|
62
|
+
*/
|
|
63
|
+
showOverlay: () => void;
|
|
64
|
+
/**
|
|
65
|
+
* Method to hide an overlay.
|
|
66
|
+
*
|
|
67
|
+
* @implementation This is a method to be called on the element and not a callback and should hence be camelCase
|
|
68
|
+
*/
|
|
69
|
+
hideOverlay: () => void;
|
|
70
|
+
/**
|
|
71
|
+
* Method to toggle the visiblity of an overlay.
|
|
72
|
+
*
|
|
73
|
+
* @implementation This is a method to be called on the element and not a callback and should hence be camelCase
|
|
74
|
+
*/
|
|
75
|
+
toggleOverlay: () => void;
|
|
76
|
+
}
|
|
77
|
+
export interface FocusEventProps {
|
|
78
|
+
/**
|
|
79
|
+
* Callback when the element loses focus.
|
|
80
|
+
*
|
|
81
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event
|
|
82
|
+
*/
|
|
83
|
+
onBlur?: (event: FocusEvent) => void;
|
|
84
|
+
/**
|
|
85
|
+
* Callback when the element receives focus.
|
|
86
|
+
*
|
|
87
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event
|
|
88
|
+
*/
|
|
89
|
+
onFocus?: (event: FocusEvent) => void;
|
|
90
|
+
}
|
|
91
|
+
export type SizeKeyword =
|
|
92
|
+
| 'small-500'
|
|
93
|
+
| 'small-400'
|
|
94
|
+
| 'small-300'
|
|
95
|
+
| 'small-200'
|
|
96
|
+
| 'small-100'
|
|
97
|
+
| 'small'
|
|
98
|
+
| 'base'
|
|
99
|
+
| 'large'
|
|
100
|
+
| 'large-100'
|
|
101
|
+
| 'large-200'
|
|
102
|
+
| 'large-300'
|
|
103
|
+
| 'large-400'
|
|
104
|
+
| 'large-500';
|
|
105
|
+
export type ColorKeyword = 'subdued' | 'base' | 'strong';
|
|
106
|
+
export type BackgroundColorKeyword = 'transparent' | ColorKeyword;
|
|
107
|
+
export interface BackgroundProps {
|
|
108
|
+
/**
|
|
109
|
+
* Adjust the background of the element.
|
|
110
|
+
*
|
|
111
|
+
* @default 'transparent'
|
|
112
|
+
*/
|
|
113
|
+
background?: BackgroundColorKeyword;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Tone is a property for defining the color treatment of a component.
|
|
117
|
+
*
|
|
118
|
+
* A tone can apply a grouping of colors to a component. For example,
|
|
119
|
+
* critical may have a specific text color and background color.
|
|
120
|
+
*
|
|
121
|
+
* In some cases, like for Banner, the tone may also affect the semantic and accessibility treatment of the component.
|
|
122
|
+
*
|
|
123
|
+
* @default 'auto'
|
|
124
|
+
*/
|
|
125
|
+
export type ToneKeyword =
|
|
126
|
+
| 'auto'
|
|
127
|
+
| 'neutral'
|
|
128
|
+
| 'info'
|
|
129
|
+
| 'success'
|
|
130
|
+
| 'caution'
|
|
131
|
+
| 'warning'
|
|
132
|
+
| 'critical'
|
|
133
|
+
| 'accent'
|
|
134
|
+
| 'custom';
|
|
135
|
+
declare const privateIconArray: readonly [
|
|
136
|
+
'adjust',
|
|
137
|
+
'affiliate',
|
|
138
|
+
'airplane',
|
|
139
|
+
'alert-bubble',
|
|
140
|
+
'alert-circle',
|
|
141
|
+
'alert-diamond',
|
|
142
|
+
'alert-location',
|
|
143
|
+
'alert-octagon',
|
|
144
|
+
'alert-octagon-filled',
|
|
145
|
+
'alert-triangle',
|
|
146
|
+
'alert-triangle-filled',
|
|
147
|
+
'app-extension',
|
|
148
|
+
'apps',
|
|
149
|
+
'archive',
|
|
150
|
+
'arrow-down',
|
|
151
|
+
'arrow-down-circle',
|
|
152
|
+
'arrow-down-right',
|
|
153
|
+
'arrow-left',
|
|
154
|
+
'arrow-left-circle',
|
|
155
|
+
'arrow-right',
|
|
156
|
+
'arrow-right-circle',
|
|
157
|
+
'arrow-up',
|
|
158
|
+
'arrow-up-circle',
|
|
159
|
+
'arrow-up-right',
|
|
160
|
+
'arrows-in-horizontal',
|
|
161
|
+
'arrows-out-horizontal',
|
|
162
|
+
'attachment',
|
|
163
|
+
'automation',
|
|
164
|
+
'backspace',
|
|
165
|
+
'bag',
|
|
166
|
+
'bank',
|
|
167
|
+
'barcode',
|
|
168
|
+
'battery-low',
|
|
169
|
+
'bill',
|
|
170
|
+
'blank',
|
|
171
|
+
'blog',
|
|
172
|
+
'bolt',
|
|
173
|
+
'bolt-filled',
|
|
174
|
+
'book',
|
|
175
|
+
'book-open',
|
|
176
|
+
'bug',
|
|
177
|
+
'bullet',
|
|
178
|
+
'business-entity',
|
|
179
|
+
'button',
|
|
180
|
+
'button-press',
|
|
181
|
+
'calculator',
|
|
182
|
+
'calendar',
|
|
183
|
+
'calendar-check',
|
|
184
|
+
'calendar-compare',
|
|
185
|
+
'calendar-list',
|
|
186
|
+
'calendar-time',
|
|
187
|
+
'camera',
|
|
188
|
+
'camera-flip',
|
|
189
|
+
'caret-down',
|
|
190
|
+
'caret-left',
|
|
191
|
+
'caret-right',
|
|
192
|
+
'caret-up',
|
|
193
|
+
'cart',
|
|
194
|
+
'cart-abandoned',
|
|
195
|
+
'cart-discount',
|
|
196
|
+
'cart-down',
|
|
197
|
+
'cart-filled',
|
|
198
|
+
'cart-sale',
|
|
199
|
+
'cart-send',
|
|
200
|
+
'cart-up',
|
|
201
|
+
'cash-dollar',
|
|
202
|
+
'cash-euro',
|
|
203
|
+
'cash-pound',
|
|
204
|
+
'cash-rupee',
|
|
205
|
+
'cash-yen',
|
|
206
|
+
'catalog-product',
|
|
207
|
+
'categories',
|
|
208
|
+
'channels',
|
|
209
|
+
'chart-cohort',
|
|
210
|
+
'chart-donut',
|
|
211
|
+
'chart-funnel',
|
|
212
|
+
'chart-histogram-first',
|
|
213
|
+
'chart-histogram-first-last',
|
|
214
|
+
'chart-histogram-flat',
|
|
215
|
+
'chart-histogram-full',
|
|
216
|
+
'chart-histogram-growth',
|
|
217
|
+
'chart-histogram-last',
|
|
218
|
+
'chart-histogram-second-last',
|
|
219
|
+
'chart-horizontal',
|
|
220
|
+
'chart-line',
|
|
221
|
+
'chart-popular',
|
|
222
|
+
'chart-stacked',
|
|
223
|
+
'chart-vertical',
|
|
224
|
+
'chat',
|
|
225
|
+
'chat-new',
|
|
226
|
+
'chat-referral',
|
|
227
|
+
'check',
|
|
228
|
+
'check-circle',
|
|
229
|
+
'check-circle-filled',
|
|
230
|
+
'checkbox',
|
|
231
|
+
'chevron-down',
|
|
232
|
+
'chevron-down-circle',
|
|
233
|
+
'chevron-left',
|
|
234
|
+
'chevron-left-circle',
|
|
235
|
+
'chevron-right',
|
|
236
|
+
'chevron-right-circle',
|
|
237
|
+
'chevron-up',
|
|
238
|
+
'chevron-up-circle',
|
|
239
|
+
'circle',
|
|
240
|
+
'circle-dashed',
|
|
241
|
+
'clipboard',
|
|
242
|
+
'clipboard-check',
|
|
243
|
+
'clipboard-checklist',
|
|
244
|
+
'clock',
|
|
245
|
+
'clock-revert',
|
|
246
|
+
'code',
|
|
247
|
+
'code-add',
|
|
248
|
+
'collection',
|
|
249
|
+
'collection-featured',
|
|
250
|
+
'collection-list',
|
|
251
|
+
'collection-reference',
|
|
252
|
+
'color',
|
|
253
|
+
'color-none',
|
|
254
|
+
'compass',
|
|
255
|
+
'complete',
|
|
256
|
+
'compose',
|
|
257
|
+
'confetti',
|
|
258
|
+
'connect',
|
|
259
|
+
'content',
|
|
260
|
+
'contract',
|
|
261
|
+
'corner-pill',
|
|
262
|
+
'corner-round',
|
|
263
|
+
'corner-square',
|
|
264
|
+
'credit-card',
|
|
265
|
+
'credit-card-cancel',
|
|
266
|
+
'credit-card-percent',
|
|
267
|
+
'credit-card-reader',
|
|
268
|
+
'credit-card-reader-chip',
|
|
269
|
+
'credit-card-reader-tap',
|
|
270
|
+
'credit-card-secure',
|
|
271
|
+
'credit-card-tap-chip',
|
|
272
|
+
'crop',
|
|
273
|
+
'currency-convert',
|
|
274
|
+
'cursor',
|
|
275
|
+
'cursor-banner',
|
|
276
|
+
'cursor-option',
|
|
277
|
+
'data-presentation',
|
|
278
|
+
'data-table',
|
|
279
|
+
'database',
|
|
280
|
+
'database-add',
|
|
281
|
+
'database-connect',
|
|
282
|
+
'delete',
|
|
283
|
+
'delivered',
|
|
284
|
+
'delivery',
|
|
285
|
+
'desktop',
|
|
286
|
+
'disabled',
|
|
287
|
+
'disabled-filled',
|
|
288
|
+
'discount',
|
|
289
|
+
'discount-add',
|
|
290
|
+
'discount-automatic',
|
|
291
|
+
'discount-code',
|
|
292
|
+
'discount-remove',
|
|
293
|
+
'dns-settings',
|
|
294
|
+
'dock-floating',
|
|
295
|
+
'dock-side',
|
|
296
|
+
'domain',
|
|
297
|
+
'domain-landing-page',
|
|
298
|
+
'domain-new',
|
|
299
|
+
'domain-redirect',
|
|
300
|
+
'download',
|
|
301
|
+
'drag-drop',
|
|
302
|
+
'drag-handle',
|
|
303
|
+
'drawer',
|
|
304
|
+
'duplicate',
|
|
305
|
+
'edit',
|
|
306
|
+
'email',
|
|
307
|
+
'email-follow-up',
|
|
308
|
+
'email-newsletter',
|
|
309
|
+
'empty',
|
|
310
|
+
'enabled',
|
|
311
|
+
'enter',
|
|
312
|
+
'envelope',
|
|
313
|
+
'envelope-soft-pack',
|
|
314
|
+
'eraser',
|
|
315
|
+
'exchange',
|
|
316
|
+
'exit',
|
|
317
|
+
'export',
|
|
318
|
+
'external',
|
|
319
|
+
'eye-check-mark',
|
|
320
|
+
'eye-dropper',
|
|
321
|
+
'eye-dropper-list',
|
|
322
|
+
'eye-first',
|
|
323
|
+
'eyeglasses',
|
|
324
|
+
'fav',
|
|
325
|
+
'favicon',
|
|
326
|
+
'file',
|
|
327
|
+
'file-list',
|
|
328
|
+
'filter',
|
|
329
|
+
'filter-active',
|
|
330
|
+
'flag',
|
|
331
|
+
'flip-horizontal',
|
|
332
|
+
'flip-vertical',
|
|
333
|
+
'flower',
|
|
334
|
+
'folder',
|
|
335
|
+
'folder-add',
|
|
336
|
+
'folder-down',
|
|
337
|
+
'folder-remove',
|
|
338
|
+
'folder-up',
|
|
339
|
+
'food',
|
|
340
|
+
'foreground',
|
|
341
|
+
'forklift',
|
|
342
|
+
'forms',
|
|
343
|
+
'games',
|
|
344
|
+
'gauge',
|
|
345
|
+
'geolocation',
|
|
346
|
+
'gift',
|
|
347
|
+
'gift-card',
|
|
348
|
+
'git-branch',
|
|
349
|
+
'git-commit',
|
|
350
|
+
'git-repository',
|
|
351
|
+
'globe',
|
|
352
|
+
'globe-asia',
|
|
353
|
+
'globe-europe',
|
|
354
|
+
'globe-lines',
|
|
355
|
+
'globe-list',
|
|
356
|
+
'graduation-hat',
|
|
357
|
+
'grid',
|
|
358
|
+
'hashtag',
|
|
359
|
+
'hashtag-decimal',
|
|
360
|
+
'hashtag-list',
|
|
361
|
+
'heart',
|
|
362
|
+
'hide',
|
|
363
|
+
'hide-filled',
|
|
364
|
+
'home',
|
|
365
|
+
'home-filled',
|
|
366
|
+
'icons',
|
|
367
|
+
'identity-card',
|
|
368
|
+
'image',
|
|
369
|
+
'image-add',
|
|
370
|
+
'image-alt',
|
|
371
|
+
'image-explore',
|
|
372
|
+
'image-magic',
|
|
373
|
+
'image-none',
|
|
374
|
+
'image-with-text-overlay',
|
|
375
|
+
'images',
|
|
376
|
+
'import',
|
|
377
|
+
'in-progress',
|
|
378
|
+
'incentive',
|
|
379
|
+
'incoming',
|
|
380
|
+
'incomplete',
|
|
381
|
+
'info',
|
|
382
|
+
'info-filled',
|
|
383
|
+
'inheritance',
|
|
384
|
+
'inventory',
|
|
385
|
+
'inventory-edit',
|
|
386
|
+
'inventory-list',
|
|
387
|
+
'inventory-transfer',
|
|
388
|
+
'inventory-updated',
|
|
389
|
+
'iq',
|
|
390
|
+
'key',
|
|
391
|
+
'keyboard',
|
|
392
|
+
'keyboard-filled',
|
|
393
|
+
'keyboard-hide',
|
|
394
|
+
'keypad',
|
|
395
|
+
'label-printer',
|
|
396
|
+
'language',
|
|
397
|
+
'language-translate',
|
|
398
|
+
'layout-block',
|
|
399
|
+
'layout-buy-button',
|
|
400
|
+
'layout-buy-button-horizontal',
|
|
401
|
+
'layout-buy-button-vertical',
|
|
402
|
+
'layout-column-1',
|
|
403
|
+
'layout-columns-2',
|
|
404
|
+
'layout-columns-3',
|
|
405
|
+
'layout-footer',
|
|
406
|
+
'layout-header',
|
|
407
|
+
'layout-logo-block',
|
|
408
|
+
'layout-popup',
|
|
409
|
+
'layout-rows-2',
|
|
410
|
+
'layout-section',
|
|
411
|
+
'layout-sidebar-left',
|
|
412
|
+
'layout-sidebar-right',
|
|
413
|
+
'lightbulb',
|
|
414
|
+
'link',
|
|
415
|
+
'link-list',
|
|
416
|
+
'list-bulleted',
|
|
417
|
+
'list-bulleted-filled',
|
|
418
|
+
'list-numbered',
|
|
419
|
+
'live',
|
|
420
|
+
'live-critical',
|
|
421
|
+
'live-none',
|
|
422
|
+
'location',
|
|
423
|
+
'location-none',
|
|
424
|
+
'lock',
|
|
425
|
+
'map',
|
|
426
|
+
'markets',
|
|
427
|
+
'markets-euro',
|
|
428
|
+
'markets-rupee',
|
|
429
|
+
'markets-yen',
|
|
430
|
+
'maximize',
|
|
431
|
+
'measurement-size',
|
|
432
|
+
'measurement-size-list',
|
|
433
|
+
'measurement-volume',
|
|
434
|
+
'measurement-volume-list',
|
|
435
|
+
'measurement-weight',
|
|
436
|
+
'measurement-weight-list',
|
|
437
|
+
'media-receiver',
|
|
438
|
+
'megaphone',
|
|
439
|
+
'mention',
|
|
440
|
+
'menu',
|
|
441
|
+
'menu-filled',
|
|
442
|
+
'menu-horizontal',
|
|
443
|
+
'menu-vertical',
|
|
444
|
+
'merge',
|
|
445
|
+
'metafields',
|
|
446
|
+
'metaobject',
|
|
447
|
+
'metaobject-list',
|
|
448
|
+
'metaobject-reference',
|
|
449
|
+
'microphone',
|
|
450
|
+
'minimize',
|
|
451
|
+
'minus',
|
|
452
|
+
'minus-circle',
|
|
453
|
+
'mobile',
|
|
454
|
+
'money',
|
|
455
|
+
'money-none',
|
|
456
|
+
'money-split',
|
|
457
|
+
'moon',
|
|
458
|
+
'nature',
|
|
459
|
+
'note',
|
|
460
|
+
'note-add',
|
|
461
|
+
'notification',
|
|
462
|
+
'order',
|
|
463
|
+
'order-batches',
|
|
464
|
+
'order-draft',
|
|
465
|
+
'order-filled',
|
|
466
|
+
'order-first',
|
|
467
|
+
'order-fulfilled',
|
|
468
|
+
'order-repeat',
|
|
469
|
+
'order-unfulfilled',
|
|
470
|
+
'orders-status',
|
|
471
|
+
'organization',
|
|
472
|
+
'outdent',
|
|
473
|
+
'outgoing',
|
|
474
|
+
'package',
|
|
475
|
+
'package-cancel',
|
|
476
|
+
'package-fulfilled',
|
|
477
|
+
'package-on-hold',
|
|
478
|
+
'package-reassign',
|
|
479
|
+
'package-returned',
|
|
480
|
+
'page',
|
|
481
|
+
'page-add',
|
|
482
|
+
'page-attachment',
|
|
483
|
+
'page-clock',
|
|
484
|
+
'page-down',
|
|
485
|
+
'page-heart',
|
|
486
|
+
'page-list',
|
|
487
|
+
'page-reference',
|
|
488
|
+
'page-remove',
|
|
489
|
+
'page-report',
|
|
490
|
+
'page-up',
|
|
491
|
+
'pagination-end',
|
|
492
|
+
'pagination-start',
|
|
493
|
+
'paint-brush-flat',
|
|
494
|
+
'paint-brush-round',
|
|
495
|
+
'paper-check',
|
|
496
|
+
'partially-complete',
|
|
497
|
+
'passkey',
|
|
498
|
+
'paste',
|
|
499
|
+
'pause-circle',
|
|
500
|
+
'payment',
|
|
501
|
+
'payment-capture',
|
|
502
|
+
'payout',
|
|
503
|
+
'payout-dollar',
|
|
504
|
+
'payout-euro',
|
|
505
|
+
'payout-pound',
|
|
506
|
+
'payout-rupee',
|
|
507
|
+
'payout-yen',
|
|
508
|
+
'person',
|
|
509
|
+
'person-add',
|
|
510
|
+
'person-exit',
|
|
511
|
+
'person-filled',
|
|
512
|
+
'person-list',
|
|
513
|
+
'person-lock',
|
|
514
|
+
'person-remove',
|
|
515
|
+
'person-segment',
|
|
516
|
+
'personalized-text',
|
|
517
|
+
'phablet',
|
|
518
|
+
'phone',
|
|
519
|
+
'phone-in',
|
|
520
|
+
'phone-out',
|
|
521
|
+
'pin',
|
|
522
|
+
'pin-remove',
|
|
523
|
+
'plan',
|
|
524
|
+
'play',
|
|
525
|
+
'play-circle',
|
|
526
|
+
'plus',
|
|
527
|
+
'plus-circle',
|
|
528
|
+
'plus-circle-down',
|
|
529
|
+
'plus-circle-filled',
|
|
530
|
+
'plus-circle-up',
|
|
531
|
+
'point-of-sale',
|
|
532
|
+
'point-of-sale-register',
|
|
533
|
+
'price-list',
|
|
534
|
+
'print',
|
|
535
|
+
'product',
|
|
536
|
+
'product-add',
|
|
537
|
+
'product-cost',
|
|
538
|
+
'product-filled',
|
|
539
|
+
'product-list',
|
|
540
|
+
'product-reference',
|
|
541
|
+
'product-remove',
|
|
542
|
+
'product-return',
|
|
543
|
+
'product-unavailable',
|
|
544
|
+
'profile',
|
|
545
|
+
'profile-filled',
|
|
546
|
+
'question-circle',
|
|
547
|
+
'question-circle-filled',
|
|
548
|
+
'receipt',
|
|
549
|
+
'receipt-dollar',
|
|
550
|
+
'receipt-euro',
|
|
551
|
+
'receipt-folded',
|
|
552
|
+
'receipt-paid',
|
|
553
|
+
'receipt-pound',
|
|
554
|
+
'receipt-refund',
|
|
555
|
+
'receipt-rupee',
|
|
556
|
+
'receipt-yen',
|
|
557
|
+
'receivables',
|
|
558
|
+
'redo',
|
|
559
|
+
'referral-code',
|
|
560
|
+
'refresh',
|
|
561
|
+
'remove-background',
|
|
562
|
+
'reorder',
|
|
563
|
+
'replace',
|
|
564
|
+
'replay',
|
|
565
|
+
'reset',
|
|
566
|
+
'return',
|
|
567
|
+
'reward',
|
|
568
|
+
'rocket',
|
|
569
|
+
'rotate-left',
|
|
570
|
+
'rotate-right',
|
|
571
|
+
'sandbox',
|
|
572
|
+
'save',
|
|
573
|
+
'savings',
|
|
574
|
+
'scan-qr-code',
|
|
575
|
+
'search',
|
|
576
|
+
'search-add',
|
|
577
|
+
'search-list',
|
|
578
|
+
'search-recent',
|
|
579
|
+
'search-resource',
|
|
580
|
+
'select',
|
|
581
|
+
'send',
|
|
582
|
+
'settings',
|
|
583
|
+
'share',
|
|
584
|
+
'shield-check-mark',
|
|
585
|
+
'shield-none',
|
|
586
|
+
'shield-pending',
|
|
587
|
+
'shield-person',
|
|
588
|
+
'shipping-label',
|
|
589
|
+
'shipping-label-cancel',
|
|
590
|
+
'shopcodes',
|
|
591
|
+
'slideshow',
|
|
592
|
+
'smiley-happy',
|
|
593
|
+
'smiley-joy',
|
|
594
|
+
'smiley-neutral',
|
|
595
|
+
'smiley-sad',
|
|
596
|
+
'social-ad',
|
|
597
|
+
'social-post',
|
|
598
|
+
'sort',
|
|
599
|
+
'sort-ascending',
|
|
600
|
+
'sort-descending',
|
|
601
|
+
'sound',
|
|
602
|
+
'sports',
|
|
603
|
+
'star',
|
|
604
|
+
'star-circle',
|
|
605
|
+
'star-filled',
|
|
606
|
+
'star-half',
|
|
607
|
+
'star-list',
|
|
608
|
+
'status',
|
|
609
|
+
'status-active',
|
|
610
|
+
'stop-circle',
|
|
611
|
+
'store',
|
|
612
|
+
'store-import',
|
|
613
|
+
'store-managed',
|
|
614
|
+
'store-online',
|
|
615
|
+
'sun',
|
|
616
|
+
'table',
|
|
617
|
+
'table-masonry',
|
|
618
|
+
'tablet',
|
|
619
|
+
'target',
|
|
620
|
+
'tax',
|
|
621
|
+
'team',
|
|
622
|
+
'text',
|
|
623
|
+
'text-align-center',
|
|
624
|
+
'text-align-left',
|
|
625
|
+
'text-align-right',
|
|
626
|
+
'text-block',
|
|
627
|
+
'text-bold',
|
|
628
|
+
'text-color',
|
|
629
|
+
'text-font',
|
|
630
|
+
'text-font-list',
|
|
631
|
+
'text-grammar',
|
|
632
|
+
'text-in-columns',
|
|
633
|
+
'text-in-rows',
|
|
634
|
+
'text-indent',
|
|
635
|
+
'text-indent-remove',
|
|
636
|
+
'text-italic',
|
|
637
|
+
'text-quote',
|
|
638
|
+
'text-title',
|
|
639
|
+
'text-underline',
|
|
640
|
+
'text-with-image',
|
|
641
|
+
'theme',
|
|
642
|
+
'theme-edit',
|
|
643
|
+
'theme-store',
|
|
644
|
+
'theme-template',
|
|
645
|
+
'three-d-environment',
|
|
646
|
+
'thumbs-down',
|
|
647
|
+
'thumbs-up',
|
|
648
|
+
'tip-jar',
|
|
649
|
+
'toggle-off',
|
|
650
|
+
'toggle-on',
|
|
651
|
+
'transaction',
|
|
652
|
+
'transaction-fee-add',
|
|
653
|
+
'transaction-fee-dollar',
|
|
654
|
+
'transaction-fee-euro',
|
|
655
|
+
'transaction-fee-pound',
|
|
656
|
+
'transaction-fee-rupee',
|
|
657
|
+
'transaction-fee-yen',
|
|
658
|
+
'transfer',
|
|
659
|
+
'transfer-in',
|
|
660
|
+
'transfer-internal',
|
|
661
|
+
'transfer-out',
|
|
662
|
+
'truck',
|
|
663
|
+
'undo',
|
|
664
|
+
'unknown-device',
|
|
665
|
+
'unlock',
|
|
666
|
+
'upload',
|
|
667
|
+
'variant',
|
|
668
|
+
'view',
|
|
669
|
+
'viewport-narrow',
|
|
670
|
+
'viewport-short',
|
|
671
|
+
'viewport-tall',
|
|
672
|
+
'viewport-wide',
|
|
673
|
+
'wallet',
|
|
674
|
+
'wand',
|
|
675
|
+
'watch',
|
|
676
|
+
'wifi',
|
|
677
|
+
'work',
|
|
678
|
+
'work-list',
|
|
679
|
+
'wrench',
|
|
680
|
+
'x',
|
|
681
|
+
'x-circle',
|
|
682
|
+
'x-circle-filled',
|
|
683
|
+
];
|
|
684
|
+
export type IconType = (typeof privateIconArray)[number];
|
|
685
|
+
/**
|
|
686
|
+
* Like `Extract`, but ensures that the extracted type is a strict subtype of the input type.
|
|
687
|
+
*/
|
|
688
|
+
export type ExtractStrict<T, U extends T> = Extract<T, U>;
|
|
689
|
+
export type MaybeAllValuesShorthandProperty<T extends string> =
|
|
690
|
+
| T
|
|
691
|
+
| `${T} ${T}`
|
|
692
|
+
| `${T} ${T} ${T}`
|
|
693
|
+
| `${T} ${T} ${T} ${T}`;
|
|
694
|
+
export type MaybeTwoValuesShorthandProperty<T extends string> = T | `${T} ${T}`;
|
|
695
|
+
export type MaybeResponsive<T> = T | `@container${string}`;
|
|
696
|
+
/**
|
|
697
|
+
* Prevents widening string literal types in a union to `string`.
|
|
698
|
+
* @example
|
|
699
|
+
* type PropName = 'foo' | 'bar' | string
|
|
700
|
+
* // ^? string
|
|
701
|
+
* type PropName = 'foo' | 'bar' | (string & {})
|
|
702
|
+
* // ^? 'foo' | 'bar' | (string & {})
|
|
703
|
+
*/
|
|
704
|
+
export type AnyString = string & {};
|
|
705
|
+
/**
|
|
706
|
+
* This is purely to give the ability
|
|
707
|
+
* to have a space or not in the string literal types.
|
|
708
|
+
*
|
|
709
|
+
* For example in the `aspectRatio` property, `16/9` and `16 / 9` are both valid.
|
|
710
|
+
*/
|
|
711
|
+
export type optionalSpace = '' | ' ';
|
|
712
|
+
export interface BadgeProps extends GlobalProps {
|
|
713
|
+
/**
|
|
714
|
+
* The content of the Badge.
|
|
715
|
+
*/
|
|
716
|
+
children?: ComponentChildren;
|
|
717
|
+
/**
|
|
718
|
+
* Sets the tone of the Badge, based on the intention of the information being conveyed.
|
|
719
|
+
*
|
|
720
|
+
* @default 'auto'
|
|
721
|
+
*/
|
|
722
|
+
tone?: ToneKeyword;
|
|
723
|
+
/**
|
|
724
|
+
* Modify the color to be more or less intense.
|
|
725
|
+
*
|
|
726
|
+
* @default 'base'
|
|
727
|
+
*/
|
|
728
|
+
color?: ColorKeyword;
|
|
729
|
+
/**
|
|
730
|
+
* The type of icon to be displayed in the badge.
|
|
731
|
+
*
|
|
732
|
+
* @default ''
|
|
733
|
+
*/
|
|
734
|
+
icon?: IconType | AnyString;
|
|
735
|
+
/**
|
|
736
|
+
* The position of the icon in relation to the text.
|
|
737
|
+
*/
|
|
738
|
+
iconPosition?: 'start' | 'end';
|
|
739
|
+
/**
|
|
740
|
+
* Adjusts the size.
|
|
741
|
+
*
|
|
742
|
+
* @default 'base'
|
|
743
|
+
*/
|
|
744
|
+
size?: SizeKeyword;
|
|
745
|
+
}
|
|
746
|
+
export interface BannerProps extends GlobalProps, ActionSlots {
|
|
747
|
+
/**
|
|
748
|
+
* The title of the banner.
|
|
749
|
+
*
|
|
750
|
+
* @default ''
|
|
751
|
+
*/
|
|
752
|
+
heading?: string;
|
|
753
|
+
/**
|
|
754
|
+
* The content of the Banner.
|
|
755
|
+
*/
|
|
756
|
+
children?: ComponentChildren;
|
|
757
|
+
/**
|
|
758
|
+
* Sets the tone of the Banner, based on the intention of the information being conveyed.
|
|
759
|
+
*
|
|
760
|
+
* The banner is a live region and the type of status will be dictated by the Tone selected.
|
|
761
|
+
*
|
|
762
|
+
* - `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.
|
|
763
|
+
* - `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.
|
|
764
|
+
*
|
|
765
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions
|
|
766
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role
|
|
767
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role
|
|
768
|
+
*
|
|
769
|
+
* @default 'auto'
|
|
770
|
+
*/
|
|
771
|
+
tone?: ToneKeyword;
|
|
772
|
+
/**
|
|
773
|
+
* Makes the content collapsible.
|
|
774
|
+
* A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.
|
|
775
|
+
*
|
|
776
|
+
* @default false
|
|
777
|
+
*/
|
|
778
|
+
collapsible?: boolean;
|
|
779
|
+
/**
|
|
780
|
+
* Determines whether the close button of the banner is present.
|
|
781
|
+
*
|
|
782
|
+
* When the close button is pressed, the `dismiss` event will fire,
|
|
783
|
+
* then `hidden` will be true,
|
|
784
|
+
* any animation will complete,
|
|
785
|
+
* and the `afterhide` event will fire.
|
|
786
|
+
*
|
|
787
|
+
* @default false
|
|
788
|
+
*/
|
|
789
|
+
dismissible?: boolean;
|
|
790
|
+
/**
|
|
791
|
+
* Event handler when the banner is dismissed by the user.
|
|
792
|
+
*
|
|
793
|
+
* This does not fire when setting `hidden` manually.
|
|
794
|
+
*
|
|
795
|
+
* The `hidden` property will be `false` when this event fires.
|
|
796
|
+
*/
|
|
797
|
+
onDismiss?: (event: Event) => void;
|
|
798
|
+
/**
|
|
799
|
+
* Event handler when the banner has fully hidden.
|
|
800
|
+
*
|
|
801
|
+
* The `hidden` property will be `true` when this event fires.
|
|
802
|
+
*
|
|
803
|
+
* @implementation If implementations animate the hiding of the banner,
|
|
804
|
+
* this event must fire after the banner has fully hidden.
|
|
805
|
+
* We can add an `onHide` event in future if we want to provide a hook for the start of the animation.
|
|
806
|
+
*/
|
|
807
|
+
onAfterHide?: (event: Event) => void;
|
|
808
|
+
/**
|
|
809
|
+
* Determines whether the banner is hidden.
|
|
810
|
+
*
|
|
811
|
+
* If this property is being set on each framework render (as in 'controlled' usage),
|
|
812
|
+
* and the banner is `dismissible`,
|
|
813
|
+
* ensure you update app state for this property when the `dismiss` event fires.
|
|
814
|
+
*
|
|
815
|
+
* If the banner is not `dismissible`, it can still be hidden by setting this property.
|
|
816
|
+
*
|
|
817
|
+
* @default false
|
|
818
|
+
*/
|
|
819
|
+
hidden?: boolean;
|
|
820
|
+
}
|
|
821
|
+
export interface DisplayProps {
|
|
822
|
+
/**
|
|
823
|
+
* Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).
|
|
824
|
+
*
|
|
825
|
+
* - `auto`: the component’s initial value. The actual value depends on the component and context.
|
|
826
|
+
* - `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
|
|
827
|
+
*
|
|
828
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/display
|
|
829
|
+
* @default 'auto'
|
|
830
|
+
*/
|
|
831
|
+
display?: MaybeResponsive<'auto' | 'none'>;
|
|
832
|
+
}
|
|
833
|
+
export interface AccessibilityRoleProps {
|
|
834
|
+
/**
|
|
835
|
+
* Sets the semantic meaning of the component’s content. When set,
|
|
836
|
+
* the role will be used by assistive technologies to help users
|
|
837
|
+
* navigate the page.
|
|
838
|
+
*
|
|
839
|
+
* @implementation Although, in HTML hosts, this property changes the element used,
|
|
840
|
+
* changing this property must not impact the visual styling of inside or outside of the box.
|
|
841
|
+
*
|
|
842
|
+
* @default 'generic'
|
|
843
|
+
*/
|
|
844
|
+
accessibilityRole?: AccessibilityRole;
|
|
845
|
+
}
|
|
846
|
+
export type AccessibilityRole =
|
|
847
|
+
/**
|
|
848
|
+
* Used to indicate the primary content.
|
|
849
|
+
*
|
|
850
|
+
* In an HTML host, `main` will render a `<main>` element.
|
|
851
|
+
* Learn more about the [`<main>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/main) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/main_role) in the MDN web docs.
|
|
852
|
+
*/
|
|
853
|
+
| 'main'
|
|
854
|
+
/**
|
|
855
|
+
* Used to indicate the component is a header.
|
|
856
|
+
*
|
|
857
|
+
* In an HTML host `header` will render a `<header>` element.
|
|
858
|
+
* Learn more about the [`<header>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/main_role) in the MDN web docs.
|
|
859
|
+
*/
|
|
860
|
+
| 'header'
|
|
861
|
+
/**
|
|
862
|
+
* Used to display information such as copyright information, navigation links, and privacy statements.
|
|
863
|
+
*
|
|
864
|
+
* In an HTML host `footer` will render a `<footer>` element.
|
|
865
|
+
* Learn more about the [`<footer>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/footer) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/contentinfo_role) in the MDN web docs.
|
|
866
|
+
*/
|
|
867
|
+
| 'footer'
|
|
868
|
+
/**
|
|
869
|
+
* Used to indicate a generic section.
|
|
870
|
+
* Sections should always have a `Heading` or an accessible name provided in the `accessibilityLabel` property.
|
|
871
|
+
*
|
|
872
|
+
* In an HTML host `section` will render a `<section>` element.
|
|
873
|
+
* Learn more about the [`<section>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/section) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/region_role) in the MDN web docs.
|
|
874
|
+
*
|
|
875
|
+
*/
|
|
876
|
+
| 'section'
|
|
877
|
+
/**
|
|
878
|
+
* Used to designate a supporting section that relates to the main content.
|
|
879
|
+
*
|
|
880
|
+
* In an HTML host `aside` will render an `<aside>` element.
|
|
881
|
+
* Learn more about the [`<aside>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/aside) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/complementary_role) in the MDN web docs.
|
|
882
|
+
*/
|
|
883
|
+
| 'aside'
|
|
884
|
+
/**
|
|
885
|
+
* Used to identify major groups of links used for navigating.
|
|
886
|
+
*
|
|
887
|
+
* In an HTML host `navigation` will render a `<nav>` element.
|
|
888
|
+
* Learn more about the [`<nav>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/nav) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/navigation_role) in the MDN web docs.
|
|
889
|
+
*/
|
|
890
|
+
| 'navigation'
|
|
891
|
+
/**
|
|
892
|
+
* Used to identify a list of ordered items.
|
|
893
|
+
*
|
|
894
|
+
* In an HTML host `ordered-list` will render a `<ol>` element.
|
|
895
|
+
* Learn more about the [`<ol>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ol) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/list_role) in the MDN web docs.
|
|
896
|
+
*/
|
|
897
|
+
| 'ordered-list'
|
|
898
|
+
/**
|
|
899
|
+
* Used to identify an item inside a list of items.
|
|
900
|
+
*
|
|
901
|
+
* In an HTML host `list-item` will render a `<li>` element.
|
|
902
|
+
* Learn more about the [`<li>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/li) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/listitem_role) in the MDN web docs.
|
|
903
|
+
*/
|
|
904
|
+
| 'list-item'
|
|
905
|
+
/**
|
|
906
|
+
* Used to indicates the component acts as a divider that separates and distinguishes sections of content in a list of items.
|
|
907
|
+
*
|
|
908
|
+
* In an HTML host `list-item-separator` will render as `<li role="separator">`.
|
|
909
|
+
* Learn more about the [`<li>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/li) and the [`separator` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/separator_role) in the MDN web docs.
|
|
910
|
+
*/
|
|
911
|
+
| 'list-item-separator'
|
|
912
|
+
/**
|
|
913
|
+
* Used to identify a list of unordered items.
|
|
914
|
+
*
|
|
915
|
+
* In an HTML host `unordered-list` will render a `<ul>` element.
|
|
916
|
+
* Learn more about the [`<ul>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ul) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/list_role) in the MDN web docs.
|
|
917
|
+
*/
|
|
918
|
+
| 'unordered-list'
|
|
919
|
+
/**
|
|
920
|
+
* Used to indicates the component acts as a divider that separates and distinguishes sections of content.
|
|
921
|
+
*
|
|
922
|
+
* In an HTML host `separator` will render as `<div role="separator">`.
|
|
923
|
+
* Learn more about the [`separator` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/separator_role) in the MDN web docs.
|
|
924
|
+
*/
|
|
925
|
+
| 'separator'
|
|
926
|
+
/**
|
|
927
|
+
* Used to define a live region containing advisory information for the user that is not important enough to be an alert.
|
|
928
|
+
*
|
|
929
|
+
* In an HTML host `status` will render as `<div role="status">`.
|
|
930
|
+
* Learn more about the [`status` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) in the MDN web docs.
|
|
931
|
+
*/
|
|
932
|
+
| 'status'
|
|
933
|
+
/**
|
|
934
|
+
* Used for important, and usually time-sensitive, information.
|
|
935
|
+
*
|
|
936
|
+
* In an HTML host `alert` will render as `<div role="alert">`.
|
|
937
|
+
* Learn more about the [`alert` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) in the MDN web docs.
|
|
938
|
+
*/
|
|
939
|
+
| 'alert'
|
|
940
|
+
/**
|
|
941
|
+
* Used to create a nameless container element which has no semantic meaning on its own.
|
|
942
|
+
*
|
|
943
|
+
* In an HTML host `generic'` will render a `<div>` element.
|
|
944
|
+
* Learn more about the [`generic` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/generic_role) in the MDN web docs.
|
|
945
|
+
*/
|
|
946
|
+
| 'generic'
|
|
947
|
+
/**
|
|
948
|
+
* Used to strip the semantic meaning of an element, but leave the visual styling intact.
|
|
949
|
+
*
|
|
950
|
+
* Synonym for `none`
|
|
951
|
+
* Learn more about the [`presentation` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/presentation_role) in the MDN web docs.
|
|
952
|
+
*/
|
|
953
|
+
| 'presentation'
|
|
954
|
+
/**
|
|
955
|
+
* Used to strip the semantic meaning of an element, but leave the visual styling intact.
|
|
956
|
+
*
|
|
957
|
+
* Synonym for `presentation`
|
|
958
|
+
* Learn more about the [`none` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/none_role) in the MDN web docs.
|
|
959
|
+
*/
|
|
960
|
+
| 'none';
|
|
961
|
+
export interface AccessibilityVisibilityProps {
|
|
962
|
+
/**
|
|
963
|
+
* Changes the visibility of the element.
|
|
964
|
+
*
|
|
965
|
+
* - `visible`: the element is visible to all users.
|
|
966
|
+
* - `hidden`: the element is removed from the accessibility tree but remains visible.
|
|
967
|
+
* - `exclusive`: the element is visually hidden but remains in the accessibility tree.
|
|
968
|
+
*
|
|
969
|
+
* @default 'visible'
|
|
970
|
+
*/
|
|
971
|
+
accessibilityVisibility?: 'visible' | 'hidden' | 'exclusive';
|
|
972
|
+
}
|
|
973
|
+
export interface LabelAccessibilityVisibilityProps {
|
|
974
|
+
/**
|
|
975
|
+
* Changes the visibility of the component's label.
|
|
976
|
+
*
|
|
977
|
+
* - `visible`: the label is visible to all users.
|
|
978
|
+
* - `exclusive`: the label is visually hidden but remains in the accessibility tree.
|
|
979
|
+
*
|
|
980
|
+
* @default 'visible'
|
|
981
|
+
*/
|
|
982
|
+
labelAccessibilityVisibility?: ExtractStrict<
|
|
983
|
+
AccessibilityVisibilityProps['accessibilityVisibility'],
|
|
984
|
+
'visible' | 'exclusive'
|
|
985
|
+
>;
|
|
986
|
+
}
|
|
987
|
+
export type PaddingKeyword = SizeKeyword | 'none';
|
|
988
|
+
export interface PaddingProps {
|
|
989
|
+
/**
|
|
990
|
+
* Adjust the padding of all edges.
|
|
991
|
+
*
|
|
992
|
+
* [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
|
|
993
|
+
* supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
|
|
994
|
+
*
|
|
995
|
+
* - 4 values: `block-start inline-end block-end inline-start`
|
|
996
|
+
* - 3 values: `block-start inline block-end`
|
|
997
|
+
* - 2 values: `block inline`
|
|
998
|
+
*
|
|
999
|
+
* For example:
|
|
1000
|
+
* - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
|
|
1001
|
+
* - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
|
|
1002
|
+
* - `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.
|
|
1003
|
+
* - `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.
|
|
1004
|
+
*
|
|
1005
|
+
* A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
|
|
1006
|
+
*
|
|
1007
|
+
* @default 'none'
|
|
1008
|
+
*/
|
|
1009
|
+
padding?: MaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>;
|
|
1010
|
+
/**
|
|
1011
|
+
* Adjust the block-padding.
|
|
1012
|
+
*
|
|
1013
|
+
* - `large none` means block-start padding is `large`, block-end padding is `none`.
|
|
1014
|
+
*
|
|
1015
|
+
* This overrides the block value of `padding`.
|
|
1016
|
+
*
|
|
1017
|
+
* @default '' - meaning no override
|
|
1018
|
+
*/
|
|
1019
|
+
paddingBlock?: MaybeResponsive<
|
|
1020
|
+
MaybeTwoValuesShorthandProperty<PaddingKeyword> | ''
|
|
1021
|
+
>;
|
|
1022
|
+
/**
|
|
1023
|
+
* Adjust the block-start padding.
|
|
1024
|
+
*
|
|
1025
|
+
* This overrides the block-start value of `paddingBlock`.
|
|
1026
|
+
*
|
|
1027
|
+
* @default '' - meaning no override
|
|
1028
|
+
*/
|
|
1029
|
+
paddingBlockStart?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1030
|
+
/**
|
|
1031
|
+
* Adjust the block-end padding.
|
|
1032
|
+
*
|
|
1033
|
+
* This overrides the block-end value of `paddingBlock`.
|
|
1034
|
+
*
|
|
1035
|
+
* @default '' - meaning no override
|
|
1036
|
+
*/
|
|
1037
|
+
paddingBlockEnd?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1038
|
+
/**
|
|
1039
|
+
* Adjust the inline padding.
|
|
1040
|
+
*
|
|
1041
|
+
* - `large none` means inline-start padding is `large`, inline-end padding is `none`.
|
|
1042
|
+
*
|
|
1043
|
+
* This overrides the inline value of `padding`.
|
|
1044
|
+
*
|
|
1045
|
+
* @default '' - meaning no override
|
|
1046
|
+
*/
|
|
1047
|
+
paddingInline?: MaybeResponsive<
|
|
1048
|
+
MaybeTwoValuesShorthandProperty<PaddingKeyword> | ''
|
|
1049
|
+
>;
|
|
1050
|
+
/**
|
|
1051
|
+
* Adjust the inline-start padding.
|
|
1052
|
+
*
|
|
1053
|
+
* This overrides the inline-start value of `paddingInline`.
|
|
1054
|
+
*
|
|
1055
|
+
* @default '' - meaning no override
|
|
1056
|
+
*/
|
|
1057
|
+
paddingInlineStart?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1058
|
+
/**
|
|
1059
|
+
* Adjust the inline-end padding.
|
|
1060
|
+
*
|
|
1061
|
+
* This overrides the inline-end value of `paddingInline`.
|
|
1062
|
+
*
|
|
1063
|
+
* @default '' - meaning no override
|
|
1064
|
+
*/
|
|
1065
|
+
paddingInlineEnd?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1066
|
+
}
|
|
1067
|
+
export type SizeUnits = `${number}px` | `${number}%` | `0`;
|
|
1068
|
+
export type SizeUnitsOrAuto = SizeUnits | 'auto';
|
|
1069
|
+
export type SizeUnitsOrNone = SizeUnits | 'none';
|
|
1070
|
+
export interface SizingProps {
|
|
1071
|
+
/**
|
|
1072
|
+
* Adjust the block size.
|
|
1073
|
+
*
|
|
1074
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/block-size
|
|
1075
|
+
*
|
|
1076
|
+
* @default 'auto'
|
|
1077
|
+
*/
|
|
1078
|
+
blockSize?: MaybeResponsive<SizeUnitsOrAuto>;
|
|
1079
|
+
/**
|
|
1080
|
+
* Adjust the minimum block size.
|
|
1081
|
+
*
|
|
1082
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size
|
|
1083
|
+
*
|
|
1084
|
+
* @default '0'
|
|
1085
|
+
*/
|
|
1086
|
+
minBlockSize?: MaybeResponsive<SizeUnits>;
|
|
1087
|
+
/**
|
|
1088
|
+
* Adjust the maximum block size.
|
|
1089
|
+
*
|
|
1090
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size
|
|
1091
|
+
*
|
|
1092
|
+
* @default 'none'
|
|
1093
|
+
*/
|
|
1094
|
+
maxBlockSize?: MaybeResponsive<SizeUnitsOrNone>;
|
|
1095
|
+
/**
|
|
1096
|
+
* Adjust the inline size.
|
|
1097
|
+
*
|
|
1098
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size
|
|
1099
|
+
*
|
|
1100
|
+
* @default 'auto'
|
|
1101
|
+
*/
|
|
1102
|
+
inlineSize?: MaybeResponsive<SizeUnitsOrAuto>;
|
|
1103
|
+
/**
|
|
1104
|
+
* Adjust the minimum inline size.
|
|
1105
|
+
*
|
|
1106
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size
|
|
1107
|
+
*
|
|
1108
|
+
* @default '0'
|
|
1109
|
+
*/
|
|
1110
|
+
minInlineSize?: MaybeResponsive<SizeUnits>;
|
|
1111
|
+
/**
|
|
1112
|
+
* Adjust the maximum inline size.
|
|
1113
|
+
*
|
|
1114
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size
|
|
1115
|
+
*
|
|
1116
|
+
* @default 'none'
|
|
1117
|
+
*/
|
|
1118
|
+
maxInlineSize?: MaybeResponsive<SizeUnitsOrNone>;
|
|
1119
|
+
}
|
|
1120
|
+
export type BorderStyleKeyword =
|
|
1121
|
+
| 'none'
|
|
1122
|
+
| 'solid'
|
|
1123
|
+
| 'dashed'
|
|
1124
|
+
| 'dotted'
|
|
1125
|
+
| 'auto';
|
|
1126
|
+
export type BorderSizeKeyword = SizeKeyword | 'none';
|
|
1127
|
+
export type BorderRadiusKeyword = SizeKeyword | 'max' | 'none';
|
|
1128
|
+
/**
|
|
1129
|
+
* Represents a shorthand for defining a border. It can be a combination of size, optionally followed by color, optionally followed by style.
|
|
1130
|
+
*/
|
|
1131
|
+
export type BorderShorthand =
|
|
1132
|
+
| BorderSizeKeyword
|
|
1133
|
+
| `${BorderSizeKeyword} ${ColorKeyword}`
|
|
1134
|
+
| `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`;
|
|
1135
|
+
export interface BorderProps {
|
|
1136
|
+
/**
|
|
1137
|
+
* Set the border via the shorthand property.
|
|
1138
|
+
*
|
|
1139
|
+
* This can be a size, optionally followed by a color, optionally followed by a style.
|
|
1140
|
+
*
|
|
1141
|
+
* If the color is not specified, it will be `base`.
|
|
1142
|
+
*
|
|
1143
|
+
* If the style is not specified, it will be `auto`.
|
|
1144
|
+
*
|
|
1145
|
+
* Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.
|
|
1146
|
+
*
|
|
1147
|
+
* @example
|
|
1148
|
+
* // The following are equivalent:
|
|
1149
|
+
* <Box border="large-100 strong dashed" />
|
|
1150
|
+
* <Box borderWidth="large-100" borderColor="strong" borderStyle="dashed" />
|
|
1151
|
+
*
|
|
1152
|
+
* @default 'none' - equivalent to `none base auto`.
|
|
1153
|
+
*/
|
|
1154
|
+
border?: BorderShorthand;
|
|
1155
|
+
/**
|
|
1156
|
+
* Set the width of the border.
|
|
1157
|
+
*
|
|
1158
|
+
* If set, it takes precedence over the `border` property's width.
|
|
1159
|
+
*
|
|
1160
|
+
* Like CSS, up to 4 values can be specified.
|
|
1161
|
+
*
|
|
1162
|
+
* If one value is specified, it applies to all sides.
|
|
1163
|
+
*
|
|
1164
|
+
* If two values are specified, they apply to the block sides and inline sides respectively.
|
|
1165
|
+
*
|
|
1166
|
+
* If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
|
|
1167
|
+
*
|
|
1168
|
+
* If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
|
|
1169
|
+
*
|
|
1170
|
+
* @default '' - meaning no override
|
|
1171
|
+
*/
|
|
1172
|
+
borderWidth?: MaybeAllValuesShorthandProperty<BorderSizeKeyword> | '';
|
|
1173
|
+
/**
|
|
1174
|
+
* Set the style of the border.
|
|
1175
|
+
*
|
|
1176
|
+
* If set, it takes precedence over the `border` property's style.
|
|
1177
|
+
*
|
|
1178
|
+
* Like CSS, up to 4 values can be specified.
|
|
1179
|
+
*
|
|
1180
|
+
* If one value is specified, it applies to all sides.
|
|
1181
|
+
*
|
|
1182
|
+
* If two values are specified, they apply to the block sides and inline sides respectively.
|
|
1183
|
+
*
|
|
1184
|
+
* If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
|
|
1185
|
+
*
|
|
1186
|
+
* If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
|
|
1187
|
+
*
|
|
1188
|
+
* @default '' - meaning no override
|
|
1189
|
+
*/
|
|
1190
|
+
borderStyle?: MaybeAllValuesShorthandProperty<BorderStyleKeyword> | '';
|
|
1191
|
+
/**
|
|
1192
|
+
* Set the color of the border.
|
|
1193
|
+
*
|
|
1194
|
+
* If set, it takes precedence over the `border` property's color.
|
|
1195
|
+
*
|
|
1196
|
+
* @default '' - meaning no override
|
|
1197
|
+
*/
|
|
1198
|
+
borderColor?: ColorKeyword | '';
|
|
1199
|
+
/**
|
|
1200
|
+
* Set the radius of the border.
|
|
1201
|
+
*
|
|
1202
|
+
* [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
|
|
1203
|
+
* supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
|
|
1204
|
+
*
|
|
1205
|
+
* - 4 values: `start-start start-end end-end end-start`
|
|
1206
|
+
* - 3 values: `start-start (start-end & end-start) start-end`
|
|
1207
|
+
* - 2 values: `(start-start & end-end) (start-end & end-start)`
|
|
1208
|
+
*
|
|
1209
|
+
* For example:
|
|
1210
|
+
* - `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.
|
|
1211
|
+
* - `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.
|
|
1212
|
+
* - `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.
|
|
1213
|
+
* - `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.
|
|
1214
|
+
*
|
|
1215
|
+
* @defaultValue 'none'
|
|
1216
|
+
*/
|
|
1217
|
+
borderRadius?: MaybeAllValuesShorthandProperty<BorderRadiusKeyword>;
|
|
1218
|
+
}
|
|
1219
|
+
export interface OverflowProps {
|
|
1220
|
+
/**
|
|
1221
|
+
* Sets the overflow behavior of the element.
|
|
1222
|
+
*
|
|
1223
|
+
* - `hidden`: clips the content when it is larger than the element’s container.
|
|
1224
|
+
* The element will not be scrollable and the users will not be able
|
|
1225
|
+
* to access the clipped content by dragging or using a scroll wheel on a mouse.
|
|
1226
|
+
* - `visible`: the content that extends beyond the element’s container is visible.
|
|
1227
|
+
*
|
|
1228
|
+
* @default 'visible'
|
|
1229
|
+
*/
|
|
1230
|
+
overflow?: 'hidden' | 'visible';
|
|
1231
|
+
}
|
|
1232
|
+
export interface BaseBoxProps
|
|
1233
|
+
extends AccessibilityVisibilityProps,
|
|
1234
|
+
BackgroundProps,
|
|
1235
|
+
DisplayProps,
|
|
1236
|
+
SizingProps,
|
|
1237
|
+
PaddingProps,
|
|
1238
|
+
BorderProps,
|
|
1239
|
+
OverflowProps {
|
|
1240
|
+
/**
|
|
1241
|
+
* The content of the Box.
|
|
1242
|
+
*/
|
|
1243
|
+
children?: ComponentChildren;
|
|
1244
|
+
/**
|
|
1245
|
+
* A label that describes the purpose or contents of the element.
|
|
1246
|
+
* When set, it will be announced to users using assistive technologies and will provide them with more context.
|
|
1247
|
+
*
|
|
1248
|
+
* Only use this when the element's content is not enough context for users using assistive technologies.
|
|
1249
|
+
*/
|
|
1250
|
+
accessibilityLabel?: string;
|
|
1251
|
+
}
|
|
1252
|
+
export interface BaseBoxPropsWithRole
|
|
1253
|
+
extends BaseBoxProps,
|
|
1254
|
+
AccessibilityRoleProps {}
|
|
1255
|
+
export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
|
|
1256
|
+
/**
|
|
1257
|
+
* The behavior of the Button.
|
|
1258
|
+
*
|
|
1259
|
+
* - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.
|
|
1260
|
+
* - `button`: Used to indicate the component acts as a button, meaning it has no default action.
|
|
1261
|
+
* - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).
|
|
1262
|
+
*
|
|
1263
|
+
* This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.
|
|
1264
|
+
*
|
|
1265
|
+
* @default 'button'
|
|
1266
|
+
*/
|
|
1267
|
+
type?: 'submit' | 'button' | 'reset';
|
|
1268
|
+
/**
|
|
1269
|
+
* Callback when the Button is activated.
|
|
1270
|
+
* This will be called before the action indicated by `type`.
|
|
1271
|
+
*
|
|
1272
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event
|
|
1273
|
+
*/
|
|
1274
|
+
onClick?: (event: Event) => void;
|
|
1275
|
+
/**
|
|
1276
|
+
* Disables the Button meaning it cannot be clicked or receive focus.
|
|
1277
|
+
*
|
|
1278
|
+
* @default false
|
|
1279
|
+
*/
|
|
1280
|
+
disabled?: boolean;
|
|
1281
|
+
/**
|
|
1282
|
+
* Replaces content with a loading indicator while a background action is being performed.
|
|
1283
|
+
*
|
|
1284
|
+
* This also disables the Button.
|
|
1285
|
+
*
|
|
1286
|
+
* @default false
|
|
1287
|
+
*/
|
|
1288
|
+
loading?: boolean;
|
|
1289
|
+
}
|
|
1290
|
+
export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
|
|
1291
|
+
/**
|
|
1292
|
+
* The URL to link to.
|
|
1293
|
+
*
|
|
1294
|
+
* - If set, it will navigate to the location specified by `href` after executing the `click` event.
|
|
1295
|
+
* - If a `commandFor` is set, the `command` will be executed instead of the navigation.
|
|
1296
|
+
*/
|
|
1297
|
+
href?: string;
|
|
1298
|
+
/**
|
|
1299
|
+
* Specifies where to display the linked URL.
|
|
1300
|
+
*
|
|
1301
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target
|
|
1302
|
+
*
|
|
1303
|
+
* 'auto': The target is automatically determined based on the origin of the URL.
|
|
1304
|
+
*
|
|
1305
|
+
* @implementation Surfaces can set specific rules on how they handle each URL.
|
|
1306
|
+
* @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases.
|
|
1307
|
+
* @implementation For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).
|
|
1308
|
+
*
|
|
1309
|
+
* @default 'auto'
|
|
1310
|
+
*/
|
|
1311
|
+
target?: 'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString;
|
|
1312
|
+
/**
|
|
1313
|
+
* Causes the browser to treat the linked URL as a download with the string being the file name.
|
|
1314
|
+
* Download only works for same-origin URLs or the `blob:` and `data:` schemes.
|
|
1315
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download
|
|
1316
|
+
*/
|
|
1317
|
+
download?: string;
|
|
1318
|
+
/**
|
|
1319
|
+
* Callback when the link is activated.
|
|
1320
|
+
* This will be called before navigating to the location specified by `href`.
|
|
1321
|
+
*
|
|
1322
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event
|
|
1323
|
+
*/
|
|
1324
|
+
onClick?: (event: Event) => void;
|
|
1325
|
+
}
|
|
1326
|
+
export interface InteractionProps {
|
|
1327
|
+
/**
|
|
1328
|
+
* ID of a component that should respond to activations (e.g. clicks) on this component.
|
|
1329
|
+
*
|
|
1330
|
+
* See `command` for how to control the behavior of the target.
|
|
1331
|
+
*
|
|
1332
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor
|
|
1333
|
+
*/
|
|
1334
|
+
commandFor?: string;
|
|
1335
|
+
/**
|
|
1336
|
+
* Sets the action the `commandFor` should take when this clickable is activated.
|
|
1337
|
+
*
|
|
1338
|
+
* See the documentation of particular components for the actions they support.
|
|
1339
|
+
*
|
|
1340
|
+
* - `--auto`: a default action for the target component.
|
|
1341
|
+
* - `--show`: shows the target component.
|
|
1342
|
+
* - `--hide`: hides the target component.
|
|
1343
|
+
* - `--toggle`: toggles the target component.
|
|
1344
|
+
* - `--copy`: copies the target ClipboardItem.
|
|
1345
|
+
*
|
|
1346
|
+
* @default '--auto'
|
|
1347
|
+
*
|
|
1348
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command
|
|
1349
|
+
*/
|
|
1350
|
+
command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';
|
|
1351
|
+
/**
|
|
1352
|
+
* ID of a component that should respond to interest (e.g. hover and focus) on this component.
|
|
1353
|
+
*/
|
|
1354
|
+
interestFor?: string;
|
|
1355
|
+
}
|
|
1356
|
+
export interface BaseClickableProps
|
|
1357
|
+
extends ButtonBehaviorProps,
|
|
1358
|
+
LinkBehaviorProps {}
|
|
1359
|
+
export interface ButtonProps extends GlobalProps, BaseClickableProps {
|
|
1360
|
+
/**
|
|
1361
|
+
* A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.
|
|
1362
|
+
*
|
|
1363
|
+
* Use this when using only an icon or the Button text is not enough context
|
|
1364
|
+
* for users using assistive technologies.
|
|
1365
|
+
*/
|
|
1366
|
+
accessibilityLabel?: string;
|
|
1367
|
+
/**
|
|
1368
|
+
* The content of the Button.
|
|
1369
|
+
*/
|
|
1370
|
+
children?: ComponentChildren;
|
|
1371
|
+
/**
|
|
1372
|
+
* The type of icon to be displayed in the Button.
|
|
1373
|
+
*
|
|
1374
|
+
* @default ''
|
|
1375
|
+
*/
|
|
1376
|
+
icon?: IconType | AnyString;
|
|
1377
|
+
/**
|
|
1378
|
+
* The displayed inline width of the Button.
|
|
1379
|
+
*
|
|
1380
|
+
* - `auto`: the size of the button depends on the surface and context.
|
|
1381
|
+
* - `fill`: the button will takes up 100% of the available inline size.
|
|
1382
|
+
* - `fit-content`: the button will take up the minimum inline-size required to fit its content.
|
|
1383
|
+
*
|
|
1384
|
+
* @default 'auto'
|
|
1385
|
+
*/
|
|
1386
|
+
inlineSize?: 'auto' | 'fill' | 'fit-content';
|
|
1387
|
+
/**
|
|
1388
|
+
* Changes the visual appearance of the Button.
|
|
1389
|
+
*
|
|
1390
|
+
* @default 'auto' - the variant is automatically determined by the Button's context
|
|
1391
|
+
*/
|
|
1392
|
+
variant?: 'auto' | 'primary' | 'secondary' | 'tertiary';
|
|
1393
|
+
/**
|
|
1394
|
+
* Sets the tone of the Button based on the intention of the information being conveyed.
|
|
1395
|
+
*
|
|
1396
|
+
* @default 'auto'
|
|
1397
|
+
*/
|
|
1398
|
+
tone?: ToneKeyword;
|
|
1399
|
+
/**
|
|
1400
|
+
* Indicate the text language. Useful when the text is in a different language than the rest of the page.
|
|
1401
|
+
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
1402
|
+
* [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
|
|
1403
|
+
*/
|
|
1404
|
+
lang?: string;
|
|
1405
|
+
}
|
|
1406
|
+
export interface BaseInputProps {
|
|
1407
|
+
/**
|
|
1408
|
+
* An identifier for the field that is unique within the nearest containing form.
|
|
1409
|
+
*/
|
|
1410
|
+
name?: string;
|
|
1411
|
+
/**
|
|
1412
|
+
* Disables the field, disallowing any interaction.
|
|
1413
|
+
*
|
|
1414
|
+
* @default false
|
|
1415
|
+
*/
|
|
1416
|
+
disabled?: boolean;
|
|
1417
|
+
}
|
|
1418
|
+
export interface InputProps extends BaseInputProps {
|
|
1419
|
+
/**
|
|
1420
|
+
* Callback when the user has **finished editing** a field, e.g. once they have blurred the field.
|
|
1421
|
+
*
|
|
1422
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
|
|
1423
|
+
*/
|
|
1424
|
+
onChange?: (event: Event) => void;
|
|
1425
|
+
/**
|
|
1426
|
+
* Callback when the user makes any changes in the field.
|
|
1427
|
+
*
|
|
1428
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
|
|
1429
|
+
*/
|
|
1430
|
+
onInput?: (event: Event) => void;
|
|
1431
|
+
/**
|
|
1432
|
+
* The current value for the field. If omitted, the field will be empty.
|
|
1433
|
+
*/
|
|
1434
|
+
value?: string;
|
|
1435
|
+
/**
|
|
1436
|
+
* The default value for the field.
|
|
1437
|
+
*
|
|
1438
|
+
* @implementation `defaultValue` reflects to the `value` attribute.
|
|
1439
|
+
*/
|
|
1440
|
+
defaultValue?: string;
|
|
1441
|
+
}
|
|
1442
|
+
export interface MultipleInputProps extends BaseInputProps {
|
|
1443
|
+
/**
|
|
1444
|
+
* Callback when the user has selected option(s).
|
|
1445
|
+
*
|
|
1446
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
|
|
1447
|
+
*/
|
|
1448
|
+
onChange?: (event: Event) => void;
|
|
1449
|
+
/**
|
|
1450
|
+
* Callback when the user has selected option(s).
|
|
1451
|
+
*
|
|
1452
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
|
|
1453
|
+
*/
|
|
1454
|
+
onInput?: (event: Event) => void;
|
|
1455
|
+
/**
|
|
1456
|
+
* An array of the `value`s of the selected options.
|
|
1457
|
+
*
|
|
1458
|
+
* This is a convenience prop for setting the `selected` prop on child options.
|
|
1459
|
+
*/
|
|
1460
|
+
values?: string[];
|
|
1461
|
+
}
|
|
1462
|
+
export interface FieldErrorProps {
|
|
1463
|
+
/**
|
|
1464
|
+
* Indicate an error to the user. The field will be given a specific stylistic treatment
|
|
1465
|
+
* to communicate problems that have to be resolved immediately.
|
|
1466
|
+
*/
|
|
1467
|
+
error?: string;
|
|
1468
|
+
}
|
|
1469
|
+
export interface BasicFieldProps
|
|
1470
|
+
extends FieldErrorProps,
|
|
1471
|
+
LabelAccessibilityVisibilityProps {
|
|
1472
|
+
/**
|
|
1473
|
+
* Whether the field needs a value. This requirement adds semantic value
|
|
1474
|
+
* to the field, but it will not cause an error to appear automatically.
|
|
1475
|
+
* If you want to present an error when this field is empty, you can do
|
|
1476
|
+
* so with the `error` property.
|
|
1477
|
+
*
|
|
1478
|
+
* @default false
|
|
1479
|
+
*/
|
|
1480
|
+
required?: boolean;
|
|
1481
|
+
/**
|
|
1482
|
+
* Content to use as the field label.
|
|
1483
|
+
*/
|
|
1484
|
+
label?: string;
|
|
1485
|
+
}
|
|
1486
|
+
export interface FieldDetailsProps {
|
|
1487
|
+
/**
|
|
1488
|
+
* Additional text to provide context or guidance for the field.
|
|
1489
|
+
* This text is displayed along with the field and its label
|
|
1490
|
+
* to offer more information or instructions to the user.
|
|
1491
|
+
*
|
|
1492
|
+
* This will also be exposed to screen reader users.
|
|
1493
|
+
*/
|
|
1494
|
+
details?: string;
|
|
1495
|
+
}
|
|
1496
|
+
export interface FieldProps
|
|
1497
|
+
extends BasicFieldProps,
|
|
1498
|
+
InputProps,
|
|
1499
|
+
FocusEventProps,
|
|
1500
|
+
FieldDetailsProps {
|
|
1501
|
+
/**
|
|
1502
|
+
* A short hint that describes the expected value of the field.
|
|
1503
|
+
*/
|
|
1504
|
+
placeholder?: string;
|
|
1505
|
+
}
|
|
1506
|
+
export interface BaseTextFieldProps extends FieldProps {
|
|
1507
|
+
/**
|
|
1508
|
+
* The field cannot be edited by the user. It is focusable will be announced by screen readers.
|
|
1509
|
+
*
|
|
1510
|
+
* @default false
|
|
1511
|
+
*/
|
|
1512
|
+
readOnly?: boolean;
|
|
1513
|
+
}
|
|
1514
|
+
export interface FieldDecorationProps {
|
|
1515
|
+
/**
|
|
1516
|
+
* A value to be displayed immediately after the editable portion of the field.
|
|
1517
|
+
*
|
|
1518
|
+
* This is useful for displaying an implied part of the value, such as "@shopify.com", or "%".
|
|
1519
|
+
*
|
|
1520
|
+
* This cannot be edited by the user, and it isn't included in the value of the field.
|
|
1521
|
+
*
|
|
1522
|
+
* It may not be displayed until the user has interacted with the input.
|
|
1523
|
+
* For example, an inline label may take the place of the suffix until the user focuses the input.
|
|
1524
|
+
*
|
|
1525
|
+
* @default ''
|
|
1526
|
+
*/
|
|
1527
|
+
suffix?: string;
|
|
1528
|
+
/**
|
|
1529
|
+
* A value to be displayed immediately before the editable portion of the field.
|
|
1530
|
+
*
|
|
1531
|
+
* This is useful for displaying an implied part of the value, such as "https://" or "+353".
|
|
1532
|
+
*
|
|
1533
|
+
* This cannot be edited by the user, and it isn't included in the value of the field.
|
|
1534
|
+
*
|
|
1535
|
+
* It may not be displayed until the user has interacted with the input.
|
|
1536
|
+
* For example, an inline label may take the place of the prefix until the user focuses the input.
|
|
1537
|
+
*
|
|
1538
|
+
* @default ''
|
|
1539
|
+
*/
|
|
1540
|
+
prefix?: string;
|
|
1541
|
+
/**
|
|
1542
|
+
* The type of icon to be displayed in the field.
|
|
1543
|
+
*
|
|
1544
|
+
* @default ''
|
|
1545
|
+
*/
|
|
1546
|
+
icon?: IconType | AnyString;
|
|
1547
|
+
/**
|
|
1548
|
+
* Additional content to be displayed in the field.
|
|
1549
|
+
* Commonly used to display an icon that activates a tooltip providing more information.
|
|
1550
|
+
*/
|
|
1551
|
+
accessory?: ComponentChildren;
|
|
1552
|
+
}
|
|
1553
|
+
export interface NumberConstraintsProps {
|
|
1554
|
+
/**
|
|
1555
|
+
* The highest decimal or integer to be accepted for the field.
|
|
1556
|
+
* When used with `step` the value will round down to the max number.
|
|
1557
|
+
*
|
|
1558
|
+
* Note: a user will still be able to use the keyboard to input a number higher than
|
|
1559
|
+
* the max. It is up to the developer to add appropriate validation.
|
|
1560
|
+
*
|
|
1561
|
+
* @default Infinity
|
|
1562
|
+
*/
|
|
1563
|
+
max?: number;
|
|
1564
|
+
/**
|
|
1565
|
+
* The lowest decimal or integer to be accepted for the field.
|
|
1566
|
+
* When used with `step` the value will round up to the min number.
|
|
1567
|
+
*
|
|
1568
|
+
* Note: a user will still be able to use the keyboard to input a number lower than
|
|
1569
|
+
* the min. It is up to the developer to add appropriate validation.
|
|
1570
|
+
*
|
|
1571
|
+
* @default -Infinity
|
|
1572
|
+
*/
|
|
1573
|
+
min?: number;
|
|
1574
|
+
/**
|
|
1575
|
+
* The amount the value can increase or decrease by. This can be an integer or decimal.
|
|
1576
|
+
* If a `max` or `min` is specified with `step` when increasing/decreasing the value
|
|
1577
|
+
* via the buttons, the final value will always round to the `max` or `min`
|
|
1578
|
+
* rather than the closest valid amount.
|
|
1579
|
+
*
|
|
1580
|
+
* @default 1
|
|
1581
|
+
*/
|
|
1582
|
+
step?: number;
|
|
1583
|
+
/**
|
|
1584
|
+
* Sets the type of controls displayed in the field.
|
|
1585
|
+
*
|
|
1586
|
+
* - `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property.
|
|
1587
|
+
* Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.
|
|
1588
|
+
* - `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.
|
|
1589
|
+
* - `auto`: the presence of the controls depends on the surface and context.
|
|
1590
|
+
*
|
|
1591
|
+
* @default 'auto'
|
|
1592
|
+
*/
|
|
1593
|
+
controls?: 'auto' | 'stepper' | 'none';
|
|
1594
|
+
}
|
|
1595
|
+
export interface MinMaxLengthProps {
|
|
1596
|
+
/**
|
|
1597
|
+
* Specifies the maximum number of characters allowed.
|
|
1598
|
+
*
|
|
1599
|
+
* @default Infinity
|
|
1600
|
+
*/
|
|
1601
|
+
maxLength?: number;
|
|
1602
|
+
/**
|
|
1603
|
+
* Specifies the min number of characters allowed.
|
|
1604
|
+
*
|
|
1605
|
+
* @default 0
|
|
1606
|
+
*/
|
|
1607
|
+
minLength?: number;
|
|
1608
|
+
}
|
|
1609
|
+
export interface BaseSelectableProps {
|
|
1610
|
+
/**
|
|
1611
|
+
* A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced.
|
|
1612
|
+
* This can also be used to display a control without a visual label, while still providing context to users using screen readers.
|
|
1613
|
+
*/
|
|
1614
|
+
accessibilityLabel?: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* Disables the control, disallowing any interaction.
|
|
1617
|
+
*
|
|
1618
|
+
* @default false
|
|
1619
|
+
*/
|
|
1620
|
+
disabled?: boolean;
|
|
1621
|
+
/**
|
|
1622
|
+
* The value used in form data when the control is checked.
|
|
1623
|
+
*/
|
|
1624
|
+
value?: string;
|
|
1625
|
+
}
|
|
1626
|
+
export interface BaseOptionProps extends BaseSelectableProps {
|
|
1627
|
+
/**
|
|
1628
|
+
* Whether the control is active.
|
|
1629
|
+
*
|
|
1630
|
+
* @default false
|
|
1631
|
+
*/
|
|
1632
|
+
selected?: boolean;
|
|
1633
|
+
/**
|
|
1634
|
+
* Whether the control is active by default.
|
|
1635
|
+
*
|
|
1636
|
+
* @implementation `defaultSelected` reflects to the `selected` attribute.
|
|
1637
|
+
*
|
|
1638
|
+
* @default false
|
|
1639
|
+
*/
|
|
1640
|
+
defaultSelected?: boolean;
|
|
1641
|
+
}
|
|
1642
|
+
export interface ChoiceProps extends GlobalProps, BaseOptionProps {
|
|
1643
|
+
/**
|
|
1644
|
+
* Content to use as the choice label.
|
|
1645
|
+
*
|
|
1646
|
+
* @implementation (StringChildren) The label is produced by extracting and
|
|
1647
|
+
* concatenating the text nodes from the provided content; any markup or
|
|
1648
|
+
* element structure is ignored.
|
|
1649
|
+
*
|
|
1650
|
+
* @implementation (ComponentChildren) Behaves as a slot: any elements passed
|
|
1651
|
+
* are rendered as the label content (subject to surface constraints); there
|
|
1652
|
+
* is no coercion to a string.
|
|
1653
|
+
*/
|
|
1654
|
+
children?: ComponentChildren | StringChildren;
|
|
1655
|
+
/**
|
|
1656
|
+
* Additional text to provide context or guidance for the input.
|
|
1657
|
+
*
|
|
1658
|
+
* This text is displayed along with the input and its label
|
|
1659
|
+
* to offer more information or instructions to the user.
|
|
1660
|
+
*
|
|
1661
|
+
* @implementation this content should be linked to the input with an `aria-describedby` attribute.
|
|
1662
|
+
*/
|
|
1663
|
+
details?: ComponentChildren;
|
|
1664
|
+
/**
|
|
1665
|
+
* Set to `true` to associate a choice with the error passed to `ChoiceList`
|
|
1666
|
+
*
|
|
1667
|
+
* @default false
|
|
1668
|
+
*/
|
|
1669
|
+
error?: boolean;
|
|
1670
|
+
/**
|
|
1671
|
+
* Secondary content for a choice.
|
|
1672
|
+
*/
|
|
1673
|
+
secondaryContent?: ComponentChildren;
|
|
1674
|
+
/**
|
|
1675
|
+
* Content to display when the option is selected.
|
|
1676
|
+
*
|
|
1677
|
+
* This can be used to provide additional information or options related to the choice.
|
|
1678
|
+
*/
|
|
1679
|
+
selectedContent?: ComponentChildren;
|
|
1680
|
+
}
|
|
1681
|
+
export interface ChoiceListProps
|
|
1682
|
+
extends GlobalProps,
|
|
1683
|
+
Pick<BasicFieldProps, 'label' | 'labelAccessibilityVisibility' | 'error'>,
|
|
1684
|
+
MultipleInputProps,
|
|
1685
|
+
FieldDetailsProps {
|
|
1686
|
+
/**
|
|
1687
|
+
* Whether multiple choices can be selected.
|
|
1688
|
+
*
|
|
1689
|
+
* @default false
|
|
1690
|
+
*/
|
|
1691
|
+
multiple?: boolean;
|
|
1692
|
+
/**
|
|
1693
|
+
* The choices a user can select from.
|
|
1694
|
+
*
|
|
1695
|
+
* Accepts `Choice` components.
|
|
1696
|
+
*/
|
|
1697
|
+
children?: ComponentChildren;
|
|
1698
|
+
/**
|
|
1699
|
+
* Disables the field, disallowing any interaction.
|
|
1700
|
+
*
|
|
1701
|
+
* `disabled` on any child choices is ignored when this is true.
|
|
1702
|
+
*
|
|
1703
|
+
* @default false
|
|
1704
|
+
*/
|
|
1705
|
+
disabled?: MultipleInputProps['disabled'];
|
|
1706
|
+
/**
|
|
1707
|
+
* The variant of the choice grid.
|
|
1708
|
+
*
|
|
1709
|
+
* - `auto`: The variant is determined by the context.
|
|
1710
|
+
* - `list`: The choices are displayed in a list.
|
|
1711
|
+
* - `inline`: The choices are displayed on the inline axis.
|
|
1712
|
+
* - `block`: The choices are displayed on the block axis.
|
|
1713
|
+
* - `grid`: The choices are displayed in a grid.
|
|
1714
|
+
*
|
|
1715
|
+
* @implementation The `block`, `inline` and `grid` variants are more suitable for button looking choices, but it's at the
|
|
1716
|
+
* discretion of each surface.
|
|
1717
|
+
*
|
|
1718
|
+
* @default 'auto'
|
|
1719
|
+
*/
|
|
1720
|
+
variant?: 'auto' | 'list' | 'inline' | 'block' | 'grid';
|
|
1721
|
+
}
|
|
1722
|
+
export interface ClickableProps
|
|
1723
|
+
extends GlobalProps,
|
|
1724
|
+
BaseBoxProps,
|
|
1725
|
+
BaseClickableProps {
|
|
1726
|
+
/**
|
|
1727
|
+
* Disables the clickable, and indicates to assistive technology that the loading is in progress.
|
|
1728
|
+
*
|
|
1729
|
+
* This also disables the clickable.
|
|
1730
|
+
*/
|
|
1731
|
+
loading?: BaseClickableProps['loading'];
|
|
1732
|
+
/**
|
|
1733
|
+
* Disables the clickable, meaning it cannot be clicked or receive focus.
|
|
1734
|
+
*
|
|
1735
|
+
* In this state, onClick will not fire.
|
|
1736
|
+
* If the click event originates from a child element, the event will immediately stop propagating from this element.
|
|
1737
|
+
*
|
|
1738
|
+
* However, items within the clickable can still receive focus and be interacted with.
|
|
1739
|
+
*
|
|
1740
|
+
* This has no impact on the visual state by default,
|
|
1741
|
+
* but developers are encouraged to style the clickable accordingly.
|
|
1742
|
+
*/
|
|
1743
|
+
disabled?: BaseClickableProps['disabled'];
|
|
1744
|
+
/**
|
|
1745
|
+
* Indicate the text language. Useful when the text is in a different language than the rest of the page.
|
|
1746
|
+
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
1747
|
+
* [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
|
|
1748
|
+
*
|
|
1749
|
+
* @default ''
|
|
1750
|
+
*/
|
|
1751
|
+
lang?: string;
|
|
1752
|
+
}
|
|
1753
|
+
export interface AutocompleteProps<
|
|
1754
|
+
AutocompleteField extends AnyAutocompleteField,
|
|
1755
|
+
> {
|
|
1756
|
+
/**
|
|
1757
|
+
* A hint as to the intended content of the field.
|
|
1758
|
+
*
|
|
1759
|
+
* When set to `on` (the default), this property indicates that the field should support
|
|
1760
|
+
* autofill, but you do not have any more semantic information on the intended
|
|
1761
|
+
* contents.
|
|
1762
|
+
*
|
|
1763
|
+
* When set to `off`, you are indicating that this field contains sensitive
|
|
1764
|
+
* information, or contents that are never saved, like one-time codes.
|
|
1765
|
+
*
|
|
1766
|
+
* Alternatively, you can provide value which describes the
|
|
1767
|
+
* specific data you would like to be entered into this field during autofill.
|
|
1768
|
+
*
|
|
1769
|
+
* @see Learn more about the set of {@link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens|autocomplete values} supported in browsers.
|
|
1770
|
+
*
|
|
1771
|
+
* @default 'tel' for PhoneField
|
|
1772
|
+
* @default 'email' for EmailField
|
|
1773
|
+
* @default 'url' for URLField
|
|
1774
|
+
* @default 'on' for everything else
|
|
1775
|
+
*/
|
|
1776
|
+
autocomplete?:
|
|
1777
|
+
| AutocompleteField
|
|
1778
|
+
| `${AutocompleteSection} ${AutocompleteField}`
|
|
1779
|
+
| `${AutocompleteGroup} ${AutocompleteField}`
|
|
1780
|
+
| `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`
|
|
1781
|
+
| 'on'
|
|
1782
|
+
| 'off';
|
|
1783
|
+
}
|
|
1784
|
+
/**
|
|
1785
|
+
* The “section” scopes the autocomplete data that should be inserted
|
|
1786
|
+
* to a specific area of the page.
|
|
1787
|
+
*
|
|
1788
|
+
* Commonly used when there are multiple fields with the same autocomplete needs
|
|
1789
|
+
* in the same page. For example: 2 shipping address forms in the same page.
|
|
1790
|
+
*/
|
|
1791
|
+
export type AutocompleteSection = `section-${string}`;
|
|
1792
|
+
/**
|
|
1793
|
+
* The contact information group the autocomplete data should be sourced from.
|
|
1794
|
+
*/
|
|
1795
|
+
export type AutocompleteGroup = 'shipping' | 'billing';
|
|
1796
|
+
/**
|
|
1797
|
+
* The contact information subgroup the autocomplete data should be sourced from.
|
|
1798
|
+
*/
|
|
1799
|
+
export type AutocompleteAddressGroup = 'fax' | 'home' | 'mobile' | 'pager';
|
|
1800
|
+
export type AnyAutocompleteField =
|
|
1801
|
+
| 'additional-name'
|
|
1802
|
+
| 'address-level1'
|
|
1803
|
+
| 'address-level2'
|
|
1804
|
+
| 'address-level3'
|
|
1805
|
+
| 'address-level4'
|
|
1806
|
+
| 'address-line1'
|
|
1807
|
+
| 'address-line2'
|
|
1808
|
+
| 'address-line3'
|
|
1809
|
+
| 'country-name'
|
|
1810
|
+
| 'country'
|
|
1811
|
+
| 'current-password'
|
|
1812
|
+
| 'email'
|
|
1813
|
+
| 'family-name'
|
|
1814
|
+
| 'given-name'
|
|
1815
|
+
| 'honorific-prefix'
|
|
1816
|
+
| 'honorific-suffix'
|
|
1817
|
+
| 'language'
|
|
1818
|
+
| 'name'
|
|
1819
|
+
| 'new-password'
|
|
1820
|
+
| 'nickname'
|
|
1821
|
+
| 'one-time-code'
|
|
1822
|
+
| 'organization-title'
|
|
1823
|
+
| 'organization'
|
|
1824
|
+
| 'photo'
|
|
1825
|
+
| 'postal-code'
|
|
1826
|
+
| 'sex'
|
|
1827
|
+
| 'street-address'
|
|
1828
|
+
| 'transaction-amount'
|
|
1829
|
+
| 'transaction-currency'
|
|
1830
|
+
| 'url'
|
|
1831
|
+
| 'username'
|
|
1832
|
+
| 'bday-day'
|
|
1833
|
+
| 'bday-month'
|
|
1834
|
+
| 'bday-year'
|
|
1835
|
+
| 'bday'
|
|
1836
|
+
| 'cc-additional-name'
|
|
1837
|
+
| 'cc-expiry-month'
|
|
1838
|
+
| 'cc-expiry-year'
|
|
1839
|
+
| 'cc-expiry'
|
|
1840
|
+
| 'cc-family-name'
|
|
1841
|
+
| 'cc-given-name'
|
|
1842
|
+
| 'cc-name'
|
|
1843
|
+
| 'cc-number'
|
|
1844
|
+
| 'cc-csc'
|
|
1845
|
+
| 'cc-type'
|
|
1846
|
+
| `${AutocompleteAddressGroup} email`
|
|
1847
|
+
| 'impp'
|
|
1848
|
+
| `${AutocompleteAddressGroup} impp`
|
|
1849
|
+
| 'tel'
|
|
1850
|
+
| 'tel-area-code'
|
|
1851
|
+
| 'tel-country-code'
|
|
1852
|
+
| 'tel-extension'
|
|
1853
|
+
| 'tel-local-prefix'
|
|
1854
|
+
| 'tel-local-suffix'
|
|
1855
|
+
| 'tel-local'
|
|
1856
|
+
| 'tel-national'
|
|
1857
|
+
| `${AutocompleteAddressGroup} tel`
|
|
1858
|
+
| `${AutocompleteAddressGroup} tel-area-code`
|
|
1859
|
+
| `${AutocompleteAddressGroup} tel-country-code`
|
|
1860
|
+
| `${AutocompleteAddressGroup} tel-extension`
|
|
1861
|
+
| `${AutocompleteAddressGroup} tel-local-prefix`
|
|
1862
|
+
| `${AutocompleteAddressGroup} tel-local-suffix`
|
|
1863
|
+
| `${AutocompleteAddressGroup} tel-local`
|
|
1864
|
+
| `${AutocompleteAddressGroup} tel-national`;
|
|
1865
|
+
export type TextAutocompleteField = ExtractStrict<
|
|
1866
|
+
AnyAutocompleteField,
|
|
1867
|
+
| 'additional-name'
|
|
1868
|
+
| 'address-level1'
|
|
1869
|
+
| 'address-level2'
|
|
1870
|
+
| 'address-level3'
|
|
1871
|
+
| 'address-level4'
|
|
1872
|
+
| 'address-line1'
|
|
1873
|
+
| 'address-line2'
|
|
1874
|
+
| 'address-line3'
|
|
1875
|
+
| 'country-name'
|
|
1876
|
+
| 'country'
|
|
1877
|
+
| 'family-name'
|
|
1878
|
+
| 'given-name'
|
|
1879
|
+
| 'honorific-prefix'
|
|
1880
|
+
| 'honorific-suffix'
|
|
1881
|
+
| 'language'
|
|
1882
|
+
| 'name'
|
|
1883
|
+
| 'nickname'
|
|
1884
|
+
| 'one-time-code'
|
|
1885
|
+
| 'organization-title'
|
|
1886
|
+
| 'organization'
|
|
1887
|
+
| 'postal-code'
|
|
1888
|
+
| 'sex'
|
|
1889
|
+
| 'street-address'
|
|
1890
|
+
| 'transaction-currency'
|
|
1891
|
+
| 'username'
|
|
1892
|
+
| 'cc-name'
|
|
1893
|
+
| 'cc-given-name'
|
|
1894
|
+
| 'cc-additional-name'
|
|
1895
|
+
| 'cc-family-name'
|
|
1896
|
+
| 'cc-type'
|
|
1897
|
+
>;
|
|
1898
|
+
export interface DatePickerProps
|
|
1899
|
+
extends GlobalProps,
|
|
1900
|
+
InputProps,
|
|
1901
|
+
FocusEventProps {
|
|
1902
|
+
/**
|
|
1903
|
+
* Default month to display in `YYYY-MM` format.
|
|
1904
|
+
*
|
|
1905
|
+
* This value is used until `view` is set, either directly or as a result of user interaction.
|
|
1906
|
+
*
|
|
1907
|
+
* Defaults to the current month in the user's locale.
|
|
1908
|
+
*/
|
|
1909
|
+
defaultView?: string;
|
|
1910
|
+
/**
|
|
1911
|
+
* Displayed month in `YYYY-MM` format.
|
|
1912
|
+
*
|
|
1913
|
+
* `onViewChange` is called when this value changes.
|
|
1914
|
+
*
|
|
1915
|
+
* Defaults to `defaultView`.
|
|
1916
|
+
*/
|
|
1917
|
+
view?: string;
|
|
1918
|
+
/**
|
|
1919
|
+
* Called whenever the month to display changes.
|
|
1920
|
+
*
|
|
1921
|
+
* @param view The new month to display in `YYYY-MM` format.
|
|
1922
|
+
*/
|
|
1923
|
+
onViewChange?: (view: string) => void;
|
|
1924
|
+
/**
|
|
1925
|
+
* The type of selection the date picker allows.
|
|
1926
|
+
*
|
|
1927
|
+
* - `single` allows selecting a single date.
|
|
1928
|
+
* - `multiple` allows selecting multiple non-contiguous dates.
|
|
1929
|
+
* - `range` allows selecting a single range of dates.
|
|
1930
|
+
*
|
|
1931
|
+
* @default "single"
|
|
1932
|
+
*/
|
|
1933
|
+
type?: 'single' | 'multiple' | 'range';
|
|
1934
|
+
/**
|
|
1935
|
+
* Dates that can be selected.
|
|
1936
|
+
*
|
|
1937
|
+
* A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
|
|
1938
|
+
*
|
|
1939
|
+
* The default `''` allows all dates.
|
|
1940
|
+
*
|
|
1941
|
+
* - Dates in `YYYY-MM-DD` format allow a single date.
|
|
1942
|
+
* - Dates in `YYYY-MM` format allow a whole month.
|
|
1943
|
+
* - Dates in `YYYY` format allow a whole year.
|
|
1944
|
+
* - Ranges are expressed as `start--end`.
|
|
1945
|
+
* - Ranges are inclusive.
|
|
1946
|
+
* - If either `start` or `end` is omitted, the range is unbounded in that direction.
|
|
1947
|
+
* - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.
|
|
1948
|
+
* So `2024--` is equivalent to `2024-01-01--`.
|
|
1949
|
+
* - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.
|
|
1950
|
+
* So `--2024` is equivalent to `--2024-12-31`.
|
|
1951
|
+
* - Whitespace is allowed either side of `--`.
|
|
1952
|
+
*
|
|
1953
|
+
* @default ""
|
|
1954
|
+
*
|
|
1955
|
+
* @example
|
|
1956
|
+
* `2024-02--2025` // allow any date from February 2024 to the end of 2025
|
|
1957
|
+
* `2024-02--` // allow any date from February 2024 to the end of the month
|
|
1958
|
+
* `2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024
|
|
1959
|
+
*/
|
|
1960
|
+
allow?: string;
|
|
1961
|
+
/**
|
|
1962
|
+
* Dates that cannot be selected. These subtract from `allow`.
|
|
1963
|
+
*
|
|
1964
|
+
* A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
|
|
1965
|
+
*
|
|
1966
|
+
* The default `''` has no effect on `allow`.
|
|
1967
|
+
*
|
|
1968
|
+
* - Dates in `YYYY-MM-DD` format disallow a single date.
|
|
1969
|
+
* - Dates in `YYYY-MM` format disallow a whole month.
|
|
1970
|
+
* - Dates in `YYYY` format disallow a whole year.
|
|
1971
|
+
* - Ranges are expressed as `start--end`.
|
|
1972
|
+
* - Ranges are inclusive.
|
|
1973
|
+
* - If either `start` or `end` is omitted, the range is unbounded in that direction.
|
|
1974
|
+
* - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.
|
|
1975
|
+
* So `2024--` is equivalent to `2024-01-01--`.
|
|
1976
|
+
* - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.
|
|
1977
|
+
* So `--2024` is equivalent to `--2024-12-31`.
|
|
1978
|
+
* - Whitespace is allowed either side of `--`.
|
|
1979
|
+
*
|
|
1980
|
+
* @default ""
|
|
1981
|
+
*
|
|
1982
|
+
* @example
|
|
1983
|
+
* `--2024-02` // disallow any date before February 2024
|
|
1984
|
+
* `2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024
|
|
1985
|
+
*/
|
|
1986
|
+
disallow?: string;
|
|
1987
|
+
/**
|
|
1988
|
+
* Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.
|
|
1989
|
+
*
|
|
1990
|
+
* A comma-separated list of days. Whitespace is allowed after commas.
|
|
1991
|
+
*
|
|
1992
|
+
* The default `''` has no effect on the result of `allow` and `disallow`.
|
|
1993
|
+
*
|
|
1994
|
+
* Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.
|
|
1995
|
+
*
|
|
1996
|
+
* @default ""
|
|
1997
|
+
*
|
|
1998
|
+
* @example
|
|
1999
|
+
* 'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.
|
|
2000
|
+
*/
|
|
2001
|
+
allowDays?: string;
|
|
2002
|
+
/**
|
|
2003
|
+
* Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`.
|
|
2004
|
+
*
|
|
2005
|
+
* A comma-separated list of days. Whitespace is allowed after commas.
|
|
2006
|
+
*
|
|
2007
|
+
* The default `''` has no effect on `allowDays`.
|
|
2008
|
+
*
|
|
2009
|
+
* Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.
|
|
2010
|
+
*
|
|
2011
|
+
* @default ""
|
|
2012
|
+
*
|
|
2013
|
+
* @example
|
|
2014
|
+
* 'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.
|
|
2015
|
+
*/
|
|
2016
|
+
disallowDays?: string;
|
|
2017
|
+
/**
|
|
2018
|
+
* Default selected value.
|
|
2019
|
+
*
|
|
2020
|
+
* The default means no date is selected.
|
|
2021
|
+
*
|
|
2022
|
+
* If the provided value is invalid, no date is selected.
|
|
2023
|
+
*
|
|
2024
|
+
* - If `type="single"`, this is a date in `YYYY-MM-DD` format.
|
|
2025
|
+
* - If `type="multiple"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.
|
|
2026
|
+
* - If `type="range"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.
|
|
2027
|
+
*
|
|
2028
|
+
* @default ""
|
|
2029
|
+
*/
|
|
2030
|
+
defaultValue?: string;
|
|
2031
|
+
/**
|
|
2032
|
+
* Current selected value.
|
|
2033
|
+
*
|
|
2034
|
+
* The default means no date is selected.
|
|
2035
|
+
*
|
|
2036
|
+
* If the provided value is invalid, no date is selected.
|
|
2037
|
+
*
|
|
2038
|
+
* Otherwise:
|
|
2039
|
+
*
|
|
2040
|
+
* - If `type="single"`, this is a date in `YYYY-MM-DD` format.
|
|
2041
|
+
* - If `type="multiple"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.
|
|
2042
|
+
* - If `type="range"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.
|
|
2043
|
+
*
|
|
2044
|
+
* @default ""
|
|
2045
|
+
*/
|
|
2046
|
+
value?: string;
|
|
2047
|
+
/**
|
|
2048
|
+
* Callback when any date is selected.
|
|
2049
|
+
*
|
|
2050
|
+
* - If `type="single"`, fires when a date is selected and happens before `onChange`.
|
|
2051
|
+
* - If `type="multiple"`, fires when a date is selected before `onChange`.
|
|
2052
|
+
* - If `type="range"`, fires when a first date is selected (with the partial value formatted as `YYYY-MM-DD--`), and when the last date is selected before `onChange`.
|
|
2053
|
+
*/
|
|
2054
|
+
onInput?: (event: Event) => void;
|
|
2055
|
+
/**
|
|
2056
|
+
* Callback when the value is committed.
|
|
2057
|
+
*
|
|
2058
|
+
* - If `type="single"`, fires when a date is selected after `onInput`.
|
|
2059
|
+
* - If `type="multiple"`, fires when a date is selected after `onInput`.
|
|
2060
|
+
* - If `type="range"`, fires when a range is completed by selecting the end date after `onInput`.
|
|
2061
|
+
*/
|
|
2062
|
+
onChange?: (event: Event) => void;
|
|
2063
|
+
}
|
|
2064
|
+
export interface DateFieldProps
|
|
2065
|
+
extends GlobalProps,
|
|
2066
|
+
BaseTextFieldProps,
|
|
2067
|
+
Pick<
|
|
2068
|
+
DatePickerProps,
|
|
2069
|
+
| 'view'
|
|
2070
|
+
| 'defaultView'
|
|
2071
|
+
| 'value'
|
|
2072
|
+
| 'defaultValue'
|
|
2073
|
+
| 'allow'
|
|
2074
|
+
| 'disallow'
|
|
2075
|
+
| 'allowDays'
|
|
2076
|
+
| 'disallowDays'
|
|
2077
|
+
| 'onViewChange'
|
|
2078
|
+
>,
|
|
2079
|
+
AutocompleteProps<DateAutocompleteField> {
|
|
2080
|
+
/**
|
|
2081
|
+
* Callback when the field has an invalid date.
|
|
2082
|
+
* This callback will be called, if the date typed is invalid or disabled.
|
|
2083
|
+
*
|
|
2084
|
+
* Dates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:
|
|
2085
|
+
* - 2021-02-31: February doesn’t have 31 days
|
|
2086
|
+
* - 2021-02-00: The day can’t be 00
|
|
2087
|
+
*
|
|
2088
|
+
* Disallowed dates are considered invalid.
|
|
2089
|
+
*
|
|
2090
|
+
* It’s important to note that this callback will be called only when the user **finishes editing** the date,
|
|
2091
|
+
* and it’s called right after the `onChange` callback.
|
|
2092
|
+
* The field is **not** validated on every change to the input. Once the buyer has signalled that
|
|
2093
|
+
* they have finished editing the field (typically, by blurring the field), the field gets validated and the callback is run if the value is invalid.
|
|
2094
|
+
*/
|
|
2095
|
+
onInvalid?: (event: Event) => void;
|
|
2096
|
+
}
|
|
2097
|
+
export type DateAutocompleteField = ExtractStrict<
|
|
2098
|
+
AnyAutocompleteField,
|
|
2099
|
+
| 'bday'
|
|
2100
|
+
| 'bday-day'
|
|
2101
|
+
| 'bday-month'
|
|
2102
|
+
| 'bday-year'
|
|
2103
|
+
| 'cc-expiry'
|
|
2104
|
+
| 'cc-expiry-month'
|
|
2105
|
+
| 'cc-expiry-year'
|
|
2106
|
+
>;
|
|
2107
|
+
export interface DateSpinnerProps
|
|
2108
|
+
extends GlobalProps,
|
|
2109
|
+
Pick<
|
|
2110
|
+
DatePickerProps,
|
|
2111
|
+
'defaultValue' | 'value' | 'onInput' | 'onChange' | 'onBlur' | 'onFocus'
|
|
2112
|
+
> {
|
|
2113
|
+
/**
|
|
2114
|
+
* Default selected value for the spinner.
|
|
2115
|
+
*
|
|
2116
|
+
* This uses a date in `YYYY-MM-DD` format.
|
|
2117
|
+
*
|
|
2118
|
+
* @default ""
|
|
2119
|
+
*/
|
|
2120
|
+
defaultValue?: string;
|
|
2121
|
+
/**
|
|
2122
|
+
* Current selected value for the spinner.
|
|
2123
|
+
*
|
|
2124
|
+
* This uses a date in `YYYY-MM-DD` format.
|
|
2125
|
+
*
|
|
2126
|
+
* @default ""
|
|
2127
|
+
*/
|
|
2128
|
+
value?: string;
|
|
2129
|
+
/**
|
|
2130
|
+
* Callback after the wheels have finished spinning and the value has
|
|
2131
|
+
* settled.
|
|
2132
|
+
*
|
|
2133
|
+
* Fires once when inertial/momentum scrolling stops and the selection snaps
|
|
2134
|
+
* into place.
|
|
2135
|
+
*/
|
|
2136
|
+
onInput?: (event: Event) => void;
|
|
2137
|
+
/**
|
|
2138
|
+
* Callback when the selection has been confirmed by the user.
|
|
2139
|
+
*
|
|
2140
|
+
* Fires only when the user explicitly commits the selection (for example, by
|
|
2141
|
+
* pressing a confirmation control).
|
|
2142
|
+
*/
|
|
2143
|
+
onChange?: (event: Event) => void;
|
|
2144
|
+
}
|
|
2145
|
+
export interface DividerProps extends GlobalProps {
|
|
2146
|
+
/**
|
|
2147
|
+
* Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
|
|
2148
|
+
*
|
|
2149
|
+
* @default 'inline'
|
|
2150
|
+
*/
|
|
2151
|
+
direction?: 'inline' | 'block';
|
|
2152
|
+
/**
|
|
2153
|
+
* Modify the color to be more or less intense.
|
|
2154
|
+
*
|
|
2155
|
+
* @default 'base'
|
|
2156
|
+
*/
|
|
2157
|
+
color?: ColorKeyword;
|
|
2158
|
+
}
|
|
2159
|
+
export interface EmailFieldProps
|
|
2160
|
+
extends GlobalProps,
|
|
2161
|
+
BaseTextFieldProps,
|
|
2162
|
+
MinMaxLengthProps,
|
|
2163
|
+
AutocompleteProps<EmailAutocompleteField> {}
|
|
2164
|
+
export type EmailAutocompleteField = ExtractStrict<
|
|
2165
|
+
AnyAutocompleteField,
|
|
2166
|
+
'email' | `${AutocompleteAddressGroup} email`
|
|
2167
|
+
>;
|
|
2168
|
+
export type SpacingKeyword = SizeKeyword | 'none';
|
|
2169
|
+
export interface GapProps {
|
|
2170
|
+
/**
|
|
2171
|
+
* Adjust spacing between elements.
|
|
2172
|
+
*
|
|
2173
|
+
* A single value applies to both axes.
|
|
2174
|
+
* A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.
|
|
2175
|
+
*
|
|
2176
|
+
* @default 'none'
|
|
2177
|
+
*/
|
|
2178
|
+
gap?: MaybeResponsive<MaybeTwoValuesShorthandProperty<SpacingKeyword>>;
|
|
2179
|
+
/**
|
|
2180
|
+
* Adjust spacing between elements in the block axis.
|
|
2181
|
+
*
|
|
2182
|
+
* This overrides the row value of `gap`.
|
|
2183
|
+
*
|
|
2184
|
+
* @default '' - meaning no override
|
|
2185
|
+
*/
|
|
2186
|
+
rowGap?: MaybeResponsive<SpacingKeyword | ''>;
|
|
2187
|
+
/**
|
|
2188
|
+
* Adjust spacing between elements in the inline axis.
|
|
2189
|
+
*
|
|
2190
|
+
* This overrides the column value of `gap`.
|
|
2191
|
+
*
|
|
2192
|
+
* @default '' - meaning no override
|
|
2193
|
+
*/
|
|
2194
|
+
columnGap?: MaybeResponsive<SpacingKeyword | ''>;
|
|
2195
|
+
}
|
|
2196
|
+
export type BaselinePosition = 'baseline' | 'first baseline' | 'last baseline';
|
|
2197
|
+
export type ContentDistribution =
|
|
2198
|
+
| 'space-between'
|
|
2199
|
+
| 'space-around'
|
|
2200
|
+
| 'space-evenly'
|
|
2201
|
+
| 'stretch';
|
|
2202
|
+
export type ContentPosition = 'center' | 'start' | 'end';
|
|
2203
|
+
export type OverflowPosition =
|
|
2204
|
+
| `unsafe ${ContentPosition}`
|
|
2205
|
+
| `safe ${ContentPosition}`;
|
|
2206
|
+
/**
|
|
2207
|
+
* Align items sets the align-self value on all direct children as a group.
|
|
2208
|
+
*
|
|
2209
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
2210
|
+
*/
|
|
2211
|
+
export type AlignItemsKeyword =
|
|
2212
|
+
| 'normal'
|
|
2213
|
+
| 'stretch'
|
|
2214
|
+
| BaselinePosition
|
|
2215
|
+
| OverflowPosition
|
|
2216
|
+
| ContentPosition;
|
|
2217
|
+
/**
|
|
2218
|
+
* Justify content defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container.
|
|
2219
|
+
*
|
|
2220
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
2221
|
+
*/
|
|
2222
|
+
export type JustifyContentKeyword =
|
|
2223
|
+
| 'normal'
|
|
2224
|
+
| ContentDistribution
|
|
2225
|
+
| OverflowPosition
|
|
2226
|
+
| ContentPosition;
|
|
2227
|
+
/**
|
|
2228
|
+
*Align content sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis.
|
|
2229
|
+
*
|
|
2230
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
2231
|
+
*/
|
|
2232
|
+
export type AlignContentKeyword =
|
|
2233
|
+
| 'normal'
|
|
2234
|
+
| BaselinePosition
|
|
2235
|
+
| ContentDistribution
|
|
2236
|
+
| OverflowPosition
|
|
2237
|
+
| ContentPosition;
|
|
2238
|
+
export interface BaseTypographyProps {
|
|
2239
|
+
/**
|
|
2240
|
+
* Modify the color to be more or less intense.
|
|
2241
|
+
*
|
|
2242
|
+
* @default 'base'
|
|
2243
|
+
*/
|
|
2244
|
+
color?: ColorKeyword;
|
|
2245
|
+
/**
|
|
2246
|
+
* Sets the tone of the component, based on the intention of the information being conveyed.
|
|
2247
|
+
*
|
|
2248
|
+
* @default 'auto'
|
|
2249
|
+
*/
|
|
2250
|
+
tone?: ToneKeyword;
|
|
2251
|
+
/**
|
|
2252
|
+
* Set the numeric properties of the font.
|
|
2253
|
+
*
|
|
2254
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric
|
|
2255
|
+
*
|
|
2256
|
+
* @default 'auto' - inherit from the parent element
|
|
2257
|
+
*/
|
|
2258
|
+
fontVariantNumeric?: 'auto' | 'normal' | 'tabular-nums';
|
|
2259
|
+
/**
|
|
2260
|
+
* Indicate the text language. Useful when the text is in a different language than the rest of the page.
|
|
2261
|
+
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
2262
|
+
* [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
|
|
2263
|
+
*
|
|
2264
|
+
* It is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.
|
|
2265
|
+
*
|
|
2266
|
+
* @default ''
|
|
2267
|
+
*/
|
|
2268
|
+
lang?: string;
|
|
2269
|
+
/**
|
|
2270
|
+
* Indicates the directionality of the element’s text.
|
|
2271
|
+
*
|
|
2272
|
+
* - `ltr`: languages written from left to right (e.g. English)
|
|
2273
|
+
* - `rtl`: languages written from right to left (e.g. Arabic)
|
|
2274
|
+
* - `auto`: the user agent determines the direction based on the content
|
|
2275
|
+
* - `''`: direction is inherited from parent elements (equivalent to not setting the attribute)
|
|
2276
|
+
*
|
|
2277
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir
|
|
2278
|
+
*
|
|
2279
|
+
* @default ''
|
|
2280
|
+
*/
|
|
2281
|
+
dir?: 'ltr' | 'rtl' | 'auto' | '';
|
|
2282
|
+
}
|
|
2283
|
+
export interface BlockTypographyProps {
|
|
2284
|
+
/**
|
|
2285
|
+
* Truncates the text content to the specified number of lines.
|
|
2286
|
+
*
|
|
2287
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp
|
|
2288
|
+
*
|
|
2289
|
+
* @default Infinity - no truncation is applied
|
|
2290
|
+
*/
|
|
2291
|
+
lineClamp?: number;
|
|
2292
|
+
}
|
|
2293
|
+
export interface HeadingProps
|
|
2294
|
+
extends GlobalProps,
|
|
2295
|
+
AccessibilityVisibilityProps,
|
|
2296
|
+
BlockTypographyProps {
|
|
2297
|
+
/**
|
|
2298
|
+
* The content of the Heading.
|
|
2299
|
+
*/
|
|
2300
|
+
children?: ComponentChildren;
|
|
2301
|
+
/**
|
|
2302
|
+
* Sets the semantic meaning of the component’s content. When set,
|
|
2303
|
+
* the role will be used by assistive technologies to help users
|
|
2304
|
+
* navigate the page.
|
|
2305
|
+
*
|
|
2306
|
+
* - `heading`: defines the element as a heading to a page or section.
|
|
2307
|
+
* - `presentation`: the heading level will be stripped,
|
|
2308
|
+
* and will prevent the element’s implicit ARIA semantics from
|
|
2309
|
+
* being exposed to the accessibility tree.
|
|
2310
|
+
* - `none`: a synonym for the `presentation` role.
|
|
2311
|
+
*
|
|
2312
|
+
* @default 'heading'
|
|
2313
|
+
*
|
|
2314
|
+
* @implementation The `heading` role doesn't need to be applied if
|
|
2315
|
+
* the host applies it for you; for example, an HTML host rendering
|
|
2316
|
+
* an `<h2>` element should not apply the `heading` role.
|
|
2317
|
+
*/
|
|
2318
|
+
accessibilityRole?:
|
|
2319
|
+
| 'heading'
|
|
2320
|
+
| ExtractStrict<AccessibilityRole, 'presentation' | 'none'>;
|
|
2321
|
+
}
|
|
2322
|
+
export interface IconProps
|
|
2323
|
+
extends GlobalProps,
|
|
2324
|
+
Pick<InteractionProps, 'interestFor'> {
|
|
2325
|
+
/**
|
|
2326
|
+
* Sets the tone of the icon, based on the intention of the information being conveyed.
|
|
2327
|
+
*
|
|
2328
|
+
* @default 'auto'
|
|
2329
|
+
*/
|
|
2330
|
+
tone?: ToneKeyword;
|
|
2331
|
+
/**
|
|
2332
|
+
* Modify the color to be more or less intense.
|
|
2333
|
+
*
|
|
2334
|
+
* @default 'base'
|
|
2335
|
+
*/
|
|
2336
|
+
color?: ColorKeyword;
|
|
2337
|
+
/**
|
|
2338
|
+
* Adjusts the size of the icon.
|
|
2339
|
+
*
|
|
2340
|
+
* @default 'base'
|
|
2341
|
+
*/
|
|
2342
|
+
size?: SizeKeyword;
|
|
2343
|
+
type?: IconType | AnyString;
|
|
2344
|
+
}
|
|
2345
|
+
export interface BaseImageProps {
|
|
2346
|
+
/**
|
|
2347
|
+
* An alternative text description that describe the image for the reader to
|
|
2348
|
+
* understand what it is about. It is extremely useful for both users using
|
|
2349
|
+
* assistive technology and sighted users. A well written description
|
|
2350
|
+
* provides people with visual impairments the ability to participate in
|
|
2351
|
+
* consuming non-text content. When a screen readers encounters an `s-image`,
|
|
2352
|
+
* the description is read and announced aloud. If an image fails to load,
|
|
2353
|
+
* potentially due to a poor connection, the `alt` is displayed on
|
|
2354
|
+
* screen instead. This has the benefit of letting a sighted buyer know an
|
|
2355
|
+
* image was meant to load here, but as an alternative, they’re still able to
|
|
2356
|
+
* consume the text content. Read
|
|
2357
|
+
* [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4)
|
|
2358
|
+
* to learn more.
|
|
2359
|
+
*
|
|
2360
|
+
* @default `''`
|
|
2361
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt
|
|
2362
|
+
*/
|
|
2363
|
+
alt?: string;
|
|
2364
|
+
/**
|
|
2365
|
+
* A set of media conditions and their corresponding sizes.
|
|
2366
|
+
*
|
|
2367
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes
|
|
2368
|
+
*/
|
|
2369
|
+
sizes?: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* The image source (either a remote URL or a local file resource).
|
|
2372
|
+
*
|
|
2373
|
+
* When the image is loading or no `src` is provided, a placeholder will be rendered.
|
|
2374
|
+
*
|
|
2375
|
+
* @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be
|
|
2376
|
+
* reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare.
|
|
2377
|
+
*
|
|
2378
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src
|
|
2379
|
+
*/
|
|
2380
|
+
src?: string;
|
|
2381
|
+
/**
|
|
2382
|
+
* A set of image sources and their width or pixel density descriptors.
|
|
2383
|
+
*
|
|
2384
|
+
* This overrides the `src` property.
|
|
2385
|
+
*
|
|
2386
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset
|
|
2387
|
+
*/
|
|
2388
|
+
srcSet?: string;
|
|
2389
|
+
}
|
|
2390
|
+
export interface ImageProps extends GlobalProps, BaseImageProps, BorderProps {
|
|
2391
|
+
/**
|
|
2392
|
+
* Sets the semantic meaning of the component’s content. When set,
|
|
2393
|
+
* the role will be used by assistive technologies to help users
|
|
2394
|
+
* navigate the page.
|
|
2395
|
+
*
|
|
2396
|
+
* @default 'img'
|
|
2397
|
+
*
|
|
2398
|
+
* @implementation The `img` role doesn't need to be applied if
|
|
2399
|
+
* the host applies it for you; for example, an HTML host rendering
|
|
2400
|
+
* an `<img>` element should not apply the `img` role.
|
|
2401
|
+
*/
|
|
2402
|
+
accessibilityRole?:
|
|
2403
|
+
| 'img'
|
|
2404
|
+
| ExtractStrict<AccessibilityRole, 'presentation' | 'none'>;
|
|
2405
|
+
/**
|
|
2406
|
+
* The displayed inline width of the image.
|
|
2407
|
+
*
|
|
2408
|
+
* - `fill`: the image will takes up 100% of the available inline size.
|
|
2409
|
+
* - `auto`: the image will be displayed at its natural size.
|
|
2410
|
+
*
|
|
2411
|
+
* @default 'fill'
|
|
2412
|
+
*
|
|
2413
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width
|
|
2414
|
+
*/
|
|
2415
|
+
inlineSize?: 'fill' | 'auto';
|
|
2416
|
+
/**
|
|
2417
|
+
* The aspect ratio of the image.
|
|
2418
|
+
*
|
|
2419
|
+
* The rendering of the image will depend on the `inlineSize` value:
|
|
2420
|
+
*
|
|
2421
|
+
* - `inlineSize="fill"`: the aspect ratio will be respected and the image will take the necessary space.
|
|
2422
|
+
* - `inlineSize="auto"`: the image will not render until it has loaded and the aspect ratio will be ignored.
|
|
2423
|
+
*
|
|
2424
|
+
* For example, if the value is set as `50 / 100`, the getter returns `50 / 100`.
|
|
2425
|
+
* If the value is set as `0.5`, the getter returns `0.5 / 1`.
|
|
2426
|
+
*
|
|
2427
|
+
* @default '1/1'
|
|
2428
|
+
*
|
|
2429
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio
|
|
2430
|
+
*/
|
|
2431
|
+
aspectRatio?:
|
|
2432
|
+
| `${number}${optionalSpace}/${optionalSpace}${number}`
|
|
2433
|
+
| `${number}`;
|
|
2434
|
+
/**
|
|
2435
|
+
* Determines how the content of the image is resized to fit its container.
|
|
2436
|
+
* The image is positioned in the center of the container.
|
|
2437
|
+
*
|
|
2438
|
+
* @default 'contain'
|
|
2439
|
+
*
|
|
2440
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
2441
|
+
*/
|
|
2442
|
+
objectFit?: 'contain' | 'cover';
|
|
2443
|
+
/**
|
|
2444
|
+
* Determines the loading behavior of the image:
|
|
2445
|
+
* - `eager`: Immediately loads the image, irrespective of its position within the visible viewport.
|
|
2446
|
+
* - `lazy`: Delays loading the image until it approaches a specified distance from the viewport.
|
|
2447
|
+
*
|
|
2448
|
+
* @default 'eager'
|
|
2449
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading
|
|
2450
|
+
*/
|
|
2451
|
+
loading?: 'eager' | 'lazy';
|
|
2452
|
+
/**
|
|
2453
|
+
* Invoked when load completes successfully.
|
|
2454
|
+
*
|
|
2455
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
|
|
2456
|
+
*/
|
|
2457
|
+
onLoad?: (event: Event) => void;
|
|
2458
|
+
/**
|
|
2459
|
+
* Invoked on load error.
|
|
2460
|
+
*
|
|
2461
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
|
|
2462
|
+
*/
|
|
2463
|
+
onError?: (event: Event) => void;
|
|
2464
|
+
}
|
|
2465
|
+
export interface ModalProps
|
|
2466
|
+
extends GlobalProps,
|
|
2467
|
+
BaseOverlayProps,
|
|
2468
|
+
BaseOverlayMethods,
|
|
2469
|
+
ActionSlots {
|
|
2470
|
+
/**
|
|
2471
|
+
* A label that describes the purpose of the modal. When set,
|
|
2472
|
+
* it will be announced to users using assistive technologies and will
|
|
2473
|
+
* provide them with more context.
|
|
2474
|
+
*
|
|
2475
|
+
* This overrides the `heading` prop for screen readers.
|
|
2476
|
+
*/
|
|
2477
|
+
accessibilityLabel?: string;
|
|
2478
|
+
/**
|
|
2479
|
+
* A title that describes the content of the Modal.
|
|
2480
|
+
*
|
|
2481
|
+
*/
|
|
2482
|
+
heading?: string;
|
|
2483
|
+
/**
|
|
2484
|
+
* Adjust the padding around the Modal content.
|
|
2485
|
+
*
|
|
2486
|
+
* `base`: applies padding that is appropriate for the element.
|
|
2487
|
+
*
|
|
2488
|
+
* `none`: removes all padding from the element. This can be useful when elements inside the Modal need to span
|
|
2489
|
+
* to the edge of the Modal. For example, a full-width image. In this case, rely on `Box` with a padding of 'base'
|
|
2490
|
+
* to bring back the desired padding for the rest of the content.
|
|
2491
|
+
*
|
|
2492
|
+
* @default 'base'
|
|
2493
|
+
*/
|
|
2494
|
+
padding?: 'base' | 'none';
|
|
2495
|
+
/**
|
|
2496
|
+
* Adjust the size of the Modal.
|
|
2497
|
+
*
|
|
2498
|
+
* `max`: expands the Modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.
|
|
2499
|
+
*
|
|
2500
|
+
* @default 'base'
|
|
2501
|
+
*/
|
|
2502
|
+
size?: SizeKeyword | 'max';
|
|
2503
|
+
/**
|
|
2504
|
+
* The content of the Modal.
|
|
2505
|
+
*/
|
|
2506
|
+
children?: ComponentChildren;
|
|
2507
|
+
}
|
|
2508
|
+
export interface NumberFieldProps
|
|
2509
|
+
extends GlobalProps,
|
|
2510
|
+
BaseTextFieldProps,
|
|
2511
|
+
AutocompleteProps<NumberAutocompleteField>,
|
|
2512
|
+
NumberConstraintsProps,
|
|
2513
|
+
FieldDecorationProps {
|
|
2514
|
+
/**
|
|
2515
|
+
* Sets the virtual keyboard.
|
|
2516
|
+
*
|
|
2517
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
|
|
2518
|
+
* @default 'decimal'
|
|
2519
|
+
*/
|
|
2520
|
+
inputMode?: 'decimal' | 'numeric';
|
|
2521
|
+
}
|
|
2522
|
+
export type NumberAutocompleteField = ExtractStrict<
|
|
2523
|
+
AnyAutocompleteField,
|
|
2524
|
+
'one-time-code' | 'cc-number' | 'cc-csc'
|
|
2525
|
+
>;
|
|
2526
|
+
export interface PageProps extends GlobalProps, ActionSlots {
|
|
2527
|
+
/**
|
|
2528
|
+
* The content of the Page.
|
|
2529
|
+
*/
|
|
2530
|
+
children?: ComponentChildren;
|
|
2531
|
+
/**
|
|
2532
|
+
* The main page heading
|
|
2533
|
+
*/
|
|
2534
|
+
heading?: string;
|
|
2535
|
+
/**
|
|
2536
|
+
* The text to be used as subtitle.
|
|
2537
|
+
*/
|
|
2538
|
+
subheading?: string;
|
|
2539
|
+
/**
|
|
2540
|
+
* Additional contextual information about the page.
|
|
2541
|
+
*/
|
|
2542
|
+
accessory?: ComponentChildren;
|
|
2543
|
+
/**
|
|
2544
|
+
* The breadcrumb actions to perform, provided as link elements.
|
|
2545
|
+
*/
|
|
2546
|
+
breadcrumbActions?: ComponentChildren;
|
|
2547
|
+
/**
|
|
2548
|
+
* The aside element is section of a page that contains content that is tangentially related to the content around the aside element, and which could be considered separate from that content.
|
|
2549
|
+
* Such sections are often represented as sidebars in printed typography.
|
|
2550
|
+
* @implementation surfaces built ontop of the web platform should implement this using the <aside> element https://developer.mozilla.org/en-US/docs/Web/HTML/Element/aside
|
|
2551
|
+
*/
|
|
2552
|
+
aside?: ComponentChildren;
|
|
2553
|
+
/**
|
|
2554
|
+
* The inline size of the page
|
|
2555
|
+
* - `base` corresponds to a set default inline size
|
|
2556
|
+
* - `large` full width with whitespace
|
|
2557
|
+
*
|
|
2558
|
+
* @default 'base'
|
|
2559
|
+
*/
|
|
2560
|
+
inlineSize?: SizeKeyword;
|
|
2561
|
+
}
|
|
2562
|
+
export interface POSBlockProps
|
|
2563
|
+
extends GlobalProps,
|
|
2564
|
+
Pick<ActionSlots, 'secondaryActions'> {
|
|
2565
|
+
/**
|
|
2566
|
+
* The heading to display within the POSBlock.
|
|
2567
|
+
*
|
|
2568
|
+
* If not provided, the description of the extension will be used when a heading is appropriate.
|
|
2569
|
+
*/
|
|
2570
|
+
heading?: string;
|
|
2571
|
+
/**
|
|
2572
|
+
* The content to display within the POSBlock.
|
|
2573
|
+
*/
|
|
2574
|
+
children?: ComponentChildren;
|
|
2575
|
+
/**
|
|
2576
|
+
* The secondary actions to perform, provided as button or link type elements.
|
|
2577
|
+
*/
|
|
2578
|
+
secondaryActions?: ComponentChildren;
|
|
2579
|
+
}
|
|
2580
|
+
export interface QRCodeProps extends GlobalProps {
|
|
2581
|
+
/**
|
|
2582
|
+
* Set the border of the QR code.
|
|
2583
|
+
*
|
|
2584
|
+
* `base`: applies border that is appropriate for the element.
|
|
2585
|
+
* `none`: removes the border from the element.
|
|
2586
|
+
*
|
|
2587
|
+
* @default 'base'
|
|
2588
|
+
*/
|
|
2589
|
+
border?: 'base' | 'none';
|
|
2590
|
+
/**
|
|
2591
|
+
* The content to be encoded in the QR code, which can be any string such as a URL, email address, plain text, etc.
|
|
2592
|
+
* Specific string formatting can trigger actions on the user's device when scanned, like opening geolocation
|
|
2593
|
+
* coordinates on a map, opening a preferred app or app store entry, preparing an email, text message, and more.
|
|
2594
|
+
*/
|
|
2595
|
+
content?: string;
|
|
2596
|
+
/**
|
|
2597
|
+
* The displayed size of the QR code.
|
|
2598
|
+
*
|
|
2599
|
+
* `fill`: the QR code will takes up 100% of the available inline-size and maintain a 1:1 aspect ratio.
|
|
2600
|
+
* `base`: the QR code will be displayed at its default size.
|
|
2601
|
+
*
|
|
2602
|
+
* @default 'base'
|
|
2603
|
+
*/
|
|
2604
|
+
size?: 'base' | 'fill';
|
|
2605
|
+
/**
|
|
2606
|
+
* A label that describes the purpose or contents of the QR code. When set,
|
|
2607
|
+
* it will be announced to users using assistive technologies and will
|
|
2608
|
+
* provide more context about what the QR code may do when scanned.
|
|
2609
|
+
*
|
|
2610
|
+
* @default 'QR code' (translated to the user's locale)
|
|
2611
|
+
*/
|
|
2612
|
+
accessibilityLabel?: string;
|
|
2613
|
+
/**
|
|
2614
|
+
* Invoked when the conversion of `content` to a QR code fails.
|
|
2615
|
+
* If an error occurs, the QR code and its child elements will not be displayed.
|
|
2616
|
+
*/
|
|
2617
|
+
onError?: (event: Event) => void;
|
|
2618
|
+
/**
|
|
2619
|
+
* URL of an image to be displayed in the center of the QR code.
|
|
2620
|
+
* This is useful for branding or to indicate to the user what scanning the QR code will do.
|
|
2621
|
+
* By default, no image is displayed.
|
|
2622
|
+
*/
|
|
2623
|
+
logo?: string;
|
|
2624
|
+
}
|
|
2625
|
+
export interface ScrollEventProps {
|
|
2626
|
+
/**
|
|
2627
|
+
* Callback when the scroll position reaches any edge.
|
|
2628
|
+
*
|
|
2629
|
+
* Provides information about which edges have been reached:
|
|
2630
|
+
* - `inline: 'start'` - reached the inline-start edge
|
|
2631
|
+
* - `inline: 'end'` - reached the inline-end edge
|
|
2632
|
+
* - `block: 'start'` - reached the block-start edge
|
|
2633
|
+
* - `block: 'end'` - reached the block-end edge
|
|
2634
|
+
* - `null` - not at that edge
|
|
2635
|
+
*
|
|
2636
|
+
* Uses the flow‑relative axes.
|
|
2637
|
+
*/
|
|
2638
|
+
onScrollToEdge?: (
|
|
2639
|
+
inline: 'start' | 'end' | null,
|
|
2640
|
+
block: 'start' | 'end' | null,
|
|
2641
|
+
) => void;
|
|
2642
|
+
/**
|
|
2643
|
+
* Distance from the edge at which `onScrollToEdge` fires.
|
|
2644
|
+
* Percentage values are relative to the scrollable content's size in that axis.
|
|
2645
|
+
*
|
|
2646
|
+
* [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
|
|
2647
|
+
* supported.
|
|
2648
|
+
*
|
|
2649
|
+
* The order is:
|
|
2650
|
+
* - 4 values: `block-start inline-end block-end inline-start`
|
|
2651
|
+
* - 3 values: `block-start inline block-end`
|
|
2652
|
+
* - 2 values: `block inline`
|
|
2653
|
+
*
|
|
2654
|
+
* For example:
|
|
2655
|
+
* - `48px` means the distance from the edge at which `onScrollToEdge` fires from block-start, inline-end, block-end and inline-start is `48px`.
|
|
2656
|
+
* - `48px 0` means the distance from the edge at which `onScrollToEdge` fires from block-start and block-end is `48px`, and for inline-start and inline-end is `0`.
|
|
2657
|
+
* - `48 0 48` means the distance from the edge at which `onScrollToEdge` fires from block-start is `48px`, for inline-end is `0`, for block-end is `48px` and for inline-start is `0`.
|
|
2658
|
+
* - `48px 0 48px 10%` means the distance from the edge at which `onScrollToEdge` fires from block-start is `48px`, for inline-end is `0`, for block-end is `48px` and for inline-start is `10%`.
|
|
2659
|
+
*
|
|
2660
|
+
* @default '0'
|
|
2661
|
+
* Refer to [MDN](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/scrollMargin) for more details.
|
|
2662
|
+
*/
|
|
2663
|
+
scrollMargin?: MaybeAllValuesShorthandProperty<SizeUnits>;
|
|
2664
|
+
}
|
|
2665
|
+
export type OverflowKeyword = 'auto' | 'hidden';
|
|
2666
|
+
export interface ScrollBoxProps
|
|
2667
|
+
extends GlobalProps,
|
|
2668
|
+
ScrollEventProps,
|
|
2669
|
+
Omit<BaseBoxPropsWithRole, 'overflow'> {
|
|
2670
|
+
/**
|
|
2671
|
+
* Sets the overflow behavior of the element.
|
|
2672
|
+
*
|
|
2673
|
+
* - `hidden`: clips the content when it is larger than the element’s container and the element will not be scrollable in that axis.
|
|
2674
|
+
* - `auto`: clips the content when it is larger than the element’s container and make it scrollable in that axis.
|
|
2675
|
+
*
|
|
2676
|
+
* 1-to-2-value syntax is supported but note that, contrary to the CSS, it uses flow-relative values and the order is:
|
|
2677
|
+
*
|
|
2678
|
+
* - 2 values: `block inline`
|
|
2679
|
+
*
|
|
2680
|
+
* @default 'auto'
|
|
2681
|
+
*
|
|
2682
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/overflow
|
|
2683
|
+
*/
|
|
2684
|
+
overflow?: OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`;
|
|
2685
|
+
}
|
|
2686
|
+
export interface SearchFieldProps
|
|
2687
|
+
extends GlobalProps,
|
|
2688
|
+
BaseTextFieldProps,
|
|
2689
|
+
MinMaxLengthProps,
|
|
2690
|
+
AutocompleteProps<SearchAutocompleteField> {}
|
|
2691
|
+
export type SearchAutocompleteField = TextAutocompleteField;
|
|
2692
|
+
export interface SectionProps extends GlobalProps, ActionSlots {
|
|
2693
|
+
/**
|
|
2694
|
+
* The content of the Section.
|
|
2695
|
+
*/
|
|
2696
|
+
children?: ComponentChildren;
|
|
2697
|
+
/**
|
|
2698
|
+
* A label used to describe the section that will be announced by assistive technologies.
|
|
2699
|
+
*
|
|
2700
|
+
* When no `heading` property is provided or included as a children of the Section, you **must** provide an
|
|
2701
|
+
* `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide
|
|
2702
|
+
* the right context to users.
|
|
2703
|
+
*/
|
|
2704
|
+
accessibilityLabel?: string;
|
|
2705
|
+
/**
|
|
2706
|
+
* A title that describes the content of the section.
|
|
2707
|
+
*/
|
|
2708
|
+
heading?: string;
|
|
2709
|
+
/**
|
|
2710
|
+
* Adjust the padding of all edges.
|
|
2711
|
+
*
|
|
2712
|
+
* - `base`: applies padding that is appropriate for the element. Note that it may result in no padding if
|
|
2713
|
+
* this is the right design decision in a particular context.
|
|
2714
|
+
* - `none`: removes all padding from the element. This can be useful when elements inside the Section need to span
|
|
2715
|
+
* to the edge of the Section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base'
|
|
2716
|
+
* to bring back the desired padding for the rest of the content.
|
|
2717
|
+
*
|
|
2718
|
+
* @default 'base'
|
|
2719
|
+
*/
|
|
2720
|
+
padding?: 'base' | 'none';
|
|
2721
|
+
}
|
|
2722
|
+
export interface StackProps
|
|
2723
|
+
extends GlobalProps,
|
|
2724
|
+
BaseBoxPropsWithRole,
|
|
2725
|
+
GapProps {
|
|
2726
|
+
/**
|
|
2727
|
+
* The content of the Stack.
|
|
2728
|
+
*/
|
|
2729
|
+
children?: ComponentChildren;
|
|
2730
|
+
/**
|
|
2731
|
+
* Sets how the children are placed within the Stack. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
|
|
2732
|
+
*
|
|
2733
|
+
* @default 'block'
|
|
2734
|
+
*
|
|
2735
|
+
* @implementation the content will wrap if the direction is 'inline', and not wrap if the direction is 'block'
|
|
2736
|
+
*/
|
|
2737
|
+
direction?: MaybeResponsive<'block' | 'inline'>;
|
|
2738
|
+
/**
|
|
2739
|
+
* Aligns the Stack along the main axis.
|
|
2740
|
+
*
|
|
2741
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
2742
|
+
* @default 'normal'
|
|
2743
|
+
*/
|
|
2744
|
+
justifyContent?: MaybeResponsive<JustifyContentKeyword>;
|
|
2745
|
+
/**
|
|
2746
|
+
* Aligns the Stack's children along the cross axis.
|
|
2747
|
+
*
|
|
2748
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
2749
|
+
* @default 'normal'
|
|
2750
|
+
*/
|
|
2751
|
+
alignItems?: MaybeResponsive<AlignItemsKeyword>;
|
|
2752
|
+
/**
|
|
2753
|
+
* Aligns the Stack along the cross axis.
|
|
2754
|
+
*
|
|
2755
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
2756
|
+
* @default 'normal'
|
|
2757
|
+
*/
|
|
2758
|
+
alignContent?: MaybeResponsive<AlignContentKeyword>;
|
|
2759
|
+
}
|
|
2760
|
+
export interface TextProps
|
|
2761
|
+
extends GlobalProps,
|
|
2762
|
+
AccessibilityVisibilityProps,
|
|
2763
|
+
BaseTypographyProps,
|
|
2764
|
+
DisplayProps,
|
|
2765
|
+
Pick<InteractionProps, 'interestFor'> {
|
|
2766
|
+
/**
|
|
2767
|
+
* The content of the Text.
|
|
2768
|
+
*/
|
|
2769
|
+
children?: ComponentChildren;
|
|
2770
|
+
/**
|
|
2771
|
+
* Provide semantic meaning and default styling to the text.
|
|
2772
|
+
*
|
|
2773
|
+
* Other presentation properties on Text override the default styling.
|
|
2774
|
+
*
|
|
2775
|
+
* @default 'generic'
|
|
2776
|
+
*/
|
|
2777
|
+
type?: TextType;
|
|
2778
|
+
}
|
|
2779
|
+
export type TextType =
|
|
2780
|
+
/**
|
|
2781
|
+
* Indicate the text is contact information. Typically used for addresses.
|
|
2782
|
+
*
|
|
2783
|
+
* This must have `inline` layout (despite the default being `block` in HTML hosts).
|
|
2784
|
+
*
|
|
2785
|
+
* Surfaces may apply styling to this type.
|
|
2786
|
+
*
|
|
2787
|
+
* In an HTML host, the text will be rendered in an `<address>` element.
|
|
2788
|
+
*
|
|
2789
|
+
* @implementation vertical alignment should be `baseline` (`vertical-align: baseline`)
|
|
2790
|
+
*
|
|
2791
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address
|
|
2792
|
+
*/
|
|
2793
|
+
| 'address'
|
|
2794
|
+
/**
|
|
2795
|
+
* Indicate the text is no longer accurate or no longer relevant. One such use-case is discounted prices.
|
|
2796
|
+
*
|
|
2797
|
+
* Surfaces should apply styling to this type to suggest its content no longer applies.
|
|
2798
|
+
*
|
|
2799
|
+
* In an HTML host, the text will be rendered in a `<s>` element.
|
|
2800
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s
|
|
2801
|
+
*/
|
|
2802
|
+
| 'redundant'
|
|
2803
|
+
/**
|
|
2804
|
+
* Indicate the text is marked or highlighted and relevant to the user’s current action.
|
|
2805
|
+
* One such use-case is to indicate the characters that matched a search query.
|
|
2806
|
+
*
|
|
2807
|
+
* Surfaces should apply styling to this type to draw attention to the content.
|
|
2808
|
+
*
|
|
2809
|
+
* In an HTML host, the text will be rendered in a `<mark>` element.
|
|
2810
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark
|
|
2811
|
+
*/
|
|
2812
|
+
| 'mark'
|
|
2813
|
+
/**
|
|
2814
|
+
* Indicate emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text.
|
|
2815
|
+
*
|
|
2816
|
+
* Surfaces should apply styling to this type to distinguish it from surrounding text. Italicization is a common choice, but not required.
|
|
2817
|
+
*
|
|
2818
|
+
* In an HTML host, the text will be rendered in an `<em>` element.
|
|
2819
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em
|
|
2820
|
+
*/
|
|
2821
|
+
| 'emphasis'
|
|
2822
|
+
/**
|
|
2823
|
+
* Indicate an offset from the normal prose of the text. Typically used to indicate
|
|
2824
|
+
* a foreign word, fictional character thoughts, or when the text refers to the definition of a word
|
|
2825
|
+
* instead of representing its semantic meaning.
|
|
2826
|
+
*
|
|
2827
|
+
* Surfaces should italicize this content by default.
|
|
2828
|
+
*
|
|
2829
|
+
* In an HTML host, the text will be rendered in a `<i>` tag.
|
|
2830
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i
|
|
2831
|
+
*/
|
|
2832
|
+
| 'offset'
|
|
2833
|
+
/**
|
|
2834
|
+
* Indicate strong importance, seriousness, or urgency.
|
|
2835
|
+
*
|
|
2836
|
+
* Surfaces should render this content bold by default.
|
|
2837
|
+
*
|
|
2838
|
+
* In an HTML host, the text will be rendered in a `<strong>` tag.
|
|
2839
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong
|
|
2840
|
+
*/
|
|
2841
|
+
| 'strong'
|
|
2842
|
+
/**
|
|
2843
|
+
* Indicates the text is considered less important than the main content, but is still necessary for the reader to understand.
|
|
2844
|
+
* It can be used for secondary content but also for disclaimers, terms and conditions, or legal information.
|
|
2845
|
+
*
|
|
2846
|
+
* Surfaces should apply a smaller font size than the default size.
|
|
2847
|
+
*
|
|
2848
|
+
* In an HTML host, the text will be rendered in a `<small>` element.
|
|
2849
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small
|
|
2850
|
+
*/
|
|
2851
|
+
| 'small'
|
|
2852
|
+
/**
|
|
2853
|
+
* No additional semantics or styling is applied.
|
|
2854
|
+
*
|
|
2855
|
+
* Surfaces must not apply any default styling to this type.
|
|
2856
|
+
*
|
|
2857
|
+
* In an HTML host, the text will be rendered in a `<span>` tag.
|
|
2858
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span
|
|
2859
|
+
*/
|
|
2860
|
+
| 'generic';
|
|
2861
|
+
export interface TextAreaProps
|
|
2862
|
+
extends GlobalProps,
|
|
2863
|
+
BaseTextFieldProps,
|
|
2864
|
+
MinMaxLengthProps,
|
|
2865
|
+
AutocompleteProps<TextAutocompleteField> {
|
|
2866
|
+
/**
|
|
2867
|
+
* A number of visible text lines.
|
|
2868
|
+
*
|
|
2869
|
+
* @default 2
|
|
2870
|
+
*/
|
|
2871
|
+
rows?: number;
|
|
2872
|
+
}
|
|
2873
|
+
export interface TextFieldProps
|
|
2874
|
+
extends GlobalProps,
|
|
2875
|
+
BaseTextFieldProps,
|
|
2876
|
+
MinMaxLengthProps,
|
|
2877
|
+
AutocompleteProps<TextAutocompleteField>,
|
|
2878
|
+
FieldDecorationProps {}
|
|
2879
|
+
export interface TileProps
|
|
2880
|
+
extends GlobalProps,
|
|
2881
|
+
Pick<BaseClickableProps, 'onClick' | 'disabled'> {
|
|
2882
|
+
/**
|
|
2883
|
+
* A title that describes the content of the Tile.
|
|
2884
|
+
*
|
|
2885
|
+
* @default ''
|
|
2886
|
+
*/
|
|
2887
|
+
heading?: string;
|
|
2888
|
+
/**
|
|
2889
|
+
* Supporting text displayed below the heading.
|
|
2890
|
+
*
|
|
2891
|
+
* @default ''
|
|
2892
|
+
*/
|
|
2893
|
+
subheading?: string;
|
|
2894
|
+
/**
|
|
2895
|
+
* A numeric indicator rendered within the Tile (for example, a count or a step number).
|
|
2896
|
+
*
|
|
2897
|
+
* - When provided, the indicator is displayed inside the tile.
|
|
2898
|
+
* - Intended for small integers. It may clamp, truncate, or abbreviate larger values.
|
|
2899
|
+
*
|
|
2900
|
+
*/
|
|
2901
|
+
itemCount?: number;
|
|
2902
|
+
/**
|
|
2903
|
+
* Sets the tone of the Tile, based on the intention of the information being conveyed.
|
|
2904
|
+
* @default 'auto'
|
|
2905
|
+
*/
|
|
2906
|
+
tone?: ExtractStrict<ToneKeyword, 'auto' | 'neutral' | 'accent'>;
|
|
2907
|
+
}
|
|
2908
|
+
export interface TimePickerProps
|
|
2909
|
+
extends GlobalProps,
|
|
2910
|
+
InputProps,
|
|
2911
|
+
FocusEventProps {
|
|
2912
|
+
/**
|
|
2913
|
+
* Times that can be selected.
|
|
2914
|
+
*
|
|
2915
|
+
* A comma-separated list of allowed time ranges. Whitespace is allowed after commas.
|
|
2916
|
+
*
|
|
2917
|
+
* The default `''` allows all times.
|
|
2918
|
+
*
|
|
2919
|
+
* Each time range is in `HH:MM--HH:MM` format.
|
|
2920
|
+
*
|
|
2921
|
+
* The end of the range is exclusive, so `09:00--10:00` allows selecting `09:00` but not `10:00`.
|
|
2922
|
+
*
|
|
2923
|
+
* Either side of `--` can be omitted to create an unbounded range.
|
|
2924
|
+
*
|
|
2925
|
+
* Whitespace is allowed either side of `--`.
|
|
2926
|
+
*
|
|
2927
|
+
* @default ''
|
|
2928
|
+
*
|
|
2929
|
+
* @example
|
|
2930
|
+
* `09:00--10:00, 13:00--14:00` - assuming the step is 1 hour, this allows selecting `09:00` or `13:00`.
|
|
2931
|
+
* `12:00--` - allows selecting `12:00` and all times after it.
|
|
2932
|
+
*/
|
|
2933
|
+
allow?: string;
|
|
2934
|
+
/**
|
|
2935
|
+
* Times that cannot be selected. This subtracts from `allow`.
|
|
2936
|
+
*
|
|
2937
|
+
* A comma-separated list of allowed time ranges. Whitespace is allowed after commas.
|
|
2938
|
+
*
|
|
2939
|
+
* The default `''` has no effect on `allow`.
|
|
2940
|
+
*
|
|
2941
|
+
* Each time range is in `HH:MM--HH:MM` format.
|
|
2942
|
+
*
|
|
2943
|
+
* The end of the range is exclusive, so `09:00--10:00` disallows selecting `09:00` but not `10:00`.
|
|
2944
|
+
*
|
|
2945
|
+
* Either side of `--` can be omitted to create an unbounded range.
|
|
2946
|
+
*
|
|
2947
|
+
* Whitespace is allowed either side of `--`.
|
|
2948
|
+
*
|
|
2949
|
+
* @default ''
|
|
2950
|
+
*
|
|
2951
|
+
* @example
|
|
2952
|
+
* `09:00--10:00, 13:00--14:00` - assuming the step is 1 hour, this disallows selecting `09:00` or `13:00`.
|
|
2953
|
+
*/
|
|
2954
|
+
disallow?: string;
|
|
2955
|
+
/**
|
|
2956
|
+
* Default selected value.
|
|
2957
|
+
*
|
|
2958
|
+
* The default, `''`, means no time is selected.
|
|
2959
|
+
*
|
|
2960
|
+
* The value must be a 24-hour time in `HH:mm:ss` format, with leading zeros.
|
|
2961
|
+
*
|
|
2962
|
+
* Examples: `"00:00:00"`, `"09:05:00"`, `"23:59:00"`, `"14:03:30"`.
|
|
2963
|
+
*
|
|
2964
|
+
* This follows the HTML time input value format, which is always 24-hour with
|
|
2965
|
+
* leading zeros regardless of UI presentation.
|
|
2966
|
+
*
|
|
2967
|
+
* See: https://developer.mozilla.org/docs/Web/HTML/Element/input/time
|
|
2968
|
+
*
|
|
2969
|
+
* If the provided value is invalid, '' is used as the value.
|
|
2970
|
+
*
|
|
2971
|
+
* @default ''
|
|
2972
|
+
*/
|
|
2973
|
+
defaultValue?: string;
|
|
2974
|
+
/**
|
|
2975
|
+
* Current selected value.
|
|
2976
|
+
*
|
|
2977
|
+
* The default, `''`, means no time is selected.
|
|
2978
|
+
*
|
|
2979
|
+
* The value must be a 24-hour time in `HH:mm:ss` format, with leading zeros.
|
|
2980
|
+
*
|
|
2981
|
+
* Examples: `"00:00:00"`, `"09:05:00"`, `"23:59:00"`, `"14:03:30"`.
|
|
2982
|
+
*
|
|
2983
|
+
* This follows the HTML time input value format, which is always 24-hour with
|
|
2984
|
+
* leading zeros regardless of UI presentation.
|
|
2985
|
+
*
|
|
2986
|
+
* See: https://developer.mozilla.org/docs/Web/HTML/Element/input/time
|
|
2987
|
+
*
|
|
2988
|
+
* If the provided value is invalid, '' is used as the value.
|
|
2989
|
+
*
|
|
2990
|
+
* @default ''
|
|
2991
|
+
*/
|
|
2992
|
+
value?: string;
|
|
2993
|
+
/**
|
|
2994
|
+
* The step between selectable times, in seconds.
|
|
2995
|
+
*
|
|
2996
|
+
* @default 60
|
|
2997
|
+
*/
|
|
2998
|
+
step?: number;
|
|
2999
|
+
}
|
|
3000
|
+
export interface TimeFieldProps
|
|
3001
|
+
extends GlobalProps,
|
|
3002
|
+
BaseTextFieldProps,
|
|
3003
|
+
Pick<
|
|
3004
|
+
TimePickerProps,
|
|
3005
|
+
'value' | 'defaultValue' | 'allow' | 'disallow' | 'step'
|
|
3006
|
+
> {
|
|
3007
|
+
/**
|
|
3008
|
+
* Callback when the field has an invalid time.
|
|
3009
|
+
* This callback will be called, if the time typed is invalid or disabled.
|
|
3010
|
+
*
|
|
3011
|
+
* Times that don’t exist or have formatting errors are considered invalid. Some examples of invalid times are:
|
|
3012
|
+
* - 24:00
|
|
3013
|
+
* - 12:60
|
|
3014
|
+
*
|
|
3015
|
+
* Disallowed times are considered invalid.
|
|
3016
|
+
*
|
|
3017
|
+
* It’s important to note that this callback will be called only when the user **finishes editing** the time,
|
|
3018
|
+
* and it’s called right after the `onChange` callback.
|
|
3019
|
+
* The field is **not** validated on every change to the input. Once the buyer has signalled that
|
|
3020
|
+
* they have finished editing the field (typically, by blurring the field), the field gets validated and the callback is run if the value is invalid.
|
|
3021
|
+
*/
|
|
3022
|
+
onInvalid?: (event: Event) => void;
|
|
3023
|
+
/**
|
|
3024
|
+
* Current selected value.
|
|
3025
|
+
*
|
|
3026
|
+
* The default, `''`, means no time is selected.
|
|
3027
|
+
*
|
|
3028
|
+
* The value must be a 24-hour time in `HH:mm:ss` format, with leading zeros.
|
|
3029
|
+
*
|
|
3030
|
+
* Examples: `"00:00:00"`, `"09:05:00"`, `"23:59:00"`, `"14:03:30"`.
|
|
3031
|
+
*
|
|
3032
|
+
* This follows the HTML time input value format, which is always 24-hour with
|
|
3033
|
+
* leading zeros regardless of UI presentation.
|
|
3034
|
+
*
|
|
3035
|
+
* See: https://developer.mozilla.org/docs/Web/HTML/Element/input/time
|
|
3036
|
+
*/
|
|
3037
|
+
value?: string;
|
|
3038
|
+
/**
|
|
3039
|
+
* Default selected value.
|
|
3040
|
+
*
|
|
3041
|
+
* The default, `''`, means no time is selected.
|
|
3042
|
+
*
|
|
3043
|
+
* The value must be a 24-hour time in `HH:mm:ss` format, with leading zeros.
|
|
3044
|
+
*
|
|
3045
|
+
* Examples: `"00:00:00"`, `"09:05:00"`, `"23:59:00"`, `"14:03:30"`.
|
|
3046
|
+
*
|
|
3047
|
+
* This follows the HTML time input value format, which is always 24-hour with
|
|
3048
|
+
* leading zeros regardless of UI presentation.
|
|
3049
|
+
*
|
|
3050
|
+
* See: https://developer.mozilla.org/docs/Web/HTML/Element/input/time
|
|
3051
|
+
*/
|
|
3052
|
+
defaultValue?: string;
|
|
3053
|
+
}
|
|
3054
|
+
//
|
|
3055
|
+
// Preact Virtual DOM
|
|
3056
|
+
// -----------------------------------
|
|
3057
|
+
export interface VNode<P = {}> {
|
|
3058
|
+
type: ComponentType<P> | string;
|
|
3059
|
+
props: P & {
|
|
3060
|
+
children: ComponentChildren$1;
|
|
3061
|
+
};
|
|
3062
|
+
key: Key;
|
|
3063
|
+
/**
|
|
3064
|
+
* ref is not guaranteed by React.ReactElement, for compatibility reasons
|
|
3065
|
+
* with popular react libs we define it as optional too
|
|
3066
|
+
*/
|
|
3067
|
+
ref?: Ref<any> | null;
|
|
3068
|
+
/**
|
|
3069
|
+
* The time this `vnode` started rendering. Will only be set when
|
|
3070
|
+
* the devtools are attached.
|
|
3071
|
+
* Default value: `0`
|
|
3072
|
+
*/
|
|
3073
|
+
startTime?: number;
|
|
3074
|
+
/**
|
|
3075
|
+
* The time that the rendering of this `vnode` was completed. Will only be
|
|
3076
|
+
* set when the devtools are attached.
|
|
3077
|
+
* Default value: `-1`
|
|
3078
|
+
*/
|
|
3079
|
+
endTime?: number;
|
|
3080
|
+
}
|
|
3081
|
+
//
|
|
3082
|
+
// Preact Component interface
|
|
3083
|
+
// -----------------------------------
|
|
3084
|
+
export type Key = string | number | any;
|
|
3085
|
+
export type RefObject<T> = {
|
|
3086
|
+
current: T | null;
|
|
3087
|
+
};
|
|
3088
|
+
export type RefCallback<T> = (instance: T | null) => void | (() => void);
|
|
3089
|
+
export type Ref<T> = RefObject<T> | RefCallback<T> | null;
|
|
3090
|
+
export type ComponentChild =
|
|
3091
|
+
| VNode<any>
|
|
3092
|
+
| object
|
|
3093
|
+
| string
|
|
3094
|
+
| number
|
|
3095
|
+
| bigint
|
|
3096
|
+
| boolean
|
|
3097
|
+
| null
|
|
3098
|
+
| undefined;
|
|
3099
|
+
type ComponentChildren$1 = ComponentChild[] | ComponentChild;
|
|
3100
|
+
export interface Attributes {
|
|
3101
|
+
key?: Key | undefined;
|
|
3102
|
+
jsx?: boolean | undefined;
|
|
3103
|
+
}
|
|
3104
|
+
export interface ErrorInfo {
|
|
3105
|
+
componentStack?: string;
|
|
3106
|
+
}
|
|
3107
|
+
export type RenderableProps<P, RefType = any> = P &
|
|
3108
|
+
Readonly<
|
|
3109
|
+
Attributes & {
|
|
3110
|
+
children?: ComponentChildren$1;
|
|
3111
|
+
ref?: Ref<RefType>;
|
|
3112
|
+
}
|
|
3113
|
+
>;
|
|
3114
|
+
export type ComponentType<P = {}> = ComponentClass<P> | FunctionComponent<P>;
|
|
3115
|
+
export interface FunctionComponent<P = {}> {
|
|
3116
|
+
(props: RenderableProps<P>, context?: any): ComponentChildren$1;
|
|
3117
|
+
displayName?: string;
|
|
3118
|
+
defaultProps?: Partial<P> | undefined;
|
|
3119
|
+
}
|
|
3120
|
+
export interface ComponentClass<P = {}, S = {}> {
|
|
3121
|
+
new (props: P, context?: any): Component<P, S>;
|
|
3122
|
+
displayName?: string;
|
|
3123
|
+
defaultProps?: Partial<P>;
|
|
3124
|
+
contextType?: Context<any>;
|
|
3125
|
+
getDerivedStateFromProps?(
|
|
3126
|
+
props: Readonly<P>,
|
|
3127
|
+
state: Readonly<S>,
|
|
3128
|
+
): Partial<S> | null;
|
|
3129
|
+
getDerivedStateFromError?(error: any): Partial<S> | null;
|
|
3130
|
+
}
|
|
3131
|
+
export interface Component<P = {}, S = {}> {
|
|
3132
|
+
componentWillMount?(): void;
|
|
3133
|
+
componentDidMount?(): void;
|
|
3134
|
+
componentWillUnmount?(): void;
|
|
3135
|
+
getChildContext?(): object;
|
|
3136
|
+
componentWillReceiveProps?(nextProps: Readonly<P>, nextContext: any): void;
|
|
3137
|
+
shouldComponentUpdate?(
|
|
3138
|
+
nextProps: Readonly<P>,
|
|
3139
|
+
nextState: Readonly<S>,
|
|
3140
|
+
nextContext: any,
|
|
3141
|
+
): boolean;
|
|
3142
|
+
componentWillUpdate?(
|
|
3143
|
+
nextProps: Readonly<P>,
|
|
3144
|
+
nextState: Readonly<S>,
|
|
3145
|
+
nextContext: any,
|
|
3146
|
+
): void;
|
|
3147
|
+
getSnapshotBeforeUpdate?(oldProps: Readonly<P>, oldState: Readonly<S>): any;
|
|
3148
|
+
componentDidUpdate?(
|
|
3149
|
+
previousProps: Readonly<P>,
|
|
3150
|
+
previousState: Readonly<S>,
|
|
3151
|
+
snapshot: any,
|
|
3152
|
+
): void;
|
|
3153
|
+
componentDidCatch?(error: any, errorInfo: ErrorInfo): void;
|
|
3154
|
+
}
|
|
3155
|
+
declare abstract class Component<P, S> {
|
|
3156
|
+
constructor(props?: P, context?: any);
|
|
3157
|
+
static displayName?: string;
|
|
3158
|
+
static defaultProps?: any;
|
|
3159
|
+
static contextType?: Context<any>;
|
|
3160
|
+
// Static members cannot reference class type parameters. This is not
|
|
3161
|
+
// supported in TypeScript. Reusing the same type arguments from `Component`
|
|
3162
|
+
// will lead to an impossible state where one cannot satisfy the type
|
|
3163
|
+
// constraint under no circumstances, see #1356.In general type arguments
|
|
3164
|
+
// seem to be a bit buggy and not supported well at the time of this
|
|
3165
|
+
// writing with TS 3.3.3333.
|
|
3166
|
+
static getDerivedStateFromProps?(
|
|
3167
|
+
props: Readonly<object>,
|
|
3168
|
+
state: Readonly<object>,
|
|
3169
|
+
): object | null;
|
|
3170
|
+
static getDerivedStateFromError?(error: any): object | null;
|
|
3171
|
+
state: Readonly<S>;
|
|
3172
|
+
props: RenderableProps<P>;
|
|
3173
|
+
context: any;
|
|
3174
|
+
base?: Element | Text;
|
|
3175
|
+
// From https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e836acc75a78cf0655b5dfdbe81d69fdd4d8a252/types/react/index.d.ts#L402
|
|
3176
|
+
// // We MUST keep setState() as a unified signature because it allows proper checking of the method return type.
|
|
3177
|
+
// // See: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/18365#issuecomment-351013257
|
|
3178
|
+
setState<K extends keyof S>(
|
|
3179
|
+
state:
|
|
3180
|
+
| ((
|
|
3181
|
+
prevState: Readonly<S>,
|
|
3182
|
+
props: Readonly<P>,
|
|
3183
|
+
) => Pick<S, K> | Partial<S> | null)
|
|
3184
|
+
| (Pick<S, K> | Partial<S> | null),
|
|
3185
|
+
callback?: () => void,
|
|
3186
|
+
): void;
|
|
3187
|
+
forceUpdate(callback?: () => void): void;
|
|
3188
|
+
abstract render(
|
|
3189
|
+
props?: RenderableProps<P>,
|
|
3190
|
+
state?: Readonly<S>,
|
|
3191
|
+
context?: any,
|
|
3192
|
+
): ComponentChildren$1;
|
|
3193
|
+
}
|
|
3194
|
+
//
|
|
3195
|
+
// Context
|
|
3196
|
+
// -----------------------------------
|
|
3197
|
+
export interface Consumer<T>
|
|
3198
|
+
extends FunctionComponent<{
|
|
3199
|
+
children: (value: T) => ComponentChildren$1;
|
|
3200
|
+
}> {}
|
|
3201
|
+
export interface Provider<T>
|
|
3202
|
+
extends FunctionComponent<{
|
|
3203
|
+
value: T;
|
|
3204
|
+
children?: ComponentChildren$1;
|
|
3205
|
+
}> {}
|
|
3206
|
+
export interface Context<T> extends Provider<T> {
|
|
3207
|
+
Consumer: Consumer<T>;
|
|
3208
|
+
Provider: Provider<T>;
|
|
3209
|
+
displayName?: string;
|
|
3210
|
+
}
|