@shopify/ui-extensions 2026.1.2 → 2026.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/surfaces/checkout/shared.js +1 -10
- package/build/cjs/surfaces/customer-account/preact/metafield.js +1 -0
- package/build/cjs/surfaces/customer-account/preact/metafields.js +1 -0
- package/build/esm/surfaces/checkout/shared.mjs +1 -10
- package/build/esm/surfaces/customer-account/preact/metafield.mjs +1 -0
- package/build/esm/surfaces/customer-account/preact/metafields.mjs +1 -0
- package/build/esnext/surfaces/checkout/shared.esnext +1 -10
- package/build/esnext/surfaces/customer-account/preact/metafield.esnext +1 -0
- package/build/esnext/surfaces/customer-account/preact/metafields.esnext +1 -0
- package/build/ts/docs/shared/component-definitions.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Avatar.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Badge.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Banner.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Box.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Button.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ButtonGroup.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Checkbox.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Chip.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Choice.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ChoiceList.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Clickable.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ClickableChip.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ColorField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ColorPicker.d.ts.map +1 -1
- package/build/ts/docs/shared/components/DateField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/DatePicker.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Divider.d.ts.map +1 -1
- package/build/ts/docs/shared/components/EmailField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Form.d.ts.map +1 -1
- package/build/ts/docs/shared/components/FunctionSettings.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Grid.d.ts.map +1 -1
- package/build/ts/docs/shared/components/GridItem.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Heading.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Icon.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Image.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Link.d.ts.map +1 -1
- package/build/ts/docs/shared/components/ListItem.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Menu.d.ts.map +1 -1
- package/build/ts/docs/shared/components/MoneyField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/NumberField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/OrderedList.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Paragraph.d.ts.map +1 -1
- package/build/ts/docs/shared/components/PasswordField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/QueryContainer.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Section.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Select.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Spinner.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Stack.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Switch.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Table.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableBody.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableCell.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableHeader.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableHeaderRow.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TableRow.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Text.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TextArea.d.ts.map +1 -1
- package/build/ts/docs/shared/components/TextField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Thumbnail.d.ts.map +1 -1
- package/build/ts/docs/shared/components/Tooltip.d.ts.map +1 -1
- package/build/ts/docs/shared/components/URLField.d.ts.map +1 -1
- package/build/ts/docs/shared/components/UnorderedList.d.ts.map +1 -1
- package/build/ts/shared.d.ts +6 -4
- package/build/ts/shared.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts +1 -8
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ActionExtensionComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/AdminAction/AdminAction.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminAction.d.ts +113 -12
- package/build/ts/surfaces/admin/components/AdminBlock/AdminBlock.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminBlock.d.ts +109 -9
- package/build/ts/surfaces/admin/components/AdminPrintAction/AdminPrintAction.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminPrintAction.d.ts +105 -9
- package/build/ts/surfaces/admin/components/Avatar/Avatar.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Avatar.d.ts +165 -13
- package/build/ts/surfaces/admin/components/Badge/Badge.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Badge.d.ts +195 -24
- package/build/ts/surfaces/admin/components/Banner/Banner.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Banner.d.ts +161 -19
- package/build/ts/surfaces/admin/components/BlockExtensionComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/Box/Box.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Box.d.ts +260 -78
- package/build/ts/surfaces/admin/components/Button/Button.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Button.d.ts +316 -56
- package/build/ts/surfaces/admin/components/ButtonGroup/ButtonGroup.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ButtonGroup.d.ts +138 -28
- package/build/ts/surfaces/admin/components/Checkbox/Checkbox.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Checkbox.d.ts +193 -9
- package/build/ts/surfaces/admin/components/Chip/Chip.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Chip.d.ts +2 -4
- package/build/ts/surfaces/admin/components/Choice.d.ts +129 -27
- package/build/ts/surfaces/admin/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ChoiceList.d.ts +162 -15
- package/build/ts/surfaces/admin/components/Clickable/Clickable.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Clickable.d.ts +202 -48
- package/build/ts/surfaces/admin/components/ClickableChip/ClickableChip.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ClickableChip.d.ts +176 -30
- package/build/ts/surfaces/admin/components/ColorField/ColorField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ColorField.d.ts +237 -23
- package/build/ts/surfaces/admin/components/ColorPicker/ColorPicker.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ColorPicker.d.ts +160 -13
- package/build/ts/surfaces/admin/components/DateField/DateField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/DateField.d.ts +255 -27
- package/build/ts/surfaces/admin/components/DatePicker/DatePicker.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/DatePicker.d.ts +201 -12
- package/build/ts/surfaces/admin/components/Divider/Divider.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Divider.d.ts +147 -13
- package/build/ts/surfaces/admin/components/DropZone/DropZone.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/EmailField/EmailField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/EmailField.d.ts +219 -12
- package/build/ts/surfaces/admin/components/Form/Form.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Form.d.ts +125 -10
- package/build/ts/surfaces/admin/components/FormExtensionComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/FunctionSettings/FunctionSettings.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/FunctionSettings.d.ts +139 -9
- package/build/ts/surfaces/admin/components/FunctionSettingsComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/Grid/Grid.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Grid.d.ts +307 -73
- package/build/ts/surfaces/admin/components/GridItem.d.ts +270 -37
- package/build/ts/surfaces/admin/components/Heading/Heading.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Heading.d.ts +128 -29
- package/build/ts/surfaces/admin/components/Icon/Icon.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Icon.d.ts +150 -27
- package/build/ts/surfaces/admin/components/Image/Image.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Image.d.ts +290 -36
- package/build/ts/surfaces/admin/components/Link/Link.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Link.d.ts +141 -39
- package/build/ts/surfaces/admin/components/ListItem.d.ts +119 -16
- package/build/ts/surfaces/admin/components/Menu/Menu.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Menu.d.ts +160 -29
- package/build/ts/surfaces/admin/components/Modal/Modal.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/MoneyField/MoneyField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/MoneyField.d.ts +218 -12
- package/build/ts/surfaces/admin/components/NumberField/NumberField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/NumberField.d.ts +230 -12
- package/build/ts/surfaces/admin/components/Option.d.ts +122 -14
- package/build/ts/surfaces/admin/components/OptionGroup.d.ts +116 -16
- package/build/ts/surfaces/admin/components/OrderedList/OrderedList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/OrderedList.d.ts +117 -18
- package/build/ts/surfaces/admin/components/Page/Page.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Paragraph/Paragraph.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Paragraph.d.ts +162 -38
- package/build/ts/surfaces/admin/components/PasswordField/PasswordField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/PasswordField.d.ts +226 -19
- package/build/ts/surfaces/admin/components/Popover/Popover.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/PrintActionExtensionComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/QueryContainer/QueryContainer.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/QueryContainer.d.ts +127 -18
- package/build/ts/surfaces/admin/components/SearchField/SearchField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/SearchField.d.ts +212 -18
- package/build/ts/surfaces/admin/components/Section/Section.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Section.d.ts +143 -26
- package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Select.d.ts +209 -33
- package/build/ts/surfaces/admin/components/Spinner/Spinner.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Spinner.d.ts +127 -13
- package/build/ts/surfaces/admin/components/Stack/Stack.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Stack.d.ts +297 -65
- package/build/ts/surfaces/admin/components/Switch/Switch.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Switch.d.ts +185 -17
- package/build/ts/surfaces/admin/components/Table/Table.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Table.d.ts +237 -18
- package/build/ts/surfaces/admin/components/TableBody.d.ts +122 -16
- package/build/ts/surfaces/admin/components/TableCell.d.ts +125 -12
- package/build/ts/surfaces/admin/components/TableHeader.d.ts +137 -16
- package/build/ts/surfaces/admin/components/TableHeaderRow.d.ts +122 -16
- package/build/ts/surfaces/admin/components/TableRow.d.ts +125 -16
- package/build/ts/surfaces/admin/components/Text/Text.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Text.d.ts +192 -38
- package/build/ts/surfaces/admin/components/TextArea/TextArea.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/TextArea.d.ts +217 -12
- package/build/ts/surfaces/admin/components/TextField/TextField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/TextField.d.ts +232 -38
- package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Thumbnail.d.ts +158 -13
- package/build/ts/surfaces/admin/components/Tooltip/Tooltip.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Tooltip.d.ts +157 -29
- package/build/ts/surfaces/admin/components/URLField/URLField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/URLField.d.ts +231 -19
- package/build/ts/surfaces/admin/components/UnorderedList/UnorderedList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/UnorderedList.d.ts +117 -18
- package/build/ts/surfaces/admin/components/patterns/accountConnection.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/accountConnection.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/appCard.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/appCard.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/calloutCard.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/calloutCard.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/details.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/details.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/emptyState.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/emptyState.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/footerHelp.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/footerHelp.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/homepage.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/homepage.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/index.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/index.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/indexTable.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/interstitialNav.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/interstitialNav.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/mediaCard.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/mediaCard.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/metricsCard.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/metricsCard.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/resourceList.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/resourceList.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/settings.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/settings.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/patterns/setupGuide.ab.doc.d.ts +2 -2
- package/build/ts/surfaces/admin/components/patterns/setupGuide.ab.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/shared.d.ts +845 -931
- package/build/ts/surfaces/admin/docs-types.d.ts +7 -1
- package/build/ts/surfaces/admin/docs-types.d.ts.map +1 -1
- package/build/ts/surfaces/admin/extension-targets.d.ts +6 -6
- package/build/ts/surfaces/checkout/api/docs.d.ts +0 -2
- package/build/ts/surfaces/checkout/api/docs.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +0 -18
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/shared.d.ts +8 -11
- package/build/ts/surfaces/checkout/shared.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +356 -317
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/shared.d.ts +84 -97
- package/build/ts/surfaces/customer-account/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts +8 -10
- package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Abbreviation/Abbreviation.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Abbreviation/Abbreviation.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Announcement/Announcement.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Announcement/Announcement.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Badge/Badge.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Badge/Badge.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Banner/Banner.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Banner/Banner.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Box/Box.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Box/Box.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Button/Button.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Button/Button.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ButtonGroup.d.ts +2 -2
- package/build/ts/surfaces/customer-account/components/Checkbox/Checkbox.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Checkbox/Checkbox.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Chip/Chip.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Chip/Chip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ChoiceList/ChoiceList.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Clickable/Clickable.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Clickable/Clickable.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ClickableChip/ClickableChip.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ClickableChip/ClickableChip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ClipboardItem/ClipboardItem.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ClipboardItem/ClipboardItem.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ConsentCheckbox/ConsentCheckbox.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ConsentCheckbox/ConsentCheckbox.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ConsentPhoneField/ConsentPhoneField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ConsentPhoneField/ConsentPhoneField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/DateField/DateField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/DateField/DateField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/DatePicker/DatePicker.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/DatePicker/DatePicker.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Details/Details.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Details/Details.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Divider/Divider.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Divider/Divider.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/DropZone/DropZone.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/DropZone/DropZone.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/EmailField/EmailField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/EmailField/EmailField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Form/Form.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Form/Form.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Grid/Grid.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Grid/Grid.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Heading/Heading.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Heading/Heading.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Icon/Icon.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Icon/Icon.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Image/Image.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Image/Image.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Link/Link.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Link/Link.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Map/Map.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Map/Map.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Modal/Modal.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Modal/Modal.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/MoneyField/MoneyField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/MoneyField/MoneyField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/NumberField/NumberField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/NumberField/NumberField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/OrderedList/OrderedList.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/OrderedList/OrderedList.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Paragraph/Paragraph.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Paragraph/Paragraph.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/PasswordField/PasswordField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/PasswordField/PasswordField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/PaymentIcon/PaymentIcon.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/PaymentIcon/PaymentIcon.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/PhoneField/PhoneField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/PhoneField/PhoneField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Popover/Popover.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Popover/Popover.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/PressButton/PressButton.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/PressButton/PressButton.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ProductThumbnail/ProductThumbnail.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ProductThumbnail/ProductThumbnail.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Progress/Progress.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Progress/Progress.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/QRCode/QRCode.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/QRCode/QRCode.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/QueryContainer/QueryContainer.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/QueryContainer/QueryContainer.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/ScrollBox/ScrollBox.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/ScrollBox/ScrollBox.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Select/Select.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Select/Select.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Sheet/Sheet.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Sheet/Sheet.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/SkeletonParagraph/SkeletonParagraph.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/SkeletonParagraph/SkeletonParagraph.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Spinner/Spinner.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Spinner/Spinner.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Stack/Stack.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Stack/Stack.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Switch/Switch.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Switch/Switch.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Text/Text.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Text/Text.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/TextArea/TextArea.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/TextArea/TextArea.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/TextField/TextField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/TextField/TextField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Time/Time.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Time/Time.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/Tooltip/Tooltip.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Tooltip/Tooltip.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/URLField/URLField.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/URLField/URLField.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/components/UnorderedList/UnorderedList.doc.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/UnorderedList/UnorderedList.doc.d.ts.map +1 -0
- package/build/ts/surfaces/customer-account/preact/metafield.d.ts +1 -0
- package/build/ts/surfaces/customer-account/preact/metafield.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/preact/metafields.d.ts +1 -0
- package/build/ts/surfaces/customer-account/preact/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/Button.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/EmptyState.d.ts +2 -2
- package/build/ts/surfaces/point-of-sale/components/Link.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +10 -10
- package/build/ts/surfaces/point-of-sale/components/Text.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +55 -55
- package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +2 -2
- package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +23 -2
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/docs/shared/component-definitions.ts +15 -5
- package/src/docs/shared/components/Abbreviation.ts +2 -2
- package/src/docs/shared/components/Announcement.ts +2 -2
- package/src/docs/shared/components/Avatar.ts +3 -2
- package/src/docs/shared/components/Badge.ts +3 -2
- package/src/docs/shared/components/Banner.ts +3 -2
- package/src/docs/shared/components/Box.ts +3 -2
- package/src/docs/shared/components/Button.ts +3 -2
- package/src/docs/shared/components/ButtonGroup.ts +5 -3
- package/src/docs/shared/components/Checkbox.ts +3 -2
- package/src/docs/shared/components/Chip.ts +3 -2
- package/src/docs/shared/components/Choice.ts +3 -2
- package/src/docs/shared/components/ChoiceList.ts +4 -3
- package/src/docs/shared/components/Clickable.ts +3 -2
- package/src/docs/shared/components/ClickableChip.ts +4 -3
- package/src/docs/shared/components/ClipboardItem.ts +3 -3
- package/src/docs/shared/components/ColorField.ts +4 -3
- package/src/docs/shared/components/ColorPicker.ts +5 -3
- package/src/docs/shared/components/ConsentCheckbox.ts +2 -2
- package/src/docs/shared/components/ConsentPhoneField.ts +2 -2
- package/src/docs/shared/components/DateField.ts +5 -3
- package/src/docs/shared/components/DatePicker.ts +5 -3
- package/src/docs/shared/components/Details.ts +2 -2
- package/src/docs/shared/components/Divider.ts +3 -2
- package/src/docs/shared/components/DropZone.ts +3 -3
- package/src/docs/shared/components/EmailField.ts +4 -3
- package/src/docs/shared/components/Form.ts +3 -2
- package/src/docs/shared/components/FunctionSettings.ts +5 -20
- package/src/docs/shared/components/Grid.ts +3 -2
- package/src/docs/shared/components/GridItem.ts +6 -4
- package/src/docs/shared/components/Heading.ts +3 -2
- package/src/docs/shared/components/Icon.ts +3 -2
- package/src/docs/shared/components/Image.ts +3 -2
- package/src/docs/shared/components/Link.ts +3 -2
- package/src/docs/shared/components/ListItem.ts +5 -4
- package/src/docs/shared/components/Map.ts +2 -2
- package/src/docs/shared/components/MapMarker.ts +3 -3
- package/src/docs/shared/components/Menu.ts +3 -2
- package/src/docs/shared/components/Modal.ts +2 -2
- package/src/docs/shared/components/MoneyField.ts +4 -3
- package/src/docs/shared/components/NumberField.ts +4 -3
- package/src/docs/shared/components/Option.ts +1 -1
- package/src/docs/shared/components/OptionGroup.ts +2 -2
- package/src/docs/shared/components/OrderedList.ts +4 -3
- package/src/docs/shared/components/Page.ts +3 -3
- package/src/docs/shared/components/Paragraph.ts +3 -2
- package/src/docs/shared/components/PasswordField.ts +5 -3
- package/src/docs/shared/components/PaymentIcon.ts +3 -3
- package/src/docs/shared/components/PhoneField.ts +2 -2
- package/src/docs/shared/components/Popover.ts +2 -2
- package/src/docs/shared/components/PressButton.ts +2 -2
- package/src/docs/shared/components/ProductThumbnail.ts +3 -3
- package/src/docs/shared/components/Progress.ts +2 -2
- package/src/docs/shared/components/QRCode.ts +3 -3
- package/src/docs/shared/components/QueryContainer.ts +4 -3
- package/src/docs/shared/components/ScrollBox.ts +3 -3
- package/src/docs/shared/components/SearchField.ts +3 -3
- package/src/docs/shared/components/Section.ts +3 -2
- package/src/docs/shared/components/Select.ts +3 -2
- package/src/docs/shared/components/Sheet.ts +1 -1
- package/src/docs/shared/components/SkeletonParagraph.ts +3 -3
- package/src/docs/shared/components/Spinner.ts +3 -2
- package/src/docs/shared/components/Stack.ts +3 -2
- package/src/docs/shared/components/Summary.ts +2 -2
- package/src/docs/shared/components/Switch.ts +4 -2
- package/src/docs/shared/components/Table.ts +3 -2
- package/src/docs/shared/components/TableBody.ts +4 -3
- package/src/docs/shared/components/TableCell.ts +5 -3
- package/src/docs/shared/components/TableHeader.ts +5 -3
- package/src/docs/shared/components/TableHeaderRow.ts +4 -3
- package/src/docs/shared/components/TableRow.ts +5 -3
- package/src/docs/shared/components/Text.ts +3 -2
- package/src/docs/shared/components/TextArea.ts +4 -3
- package/src/docs/shared/components/TextField.ts +4 -3
- package/src/docs/shared/components/Thumbnail.ts +3 -2
- package/src/docs/shared/components/Time.ts +2 -2
- package/src/docs/shared/components/Tooltip.ts +3 -2
- package/src/docs/shared/components/URLField.ts +4 -3
- package/src/docs/shared/components/UnorderedList.ts +4 -3
- package/src/shared.ts +6 -4
- package/src/surfaces/admin/api/discount-function-settings/launch-options.ts +1 -8
- package/src/surfaces/admin/api/print-action/examples/custom-product-labels.jsx +17 -14
- package/src/surfaces/admin/api/print-action/examples/generate-packing-slip.jsx +18 -12
- package/src/surfaces/admin/api/print-action/examples/shipping-manifest.jsx +11 -12
- package/src/surfaces/admin/components/ActionExtensionComponents.ts +1 -1
- package/src/surfaces/admin/components/{ButtonGroup/examples/default.jsx → AdminAction/examples/default.html} +3 -2
- package/src/surfaces/admin/components/AdminAction/examples/destructive-action.html +10 -0
- package/src/surfaces/admin/components/AdminAction/examples/loading-state.html +5 -0
- package/src/surfaces/admin/components/AdminAction/examples/with-form-content.html +8 -0
- package/src/surfaces/admin/components/AdminAction/examples/with-resource-details.html +15 -0
- package/src/surfaces/admin/components/AdminAction.d.ts +113 -12
- package/src/surfaces/admin/components/AdminBlock/examples/default.html +3 -0
- package/src/surfaces/admin/components/AdminBlock/examples/with-actions.html +14 -0
- package/src/surfaces/admin/components/AdminBlock/examples/with-badges.html +14 -0
- package/src/surfaces/admin/components/AdminBlock/examples/with-collapsed-summary.html +7 -0
- package/src/surfaces/admin/components/AdminBlock/examples/with-data-table.html +21 -0
- package/src/surfaces/admin/components/AdminBlock.d.ts +109 -9
- package/src/surfaces/admin/components/AdminPrintAction/examples/default.html +1 -0
- package/src/surfaces/admin/components/AdminPrintAction/examples/dynamic-url.html +1 -0
- package/src/surfaces/admin/components/AdminPrintAction/examples/pdf-source.html +1 -0
- package/src/surfaces/admin/components/AdminPrintAction.d.ts +105 -9
- package/src/surfaces/admin/components/Avatar.d.ts +165 -13
- package/src/surfaces/admin/components/Badge.d.ts +195 -24
- package/src/surfaces/admin/components/Banner.d.ts +161 -19
- package/src/surfaces/admin/components/BlockExtensionComponents.ts +1 -1
- package/src/surfaces/admin/components/Box/examples/accessible-status-messages.html +8 -14
- package/src/surfaces/admin/components/Box/examples/screen-reader-only-content.html +3 -0
- package/src/surfaces/admin/components/Box.d.ts +260 -78
- package/src/surfaces/admin/components/Button/examples/component-interactions.html +8 -6
- package/src/surfaces/admin/components/Button/examples/icon-only-button.html +17 -1
- package/src/surfaces/admin/components/Button.d.ts +316 -56
- package/src/surfaces/admin/components/ButtonGroup.d.ts +138 -28
- package/src/surfaces/admin/components/Checkbox/examples/indeterminate-state.html +10 -0
- package/src/surfaces/admin/components/Checkbox/examples/validation-example.html +9 -0
- package/src/surfaces/admin/components/Checkbox.d.ts +193 -9
- package/src/surfaces/admin/components/Chip/examples/default.html +1 -1
- package/src/surfaces/admin/components/Chip.d.ts +2 -4
- package/src/surfaces/admin/components/Choice.d.ts +129 -27
- package/src/surfaces/admin/components/ChoiceList/examples/disabled-state.html +5 -0
- package/src/surfaces/admin/components/ChoiceList/examples/with-error-state.html +2 -3
- package/src/surfaces/admin/components/ChoiceList.d.ts +162 -15
- package/src/surfaces/admin/components/Clickable.d.ts +202 -48
- package/src/surfaces/admin/components/ClickableChip.d.ts +176 -30
- package/src/surfaces/admin/components/ColorField/examples/default.html +4 -1
- package/src/surfaces/admin/components/ColorField/examples/validation-example.html +12 -0
- package/src/surfaces/admin/components/ColorField.d.ts +237 -23
- package/src/surfaces/admin/components/ColorPicker/examples/default.html +1 -1
- package/src/surfaces/admin/components/ColorPicker.d.ts +160 -13
- package/src/surfaces/admin/components/DateField.d.ts +255 -27
- package/src/surfaces/admin/components/DatePicker.d.ts +201 -12
- package/src/surfaces/admin/components/Divider.d.ts +147 -13
- package/src/surfaces/admin/components/DropZone/examples/upload-with-validation.html +42 -0
- package/src/surfaces/admin/components/EmailField/examples/disabled-state.html +5 -0
- package/src/surfaces/admin/components/EmailField.d.ts +219 -12
- package/src/surfaces/admin/components/Form/examples/default.html +1 -1
- package/src/surfaces/admin/components/Form/examples/with-choice-fields.html +12 -0
- package/src/surfaces/admin/components/Form/examples/with-multiple-fields.html +12 -0
- package/src/surfaces/admin/components/Form/examples/with-sections.html +21 -0
- package/src/surfaces/admin/components/Form/examples/with-validation.html +7 -0
- package/src/surfaces/admin/components/Form.d.ts +125 -10
- package/src/surfaces/admin/components/FormExtensionComponents.ts +1 -1
- package/src/surfaces/admin/components/FunctionSettings/examples/default.html +9 -0
- package/src/surfaces/admin/components/FunctionSettings/examples/with-multiple-settings.html +16 -0
- package/src/surfaces/admin/components/FunctionSettings/examples/with-select-options.html +10 -0
- package/src/surfaces/admin/components/FunctionSettings/examples/with-toggle.html +13 -0
- package/src/surfaces/admin/components/FunctionSettings/examples/with-validation.html +23 -0
- package/src/surfaces/admin/components/FunctionSettings.d.ts +139 -9
- package/src/surfaces/admin/components/FunctionSettingsComponents.ts +1 -1
- package/src/surfaces/admin/components/Grid.d.ts +307 -73
- package/src/surfaces/admin/components/GridItem.d.ts +270 -37
- package/src/surfaces/admin/components/Heading.d.ts +128 -29
- package/src/surfaces/admin/components/Icon.d.ts +150 -27
- package/src/surfaces/admin/components/Image/examples/basic-usage.html +15 -4
- package/src/surfaces/admin/components/Image.d.ts +290 -36
- package/src/surfaces/admin/components/Link/examples/default.html +1 -1
- package/src/surfaces/admin/components/Link.d.ts +141 -39
- package/src/surfaces/admin/components/ListItem.d.ts +119 -16
- package/src/surfaces/admin/components/Menu/examples/{menu-with-icons.html → icon-only-trigger.html} +7 -2
- package/src/surfaces/admin/components/Menu.d.ts +160 -29
- package/src/surfaces/admin/components/Modal/examples/delete-with-async-handling.html +28 -0
- package/src/surfaces/admin/components/MoneyField/examples/basic-field.html +0 -1
- package/src/surfaces/admin/components/MoneyField.d.ts +218 -12
- package/src/surfaces/admin/components/NumberField/examples/disabled-and-read-only.html +15 -0
- package/src/surfaces/admin/components/NumberField/examples/{basic-usage.html → with-error-state.html} +3 -1
- package/src/surfaces/admin/components/NumberField.d.ts +230 -12
- package/src/surfaces/admin/components/Option.d.ts +122 -14
- package/src/surfaces/admin/components/OptionGroup.d.ts +116 -16
- package/src/surfaces/admin/components/OrderedList/examples/default.html +3 -3
- package/src/surfaces/admin/components/OrderedList.d.ts +117 -18
- package/src/surfaces/admin/components/Page/examples/edit-page-with-all-slots.html +36 -0
- package/src/surfaces/admin/components/Paragraph/examples/subdued-color.html +3 -0
- package/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.html +13 -1
- package/src/surfaces/admin/components/Paragraph.d.ts +162 -38
- package/src/surfaces/admin/components/PasswordField.d.ts +226 -19
- package/src/surfaces/admin/components/Popover/examples/filter-with-apply-and-clear.html +35 -0
- package/src/surfaces/admin/components/PrintActionExtensionComponents.ts +1 -1
- package/src/surfaces/admin/components/QueryContainer.d.ts +127 -18
- package/src/surfaces/admin/components/SearchField.d.ts +212 -18
- package/src/surfaces/admin/components/Section.d.ts +143 -26
- package/src/surfaces/admin/components/Select/examples/with-error-state.html +2 -2
- package/src/surfaces/admin/components/Select/examples/with-option-groups.html +4 -4
- package/src/surfaces/admin/components/Select.d.ts +209 -33
- package/src/surfaces/admin/components/Spinner/examples/spinner-sizes.html +5 -0
- package/src/surfaces/admin/components/Spinner.d.ts +127 -13
- package/src/surfaces/admin/components/Stack.d.ts +297 -65
- package/src/surfaces/admin/components/Switch/examples/disabled-switch.html +2 -2
- package/src/surfaces/admin/components/Switch/examples/form-integration.html +15 -12
- package/src/surfaces/admin/components/Switch/examples/hidden-label-for-accessibility.html +1 -1
- package/src/surfaces/admin/components/Switch/examples/settings-panel-with-stack.html +1 -1
- package/src/surfaces/admin/components/Switch/examples/with-details-and-error.html +1 -1
- package/src/surfaces/admin/components/Switch.d.ts +185 -17
- package/src/surfaces/admin/components/Table/examples/{basic-usage.jsx → with-filters.html} +2 -13
- package/src/surfaces/admin/components/Table.d.ts +237 -18
- package/src/surfaces/admin/components/TableBody.d.ts +122 -16
- package/src/surfaces/admin/components/TableCell.d.ts +125 -12
- package/src/surfaces/admin/components/TableHeader.d.ts +137 -16
- package/src/surfaces/admin/components/TableHeaderRow.d.ts +122 -16
- package/src/surfaces/admin/components/TableRow.d.ts +125 -16
- package/src/surfaces/admin/components/Text.d.ts +192 -38
- package/src/surfaces/admin/components/TextArea/examples/disabled-and-read-only.html +15 -0
- package/src/surfaces/admin/components/TextArea.d.ts +217 -12
- package/src/surfaces/admin/components/TextField/examples/disabled-and-read-only.html +13 -0
- package/src/surfaces/admin/components/TextField.d.ts +232 -38
- package/src/surfaces/admin/components/Thumbnail/examples/default.html +1 -1
- package/src/surfaces/admin/components/Thumbnail/examples/different-sizes.html +3 -3
- package/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.html +22 -9
- package/src/surfaces/admin/components/Thumbnail.d.ts +158 -13
- package/src/surfaces/admin/components/Tooltip/examples/basic-usage.html +2 -4
- package/src/surfaces/admin/components/Tooltip/examples/keyboard-shortcut.html +2 -0
- package/src/surfaces/admin/components/Tooltip/examples/with-icon-button.html +3 -5
- package/src/surfaces/admin/components/Tooltip.d.ts +157 -29
- package/src/surfaces/admin/components/URLField/examples/default.html +2 -2
- package/src/surfaces/admin/components/URLField/examples/with-default-value.html +5 -7
- package/src/surfaces/admin/components/URLField.d.ts +231 -19
- package/src/surfaces/admin/components/UnorderedList.d.ts +117 -18
- package/src/surfaces/admin/components/patterns/examples/accountConnection-modal.html +54 -0
- package/src/surfaces/admin/components/patterns/examples/accountConnection-modal.jsx +54 -0
- package/src/surfaces/admin/components/patterns/examples/accountConnection-toast.html +25 -0
- package/src/surfaces/admin/components/patterns/examples/accountConnection-toast.jsx +27 -0
- package/src/surfaces/admin/components/patterns/examples/appCard-nav.html +29 -0
- package/src/surfaces/admin/components/patterns/examples/appCard-nav.jsx +29 -0
- package/src/surfaces/admin/components/patterns/examples/calloutCard-nav.html +35 -0
- package/src/surfaces/admin/components/patterns/examples/calloutCard-nav.jsx +37 -0
- package/src/surfaces/admin/components/patterns/examples/calloutCard-toast.html +41 -0
- package/src/surfaces/admin/components/patterns/examples/calloutCard-toast.jsx +41 -0
- package/src/surfaces/admin/components/patterns/examples/details-modal.html +36 -0
- package/src/surfaces/admin/components/patterns/examples/details-modal.jsx +39 -0
- package/src/surfaces/admin/components/patterns/examples/details-save-bar.html +21 -0
- package/src/surfaces/admin/components/patterns/examples/details-save-bar.jsx +31 -0
- package/src/surfaces/admin/components/patterns/examples/details.html +8 -3
- package/src/surfaces/admin/components/patterns/examples/details.jsx +238 -242
- package/src/surfaces/admin/components/patterns/examples/emptyState-intents.html +39 -0
- package/src/surfaces/admin/components/patterns/examples/emptyState-intents.jsx +41 -0
- package/src/surfaces/admin/components/patterns/examples/emptyState-nav.html +16 -0
- package/src/surfaces/admin/components/patterns/examples/emptyState-nav.jsx +16 -0
- package/src/surfaces/admin/components/patterns/examples/homepage.html +6 -1
- package/src/surfaces/admin/components/patterns/examples/homepage.jsx +7 -0
- package/src/surfaces/admin/components/patterns/examples/index-intents.html +39 -0
- package/src/surfaces/admin/components/patterns/examples/index-intents.jsx +41 -0
- package/src/surfaces/admin/components/patterns/examples/index.html +12 -7
- package/src/surfaces/admin/components/patterns/examples/index.jsx +13 -6
- package/src/surfaces/admin/components/patterns/examples/indexTable-bulk-selection.html +109 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-bulk-selection.jsx +131 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-nav.html +85 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-nav.jsx +85 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-pagination.html +74 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-pagination.jsx +85 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-toast.html +119 -0
- package/src/surfaces/admin/components/patterns/examples/indexTable-toast.jsx +126 -0
- package/src/surfaces/admin/components/patterns/examples/interstitialNav.html +8 -8
- package/src/surfaces/admin/components/patterns/examples/interstitialNav.jsx +7 -7
- package/src/surfaces/admin/components/patterns/examples/mediaCard-intents.html +31 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-intents.jsx +33 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-modal.html +56 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-modal.jsx +62 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-share.html +43 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-share.jsx +43 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-toast.html +36 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard-toast.jsx +36 -0
- package/src/surfaces/admin/components/patterns/examples/mediaCard.html +25 -23
- package/src/surfaces/admin/components/patterns/examples/mediaCard.jsx +29 -27
- package/src/surfaces/admin/components/patterns/examples/metricsCard-nav.html +51 -0
- package/src/surfaces/admin/components/patterns/examples/metricsCard-nav.jsx +51 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-modal.html +78 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-modal.jsx +82 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-nav.html +54 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-nav.jsx +54 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-picker.html +58 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-picker.jsx +59 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-toast.html +67 -0
- package/src/surfaces/admin/components/patterns/examples/resourceList-toast.jsx +77 -0
- package/src/surfaces/admin/components/patterns/examples/settings-modal.html +45 -0
- package/src/surfaces/admin/components/patterns/examples/settings-modal.jsx +53 -0
- package/src/surfaces/admin/components/patterns/examples/settings-toast.html +37 -0
- package/src/surfaces/admin/components/patterns/examples/settings-toast.jsx +33 -0
- package/src/surfaces/admin/components/patterns/examples/settings.html +31 -1
- package/src/surfaces/admin/components/patterns/examples/settings.jsx +31 -0
- package/src/surfaces/admin/components/patterns/examples/setupGuide-nav.html +89 -0
- package/src/surfaces/admin/components/patterns/examples/setupGuide-nav.jsx +93 -0
- package/src/surfaces/admin/components/patterns/examples/setupGuide-toast.html +94 -0
- package/src/surfaces/admin/components/patterns/examples/setupGuide-toast.jsx +103 -0
- package/src/surfaces/admin/components/patterns/examples/setupGuide.html +90 -40
- package/src/surfaces/admin/components/patterns/examples/setupGuide.jsx +81 -9
- package/src/surfaces/admin/components/patterns/index.ab.doc.ts +75 -52
- package/src/surfaces/admin/components/shared.d.ts +845 -931
- package/src/surfaces/admin/components.d.ts +3256 -2272
- package/src/surfaces/admin/docs-types.ts +10 -1
- package/src/surfaces/admin/extension-targets.ts +6 -6
- package/src/surfaces/checkout/api/docs.ts +0 -2
- package/src/surfaces/checkout/api/standard/standard.ts +0 -21
- package/src/surfaces/checkout/shared.ts +8 -11
- package/src/surfaces/customer-account/api/order-status/order-status.ts +363 -317
- package/src/surfaces/customer-account/api/shared.ts +84 -97
- package/src/surfaces/customer-account/api/standard-api/standard-api.ts +8 -10
- package/src/surfaces/customer-account/components/Abbreviation/examples/basic-abbreviation.example.html +1 -0
- package/src/surfaces/customer-account/components/Announcement/examples/basic-announcement.example.html +16 -0
- package/src/surfaces/customer-account/components/Badge/examples/basic-badge.example.html +3 -0
- package/src/surfaces/customer-account/components/Banner/examples/basic-banner.example.html +1 -0
- package/src/surfaces/customer-account/components/Box/examples/basic-box.example.html +11 -0
- package/src/surfaces/customer-account/components/Button/examples/basic-button.example.html +2 -0
- package/src/surfaces/customer-account/components/ButtonGroup.d.ts +2 -2
- package/src/surfaces/customer-account/components/Checkbox/examples/basic-checkbox.example.html +1 -0
- package/src/surfaces/customer-account/components/Chip/examples/basic-chip.example.html +1 -0
- package/src/surfaces/customer-account/components/ChoiceList/examples/basic-choice-list.example.html +7 -0
- package/src/surfaces/customer-account/components/ChoiceList/examples/block-choice-variant.example.html +47 -0
- package/src/surfaces/customer-account/components/ChoiceList/examples/grid-choice-variant.example.html +5 -0
- package/src/surfaces/customer-account/components/ChoiceList/examples/inline-choice-variant.example.html +6 -0
- package/src/surfaces/customer-account/components/ChoiceList/examples/list-choice-variant.example.html +5 -0
- package/src/surfaces/customer-account/components/Clickable/examples/basic-clickable.example.html +3 -0
- package/src/surfaces/customer-account/components/ClickableChip/examples/basic-clickable-chip.example.html +1 -0
- package/src/surfaces/customer-account/components/ClipboardItem/examples/basic-clipboard-item.example.html +2 -0
- package/src/surfaces/customer-account/components/ConsentCheckbox/examples/basic-consent-checkbox.example.html +5 -0
- package/src/surfaces/customer-account/components/ConsentPhoneField/examples/basic-consent-phone-field.example.html +5 -0
- package/src/surfaces/customer-account/components/DateField/examples/basic-date-field.example.html +1 -0
- package/src/surfaces/customer-account/components/DatePicker/examples/basic-date-picker.example.html +1 -0
- package/src/surfaces/customer-account/components/Details/examples/basic-details.example.html +6 -0
- package/src/surfaces/customer-account/components/DropZone/examples/basic-drop-zone.example.html +1 -0
- package/src/surfaces/customer-account/components/EmailField/examples/basic-email-field.example.html +1 -0
- package/src/surfaces/customer-account/components/Form/examples/basic-form.example.html +4 -0
- package/src/surfaces/customer-account/components/Grid/examples/basic-grid.example.html +11 -0
- package/src/surfaces/customer-account/components/Heading/examples/basic-heading.example.html +1 -0
- package/src/surfaces/customer-account/components/Icon/examples/basic-icon.example.html +4 -0
- package/src/surfaces/customer-account/components/Image/examples/basic-image.example.html +1 -0
- package/src/surfaces/customer-account/components/Link/examples/basic-link.example.html +1 -0
- package/src/surfaces/customer-account/components/Map/examples/basic-map.example.html +3 -0
- package/src/surfaces/customer-account/components/Map/examples/map-marker-graphic.example.html +14 -0
- package/src/surfaces/customer-account/components/Map/examples/map-marker-popover.example.html +14 -0
- package/src/surfaces/customer-account/components/Modal/examples/basic-modal.example.html +20 -0
- package/src/surfaces/customer-account/components/MoneyField/examples/basic-money-field.example.html +1 -0
- package/src/surfaces/customer-account/components/NumberField/examples/basic-number-field.example.html +8 -0
- package/src/surfaces/customer-account/components/OrderedList/examples/basic-ordered-list.example.html +5 -0
- package/src/surfaces/customer-account/components/Paragraph/examples/basic-paragraph.example.html +1 -0
- package/src/surfaces/customer-account/components/PasswordField/examples/basic-password-field.example.html +1 -0
- package/src/surfaces/customer-account/components/PaymentIcon/examples/basic-payment-icon.example.html +7 -0
- package/src/surfaces/customer-account/components/PhoneField/examples/basic-phone-field.example.html +2 -0
- package/src/surfaces/customer-account/components/Popover/examples/basic-popover.example.html +7 -0
- package/src/surfaces/customer-account/components/PressButton/examples/basic-press-button.example.html +1 -0
- package/src/surfaces/customer-account/components/ProductThumbnail/examples/basic-product-thumbnail.example.html +4 -0
- package/src/surfaces/customer-account/components/Progress/examples/basic-progress.example.html +1 -0
- package/src/surfaces/customer-account/components/QRCode/examples/basic-qr-code.example.html +4 -0
- package/src/surfaces/{admin/components/QueryContainer/examples/default.jsx → customer-account/components/QueryContainer/examples/basic-query-container.example.html} +3 -3
- package/src/surfaces/customer-account/components/ScrollBox/examples/basic-scroll-box.example.html +5 -0
- package/src/surfaces/customer-account/components/Section.d.ts +2 -2
- package/src/surfaces/customer-account/components/Select/examples/basic-select.example.html +5 -0
- package/src/surfaces/customer-account/components/Sheet/examples/basic-sheet.example.html +5 -0
- package/src/surfaces/customer-account/components/SkeletonParagraph/examples/basic-skeleton-paragraph.example.html +2 -0
- package/src/surfaces/customer-account/components/Spinner/examples/basic-spinner.example.html +1 -0
- package/src/surfaces/customer-account/components/Stack/examples/basic-stack.example.html +22 -0
- package/src/surfaces/customer-account/components/Switch/examples/basic-switch.example.html +1 -0
- package/src/surfaces/customer-account/components/Text/examples/basic-text.example.html +3 -0
- package/src/surfaces/customer-account/components/TextArea/examples/basic-text-area.example.html +5 -0
- package/src/surfaces/customer-account/components/TextField/examples/basic-text-field.example.html +4 -0
- package/src/surfaces/customer-account/components/Time/examples/basic-time.example.html +1 -0
- package/src/surfaces/customer-account/components/Tooltip/examples/basic-tooltip.example.html +9 -0
- package/src/surfaces/customer-account/components/URLField/examples/basic-url-field.example.html +1 -0
- package/src/surfaces/customer-account/components/UnorderedList/examples/basic-unordered-list.example.html +5 -0
- package/src/surfaces/customer-account/preact/metafield.ts +1 -0
- package/src/surfaces/customer-account/preact/metafields.ts +1 -0
- package/src/surfaces/point-of-sale/api/pin-pad-api.ts +1 -1
- package/src/surfaces/point-of-sale/components/Button.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/EmptyState.d.ts +2 -2
- package/src/surfaces/point-of-sale/components/Link.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/Stack.d.ts +10 -10
- package/src/surfaces/point-of-sale/components/Text.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/TextField.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/components-shared.d.ts +55 -55
- package/src/surfaces/point-of-sale/components.d.ts +110 -110
- package/src/surfaces/point-of-sale/event/data/BaseData.ts +6 -2
- package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +23 -2
- package/src/surfaces/admin/components/AdminAction/examples/default.tsx +0 -15
- package/src/surfaces/admin/components/AdminBlock/examples/default.tsx +0 -1
- package/src/surfaces/admin/components/AdminPrintAction/examples/default.tsx +0 -9
- package/src/surfaces/admin/components/Avatar/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/Avatar/examples/color-consistency-demo.jsx +0 -7
- package/src/surfaces/admin/components/Avatar/examples/default-avatar-no-props.jsx +0 -1
- package/src/surfaces/admin/components/Avatar/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Avatar/examples/error-handling-example.jsx +0 -5
- package/src/surfaces/admin/components/Avatar/examples/fulfillment-partner-avatars.jsx +0 -14
- package/src/surfaces/admin/components/Avatar/examples/in-customer-list-context.jsx +0 -24
- package/src/surfaces/admin/components/Avatar/examples/long-initials-handling.jsx +0 -5
- package/src/surfaces/admin/components/Avatar/examples/size-variations.jsx +0 -7
- package/src/surfaces/admin/components/Avatar/examples/staff-member-profiles.jsx +0 -10
- package/src/surfaces/admin/components/Avatar/examples/with-image-source-and-fallback.jsx +0 -6
- package/src/surfaces/admin/components/Avatar/examples/with-section-component.jsx +0 -17
- package/src/surfaces/admin/components/Badge/examples/default.jsx +0 -8
- package/src/surfaces/admin/components/Badge/examples/different-sizes-for-emphasis.jsx +0 -4
- package/src/surfaces/admin/components/Badge/examples/order-status-badges.html +0 -6
- package/src/surfaces/admin/components/Badge/examples/order-status-badges.jsx +0 -6
- package/src/surfaces/admin/components/Badge/examples/status-indicators-with-icons.jsx +0 -21
- package/src/surfaces/admin/components/Badge/examples/within-table-context.jsx +0 -18
- package/src/surfaces/admin/components/Banner/examples/basic-information-banner.html +0 -3
- package/src/surfaces/admin/components/Banner/examples/basic-information-banner.jsx +0 -3
- package/src/surfaces/admin/components/Banner/examples/critical-banner-with-clear-next-steps.jsx +0 -18
- package/src/surfaces/admin/components/Banner/examples/default.jsx +0 -3
- package/src/surfaces/admin/components/Banner/examples/dismissible-success-banner.jsx +0 -3
- package/src/surfaces/admin/components/Banner/examples/info-banner-with-clear-value-proposition.html +0 -14
- package/src/surfaces/admin/components/Banner/examples/info-banner-with-clear-value-proposition.jsx +0 -14
- package/src/surfaces/admin/components/Banner/examples/warning-banner-with-specific-actions.jsx +0 -18
- package/src/surfaces/admin/components/Box/examples/accessible-status-messages.jsx +0 -14
- package/src/surfaces/admin/components/Box/examples/basic-container.html +0 -9
- package/src/surfaces/admin/components/Box/examples/basic-container.jsx +0 -9
- package/src/surfaces/admin/components/Box/examples/complex-merchant-dashboard-layout.jsx +0 -34
- package/src/surfaces/admin/components/Box/examples/default.jsx +0 -7
- package/src/surfaces/admin/components/Box/examples/responsive-shipping-notice.jsx +0 -10
- package/src/surfaces/admin/components/Button/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/Button/examples/bulk-actions.html +0 -4
- package/src/surfaces/admin/components/Button/examples/bulk-actions.jsx +0 -6
- package/src/surfaces/admin/components/Button/examples/component-interactions.jsx +0 -7
- package/src/surfaces/admin/components/Button/examples/default.jsx +0 -4
- package/src/surfaces/admin/components/Button/examples/delete-confirmation.jsx +0 -6
- package/src/surfaces/admin/components/Button/examples/form-states.jsx +0 -6
- package/src/surfaces/admin/components/Button/examples/icon-only-button.jsx +0 -1
- package/src/surfaces/admin/components/Button/examples/link-buttons.jsx +0 -9
- package/src/surfaces/admin/components/Button/examples/loading-state-for-merchant-actions.jsx +0 -11
- package/src/surfaces/admin/components/Button/examples/navigation-to-admin-sections.html +0 -2
- package/src/surfaces/admin/components/Button/examples/navigation-to-admin-sections.jsx +0 -3
- package/src/surfaces/admin/components/Button/examples/product-save-form.html +0 -4
- package/src/surfaces/admin/components/Button/examples/product-save-form.jsx +0 -6
- package/src/surfaces/admin/components/Button/examples/tones.jsx +0 -5
- package/src/surfaces/admin/components/Button/examples/toolbar-icon-buttons.html +0 -17
- package/src/surfaces/admin/components/Button/examples/toolbar-icon-buttons.jsx +0 -17
- package/src/surfaces/admin/components/Button/examples/variants.jsx +0 -6
- package/src/surfaces/admin/components/Button/examples/with-icon.jsx +0 -1
- package/src/surfaces/admin/components/ButtonGroup/examples/basic-usage.html +0 -4
- package/src/surfaces/admin/components/ButtonGroup/examples/basic-usage.jsx +0 -6
- package/src/surfaces/admin/components/ButtonGroup/examples/bulk-actions-in-data-tables.jsx +0 -7
- package/src/surfaces/admin/components/ButtonGroup/examples/destructive-actions-pattern.jsx +0 -6
- package/src/surfaces/admin/components/ButtonGroup/examples/form-action-buttons.html +0 -4
- package/src/surfaces/admin/components/ButtonGroup/examples/form-action-buttons.jsx +0 -6
- package/src/surfaces/admin/components/ButtonGroup/examples/segmented-appearance.jsx +0 -5
- package/src/surfaces/admin/components/ButtonGroup/examples/toolbar-buttons-with-icons.jsx +0 -11
- package/src/surfaces/admin/components/Checkbox/examples/default.jsx +0 -4
- package/src/surfaces/admin/components/Checkbox/examples/disabled-state.jsx +0 -5
- package/src/surfaces/admin/components/Checkbox/examples/error-state.jsx +0 -4
- package/src/surfaces/admin/components/Checkbox/examples/help-text.html +0 -4
- package/src/surfaces/admin/components/Checkbox/examples/help-text.jsx +0 -4
- package/src/surfaces/admin/components/Checkbox/examples/indeterminate-state.jsx +0 -21
- package/src/surfaces/admin/components/Checkbox/examples/settings-group.jsx +0 -12
- package/src/surfaces/admin/components/Checkbox/examples/validation-example.jsx +0 -20
- package/src/surfaces/admin/components/Chip/examples/basic-usage.html +0 -3
- package/src/surfaces/admin/components/Chip/examples/basic-usage.jsx +0 -3
- package/src/surfaces/admin/components/Chip/examples/color-variants.jsx +0 -12
- package/src/surfaces/admin/components/Chip/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Chip/examples/product-status.html +0 -8
- package/src/surfaces/admin/components/Chip/examples/product-status.jsx +0 -12
- package/src/surfaces/admin/components/Chip/examples/text-truncation.jsx +0 -12
- package/src/surfaces/admin/components/Chip/examples/with-icon-graphic.jsx +0 -4
- package/src/surfaces/admin/components/ChoiceList/examples/basic-usage.jsx +0 -7
- package/src/surfaces/admin/components/ChoiceList/examples/default.jsx +0 -16
- package/src/surfaces/admin/components/ChoiceList/examples/multiple-choices-with-details.html +0 -18
- package/src/surfaces/admin/components/ChoiceList/examples/multiple-choices-with-details.jsx +0 -18
- package/src/surfaces/admin/components/ChoiceList/examples/multiple-selections.jsx +0 -15
- package/src/surfaces/admin/components/ChoiceList/examples/validation-example.jsx +0 -20
- package/src/surfaces/admin/components/ChoiceList/examples/with-error-state.jsx +0 -8
- package/src/surfaces/admin/components/Clickable/examples/accessibility-with-aria-attributes.jsx +0 -8
- package/src/surfaces/admin/components/Clickable/examples/basic-button-usage.html +0 -1
- package/src/surfaces/admin/components/Clickable/examples/basic-button-usage.jsx +0 -3
- package/src/surfaces/admin/components/Clickable/examples/default.jsx +0 -12
- package/src/surfaces/admin/components/Clickable/examples/disabled-link-with-aria.jsx +0 -7
- package/src/surfaces/admin/components/Clickable/examples/form-submit-button.jsx +0 -3
- package/src/surfaces/admin/components/Clickable/examples/link-mode.jsx +0 -3
- package/src/surfaces/admin/components/Clickable/examples/section-with-clickable-action.jsx +0 -9
- package/src/surfaces/admin/components/ClickableChip/examples/as-a-link.jsx +0 -8
- package/src/surfaces/admin/components/ClickableChip/examples/basic-usage.jsx +0 -17
- package/src/surfaces/admin/components/ClickableChip/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/ClickableChip/examples/disabled-state.jsx +0 -7
- package/src/surfaces/admin/components/ClickableChip/examples/multiple-chips-with-proper-spacing.html +0 -17
- package/src/surfaces/admin/components/ClickableChip/examples/multiple-chips-with-proper-spacing.jsx +0 -17
- package/src/surfaces/admin/components/ClickableChip/examples/with-icon-and-remove-button.jsx +0 -8
- package/src/surfaces/admin/components/ColorField/examples/basic-usage-required.jsx +0 -3
- package/src/surfaces/admin/components/ColorField/examples/basic-usage-web-component.jsx +0 -3
- package/src/surfaces/admin/components/ColorField/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/ColorField/examples/form-integration.jsx +0 -28
- package/src/surfaces/admin/components/ColorField/examples/read-only-state.jsx +0 -3
- package/src/surfaces/admin/components/ColorField/examples/validation-example.jsx +0 -21
- package/src/surfaces/admin/components/ColorField/examples/with-alpha-transparency.jsx +0 -7
- package/src/surfaces/admin/components/ColorField/examples/with-error-state.jsx +0 -9
- package/src/surfaces/admin/components/ColorField/examples/with-help-text.jsx +0 -7
- package/src/surfaces/admin/components/ColorField/examples/with-placeholder.html +0 -7
- package/src/surfaces/admin/components/ColorField/examples/with-placeholder.jsx +0 -7
- package/src/surfaces/admin/components/ColorPicker/examples/basic-usage.html +0 -3
- package/src/surfaces/admin/components/ColorPicker/examples/basic-usage.jsx +0 -3
- package/src/surfaces/admin/components/ColorPicker/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/ColorPicker/examples/with-alpha-transparency.jsx +0 -7
- package/src/surfaces/admin/components/DateField/examples/basic-usage.jsx +0 -5
- package/src/surfaces/admin/components/DateField/examples/date-fields-with-validation.html +0 -29
- package/src/surfaces/admin/components/DateField/examples/date-fields-with-validation.jsx +0 -29
- package/src/surfaces/admin/components/DateField/examples/date-range-selection.jsx +0 -19
- package/src/surfaces/admin/components/DateField/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/DateField/examples/disabled-and-read-only-states.jsx +0 -15
- package/src/surfaces/admin/components/DateField/examples/form-integration.jsx +0 -27
- package/src/surfaces/admin/components/DateField/examples/validation-example.jsx +0 -20
- package/src/surfaces/admin/components/DateField/examples/with-date-restrictions.jsx +0 -6
- package/src/surfaces/admin/components/DateField/examples/with-default-value.jsx +0 -5
- package/src/surfaces/admin/components/DateField/examples/with-error-state.jsx +0 -5
- package/src/surfaces/admin/components/DateField/examples/with-specific-allowed-dates.jsx +0 -6
- package/src/surfaces/admin/components/DatePicker/examples/analytics-dashboard.jsx +0 -35
- package/src/surfaces/admin/components/DatePicker/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/DatePicker/examples/form-integration.jsx +0 -28
- package/src/surfaces/admin/components/DatePicker/examples/single-date-selection.jsx +0 -6
- package/src/surfaces/admin/components/DatePicker/examples/with-date-restrictions.jsx +0 -7
- package/src/surfaces/admin/components/Divider/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/Divider/examples/custom-color.jsx +0 -1
- package/src/surfaces/admin/components/Divider/examples/custom-direction.jsx +0 -5
- package/src/surfaces/admin/components/Divider/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Divider/examples/organizing-settings-panels.html +0 -9
- package/src/surfaces/admin/components/Divider/examples/organizing-settings-panels.jsx +0 -9
- package/src/surfaces/admin/components/Divider/examples/separating-content-sections.html +0 -13
- package/src/surfaces/admin/components/Divider/examples/separating-content-sections.jsx +0 -13
- package/src/surfaces/admin/components/Divider/examples/separating-form-sections.jsx +0 -7
- package/src/surfaces/admin/components/Divider/examples/visual-breaks-in-section-layouts.html +0 -12
- package/src/surfaces/admin/components/Divider/examples/visual-breaks-in-section-layouts.jsx +0 -12
- package/src/surfaces/admin/components/DropZone/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/DropZone/examples/default.jsx +0 -9
- package/src/surfaces/admin/components/DropZone/examples/disabled-state.jsx +0 -1
- package/src/surfaces/admin/components/DropZone/examples/file-type-restrictions.jsx +0 -5
- package/src/surfaces/admin/components/DropZone/examples/image-upload.jsx +0 -1
- package/src/surfaces/admin/components/DropZone/examples/required-field.jsx +0 -1
- package/src/surfaces/admin/components/DropZone/examples/with-accessibility-options.jsx +0 -6
- package/src/surfaces/admin/components/DropZone/examples/with-error-state.jsx +0 -4
- package/src/surfaces/admin/components/EmailField/examples/basic-usage.html +0 -3
- package/src/surfaces/admin/components/EmailField/examples/basic-usage.jsx +0 -3
- package/src/surfaces/admin/components/EmailField/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/EmailField/examples/optional-field-with-placeholder.html +0 -7
- package/src/surfaces/admin/components/EmailField/examples/optional-field-with-placeholder.jsx +0 -7
- package/src/surfaces/admin/components/EmailField/examples/read-only-display.jsx +0 -7
- package/src/surfaces/admin/components/EmailField/examples/validation-example.jsx +0 -21
- package/src/surfaces/admin/components/EmailField/examples/with-error-and-help-text.jsx +0 -8
- package/src/surfaces/admin/components/EmailField/examples/with-length-constraints.jsx +0 -8
- package/src/surfaces/admin/components/Form/examples/default.jsx +0 -6
- package/src/surfaces/admin/components/FunctionSettings/examples/default.tsx +0 -38
- package/src/surfaces/admin/components/Grid/examples/basic-two-column-layout.jsx +0 -12
- package/src/surfaces/admin/components/Grid/examples/col-span-layouts.jsx +0 -34
- package/src/surfaces/admin/components/Grid/examples/default.jsx +0 -15
- package/src/surfaces/admin/components/Grid/examples/mobile-first-responsive-grid.jsx +0 -53
- package/src/surfaces/admin/components/Heading/examples/basic-heading.html +0 -1
- package/src/surfaces/admin/components/Heading/examples/basic-heading.jsx +0 -1
- package/src/surfaces/admin/components/Heading/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Heading/examples/heading-with-custom-accessibility.jsx +0 -3
- package/src/surfaces/admin/components/Heading/examples/heading-with-line-clamping.jsx +0 -5
- package/src/surfaces/admin/components/Heading/examples/heading-within-section-hierarchy.jsx +0 -12
- package/src/surfaces/admin/components/Icon/examples/basic-usage.jsx +0 -7
- package/src/surfaces/admin/components/Icon/examples/default.jsx +0 -6
- package/src/surfaces/admin/components/Icon/examples/in-badge-components.jsx +0 -8
- package/src/surfaces/admin/components/Icon/examples/in-button-components.jsx +0 -8
- package/src/surfaces/admin/components/Icon/examples/small-size.jsx +0 -1
- package/src/surfaces/admin/components/Icon/examples/subdued-color.jsx +0 -1
- package/src/surfaces/admin/components/Icon/examples/with-id-property.jsx +0 -1
- package/src/surfaces/admin/components/Icon/examples/with-interest-relationship.jsx +0 -6
- package/src/surfaces/admin/components/Icon/examples/with-semantic-tone.jsx +0 -6
- package/src/surfaces/admin/components/Image/examples/auto-sized-image.html +0 -5
- package/src/surfaces/admin/components/Image/examples/auto-sized-image.jsx +0 -5
- package/src/surfaces/admin/components/Image/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/Image/examples/decorative-image.jsx +0 -6
- package/src/surfaces/admin/components/Image/examples/default.jsx +0 -6
- package/src/surfaces/admin/components/Image/examples/responsive-images-with-srcset.jsx +0 -9
- package/src/surfaces/admin/components/Image/examples/responsive-layout-with-aspect-ratio.jsx +0 -7
- package/src/surfaces/admin/components/Image/examples/with-border-styling.jsx +0 -12
- package/src/surfaces/admin/components/Image/examples/within-layout-components.jsx +0 -26
- package/src/surfaces/admin/components/Link/examples/basic-links-in-paragraph.jsx +0 -3
- package/src/surfaces/admin/components/Link/examples/critical-context-links.html +0 -3
- package/src/surfaces/admin/components/Link/examples/critical-context-links.jsx +0 -3
- package/src/surfaces/admin/components/Link/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Link/examples/download-links.jsx +0 -3
- package/src/surfaces/admin/components/Link/examples/external-links.jsx +0 -5
- package/src/surfaces/admin/components/Link/examples/links-in-banner-context.html +0 -5
- package/src/surfaces/admin/components/Link/examples/links-in-banner-context.jsx +0 -5
- package/src/surfaces/admin/components/Link/examples/links-in-banner.jsx +0 -5
- package/src/surfaces/admin/components/Link/examples/links-in-box-container.jsx +0 -5
- package/src/surfaces/admin/components/Link/examples/links-in-subdued-paragraph.html +0 -3
- package/src/surfaces/admin/components/Link/examples/links-in-subdued-paragraph.jsx +0 -3
- package/src/surfaces/admin/components/Link/examples/links-with-auto-tone.html +0 -3
- package/src/surfaces/admin/components/Link/examples/links-with-auto-tone.jsx +0 -3
- package/src/surfaces/admin/components/Link/examples/links-with-different-tones.jsx +0 -25
- package/src/surfaces/admin/components/Link/examples/links-with-language-attribute.jsx +0 -3
- package/src/surfaces/admin/components/Menu/examples/basic-menu.html +0 -7
- package/src/surfaces/admin/components/Menu/examples/basic-menu.jsx +0 -9
- package/src/surfaces/admin/components/Menu/examples/customer-actions-menu.jsx +0 -18
- package/src/surfaces/admin/components/Menu/examples/default.jsx +0 -11
- package/src/surfaces/admin/components/Menu/examples/menu-with-icons.jsx +0 -14
- package/src/surfaces/admin/components/Menu/examples/menu-with-links-and-disabled-items.jsx +0 -13
- package/src/surfaces/admin/components/Menu/examples/menu-with-sections.jsx +0 -15
- package/src/surfaces/admin/components/Menu/examples/settings-menu.jsx +0 -19
- package/src/surfaces/admin/components/Modal/examples/basic-modal.jsx +0 -15
- package/src/surfaces/admin/components/Modal/examples/confirmation-modal-with-actions.jsx +0 -30
- package/src/surfaces/admin/components/Modal/examples/default.jsx +0 -19
- package/src/surfaces/admin/components/Modal/examples/different-modal-sizes.jsx +0 -65
- package/src/surfaces/admin/components/Modal/examples/form-modal.jsx +0 -52
- package/src/surfaces/admin/components/Modal/examples/modal-without-padding.jsx +0 -20
- package/src/surfaces/admin/components/NumberField/examples/basic-usage.jsx +0 -7
- package/src/surfaces/admin/components/NumberField/examples/default.jsx +0 -8
- package/src/surfaces/admin/components/NumberField/examples/multiple-examples.html +0 -29
- package/src/surfaces/admin/components/NumberField/examples/multiple-examples.jsx +0 -29
- package/src/surfaces/admin/components/NumberField/examples/with-prefix-and-suffix.jsx +0 -9
- package/src/surfaces/admin/components/OrderedList/examples/basic-usage.html +0 -5
- package/src/surfaces/admin/components/OrderedList/examples/basic-usage.jsx +0 -5
- package/src/surfaces/admin/components/OrderedList/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/OrderedList/examples/fulfillment-process.html +0 -18
- package/src/surfaces/admin/components/OrderedList/examples/fulfillment-process.jsx +0 -18
- package/src/surfaces/admin/components/OrderedList/examples/order-processing-steps.html +0 -8
- package/src/surfaces/admin/components/OrderedList/examples/order-processing-steps.jsx +0 -8
- package/src/surfaces/admin/components/OrderedList/examples/product-setup-instructions.jsx +0 -13
- package/src/surfaces/admin/components/Page/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/Page/examples/large-inline-size-for-wide-content.jsx +0 -33
- package/src/surfaces/admin/components/Page/examples/page-with-breadcrumbs-and-title.jsx +0 -7
- package/src/surfaces/admin/components/Page/examples/page-with-heading.jsx +0 -5
- package/src/surfaces/admin/components/Page/examples/page-with-secondary-actions.jsx +0 -8
- package/src/surfaces/admin/components/Page/examples/small-inline-size-for-focused-content.jsx +0 -9
- package/src/surfaces/admin/components/Paragraph/examples/admin-ui-patterns.html +0 -21
- package/src/surfaces/admin/components/Paragraph/examples/admin-ui-patterns.jsx +0 -21
- package/src/surfaces/admin/components/Paragraph/examples/basic-usage.html +0 -3
- package/src/surfaces/admin/components/Paragraph/examples/basic-usage.jsx +0 -3
- package/src/surfaces/admin/components/Paragraph/examples/default.jsx +0 -4
- package/src/surfaces/admin/components/Paragraph/examples/line-clamping.jsx +0 -8
- package/src/surfaces/admin/components/Paragraph/examples/rtl-support.jsx +0 -3
- package/src/surfaces/admin/components/Paragraph/examples/screen-reader-text.jsx +0 -3
- package/src/surfaces/admin/components/Paragraph/examples/tabular-numbers.jsx +0 -3
- package/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.jsx +0 -9
- package/src/surfaces/admin/components/Popover/examples/default.jsx +0 -10
- package/src/surfaces/admin/components/Popover/examples/inventory-stock-details.jsx +0 -37
- package/src/surfaces/admin/components/Popover/examples/notifications.jsx +0 -30
- package/src/surfaces/admin/components/Popover/examples/table-display-options.jsx +0 -29
- package/src/surfaces/admin/components/QueryContainer/examples/basic-usage.jsx +0 -17
- package/src/surfaces/admin/components/SearchField/examples/basic-usage.html +0 -5
- package/src/surfaces/admin/components/SearchField/examples/basic-usage.jsx +0 -5
- package/src/surfaces/admin/components/SearchField/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/SearchField/examples/disabled-state.jsx +0 -6
- package/src/surfaces/admin/components/SearchField/examples/with-character-limits.jsx +0 -7
- package/src/surfaces/admin/components/SearchField/examples/with-error-state.jsx +0 -6
- package/src/surfaces/admin/components/Section/examples/default.jsx +0 -3
- package/src/surfaces/admin/components/Section/examples/full-width-content-layout.jsx +0 -18
- package/src/surfaces/admin/components/Section/examples/nested-sections-with-visual-level-differences.jsx +0 -23
- package/src/surfaces/admin/components/Section/examples/section-with-accessibility-label.jsx +0 -13
- package/src/surfaces/admin/components/Section/examples/top-level-section-with-form-elements.jsx +0 -5
- package/src/surfaces/admin/components/Spinner/examples/basic-usage.html +0 -1
- package/src/surfaces/admin/components/Spinner/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/Spinner/examples/default.jsx +0 -1
- package/src/surfaces/admin/components/Spinner/examples/inline-loading-with-text.jsx +0 -4
- package/src/surfaces/admin/components/Spinner/examples/loading-state-in-section.jsx +0 -4
- package/src/surfaces/admin/components/Stack/examples/basic-block-stack-vertical.html +0 -5
- package/src/surfaces/admin/components/Stack/examples/basic-block-stack-vertical.jsx +0 -5
- package/src/surfaces/admin/components/Stack/examples/custom-alignment.jsx +0 -5
- package/src/surfaces/admin/components/Stack/examples/custom-spacing.jsx +0 -18
- package/src/surfaces/admin/components/Stack/examples/default.jsx +0 -6
- package/src/surfaces/admin/components/Stack/examples/inline-stack-horizontal.jsx +0 -5
- package/src/surfaces/admin/components/Stack/examples/responsive-stack-with-container-queries.jsx +0 -23
- package/src/surfaces/admin/components/Table/examples/default.jsx +0 -30
- package/src/surfaces/admin/components/Table/examples/full-width-product-inventory-table.html +0 -65
- package/src/surfaces/admin/components/Table/examples/full-width-product-inventory-table.jsx +0 -65
- package/src/surfaces/admin/components/Table/examples/list-variant.jsx +0 -44
- package/src/surfaces/admin/components/Table/examples/with-loading-state.jsx +0 -40
- package/src/surfaces/admin/components/Table/examples/with-pagination.jsx +0 -27
- package/src/surfaces/admin/components/Text/examples/accessibility-hidden-text.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/basic-usage.html +0 -3
- package/src/surfaces/admin/components/Text/examples/basic-usage.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/default.jsx +0 -4
- package/src/surfaces/admin/components/Text/examples/interest-for-association.jsx +0 -8
- package/src/surfaces/admin/components/Text/examples/right-to-left-text.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/semantic-address.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/status-tones.jsx +0 -5
- package/src/surfaces/admin/components/Text/examples/strong-text.html +0 -3
- package/src/surfaces/admin/components/Text/examples/strong-text.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/subdued-color.jsx +0 -3
- package/src/surfaces/admin/components/Text/examples/tabular-numbers.jsx +0 -3
- package/src/surfaces/admin/components/TextArea/examples/basic-usage.jsx +0 -5
- package/src/surfaces/admin/components/TextArea/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/TextArea/examples/error-state.jsx +0 -8
- package/src/surfaces/admin/components/TextArea/examples/product-care-instructions.html +0 -7
- package/src/surfaces/admin/components/TextArea/examples/product-care-instructions.jsx +0 -7
- package/src/surfaces/admin/components/TextArea/examples/seo-meta-description-with-character-limit.jsx +0 -8
- package/src/surfaces/admin/components/TextField/examples/basic-usage.html +0 -1
- package/src/surfaces/admin/components/TextField/examples/basic-usage.jsx +0 -1
- package/src/surfaces/admin/components/TextField/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/TextField/examples/required-field-with-validation.html +0 -1
- package/src/surfaces/admin/components/TextField/examples/required-field-with-validation.jsx +0 -1
- package/src/surfaces/admin/components/TextField/examples/specific-error-messages-for-merchant-context.jsx +0 -16
- package/src/surfaces/admin/components/TextField/examples/with-accessory.jsx +0 -6
- package/src/surfaces/admin/components/TextField/examples/with-icon.jsx +0 -5
- package/src/surfaces/admin/components/TextField/examples/with-prefix-and-suffix.jsx +0 -11
- package/src/surfaces/admin/components/Thumbnail/examples/basic-usage.html +0 -5
- package/src/surfaces/admin/components/Thumbnail/examples/basic-usage.jsx +0 -5
- package/src/surfaces/admin/components/Thumbnail/examples/default.jsx +0 -4
- package/src/surfaces/admin/components/Thumbnail/examples/different-sizes.jsx +0 -17
- package/src/surfaces/admin/components/Thumbnail/examples/empty-state.jsx +0 -1
- package/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.jsx +0 -13
- package/src/surfaces/admin/components/Tooltip/examples/basic-usage.jsx +0 -6
- package/src/surfaces/admin/components/Tooltip/examples/default.jsx +0 -6
- package/src/surfaces/admin/components/Tooltip/examples/with-icon-button.jsx +0 -8
- package/src/surfaces/admin/components/UnorderedList/examples/default.jsx +0 -5
- package/src/surfaces/admin/components/UnorderedList/examples/store-setup-checklist.jsx +0 -24
- /package/src/surfaces/admin/components/Button/examples/{basic-usage.html → basic-button.html} +0 -0
- /package/src/surfaces/{admin/components/Divider/examples/basic-usage.html → customer-account/components/Divider/examples/basic-divider.example.html} +0 -0
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** VERSION: 1.
|
|
1
|
+
/** VERSION: 1.25.0 **/
|
|
2
2
|
|
|
3
3
|
/* eslint-disable @typescript-eslint/ban-types */
|
|
4
4
|
|
|
@@ -24,18 +24,18 @@ export interface ActionProps {
|
|
|
24
24
|
}
|
|
25
25
|
export interface ActionSlots {
|
|
26
26
|
/**
|
|
27
|
-
* The primary action
|
|
27
|
+
* The primary action element, typically a button or link component representing the main call-to-action.
|
|
28
28
|
*/
|
|
29
29
|
primaryAction?: ComponentChildren;
|
|
30
30
|
/**
|
|
31
|
-
* The secondary
|
|
31
|
+
* The secondary action elements, typically button or link components representing alternative or supporting actions.
|
|
32
32
|
*/
|
|
33
33
|
secondaryActions?: ComponentChildren;
|
|
34
34
|
}
|
|
35
35
|
interface AdminActionProps$1 extends GlobalProps, ActionProps, ActionSlots {
|
|
36
36
|
/**
|
|
37
|
-
* Whether the action is in a loading state, such as initial page load or action
|
|
38
|
-
* When true
|
|
37
|
+
* Whether the action is in a loading state, such as during initial page load or when the action is being opened.
|
|
38
|
+
* When `true`, the action might be in an inert state that prevents user interaction.
|
|
39
39
|
*
|
|
40
40
|
* @default false
|
|
41
41
|
*/
|
|
@@ -43,39 +43,37 @@ interface AdminActionProps$1 extends GlobalProps, ActionProps, ActionSlots {
|
|
|
43
43
|
}
|
|
44
44
|
interface AdminBlockProps$1 extends GlobalProps {
|
|
45
45
|
/**
|
|
46
|
-
* The text
|
|
47
|
-
* extension will be used.
|
|
46
|
+
* The text displayed as the block's title in the header. If not provided, the extension name will be used.
|
|
48
47
|
*/
|
|
49
48
|
heading?: string;
|
|
50
49
|
/**
|
|
51
|
-
* The summary
|
|
52
|
-
* Summary longer than 30 characters will be truncated.
|
|
50
|
+
* The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated.
|
|
53
51
|
*/
|
|
54
52
|
collapsedSummary?: string;
|
|
55
53
|
}
|
|
56
54
|
interface AdminPrintActionProps$1 extends GlobalProps {
|
|
57
55
|
/**
|
|
58
|
-
*
|
|
56
|
+
* The source URL of the preview and the document to print.
|
|
59
57
|
* If not provided, the preview will show an empty state and the print button will be disabled.
|
|
60
|
-
* HTML, PDFs and images are supported.
|
|
58
|
+
* HTML, PDFs, and images are supported.
|
|
61
59
|
*/
|
|
62
60
|
src?: string;
|
|
63
61
|
}
|
|
64
62
|
export interface BaseOverlayProps {
|
|
65
63
|
/**
|
|
66
|
-
*
|
|
64
|
+
* A callback fired immediately after the overlay is shown.
|
|
67
65
|
*/
|
|
68
66
|
onShow?: (event: Event) => void;
|
|
69
67
|
/**
|
|
70
|
-
*
|
|
68
|
+
* A callback fired when the overlay is shown, after any show animations have completed.
|
|
71
69
|
*/
|
|
72
70
|
onAfterShow?: (event: Event) => void;
|
|
73
71
|
/**
|
|
74
|
-
*
|
|
72
|
+
* A callback fired immediately after the overlay is hidden.
|
|
75
73
|
*/
|
|
76
74
|
onHide?: (event: Event) => void;
|
|
77
75
|
/**
|
|
78
|
-
*
|
|
76
|
+
* A callback fired when the overlay is hidden, after any hide animations have completed.
|
|
79
77
|
*/
|
|
80
78
|
onAfterHide?: (event: Event) => void;
|
|
81
79
|
}
|
|
@@ -89,19 +87,19 @@ export interface BaseOverlayProps {
|
|
|
89
87
|
*/
|
|
90
88
|
export interface BaseOverlayMethods {
|
|
91
89
|
/**
|
|
92
|
-
*
|
|
90
|
+
* A method to programmatically show the overlay.
|
|
93
91
|
*
|
|
94
92
|
* @implementation This is a method to be called on the element and not a callback and should hence be camelCase
|
|
95
93
|
*/
|
|
96
94
|
showOverlay: () => void;
|
|
97
95
|
/**
|
|
98
|
-
*
|
|
96
|
+
* A method to programmatically hide the overlay.
|
|
99
97
|
*
|
|
100
98
|
* @implementation This is a method to be called on the element and not a callback and should hence be camelCase
|
|
101
99
|
*/
|
|
102
100
|
hideOverlay: () => void;
|
|
103
101
|
/**
|
|
104
|
-
*
|
|
102
|
+
* A method to programmatically toggle the visibility of the overlay.
|
|
105
103
|
*
|
|
106
104
|
* @implementation This is a method to be called on the element and not a callback and should hence be camelCase
|
|
107
105
|
*/
|
|
@@ -109,42 +107,35 @@ export interface BaseOverlayMethods {
|
|
|
109
107
|
}
|
|
110
108
|
export interface FocusEventProps {
|
|
111
109
|
/**
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event
|
|
110
|
+
* A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).
|
|
115
111
|
*/
|
|
116
112
|
onBlur?: (event: FocusEvent) => void;
|
|
117
113
|
/**
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event
|
|
114
|
+
* A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).
|
|
121
115
|
*/
|
|
122
116
|
onFocus?: (event: FocusEvent) => void;
|
|
123
117
|
}
|
|
124
118
|
export interface ToggleEventProps {
|
|
125
119
|
/**
|
|
126
|
-
*
|
|
120
|
+
* A callback fired when the element state changes, after any toggle animations have finished.
|
|
127
121
|
*
|
|
128
122
|
* - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the
|
|
129
123
|
* `newState` property will be set to `open`.
|
|
130
124
|
* - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the
|
|
131
125
|
* `newState` will be `closed`.
|
|
132
126
|
*
|
|
133
|
-
*
|
|
134
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState
|
|
127
|
+
* Learn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).
|
|
135
128
|
*/
|
|
136
129
|
onAfterToggle?: (event: ToggleEvent$1) => void;
|
|
137
130
|
/**
|
|
138
|
-
*
|
|
131
|
+
* A callback fired immediately when the element state changes, before any animations.
|
|
139
132
|
*
|
|
140
133
|
* - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the
|
|
141
134
|
* `newState` property will be set to `open`.
|
|
142
135
|
* - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the
|
|
143
136
|
* `newState` will be `closed`.
|
|
144
137
|
*
|
|
145
|
-
*
|
|
146
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState
|
|
147
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState
|
|
138
|
+
* Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).
|
|
148
139
|
*/
|
|
149
140
|
onToggle?: (event: ToggleEvent$1) => void;
|
|
150
141
|
}
|
|
@@ -155,11 +146,11 @@ interface ToggleEvent$1 extends Event {
|
|
|
155
146
|
}
|
|
156
147
|
export interface ExtendableEvent extends Event {
|
|
157
148
|
/**
|
|
158
|
-
*
|
|
149
|
+
* A method that accepts a promise signaling the duration and eventual success or failure of actions relating to the event.
|
|
159
150
|
*
|
|
160
|
-
* This
|
|
151
|
+
* This might be called multiple times to add promises to the event.
|
|
161
152
|
*
|
|
162
|
-
* However, this
|
|
153
|
+
* However, this might only be called synchronously during the dispatch of the event.
|
|
163
154
|
* As in, you cannot call it after a `setTimeout` or microtask.
|
|
164
155
|
*/
|
|
165
156
|
waitUntil?: (promise: Promise<void>) => void;
|
|
@@ -184,46 +175,68 @@ export type SizeKeyword =
|
|
|
184
175
|
| 'large-300'
|
|
185
176
|
| 'large-400'
|
|
186
177
|
| 'large-500';
|
|
178
|
+
/**
|
|
179
|
+
* Defines the color intensity or emphasis level for text and UI elements.
|
|
180
|
+
*
|
|
181
|
+
* - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.
|
|
182
|
+
* - `base`: Primary color for body text, standard UI elements, and general content with good readability.
|
|
183
|
+
* - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.
|
|
184
|
+
*
|
|
185
|
+
*/
|
|
187
186
|
export type ColorKeyword = 'subdued' | 'base' | 'strong';
|
|
188
187
|
interface AvatarProps$1 extends GlobalProps {
|
|
189
188
|
/**
|
|
190
|
-
*
|
|
189
|
+
* The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials (e.g., "JD" for John Doe).
|
|
191
190
|
*/
|
|
192
191
|
initials?: string;
|
|
193
192
|
/**
|
|
194
|
-
* The URL or path to the image.
|
|
195
|
-
*
|
|
196
|
-
* Initials will be rendered as a fallback if `src` is not provided, fails to load or does not load quickly
|
|
193
|
+
* The URL or path to the avatar image. When provided, the image takes priority over `initials`. If the image is not provided, fails to load, or loads slowly, `initials` will be rendered as a fallback.
|
|
197
194
|
*/
|
|
198
195
|
src?: string;
|
|
199
196
|
/**
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
|
|
197
|
+
* A callback fired when the avatar image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload).
|
|
203
198
|
*/
|
|
204
199
|
onLoad?: (event: Event) => void;
|
|
205
200
|
/**
|
|
206
|
-
*
|
|
207
|
-
*
|
|
208
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
|
|
201
|
+
* A callback fired when the avatar image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror).
|
|
209
202
|
*/
|
|
210
203
|
onError?: (event: Event) => void;
|
|
211
204
|
/**
|
|
212
|
-
*
|
|
205
|
+
* The size of the avatar. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default medium size that works well in most contexts.
|
|
213
206
|
*
|
|
214
207
|
* @default 'base'
|
|
215
208
|
*/
|
|
216
209
|
size?: SizeKeyword;
|
|
217
210
|
/**
|
|
218
|
-
*
|
|
219
|
-
*
|
|
211
|
+
* Alternative text that describes the avatar for accessibility.
|
|
212
|
+
*
|
|
213
|
+
* Provides a text description of the avatar for users with assistive technology
|
|
214
|
+
* and serves as a fallback when the avatar fails to load. A well-written description
|
|
215
|
+
* enables people with visual impairments to understand non-text content.
|
|
216
|
+
*
|
|
217
|
+
* When a screen reader encounters an avatar, it reads this description aloud.
|
|
218
|
+
* When an avatar fails to load, this text displays on screen, helping all users
|
|
219
|
+
* understand what content was intended.
|
|
220
|
+
*
|
|
221
|
+
* Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4)
|
|
222
|
+
* and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).
|
|
220
223
|
*/
|
|
221
224
|
alt?: string;
|
|
222
225
|
}
|
|
226
|
+
/**
|
|
227
|
+
* Defines the background color intensity or emphasis level for UI elements.
|
|
228
|
+
*
|
|
229
|
+
* - `transparent`: No background, allowing the underlying surface to show through.
|
|
230
|
+
* - `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.
|
|
231
|
+
*
|
|
232
|
+
*/
|
|
223
233
|
export type BackgroundColorKeyword = 'transparent' | ColorKeyword;
|
|
224
234
|
export interface BackgroundProps {
|
|
225
235
|
/**
|
|
226
|
-
*
|
|
236
|
+
* The background color of the element. Use `transparent` for no background, or choose from `subdued`, `base`, or `strong` to apply varying levels of color intensity based on the component's `tone`.
|
|
237
|
+
*
|
|
238
|
+
* - `transparent`: No background, allowing the underlying surface to show through.
|
|
239
|
+
* - `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.
|
|
227
240
|
*
|
|
228
241
|
* @default 'transparent'
|
|
229
242
|
*/
|
|
@@ -233,9 +246,9 @@ export interface BackgroundProps {
|
|
|
233
246
|
* Tone is a property for defining the color treatment of a component.
|
|
234
247
|
*
|
|
235
248
|
* A tone can apply a grouping of colors to a component. For example,
|
|
236
|
-
* critical
|
|
249
|
+
* critical might have a specific text color and background color.
|
|
237
250
|
*
|
|
238
|
-
* In some cases, like for Banner, the tone
|
|
251
|
+
* In some cases, like for Banner, the tone might also affect the semantic and accessibility treatment of the component.
|
|
239
252
|
*
|
|
240
253
|
* @default 'auto'
|
|
241
254
|
*/
|
|
@@ -261,7 +274,6 @@ declare const privateIconArray: readonly [
|
|
|
261
274
|
'alert-octagon-filled',
|
|
262
275
|
'alert-triangle',
|
|
263
276
|
'alert-triangle-filled',
|
|
264
|
-
'align-horizontal-centers',
|
|
265
277
|
'app-extension',
|
|
266
278
|
'apps',
|
|
267
279
|
'archive',
|
|
@@ -325,7 +337,6 @@ declare const privateIconArray: readonly [
|
|
|
325
337
|
'catalog-product',
|
|
326
338
|
'categories',
|
|
327
339
|
'channels',
|
|
328
|
-
'channels-filled',
|
|
329
340
|
'chart-cohort',
|
|
330
341
|
'chart-donut',
|
|
331
342
|
'chart-funnel',
|
|
@@ -816,12 +827,35 @@ export type IconType = (typeof privateIconArray)[number];
|
|
|
816
827
|
* Like `Extract`, but ensures that the extracted type is a strict subtype of the input type.
|
|
817
828
|
*/
|
|
818
829
|
export type ExtractStrict<T, U extends T> = Extract<T, U>;
|
|
830
|
+
/**
|
|
831
|
+
* Represents CSS shorthand properties that accept one to four values.
|
|
832
|
+
* Supports specifying values for all four sides: top, right, bottom, and left.
|
|
833
|
+
*
|
|
834
|
+
* - `T`: Single value that applies to all four sides.
|
|
835
|
+
* - `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right).
|
|
836
|
+
* - `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom).
|
|
837
|
+
* - `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left).
|
|
838
|
+
*/
|
|
819
839
|
export type MaybeAllValuesShorthandProperty<T extends string> =
|
|
820
840
|
| T
|
|
821
841
|
| `${T} ${T}`
|
|
822
842
|
| `${T} ${T} ${T}`
|
|
823
843
|
| `${T} ${T} ${T} ${T}`;
|
|
844
|
+
/**
|
|
845
|
+
* Represents CSS shorthand properties that accept one or two values.
|
|
846
|
+
* Supports specifying the same value for both dimensions or different values.
|
|
847
|
+
*
|
|
848
|
+
* - `T`: Single value that applies to both dimensions.
|
|
849
|
+
* - `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal).
|
|
850
|
+
*/
|
|
824
851
|
export type MaybeTwoValuesShorthandProperty<T extends string> = T | `${T} ${T}`;
|
|
852
|
+
/**
|
|
853
|
+
* Makes a property responsive by allowing it to be set conditionally based on container query conditions.
|
|
854
|
+
* The value can be either a base value or a container query string.
|
|
855
|
+
*
|
|
856
|
+
* - `T`: Base value that applies in all conditions.
|
|
857
|
+
* - `@container${string}`: Container query string for conditional responsive styling based on container size.
|
|
858
|
+
*/
|
|
825
859
|
export type MaybeResponsive<T> = T | `@container${string}`;
|
|
826
860
|
/**
|
|
827
861
|
* Prevents widening string literal types in a union to `string`.
|
|
@@ -841,33 +875,45 @@ export type AnyString = string & {};
|
|
|
841
875
|
export type optionalSpace = '' | ' ';
|
|
842
876
|
interface BadgeProps$1 extends GlobalProps {
|
|
843
877
|
/**
|
|
844
|
-
* The
|
|
878
|
+
* The text or elements displayed inside the badge component.
|
|
845
879
|
*/
|
|
846
880
|
children?: ComponentChildren;
|
|
847
881
|
/**
|
|
848
|
-
*
|
|
882
|
+
* The semantic meaning and color treatment of the component.
|
|
883
|
+
*
|
|
884
|
+
* - `auto`: Automatically determined based on context.
|
|
885
|
+
* - `neutral`: General information without specific intent.
|
|
886
|
+
* - `info`: Informational content or helpful tips.
|
|
887
|
+
* - `success`: Positive outcomes or successful states.
|
|
888
|
+
* - `caution`: Advisory notices that need attention.
|
|
889
|
+
* - `warning`: Important warnings about potential issues.
|
|
890
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
849
891
|
*
|
|
850
892
|
* @default 'auto'
|
|
851
893
|
*/
|
|
852
894
|
tone?: ToneKeyword;
|
|
853
895
|
/**
|
|
854
|
-
*
|
|
896
|
+
* Controls the visual weight and emphasis of the badge.
|
|
897
|
+
*
|
|
898
|
+
* - `base`: Standard weight with moderate emphasis, suitable for most use cases.
|
|
899
|
+
* - `strong`: Increased visual weight for higher emphasis and prominence.
|
|
855
900
|
*
|
|
856
901
|
* @default 'base'
|
|
857
902
|
*/
|
|
858
903
|
color?: ColorKeyword;
|
|
859
904
|
/**
|
|
860
|
-
*
|
|
905
|
+
* An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning.
|
|
906
|
+
* Accepts any icon name from the icon library or a custom string identifier.
|
|
861
907
|
*
|
|
862
908
|
* @default ''
|
|
863
909
|
*/
|
|
864
910
|
icon?: IconType | AnyString;
|
|
865
911
|
/**
|
|
866
|
-
* The position of the icon
|
|
912
|
+
* The position of the icon relative to the badge text. Use `start` to place the icon before the text, or `end` to place it after.
|
|
867
913
|
*/
|
|
868
914
|
iconPosition?: 'start' | 'end';
|
|
869
915
|
/**
|
|
870
|
-
*
|
|
916
|
+
* The size of the badge. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size.
|
|
871
917
|
*
|
|
872
918
|
* @default 'base'
|
|
873
919
|
*/
|
|
@@ -875,42 +921,42 @@ interface BadgeProps$1 extends GlobalProps {
|
|
|
875
921
|
}
|
|
876
922
|
interface BannerProps$1 extends GlobalProps, ActionSlots {
|
|
877
923
|
/**
|
|
878
|
-
* The
|
|
924
|
+
* The heading text displayed at the top of the banner to summarize the message or alert.
|
|
879
925
|
*
|
|
880
926
|
* @default ''
|
|
881
927
|
*/
|
|
882
928
|
heading?: string;
|
|
883
929
|
/**
|
|
884
|
-
* The content
|
|
930
|
+
* The main content displayed within the banner component, typically descriptive text or other elements providing details about the message or alert.
|
|
885
931
|
*/
|
|
886
932
|
children?: ComponentChildren;
|
|
887
933
|
/**
|
|
888
|
-
*
|
|
934
|
+
* The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.
|
|
889
935
|
*
|
|
890
|
-
*
|
|
936
|
+
* - `auto`: Automatically determined based on context.
|
|
937
|
+
* - `neutral`: General status information without emphasis.
|
|
938
|
+
* - `info`: Informational content or helpful tips.
|
|
939
|
+
* - `success`: Positive outcomes or successful states.
|
|
940
|
+
* - `caution`: Situations that need attention but aren't urgent.
|
|
941
|
+
* - `warning`: Important warnings about potential issues.
|
|
942
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
891
943
|
*
|
|
892
|
-
*
|
|
893
|
-
* - `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.
|
|
894
|
-
*
|
|
895
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions
|
|
896
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role
|
|
897
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role
|
|
944
|
+
* The `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/alert_role) that is announced by screen readers immediately. The `neutral`, `info`, `success`, `warning`, and `caution` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/status_role) that is announced by screen readers after the current message.
|
|
898
945
|
*
|
|
899
946
|
* @default 'auto'
|
|
900
947
|
*/
|
|
901
948
|
tone?: ToneKeyword;
|
|
902
949
|
/**
|
|
903
|
-
*
|
|
904
|
-
* A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.
|
|
950
|
+
* Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.
|
|
905
951
|
*
|
|
906
952
|
* @default false
|
|
907
953
|
*/
|
|
908
954
|
collapsible?: boolean;
|
|
909
955
|
/**
|
|
910
|
-
*
|
|
956
|
+
* Whether the banner displays a close button that allows users to dismiss it.
|
|
911
957
|
*
|
|
912
958
|
* When the close button is pressed, the `dismiss` event will fire,
|
|
913
|
-
* then `hidden` will be true
|
|
959
|
+
* then `hidden` will be set to `true`,
|
|
914
960
|
* any animation will complete,
|
|
915
961
|
* and the `afterhide` event will fire.
|
|
916
962
|
*
|
|
@@ -918,17 +964,17 @@ interface BannerProps$1 extends GlobalProps, ActionSlots {
|
|
|
918
964
|
*/
|
|
919
965
|
dismissible?: boolean;
|
|
920
966
|
/**
|
|
921
|
-
*
|
|
967
|
+
* A callback that fires when the banner is dismissed by the user clicking the close button.
|
|
922
968
|
*
|
|
923
|
-
* This
|
|
969
|
+
* This doesn't fire when setting `hidden` manually.
|
|
924
970
|
*
|
|
925
|
-
* The `hidden` property
|
|
971
|
+
* The `hidden` property is `false` when this event fires.
|
|
926
972
|
*/
|
|
927
973
|
onDismiss?: (event: Event) => void;
|
|
928
974
|
/**
|
|
929
|
-
*
|
|
975
|
+
* A callback that fires when the banner has fully hidden, including after any hide animations have completed.
|
|
930
976
|
*
|
|
931
|
-
* The `hidden` property
|
|
977
|
+
* The `hidden` property is `true` when this event fires.
|
|
932
978
|
*
|
|
933
979
|
* @implementation If implementations animate the hiding of the banner,
|
|
934
980
|
* this event must fire after the banner has fully hidden.
|
|
@@ -936,13 +982,12 @@ interface BannerProps$1 extends GlobalProps, ActionSlots {
|
|
|
936
982
|
*/
|
|
937
983
|
onAfterHide?: (event: Event) => void;
|
|
938
984
|
/**
|
|
939
|
-
*
|
|
985
|
+
* Controls whether the banner is visible or hidden.
|
|
940
986
|
*
|
|
941
|
-
*
|
|
942
|
-
*
|
|
943
|
-
* ensure you update app state for this property when the `dismiss` event fires.
|
|
987
|
+
* When using a controlled component pattern and the banner is `dismissible`,
|
|
988
|
+
* update this property to `true` when the `dismiss` event fires.
|
|
944
989
|
*
|
|
945
|
-
*
|
|
990
|
+
* You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.
|
|
946
991
|
*
|
|
947
992
|
* @default false
|
|
948
993
|
*/
|
|
@@ -955,7 +1000,8 @@ export interface DisplayProps {
|
|
|
955
1000
|
* - `auto`: the component’s initial value. The actual value depends on the component and context.
|
|
956
1001
|
* - `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
|
|
957
1002
|
*
|
|
958
|
-
*
|
|
1003
|
+
* Learn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).
|
|
1004
|
+
*
|
|
959
1005
|
* @default 'auto'
|
|
960
1006
|
*/
|
|
961
1007
|
display?: MaybeResponsive<'auto' | 'none'>;
|
|
@@ -973,6 +1019,36 @@ export interface AccessibilityRoleProps {
|
|
|
973
1019
|
*/
|
|
974
1020
|
accessibilityRole?: AccessibilityRole;
|
|
975
1021
|
}
|
|
1022
|
+
/**
|
|
1023
|
+
* Defines the semantic role of a component for assistive technologies like screen readers.
|
|
1024
|
+
*
|
|
1025
|
+
* Accessibility roles help users with disabilities understand the purpose and structure of content.
|
|
1026
|
+
* These roles map to HTML elements and ARIA roles, providing semantic meaning beyond visual presentation.
|
|
1027
|
+
*
|
|
1028
|
+
* Use these roles to:
|
|
1029
|
+
* - Improve navigation for screen reader users
|
|
1030
|
+
* - Provide semantic structure to your UI
|
|
1031
|
+
* - Ensure proper interpretation by assistive technologies
|
|
1032
|
+
*
|
|
1033
|
+
* Learn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles) in the MDN web docs.
|
|
1034
|
+
*
|
|
1035
|
+
* - `main`: Indicates the primary content area of the page.
|
|
1036
|
+
* - `header`: Marks a component as a header containing introductory content or navigation.
|
|
1037
|
+
* - `footer`: Designates content containing information like copyright, navigation links, or privacy statements.
|
|
1038
|
+
* - `section`: Defines a generic thematic grouping of content that should have a heading or accessible label.
|
|
1039
|
+
* - `aside`: Marks supporting content that relates to but is separate from the main content.
|
|
1040
|
+
* - `navigation`: Identifies major groups of navigation links for moving around the site or page.
|
|
1041
|
+
* - `ordered-list`: Represents a list where the order of items is meaningful.
|
|
1042
|
+
* - `list-item`: Identifies an individual item within a list.
|
|
1043
|
+
* - `list-item-separator`: Acts as a visual and semantic divider between items in a list.
|
|
1044
|
+
* - `unordered-list`: Represents a list where the order of items is not meaningful.
|
|
1045
|
+
* - `separator`: Creates a divider that separates and distinguishes sections of content.
|
|
1046
|
+
* - `status`: Defines a live region for advisory information that is not urgent enough to be an alert.
|
|
1047
|
+
* - `alert`: Marks important, time-sensitive information that requires the user's immediate attention.
|
|
1048
|
+
* - `generic`: Creates a semantically neutral container element with no inherent meaning.
|
|
1049
|
+
* - `presentation`: Removes semantic meaning from an element while preserving its visual appearance.
|
|
1050
|
+
* - `none`: Synonym for `presentation`, removes semantic meaning while keeping visual styling.
|
|
1051
|
+
*/
|
|
976
1052
|
export type AccessibilityRole =
|
|
977
1053
|
/**
|
|
978
1054
|
* Used to indicate the primary content.
|
|
@@ -997,21 +1073,13 @@ export type AccessibilityRole =
|
|
|
997
1073
|
| 'footer'
|
|
998
1074
|
/**
|
|
999
1075
|
* Used to indicate a generic section.
|
|
1000
|
-
* Sections should always have a
|
|
1076
|
+
* Sections should always have a heading or an accessible name provided in the `accessibilityLabel` property.
|
|
1001
1077
|
*
|
|
1002
1078
|
* In an HTML host `section` will render a `<section>` element.
|
|
1003
1079
|
* 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.
|
|
1004
1080
|
*
|
|
1005
1081
|
*/
|
|
1006
1082
|
| 'section'
|
|
1007
|
-
/**
|
|
1008
|
-
* Used to identify a perceivable section containing content that is relevant to a specific, author-specified purpose and sufficiently important that users will likely want to be able to navigate to the section easily.
|
|
1009
|
-
*
|
|
1010
|
-
* In an HTML host `region` will render as `<div role="region">`.
|
|
1011
|
-
* A region **must** have an accessible name provided via the `accessibilityLabel` property.
|
|
1012
|
-
* Learn more about the [`region` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/region_role) in the MDN web docs.
|
|
1013
|
-
*/
|
|
1014
|
-
| 'region'
|
|
1015
1083
|
/**
|
|
1016
1084
|
* Used to designate a supporting section that relates to the main content.
|
|
1017
1085
|
*
|
|
@@ -1098,11 +1166,11 @@ export type AccessibilityRole =
|
|
|
1098
1166
|
| 'none';
|
|
1099
1167
|
export interface AccessibilityVisibilityProps {
|
|
1100
1168
|
/**
|
|
1101
|
-
*
|
|
1169
|
+
* Controls the visibility of the element for both visual and assistive technology users.
|
|
1102
1170
|
*
|
|
1103
|
-
* - `visible`:
|
|
1104
|
-
* - `hidden`:
|
|
1105
|
-
* - `exclusive`:
|
|
1171
|
+
* - `visible`: The element is visible to all users (both sighted users and screen readers).
|
|
1172
|
+
* - `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.
|
|
1173
|
+
* - `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.
|
|
1106
1174
|
*
|
|
1107
1175
|
* @default 'visible'
|
|
1108
1176
|
*/
|
|
@@ -1110,10 +1178,13 @@ export interface AccessibilityVisibilityProps {
|
|
|
1110
1178
|
}
|
|
1111
1179
|
export interface LabelAccessibilityVisibilityProps {
|
|
1112
1180
|
/**
|
|
1113
|
-
*
|
|
1181
|
+
* Controls whether the label is visible to all users or only to screen readers.
|
|
1182
|
+
*
|
|
1183
|
+
* - `visible`: The label is shown to everyone (default).
|
|
1184
|
+
* - `exclusive`: The label is visually hidden but still announced by screen readers.
|
|
1114
1185
|
*
|
|
1115
|
-
*
|
|
1116
|
-
*
|
|
1186
|
+
* Use `exclusive` when the surrounding context makes the label redundant visually,
|
|
1187
|
+
* but screen reader users still need it for clarity.
|
|
1117
1188
|
*
|
|
1118
1189
|
* @default 'visible'
|
|
1119
1190
|
*/
|
|
@@ -1122,35 +1193,38 @@ export interface LabelAccessibilityVisibilityProps {
|
|
|
1122
1193
|
'visible' | 'exclusive'
|
|
1123
1194
|
>;
|
|
1124
1195
|
}
|
|
1196
|
+
/**
|
|
1197
|
+
* Defines the padding size for elements, using the standard size scale or `none` for no padding.
|
|
1198
|
+
*
|
|
1199
|
+
* - `SizeKeyword`: Standard padding sizes from the size scale for consistent spacing.
|
|
1200
|
+
* - `none`: No padding.
|
|
1201
|
+
*/
|
|
1125
1202
|
export type PaddingKeyword = SizeKeyword | 'none';
|
|
1126
1203
|
export interface PaddingProps {
|
|
1127
1204
|
/**
|
|
1128
|
-
*
|
|
1129
|
-
*
|
|
1130
|
-
* [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
|
|
1131
|
-
* supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
|
|
1205
|
+
* The padding applied to all edges of the component.
|
|
1132
1206
|
*
|
|
1133
|
-
* -
|
|
1134
|
-
* -
|
|
1135
|
-
* - 2 values
|
|
1207
|
+
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:
|
|
1208
|
+
* - 1 value applies to all sides
|
|
1209
|
+
* - 2 values apply to block (top/bottom) and inline (left/right)
|
|
1210
|
+
* - 3 values apply to block-start (top), inline (left/right), and block-end (bottom)
|
|
1211
|
+
* - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)
|
|
1136
1212
|
*
|
|
1137
|
-
*
|
|
1138
|
-
* - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
|
|
1139
|
-
* - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
|
|
1140
|
-
* - `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`.
|
|
1141
|
-
* - `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`.
|
|
1213
|
+
* **Examples:** `base`, `large none`, `base large-100 base small`
|
|
1142
1214
|
*
|
|
1143
|
-
*
|
|
1215
|
+
* Use `auto` to inherit padding from the nearest container with removed padding.
|
|
1144
1216
|
*
|
|
1145
1217
|
* @default 'none'
|
|
1146
1218
|
*/
|
|
1147
1219
|
padding?: MaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>;
|
|
1148
1220
|
/**
|
|
1149
|
-
*
|
|
1221
|
+
* The block-direction padding (top and bottom in horizontal writing modes).
|
|
1222
|
+
*
|
|
1223
|
+
* Accepts a single value for both sides or two space-separated values for block-start and block-end.
|
|
1150
1224
|
*
|
|
1151
|
-
*
|
|
1225
|
+
* **Example:** `large none` applies `large` to the top and `none` to the bottom.
|
|
1152
1226
|
*
|
|
1153
|
-
*
|
|
1227
|
+
* Overrides the block value from `padding`.
|
|
1154
1228
|
*
|
|
1155
1229
|
* @default '' - meaning no override
|
|
1156
1230
|
*/
|
|
@@ -1158,27 +1232,29 @@ export interface PaddingProps {
|
|
|
1158
1232
|
MaybeTwoValuesShorthandProperty<PaddingKeyword> | ''
|
|
1159
1233
|
>;
|
|
1160
1234
|
/**
|
|
1161
|
-
*
|
|
1235
|
+
* The block-start padding (top in horizontal writing modes).
|
|
1162
1236
|
*
|
|
1163
|
-
*
|
|
1237
|
+
* Overrides the block-start value from `paddingBlock`.
|
|
1164
1238
|
*
|
|
1165
1239
|
* @default '' - meaning no override
|
|
1166
1240
|
*/
|
|
1167
1241
|
paddingBlockStart?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1168
1242
|
/**
|
|
1169
|
-
*
|
|
1243
|
+
* The block-end padding (bottom in horizontal writing modes).
|
|
1170
1244
|
*
|
|
1171
|
-
*
|
|
1245
|
+
* Overrides the block-end value from `paddingBlock`.
|
|
1172
1246
|
*
|
|
1173
1247
|
* @default '' - meaning no override
|
|
1174
1248
|
*/
|
|
1175
1249
|
paddingBlockEnd?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1176
1250
|
/**
|
|
1177
|
-
*
|
|
1251
|
+
* The inline-direction padding (left and right in horizontal writing modes).
|
|
1178
1252
|
*
|
|
1179
|
-
* -
|
|
1253
|
+
* Accepts a single value for both sides or two space-separated values for inline-start and inline-end.
|
|
1180
1254
|
*
|
|
1181
|
-
*
|
|
1255
|
+
* **Example:** `large none` applies `large` to the left and `none` to the right.
|
|
1256
|
+
*
|
|
1257
|
+
* Overrides the inline value from `padding`.
|
|
1182
1258
|
*
|
|
1183
1259
|
* @default '' - meaning no override
|
|
1184
1260
|
*/
|
|
@@ -1186,70 +1262,83 @@ export interface PaddingProps {
|
|
|
1186
1262
|
MaybeTwoValuesShorthandProperty<PaddingKeyword> | ''
|
|
1187
1263
|
>;
|
|
1188
1264
|
/**
|
|
1189
|
-
*
|
|
1265
|
+
* The inline-start padding (left in LTR writing modes, right in RTL).
|
|
1190
1266
|
*
|
|
1191
|
-
*
|
|
1267
|
+
* Overrides the inline-start value from `paddingInline`.
|
|
1192
1268
|
*
|
|
1193
1269
|
* @default '' - meaning no override
|
|
1194
1270
|
*/
|
|
1195
1271
|
paddingInlineStart?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1196
1272
|
/**
|
|
1197
|
-
*
|
|
1273
|
+
* The inline-end padding (right in LTR writing modes, left in RTL).
|
|
1198
1274
|
*
|
|
1199
|
-
*
|
|
1275
|
+
* Overrides the inline-end value from `paddingInline`.
|
|
1200
1276
|
*
|
|
1201
1277
|
* @default '' - meaning no override
|
|
1202
1278
|
*/
|
|
1203
1279
|
paddingInlineEnd?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1204
1280
|
}
|
|
1281
|
+
/**
|
|
1282
|
+
* Represents size values in pixels, percentages, or zero.
|
|
1283
|
+
*
|
|
1284
|
+
* - `${number}px`: Absolute size in pixels for fixed dimensions (such as `100px`, `24px`).
|
|
1285
|
+
* - `${number}%`: Relative size as a percentage of the parent container (such as `50%`, `100%`).
|
|
1286
|
+
* - `0`: Zero size, equivalent to no dimension.
|
|
1287
|
+
*/
|
|
1205
1288
|
export type SizeUnits = `${number}px` | `${number}%` | `0`;
|
|
1289
|
+
/**
|
|
1290
|
+
* Represents size values that can also be set to `auto` for automatic sizing.
|
|
1291
|
+
*
|
|
1292
|
+
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1293
|
+
* - `auto`: Automatically sizes based on content and layout constraints.
|
|
1294
|
+
*/
|
|
1206
1295
|
export type SizeUnitsOrAuto = SizeUnits | 'auto';
|
|
1296
|
+
/**
|
|
1297
|
+
* Represents size values that can also be set to `none` to remove the size constraint.
|
|
1298
|
+
*
|
|
1299
|
+
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1300
|
+
* - `none`: No size constraint, allowing unlimited growth.
|
|
1301
|
+
*/
|
|
1207
1302
|
export type SizeUnitsOrNone = SizeUnits | 'none';
|
|
1208
1303
|
export interface SizingProps {
|
|
1209
1304
|
/**
|
|
1210
|
-
*
|
|
1305
|
+
* The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).
|
|
1211
1306
|
*
|
|
1212
|
-
*
|
|
1307
|
+
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1308
|
+
* - `auto`: Automatically sizes based on content and layout constraints.
|
|
1213
1309
|
*
|
|
1214
1310
|
* @default 'auto'
|
|
1215
1311
|
*/
|
|
1216
1312
|
blockSize?: MaybeResponsive<SizeUnitsOrAuto>;
|
|
1217
1313
|
/**
|
|
1218
|
-
*
|
|
1219
|
-
*
|
|
1220
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size
|
|
1314
|
+
* The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).
|
|
1221
1315
|
*
|
|
1222
1316
|
* @default '0'
|
|
1223
1317
|
*/
|
|
1224
1318
|
minBlockSize?: MaybeResponsive<SizeUnits>;
|
|
1225
1319
|
/**
|
|
1226
|
-
*
|
|
1227
|
-
*
|
|
1228
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size
|
|
1320
|
+
* The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).
|
|
1229
1321
|
*
|
|
1230
1322
|
* @default 'none'
|
|
1231
1323
|
*/
|
|
1232
1324
|
maxBlockSize?: MaybeResponsive<SizeUnitsOrNone>;
|
|
1233
1325
|
/**
|
|
1234
|
-
*
|
|
1326
|
+
* The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).
|
|
1235
1327
|
*
|
|
1236
|
-
*
|
|
1328
|
+
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1329
|
+
* - `auto`: Automatically sizes based on content and layout constraints.
|
|
1237
1330
|
*
|
|
1238
1331
|
* @default 'auto'
|
|
1239
1332
|
*/
|
|
1240
1333
|
inlineSize?: MaybeResponsive<SizeUnitsOrAuto>;
|
|
1241
1334
|
/**
|
|
1242
|
-
*
|
|
1243
|
-
*
|
|
1244
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size
|
|
1335
|
+
* The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).
|
|
1245
1336
|
*
|
|
1246
1337
|
* @default '0'
|
|
1247
1338
|
*/
|
|
1248
1339
|
minInlineSize?: MaybeResponsive<SizeUnits>;
|
|
1249
1340
|
/**
|
|
1250
|
-
*
|
|
1251
|
-
*
|
|
1252
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size
|
|
1341
|
+
* The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).
|
|
1253
1342
|
*
|
|
1254
1343
|
* @default 'none'
|
|
1255
1344
|
*/
|
|
@@ -1261,6 +1350,12 @@ export type BorderStyleKeyword =
|
|
|
1261
1350
|
| 'dashed'
|
|
1262
1351
|
| 'dotted'
|
|
1263
1352
|
| 'auto';
|
|
1353
|
+
/**
|
|
1354
|
+
* Defines the width of borders, using the standard size scale or `none` for no border.
|
|
1355
|
+
*
|
|
1356
|
+
* - `SizeKeyword`: Standard border widths from the size scale for consistent thickness.
|
|
1357
|
+
* - `none`: No border width (removes the border).
|
|
1358
|
+
*/
|
|
1264
1359
|
export type BorderSizeKeyword = SizeKeyword | 'none';
|
|
1265
1360
|
export type BorderRadiusKeyword = SizeKeyword | 'max' | 'none';
|
|
1266
1361
|
/**
|
|
@@ -1272,15 +1367,12 @@ export type BorderShorthand =
|
|
|
1272
1367
|
| `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`;
|
|
1273
1368
|
export interface BorderProps {
|
|
1274
1369
|
/**
|
|
1275
|
-
*
|
|
1276
|
-
*
|
|
1277
|
-
* This can be a size, optionally followed by a color, optionally followed by a style.
|
|
1278
|
-
*
|
|
1279
|
-
* If the color is not specified, it will be `base`.
|
|
1370
|
+
* Applies a border using shorthand syntax to specify width, color, and style in a single property.
|
|
1280
1371
|
*
|
|
1281
|
-
*
|
|
1372
|
+
* Accepts a size value, optionally followed by a color, optionally followed by a style.
|
|
1373
|
+
* Omitted values use defaults: color defaults to `base`, style defaults to `auto`.
|
|
1282
1374
|
*
|
|
1283
|
-
*
|
|
1375
|
+
* Individual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.
|
|
1284
1376
|
*
|
|
1285
1377
|
* @example
|
|
1286
1378
|
* // The following are equivalent:
|
|
@@ -1291,64 +1383,61 @@ export interface BorderProps {
|
|
|
1291
1383
|
*/
|
|
1292
1384
|
border?: BorderShorthand;
|
|
1293
1385
|
/**
|
|
1294
|
-
*
|
|
1386
|
+
* Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
|
|
1295
1387
|
*
|
|
1296
|
-
*
|
|
1388
|
+
* - `small`: Thin border for subtle definition.
|
|
1389
|
+
* - `small-100`: Extra thin border for minimal emphasis.
|
|
1390
|
+
* - `base`: Standard border width.
|
|
1391
|
+
* - `large`: Thick border for strong emphasis.
|
|
1392
|
+
* - `large-100`: Extra thick border for maximum prominence.
|
|
1393
|
+
* - `none`: No border.
|
|
1297
1394
|
*
|
|
1298
|
-
*
|
|
1299
|
-
*
|
|
1300
|
-
*
|
|
1301
|
-
*
|
|
1302
|
-
*
|
|
1303
|
-
*
|
|
1304
|
-
* If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
|
|
1305
|
-
*
|
|
1306
|
-
* If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
|
|
1395
|
+
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:
|
|
1396
|
+
* - One value: applies to all sides
|
|
1397
|
+
* - Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively
|
|
1398
|
+
* - Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively
|
|
1399
|
+
* - Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively
|
|
1307
1400
|
*
|
|
1308
1401
|
* @default '' - meaning no override
|
|
1309
1402
|
*/
|
|
1310
1403
|
borderWidth?: MaybeAllValuesShorthandProperty<BorderSizeKeyword> | '';
|
|
1311
1404
|
/**
|
|
1312
|
-
*
|
|
1313
|
-
*
|
|
1314
|
-
* If set, it takes precedence over the `border` property's style.
|
|
1315
|
-
*
|
|
1316
|
-
* Like CSS, up to 4 values can be specified.
|
|
1405
|
+
* Controls the visual style of the border on all sides, such as solid, dashed, or dotted.
|
|
1317
1406
|
*
|
|
1318
|
-
*
|
|
1407
|
+
* When set, this overrides the style value specified in the `border` property.
|
|
1319
1408
|
*
|
|
1320
|
-
*
|
|
1321
|
-
*
|
|
1322
|
-
*
|
|
1323
|
-
*
|
|
1324
|
-
*
|
|
1409
|
+
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:
|
|
1410
|
+
* - One value: applies to all sides
|
|
1411
|
+
* - Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively
|
|
1412
|
+
* - Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively
|
|
1413
|
+
* - Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively
|
|
1325
1414
|
*
|
|
1326
1415
|
* @default '' - meaning no override
|
|
1327
1416
|
*/
|
|
1328
1417
|
borderStyle?: MaybeAllValuesShorthandProperty<BorderStyleKeyword> | '';
|
|
1329
1418
|
/**
|
|
1330
|
-
*
|
|
1419
|
+
* Controls the color of the border using the design system's color scale.
|
|
1331
1420
|
*
|
|
1332
|
-
*
|
|
1421
|
+
* When set, this overrides the color value specified in the `border` property.
|
|
1422
|
+
* Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.
|
|
1333
1423
|
*
|
|
1334
1424
|
* @default '' - meaning no override
|
|
1335
1425
|
*/
|
|
1336
1426
|
borderColor?: ColorKeyword | '';
|
|
1337
1427
|
/**
|
|
1338
|
-
*
|
|
1339
|
-
*
|
|
1340
|
-
* [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
|
|
1341
|
-
* supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
|
|
1428
|
+
* Controls the roundedness of the element's corners using the design system's radius scale.
|
|
1342
1429
|
*
|
|
1343
|
-
* -
|
|
1344
|
-
* -
|
|
1345
|
-
* -
|
|
1430
|
+
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:
|
|
1431
|
+
* - One value: applies to all corners
|
|
1432
|
+
* - Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively
|
|
1433
|
+
* - Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively
|
|
1434
|
+
* - Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively
|
|
1346
1435
|
*
|
|
1347
|
-
*
|
|
1348
|
-
* - `small-100
|
|
1349
|
-
* - `small-100 none
|
|
1350
|
-
* - `small-100 none large-100
|
|
1351
|
-
* - `small-100 none large-100
|
|
1436
|
+
* Examples:
|
|
1437
|
+
* - `small-100`: All corners have `small-100` radius
|
|
1438
|
+
* - `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`
|
|
1439
|
+
* - `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`
|
|
1440
|
+
* - `small-100 none large-100 base`: Each corner has its specified radius value
|
|
1352
1441
|
*
|
|
1353
1442
|
* @defaultValue 'none'
|
|
1354
1443
|
*/
|
|
@@ -1358,10 +1447,10 @@ export interface OverflowProps {
|
|
|
1358
1447
|
/**
|
|
1359
1448
|
* Sets the overflow behavior of the element.
|
|
1360
1449
|
*
|
|
1450
|
+
* - `visible`: the content that extends beyond the element’s container is visible.
|
|
1361
1451
|
* - `hidden`: clips the content when it is larger than the element’s container.
|
|
1362
1452
|
* The element will not be scrollable and the users will not be able
|
|
1363
1453
|
* to access the clipped content by dragging or using a scroll wheel on a mouse.
|
|
1364
|
-
* - `visible`: the content that extends beyond the element’s container is visible.
|
|
1365
1454
|
*
|
|
1366
1455
|
* @default 'visible'
|
|
1367
1456
|
*/
|
|
@@ -1376,14 +1465,11 @@ export interface BaseBoxProps
|
|
|
1376
1465
|
BorderProps,
|
|
1377
1466
|
OverflowProps {
|
|
1378
1467
|
/**
|
|
1379
|
-
* The content of the
|
|
1468
|
+
* The content of the box.
|
|
1380
1469
|
*/
|
|
1381
1470
|
children?: ComponentChildren;
|
|
1382
1471
|
/**
|
|
1383
|
-
* A label that describes the purpose or
|
|
1384
|
-
* When set, it will be announced to users using assistive technologies and will provide them with more context.
|
|
1385
|
-
*
|
|
1386
|
-
* Only use this when the element's content is not enough context for users using assistive technologies.
|
|
1472
|
+
* A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.
|
|
1387
1473
|
*/
|
|
1388
1474
|
accessibilityLabel?: string;
|
|
1389
1475
|
}
|
|
@@ -1393,34 +1479,29 @@ export interface BaseBoxPropsWithRole
|
|
|
1393
1479
|
interface BoxProps$1 extends BaseBoxPropsWithRole, GlobalProps {}
|
|
1394
1480
|
export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
|
|
1395
1481
|
/**
|
|
1396
|
-
* The
|
|
1482
|
+
* The behavioral type of the button component, which determines what action it performs when activated.
|
|
1397
1483
|
*
|
|
1398
|
-
* - `submit`:
|
|
1399
|
-
* - `button`:
|
|
1400
|
-
* - `reset`:
|
|
1484
|
+
* - `submit`: Submits the nearest containing form.
|
|
1485
|
+
* - `button`: Performs no default action, relying on the `onClick` handler for behavior.
|
|
1486
|
+
* - `reset`: Resets all fields in the nearest containing form to their default values.
|
|
1401
1487
|
*
|
|
1402
|
-
* This property is ignored if
|
|
1488
|
+
* This property is ignored if `href` or `commandFor`/`command` is set.
|
|
1403
1489
|
*
|
|
1404
1490
|
* @default 'button'
|
|
1405
1491
|
*/
|
|
1406
1492
|
type?: 'submit' | 'button' | 'reset';
|
|
1407
1493
|
/**
|
|
1408
|
-
*
|
|
1409
|
-
* This will be called before the action indicated by `type`.
|
|
1410
|
-
*
|
|
1411
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event
|
|
1494
|
+
* A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).
|
|
1412
1495
|
*/
|
|
1413
1496
|
onClick?: (event: Event) => void;
|
|
1414
1497
|
/**
|
|
1415
|
-
*
|
|
1498
|
+
* Whether the button is disabled, preventing it from being clicked or receiving focus.
|
|
1416
1499
|
*
|
|
1417
1500
|
* @default false
|
|
1418
1501
|
*/
|
|
1419
1502
|
disabled?: boolean;
|
|
1420
1503
|
/**
|
|
1421
|
-
*
|
|
1422
|
-
*
|
|
1423
|
-
* This also disables the Button.
|
|
1504
|
+
* Whether the button is in a loading state, which replaces the button content with a loading indicator and disables interactions.
|
|
1424
1505
|
*
|
|
1425
1506
|
* @default false
|
|
1426
1507
|
*/
|
|
@@ -1428,18 +1509,19 @@ export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
|
|
|
1428
1509
|
}
|
|
1429
1510
|
export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
|
|
1430
1511
|
/**
|
|
1431
|
-
* The URL to
|
|
1432
|
-
*
|
|
1433
|
-
* - If set, it will navigate to the location specified by `href` after executing the `click` event.
|
|
1434
|
-
* - If a `commandFor` is set, the `command` will be executed instead of the navigation.
|
|
1512
|
+
* The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.
|
|
1435
1513
|
*/
|
|
1436
1514
|
href?: string;
|
|
1437
1515
|
/**
|
|
1438
1516
|
* Specifies where to display the linked URL.
|
|
1439
1517
|
*
|
|
1440
|
-
*
|
|
1518
|
+
* Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).
|
|
1441
1519
|
*
|
|
1442
|
-
*
|
|
1520
|
+
* - `auto`: The target is automatically determined based on the origin of the URL.
|
|
1521
|
+
* - `_blank`: Opens the URL in a new window or tab.
|
|
1522
|
+
* - `_self`: Opens the URL in the same browsing context as the current one.
|
|
1523
|
+
* - `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.
|
|
1524
|
+
* - `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.
|
|
1443
1525
|
*
|
|
1444
1526
|
* @implementation Surfaces can set specific rules on how they handle each URL.
|
|
1445
1527
|
* @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases.
|
|
@@ -1449,46 +1531,35 @@ export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
|
|
|
1449
1531
|
*/
|
|
1450
1532
|
target?: 'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString;
|
|
1451
1533
|
/**
|
|
1452
|
-
*
|
|
1453
|
-
* Download only works for same-origin URLs or the `blob:` and `data:` schemes.
|
|
1454
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download
|
|
1534
|
+
* A filename that causes the browser to treat the linked URL as a download. Downloads only work for same-origin URLs or the `blob:` and `data:` schemes. Learn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).
|
|
1455
1535
|
*/
|
|
1456
1536
|
download?: string;
|
|
1457
1537
|
/**
|
|
1458
|
-
*
|
|
1459
|
-
* This will be called before navigating to the location specified by `href`.
|
|
1460
|
-
*
|
|
1461
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event
|
|
1538
|
+
* A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).
|
|
1462
1539
|
*/
|
|
1463
1540
|
onClick?: (event: Event) => void;
|
|
1464
1541
|
}
|
|
1465
1542
|
export interface InteractionProps {
|
|
1466
1543
|
/**
|
|
1467
|
-
* ID of
|
|
1468
|
-
*
|
|
1469
|
-
* See `command` for how to control the behavior of the target.
|
|
1470
|
-
*
|
|
1471
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor
|
|
1544
|
+
* The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
|
|
1472
1545
|
*/
|
|
1473
1546
|
commandFor?: string;
|
|
1474
1547
|
/**
|
|
1475
|
-
*
|
|
1548
|
+
* The action that the `commandFor` target should take when this component is activated. The supported actions vary by target component type.
|
|
1476
1549
|
*
|
|
1477
|
-
*
|
|
1550
|
+
* - `--auto`: Performs the default action appropriate for the target component.
|
|
1551
|
+
* - `--show`: Displays the target component if it's currently hidden.
|
|
1552
|
+
* - `--hide`: Conceals the target component from view.
|
|
1553
|
+
* - `--toggle`: Alternates the target component between visible and hidden states.
|
|
1554
|
+
* - `--copy`: Copies the content of the target `ClipboardItem` to the system clipboard.
|
|
1478
1555
|
*
|
|
1479
|
-
*
|
|
1480
|
-
* - `--show`: shows the target component.
|
|
1481
|
-
* - `--hide`: hides the target component.
|
|
1482
|
-
* - `--toggle`: toggles the target component.
|
|
1483
|
-
* - `--copy`: copies the target ClipboardItem.
|
|
1556
|
+
* Learn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
|
|
1484
1557
|
*
|
|
1485
1558
|
* @default '--auto'
|
|
1486
|
-
*
|
|
1487
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command
|
|
1488
1559
|
*/
|
|
1489
1560
|
command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';
|
|
1490
1561
|
/**
|
|
1491
|
-
* ID of
|
|
1562
|
+
* The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.
|
|
1492
1563
|
*/
|
|
1493
1564
|
interestFor?: string;
|
|
1494
1565
|
}
|
|
@@ -1497,63 +1568,65 @@ export interface BaseClickableProps
|
|
|
1497
1568
|
LinkBehaviorProps {}
|
|
1498
1569
|
interface ButtonProps$1 extends GlobalProps, BaseClickableProps {
|
|
1499
1570
|
/**
|
|
1500
|
-
* A label that describes the purpose or
|
|
1501
|
-
*
|
|
1502
|
-
* Use this when using only an icon or the Button text is not enough context
|
|
1503
|
-
* for users using assistive technologies.
|
|
1571
|
+
* A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.
|
|
1504
1572
|
*/
|
|
1505
1573
|
accessibilityLabel?: string;
|
|
1506
1574
|
/**
|
|
1507
|
-
* The content
|
|
1575
|
+
* The content displayed within the button component.
|
|
1508
1576
|
*/
|
|
1509
1577
|
children?: ComponentChildren;
|
|
1510
1578
|
/**
|
|
1511
|
-
*
|
|
1579
|
+
* An icon displayed inside the button, typically positioned before the button text.
|
|
1580
|
+
* Use icons to help users quickly identify the button's action or to improve scannability.
|
|
1581
|
+
* Accepts any icon name from the icon library or a custom string identifier.
|
|
1512
1582
|
*
|
|
1513
1583
|
* @default ''
|
|
1514
1584
|
*/
|
|
1515
1585
|
icon?: IconType | AnyString;
|
|
1516
1586
|
/**
|
|
1517
|
-
* The
|
|
1587
|
+
* The inline width (horizontal size) of the button component.
|
|
1518
1588
|
*
|
|
1519
|
-
* - `auto`:
|
|
1520
|
-
* - `fill`:
|
|
1521
|
-
* - `fit-content`:
|
|
1589
|
+
* - `auto`: The button size depends on the surface and context.
|
|
1590
|
+
* - `fill`: The button takes up 100% of the available inline space.
|
|
1591
|
+
* - `fit-content`: The button takes up only the space needed to fit its content.
|
|
1522
1592
|
*
|
|
1523
1593
|
* @default 'auto'
|
|
1524
1594
|
*/
|
|
1525
1595
|
inlineSize?: 'auto' | 'fill' | 'fit-content';
|
|
1526
1596
|
/**
|
|
1527
|
-
*
|
|
1597
|
+
* The visual style variant of the button component, which controls its prominence and emphasis in the interface.
|
|
1528
1598
|
*
|
|
1529
|
-
* @default 'auto' - the variant is automatically determined by the
|
|
1599
|
+
* @default 'auto' - the variant is automatically determined by the button's context
|
|
1530
1600
|
*/
|
|
1531
1601
|
variant?: 'auto' | 'primary' | 'secondary' | 'tertiary';
|
|
1532
1602
|
/**
|
|
1533
|
-
*
|
|
1603
|
+
* The semantic meaning and color treatment of the component.
|
|
1604
|
+
*
|
|
1605
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
1606
|
+
* - `auto`: Automatically determined based on context.
|
|
1607
|
+
* - `neutral`: General information without specific intent.
|
|
1534
1608
|
*
|
|
1535
1609
|
* @default 'auto'
|
|
1536
1610
|
*/
|
|
1537
1611
|
tone?: ToneKeyword;
|
|
1538
1612
|
/**
|
|
1539
|
-
*
|
|
1540
|
-
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
1541
|
-
* [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
|
|
1613
|
+
* The language of the button's text content. Use this when the button text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label).
|
|
1542
1614
|
*/
|
|
1543
1615
|
lang?: string;
|
|
1544
1616
|
}
|
|
1545
1617
|
interface ButtonGroupProps$1 extends GlobalProps, ActionSlots {
|
|
1546
1618
|
/**
|
|
1547
|
-
* The content of the
|
|
1619
|
+
* The content of the button group, typically a collection of button or link components.
|
|
1548
1620
|
*/
|
|
1549
1621
|
children?: ComponentChildren;
|
|
1550
1622
|
/**
|
|
1551
|
-
* The
|
|
1623
|
+
* The spacing between button elements within the group.
|
|
1624
|
+
*
|
|
1552
1625
|
* @default 'base'
|
|
1553
1626
|
*/
|
|
1554
1627
|
gap?: 'base' | 'none';
|
|
1555
1628
|
/**
|
|
1556
|
-
*
|
|
1629
|
+
* A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.
|
|
1557
1630
|
*
|
|
1558
1631
|
* @implementation Used as a hidden heading or an aria-label on the wrapping element.
|
|
1559
1632
|
*/
|
|
@@ -1561,11 +1634,11 @@ interface ButtonGroupProps$1 extends GlobalProps, ActionSlots {
|
|
|
1561
1634
|
}
|
|
1562
1635
|
export interface BaseInputProps {
|
|
1563
1636
|
/**
|
|
1564
|
-
*
|
|
1637
|
+
* The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.
|
|
1565
1638
|
*/
|
|
1566
1639
|
name?: string;
|
|
1567
1640
|
/**
|
|
1568
|
-
*
|
|
1641
|
+
* Whether the field is disabled, preventing any user interaction.
|
|
1569
1642
|
*
|
|
1570
1643
|
* @default false
|
|
1571
1644
|
*/
|
|
@@ -1573,23 +1646,19 @@ export interface BaseInputProps {
|
|
|
1573
1646
|
}
|
|
1574
1647
|
export interface InputProps extends BaseInputProps {
|
|
1575
1648
|
/**
|
|
1576
|
-
*
|
|
1577
|
-
*
|
|
1578
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
|
|
1649
|
+
* A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).
|
|
1579
1650
|
*/
|
|
1580
1651
|
onChange?: (event: Event) => void;
|
|
1581
1652
|
/**
|
|
1582
|
-
*
|
|
1583
|
-
*
|
|
1584
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
|
|
1653
|
+
* A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
|
|
1585
1654
|
*/
|
|
1586
1655
|
onInput?: (event: Event) => void;
|
|
1587
1656
|
/**
|
|
1588
|
-
* The current value
|
|
1657
|
+
* The current value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.
|
|
1589
1658
|
*/
|
|
1590
1659
|
value?: string;
|
|
1591
1660
|
/**
|
|
1592
|
-
* The
|
|
1661
|
+
* The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. After the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value, use `value` instead.
|
|
1593
1662
|
*
|
|
1594
1663
|
* @implementation `defaultValue` reflects to the `value` attribute.
|
|
1595
1664
|
*/
|
|
@@ -1597,39 +1666,33 @@ export interface InputProps extends BaseInputProps {
|
|
|
1597
1666
|
}
|
|
1598
1667
|
export interface MultipleInputProps extends BaseInputProps {
|
|
1599
1668
|
/**
|
|
1600
|
-
*
|
|
1601
|
-
*
|
|
1602
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
|
|
1669
|
+
* A callback fired when the user has selected one or more options. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).
|
|
1603
1670
|
*/
|
|
1604
1671
|
onChange?: (event: Event) => void;
|
|
1605
1672
|
/**
|
|
1606
|
-
*
|
|
1607
|
-
*
|
|
1608
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
|
|
1673
|
+
* A callback fired when the user selects or deselects options. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
|
|
1609
1674
|
*/
|
|
1610
1675
|
onInput?: (event: Event) => void;
|
|
1611
1676
|
/**
|
|
1612
|
-
* An array of
|
|
1677
|
+
* An array of `value` attributes for the currently selected options.
|
|
1613
1678
|
*
|
|
1614
|
-
*
|
|
1679
|
+
* When provided, this property automatically sets the `selected` state on child Option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected.
|
|
1615
1680
|
*/
|
|
1616
1681
|
values?: string[];
|
|
1617
1682
|
}
|
|
1618
1683
|
export interface FileInputProps extends BaseInputProps {
|
|
1619
1684
|
/**
|
|
1620
|
-
*
|
|
1685
|
+
* A callback fired when the user has finished selecting one or more files.
|
|
1621
1686
|
*/
|
|
1622
1687
|
onChange?: (event: Event) => void;
|
|
1623
1688
|
/**
|
|
1624
|
-
*
|
|
1689
|
+
* A callback fired when the user makes any changes to the file selection.
|
|
1625
1690
|
*/
|
|
1626
1691
|
onInput?: (event: Event) => void;
|
|
1627
1692
|
/**
|
|
1628
1693
|
* A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string ("").
|
|
1629
1694
|
* When the user selected multiple files, the value represents the first file in the list of files they selected.
|
|
1630
|
-
* The value is always the file's name prefixed with "C:\fakepath\", which isn't the real path of the file.
|
|
1631
|
-
*
|
|
1632
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file#value
|
|
1695
|
+
* The value is always the file's name prefixed with "C:\fakepath\", which isn't the real path of the file. Learn more about the [file input value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file#value).
|
|
1633
1696
|
*
|
|
1634
1697
|
* @default ''
|
|
1635
1698
|
*/
|
|
@@ -1646,8 +1709,7 @@ export interface FileInputProps extends BaseInputProps {
|
|
|
1646
1709
|
}
|
|
1647
1710
|
export interface FieldErrorProps {
|
|
1648
1711
|
/**
|
|
1649
|
-
*
|
|
1650
|
-
* to communicate problems that have to be resolved immediately.
|
|
1712
|
+
* An error message to display to the user. When set, the field will be styled with error indicators to communicate problems that need to be resolved immediately.
|
|
1651
1713
|
*/
|
|
1652
1714
|
error?: string;
|
|
1653
1715
|
}
|
|
@@ -1655,26 +1717,19 @@ export interface BasicFieldProps
|
|
|
1655
1717
|
extends FieldErrorProps,
|
|
1656
1718
|
LabelAccessibilityVisibilityProps {
|
|
1657
1719
|
/**
|
|
1658
|
-
* Whether the field
|
|
1659
|
-
* to the field, but it will not cause an error to appear automatically.
|
|
1660
|
-
* If you want to present an error when this field is empty, you can do
|
|
1661
|
-
* so with the `error` property.
|
|
1720
|
+
* Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.
|
|
1662
1721
|
*
|
|
1663
1722
|
* @default false
|
|
1664
1723
|
*/
|
|
1665
1724
|
required?: boolean;
|
|
1666
1725
|
/**
|
|
1667
|
-
*
|
|
1726
|
+
* The text label displayed above or alongside the field to describe its purpose.
|
|
1668
1727
|
*/
|
|
1669
1728
|
label?: string;
|
|
1670
1729
|
}
|
|
1671
1730
|
export interface FieldDetailsProps {
|
|
1672
1731
|
/**
|
|
1673
|
-
* Additional text to provide context or
|
|
1674
|
-
* This text is displayed along with the field and its label
|
|
1675
|
-
* to offer more information or instructions to the user.
|
|
1676
|
-
*
|
|
1677
|
-
* This will also be exposed to screen reader users.
|
|
1732
|
+
* Additional helpful text displayed alongside the field to provide context, guidance, or instructions to the user. This content is accessible to both visual and screen reader users.
|
|
1678
1733
|
*/
|
|
1679
1734
|
details?: string;
|
|
1680
1735
|
}
|
|
@@ -1684,13 +1739,13 @@ export interface FieldProps
|
|
|
1684
1739
|
FocusEventProps,
|
|
1685
1740
|
FieldDetailsProps {
|
|
1686
1741
|
/**
|
|
1687
|
-
*
|
|
1742
|
+
* The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value. Unlike `defaultValue`, this is a temporary value that disappears after the user starts typing.
|
|
1688
1743
|
*/
|
|
1689
1744
|
placeholder?: string;
|
|
1690
1745
|
}
|
|
1691
1746
|
export interface BaseTextFieldProps extends FieldProps {
|
|
1692
1747
|
/**
|
|
1693
|
-
*
|
|
1748
|
+
* Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.
|
|
1694
1749
|
*
|
|
1695
1750
|
* @default false
|
|
1696
1751
|
*/
|
|
@@ -1698,27 +1753,17 @@ export interface BaseTextFieldProps extends FieldProps {
|
|
|
1698
1753
|
}
|
|
1699
1754
|
export interface FieldDecorationProps {
|
|
1700
1755
|
/**
|
|
1701
|
-
* A
|
|
1702
|
-
*
|
|
1703
|
-
* This is useful for displaying an implied part of the value, such as "@shopify.com", or "%".
|
|
1756
|
+
* A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.
|
|
1704
1757
|
*
|
|
1705
|
-
* This
|
|
1706
|
-
*
|
|
1707
|
-
* It may not be displayed until the user has interacted with the input.
|
|
1708
|
-
* For example, an inline label may take the place of the suffix until the user focuses the input.
|
|
1758
|
+
* This text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.
|
|
1709
1759
|
*
|
|
1710
1760
|
* @default ''
|
|
1711
1761
|
*/
|
|
1712
1762
|
suffix?: string;
|
|
1713
1763
|
/**
|
|
1714
|
-
* A
|
|
1715
|
-
*
|
|
1716
|
-
* This is useful for displaying an implied part of the value, such as "https://" or "+353".
|
|
1717
|
-
*
|
|
1718
|
-
* This cannot be edited by the user, and it isn't included in the value of the field.
|
|
1764
|
+
* A non-editable text value displayed immediately before the editable portion of the field. This is useful for displaying an implied part of the value, such as `https://` or `+353`.
|
|
1719
1765
|
*
|
|
1720
|
-
*
|
|
1721
|
-
* For example, an inline label may take the place of the prefix until the user focuses the input.
|
|
1766
|
+
* This text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.
|
|
1722
1767
|
*
|
|
1723
1768
|
* @default ''
|
|
1724
1769
|
*/
|
|
@@ -1730,28 +1775,25 @@ export interface FieldDecorationProps {
|
|
|
1730
1775
|
*/
|
|
1731
1776
|
icon?: IconType | AnyString;
|
|
1732
1777
|
/**
|
|
1733
|
-
* Additional content
|
|
1734
|
-
*
|
|
1778
|
+
* Additional interactive content displayed within the field.
|
|
1779
|
+
*
|
|
1780
|
+
* Accepts Button and Clickable components with text content only. Commonly used for actions like clearing the field or opening additional information.
|
|
1735
1781
|
*/
|
|
1736
1782
|
accessory?: ComponentChildren;
|
|
1737
1783
|
}
|
|
1738
1784
|
export interface NumberConstraintsProps {
|
|
1739
1785
|
/**
|
|
1740
|
-
* The highest decimal or integer
|
|
1741
|
-
* When used with `step` the value will round down to the max number.
|
|
1786
|
+
* The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.
|
|
1742
1787
|
*
|
|
1743
|
-
*
|
|
1744
|
-
* the max. It is up to the developer to add appropriate validation.
|
|
1788
|
+
* Users can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.
|
|
1745
1789
|
*
|
|
1746
1790
|
* @default Infinity
|
|
1747
1791
|
*/
|
|
1748
1792
|
max?: number;
|
|
1749
1793
|
/**
|
|
1750
|
-
* The lowest decimal or integer
|
|
1751
|
-
* When used with `step` the value will round up to the min number.
|
|
1794
|
+
* The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.
|
|
1752
1795
|
*
|
|
1753
|
-
*
|
|
1754
|
-
* the min. It is up to the developer to add appropriate validation.
|
|
1796
|
+
* Users can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.
|
|
1755
1797
|
*
|
|
1756
1798
|
* @default -Infinity
|
|
1757
1799
|
*/
|
|
@@ -1779,13 +1821,13 @@ export interface NumberConstraintsProps {
|
|
|
1779
1821
|
}
|
|
1780
1822
|
export interface MinMaxLengthProps {
|
|
1781
1823
|
/**
|
|
1782
|
-
*
|
|
1824
|
+
* The maximum number of characters allowed in the field.
|
|
1783
1825
|
*
|
|
1784
1826
|
* @default Infinity
|
|
1785
1827
|
*/
|
|
1786
1828
|
maxLength?: number;
|
|
1787
1829
|
/**
|
|
1788
|
-
*
|
|
1830
|
+
* The minimum number of characters required in the field.
|
|
1789
1831
|
*
|
|
1790
1832
|
* @default 0
|
|
1791
1833
|
*/
|
|
@@ -1793,30 +1835,29 @@ export interface MinMaxLengthProps {
|
|
|
1793
1835
|
}
|
|
1794
1836
|
export interface BaseSelectableProps {
|
|
1795
1837
|
/**
|
|
1796
|
-
* A label
|
|
1797
|
-
* This can also be used to display a control without a visual label, while still providing context to users using screen readers.
|
|
1838
|
+
* A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.
|
|
1798
1839
|
*/
|
|
1799
1840
|
accessibilityLabel?: string;
|
|
1800
1841
|
/**
|
|
1801
|
-
*
|
|
1842
|
+
* Whether the control is disabled, preventing any user interaction.
|
|
1802
1843
|
*
|
|
1803
1844
|
* @default false
|
|
1804
1845
|
*/
|
|
1805
1846
|
disabled?: boolean;
|
|
1806
1847
|
/**
|
|
1807
|
-
* The value
|
|
1848
|
+
* The value submitted with form data when the control is checked or selected.
|
|
1808
1849
|
*/
|
|
1809
1850
|
value?: string;
|
|
1810
1851
|
}
|
|
1811
1852
|
export interface BaseOptionProps extends BaseSelectableProps {
|
|
1812
1853
|
/**
|
|
1813
|
-
* Whether the
|
|
1854
|
+
* Whether the option is currently selected.
|
|
1814
1855
|
*
|
|
1815
1856
|
* @default false
|
|
1816
1857
|
*/
|
|
1817
1858
|
selected?: boolean;
|
|
1818
1859
|
/**
|
|
1819
|
-
* Whether the
|
|
1860
|
+
* Whether the option is selected by default when first rendered.
|
|
1820
1861
|
*
|
|
1821
1862
|
* @implementation `defaultSelected` reflects to the `selected` attribute.
|
|
1822
1863
|
*
|
|
@@ -1828,17 +1869,17 @@ export interface BaseCheckableProps
|
|
|
1828
1869
|
extends BaseSelectableProps,
|
|
1829
1870
|
InteractionProps {
|
|
1830
1871
|
/**
|
|
1831
|
-
*
|
|
1872
|
+
* The visual text label displayed alongside the control to describe its purpose.
|
|
1832
1873
|
*/
|
|
1833
1874
|
label?: string;
|
|
1834
1875
|
/**
|
|
1835
|
-
* Whether the control is
|
|
1876
|
+
* Whether the control is currently checked (for checkboxes) or toggled on (for switches).
|
|
1836
1877
|
*
|
|
1837
1878
|
* @default false
|
|
1838
1879
|
*/
|
|
1839
1880
|
checked?: boolean;
|
|
1840
1881
|
/**
|
|
1841
|
-
* Whether the control is
|
|
1882
|
+
* Whether the control is checked by default when first rendered.
|
|
1842
1883
|
*
|
|
1843
1884
|
* @implementation `defaultChecked` reflects to the `checked` attribute.
|
|
1844
1885
|
*
|
|
@@ -1846,20 +1887,15 @@ export interface BaseCheckableProps
|
|
|
1846
1887
|
*/
|
|
1847
1888
|
defaultChecked?: boolean;
|
|
1848
1889
|
/**
|
|
1849
|
-
*
|
|
1850
|
-
* containing `Form` component.
|
|
1890
|
+
* The name attribute for the control, which must be unique within the nearest containing Form component. This name is used to identify the control's value when the form is submitted.
|
|
1851
1891
|
*/
|
|
1852
1892
|
name?: string;
|
|
1853
1893
|
/**
|
|
1854
|
-
* A callback
|
|
1855
|
-
*
|
|
1856
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
|
|
1894
|
+
* A callback fired when the control's value changes. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).
|
|
1857
1895
|
*/
|
|
1858
1896
|
onChange?: (event: Event) => void;
|
|
1859
1897
|
/**
|
|
1860
|
-
* A callback
|
|
1861
|
-
*
|
|
1862
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
|
|
1898
|
+
* A callback fired when the control's value changes. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
|
|
1863
1899
|
*/
|
|
1864
1900
|
onInput?: (event: Event) => void;
|
|
1865
1901
|
}
|
|
@@ -1869,22 +1905,21 @@ interface CheckboxProps$1
|
|
|
1869
1905
|
FieldErrorProps,
|
|
1870
1906
|
FieldDetailsProps {
|
|
1871
1907
|
/**
|
|
1872
|
-
* Whether
|
|
1908
|
+
* Whether the checkbox displays in an indeterminate state (neither checked nor unchecked), typically used to indicate partial selection in hierarchical lists.
|
|
1873
1909
|
*
|
|
1874
|
-
*
|
|
1875
|
-
*
|
|
1876
|
-
* Whether the value is submitted along with a form is still down to the `checked` prop.
|
|
1910
|
+
* This visual state takes priority over the `checked` prop in appearance only.
|
|
1911
|
+
* The form submission value is still determined by the `checked` prop.
|
|
1877
1912
|
*
|
|
1878
|
-
* If `indeterminate` has not been explicitly set
|
|
1879
|
-
*
|
|
1913
|
+
* If `indeterminate` has not been explicitly set and hasn't been modified by user interaction,
|
|
1914
|
+
* it returns the value of `defaultIndeterminate`.
|
|
1880
1915
|
*
|
|
1881
1916
|
* @implementation The `indeterminate` property doesn't reflect to any attribute.
|
|
1882
1917
|
*/
|
|
1883
1918
|
indeterminate?: boolean;
|
|
1884
1919
|
/**
|
|
1885
|
-
* Whether the checkbox is in an
|
|
1920
|
+
* Whether the checkbox is in an indeterminate state by default when first rendered.
|
|
1886
1921
|
*
|
|
1887
|
-
* Similar to `defaultValue` and `defaultChecked`, this value applies until `indeterminate` is set
|
|
1922
|
+
* Similar to `defaultValue` and `defaultChecked`, this value applies until `indeterminate` is explicitly set or the user changes the checkbox state.
|
|
1888
1923
|
*
|
|
1889
1924
|
* @implementation `defaultIndeterminate` reflects to the `indeterminate` attribute.
|
|
1890
1925
|
*
|
|
@@ -1892,10 +1927,7 @@ interface CheckboxProps$1
|
|
|
1892
1927
|
*/
|
|
1893
1928
|
defaultIndeterminate?: boolean;
|
|
1894
1929
|
/**
|
|
1895
|
-
* Whether the
|
|
1896
|
-
* to the field, but it will not cause an error to appear automatically.
|
|
1897
|
-
* If you want to present an error when this field is empty, you can do
|
|
1898
|
-
* so with the `error` property.
|
|
1930
|
+
* Whether the checkbox must be checked before form submission. This adds semantic meaning and typically displays a visual indicator, but does not automatically validate or show errors. Use the `error` property to display validation messages.
|
|
1899
1931
|
*
|
|
1900
1932
|
* @default false
|
|
1901
1933
|
*/
|
|
@@ -1903,62 +1935,30 @@ interface CheckboxProps$1
|
|
|
1903
1935
|
}
|
|
1904
1936
|
export interface ChipProps$1 extends GlobalProps {
|
|
1905
1937
|
/**
|
|
1906
|
-
* The content
|
|
1938
|
+
* The text content displayed within the chip.
|
|
1907
1939
|
*/
|
|
1908
1940
|
children?: ComponentChildren;
|
|
1909
1941
|
/**
|
|
1910
|
-
* The graphic
|
|
1942
|
+
* The graphic element (typically an icon) displayed inside the chip.
|
|
1911
1943
|
*
|
|
1912
1944
|
* @implementation Only `s-icon` is supported.
|
|
1913
1945
|
*/
|
|
1914
1946
|
graphic?: ComponentChildren;
|
|
1915
1947
|
/**
|
|
1916
|
-
* A label that describes the purpose or
|
|
1948
|
+
* A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.
|
|
1917
1949
|
*/
|
|
1918
1950
|
accessibilityLabel?: string;
|
|
1919
1951
|
/**
|
|
1920
|
-
*
|
|
1952
|
+
* The color intensity of the chip. Use `subdued` for less intense, `base` for standard, or `strong` for more intense coloring.
|
|
1921
1953
|
*
|
|
1922
1954
|
* @default 'base'
|
|
1923
1955
|
*/
|
|
1924
1956
|
color?: ColorKeyword;
|
|
1925
|
-
/**
|
|
1926
|
-
* Whether the chip is removable.
|
|
1927
|
-
*
|
|
1928
|
-
* @default false
|
|
1929
|
-
*/
|
|
1930
|
-
removable?: boolean;
|
|
1931
|
-
/**
|
|
1932
|
-
* Callback when the chip is removed.
|
|
1933
|
-
*/
|
|
1934
|
-
onRemove?: (event: Event) => void;
|
|
1935
|
-
/**
|
|
1936
|
-
* Determines whether the chip is hidden.
|
|
1937
|
-
*
|
|
1938
|
-
* If this property is being set on each framework render (as in 'controlled' usage),
|
|
1939
|
-
* and the chip is `removable`,
|
|
1940
|
-
* ensure you update app state for this property when the `remove` event fires.
|
|
1941
|
-
*
|
|
1942
|
-
* If the chip is not `removable`, it can still be hidden by setting this property.
|
|
1943
|
-
*
|
|
1944
|
-
* @default false
|
|
1945
|
-
*/
|
|
1946
|
-
hidden?: boolean;
|
|
1947
|
-
/**
|
|
1948
|
-
* Event handler when the chip has fully hidden.
|
|
1949
|
-
*
|
|
1950
|
-
* The `hidden` property will be `true` when this event fires.
|
|
1951
|
-
*
|
|
1952
|
-
* @implementation If implementations animate the hiding of the chip,
|
|
1953
|
-
* this event must fire after the chip has fully hidden.
|
|
1954
|
-
* We can add an `onHide` event in future if we want to provide a hook for the start of the animation.
|
|
1955
|
-
*/
|
|
1956
|
-
onAfterHide?: (event: Event) => void;
|
|
1957
1957
|
}
|
|
1958
1958
|
interface ChipProps$2 extends ChipProps$1, GlobalProps {}
|
|
1959
1959
|
interface ChoiceProps$1 extends GlobalProps, BaseOptionProps {
|
|
1960
1960
|
/**
|
|
1961
|
-
*
|
|
1961
|
+
* The content displayed as the choice label.
|
|
1962
1962
|
*
|
|
1963
1963
|
* @implementation (StringChildren) The label is produced by extracting and
|
|
1964
1964
|
* concatenating the text nodes from the provided content; any markup or
|
|
@@ -1970,28 +1970,23 @@ interface ChoiceProps$1 extends GlobalProps, BaseOptionProps {
|
|
|
1970
1970
|
*/
|
|
1971
1971
|
children?: ComponentChildren | StringChildren;
|
|
1972
1972
|
/**
|
|
1973
|
-
* Additional text to provide context or
|
|
1974
|
-
*
|
|
1975
|
-
* This text is displayed along with the input and its label
|
|
1976
|
-
* to offer more information or instructions to the user.
|
|
1973
|
+
* Additional helpful text displayed alongside the choice to provide context, guidance, or instructions to the user.
|
|
1977
1974
|
*
|
|
1978
1975
|
* @implementation this content should be linked to the input with an `aria-describedby` attribute.
|
|
1979
1976
|
*/
|
|
1980
1977
|
details?: ComponentChildren;
|
|
1981
1978
|
/**
|
|
1982
|
-
*
|
|
1979
|
+
* Whether this choice should be associated with an error state from the parent ChoiceList.
|
|
1983
1980
|
*
|
|
1984
1981
|
* @default false
|
|
1985
1982
|
*/
|
|
1986
1983
|
error?: boolean;
|
|
1987
1984
|
/**
|
|
1988
|
-
* Secondary content
|
|
1985
|
+
* Secondary descriptive content displayed beneath the choice label.
|
|
1989
1986
|
*/
|
|
1990
1987
|
secondaryContent?: ComponentChildren;
|
|
1991
1988
|
/**
|
|
1992
|
-
* Content
|
|
1993
|
-
*
|
|
1994
|
-
* This can be used to provide additional information or options related to the choice.
|
|
1989
|
+
* Content displayed when the choice is selected, useful for showing additional information or nested options related to this choice.
|
|
1995
1990
|
*/
|
|
1996
1991
|
selectedContent?: ComponentChildren;
|
|
1997
1992
|
}
|
|
@@ -2001,36 +1996,33 @@ interface ChoiceListProps$1
|
|
|
2001
1996
|
MultipleInputProps,
|
|
2002
1997
|
FieldDetailsProps {
|
|
2003
1998
|
/**
|
|
2004
|
-
* Whether multiple choices
|
|
1999
|
+
* Whether users can select multiple choices simultaneously (checkboxes) or only one choice at a time (radio buttons).
|
|
2005
2000
|
*
|
|
2006
2001
|
* @default false
|
|
2007
2002
|
*/
|
|
2008
2003
|
multiple?: boolean;
|
|
2009
2004
|
/**
|
|
2010
|
-
* The
|
|
2011
|
-
*
|
|
2012
|
-
* Accepts `Choice` components.
|
|
2005
|
+
* The collection of Choice components that users can select from.
|
|
2013
2006
|
*/
|
|
2014
2007
|
children?: ComponentChildren;
|
|
2015
2008
|
/**
|
|
2016
|
-
*
|
|
2009
|
+
* Whether the entire choice list is disabled, preventing any user interaction.
|
|
2017
2010
|
*
|
|
2018
|
-
* `disabled` on
|
|
2011
|
+
* When `true`, the `disabled` property on individual child Choice components is ignored.
|
|
2019
2012
|
*
|
|
2020
2013
|
* @default false
|
|
2021
2014
|
*/
|
|
2022
2015
|
disabled?: MultipleInputProps['disabled'];
|
|
2023
2016
|
/**
|
|
2024
|
-
* The variant
|
|
2017
|
+
* The layout variant for displaying the choices.
|
|
2025
2018
|
*
|
|
2026
|
-
* - `auto`: The variant is determined by the context.
|
|
2027
|
-
* - `list`: The choices are displayed in a list.
|
|
2028
|
-
* - `inline`: The choices are
|
|
2029
|
-
* - `block`: The choices are
|
|
2030
|
-
* - `grid`: The choices are displayed in a grid.
|
|
2019
|
+
* - `auto`: The variant is automatically determined by the context.
|
|
2020
|
+
* - `list`: The choices are displayed in a vertical list.
|
|
2021
|
+
* - `inline`: The choices are arranged horizontally along the inline axis.
|
|
2022
|
+
* - `block`: The choices are arranged vertically along the block axis.
|
|
2023
|
+
* - `grid`: The choices are displayed in a grid layout.
|
|
2031
2024
|
*
|
|
2032
|
-
* @implementation The `block`, `inline` and `grid` variants are more suitable for button
|
|
2033
|
-
* discretion of each surface.
|
|
2025
|
+
* @implementation The `block`, `inline` and `grid` variants are more suitable for button-styled choices, but it's at the discretion of each surface.
|
|
2034
2026
|
*
|
|
2035
2027
|
* @default 'auto'
|
|
2036
2028
|
*/
|
|
@@ -2041,27 +2033,15 @@ interface ClickableProps$1
|
|
|
2041
2033
|
BaseBoxProps,
|
|
2042
2034
|
BaseClickableProps {
|
|
2043
2035
|
/**
|
|
2044
|
-
*
|
|
2045
|
-
*
|
|
2046
|
-
* This also disables the clickable.
|
|
2036
|
+
* Whether the component is in a loading state, which indicates to assistive technology that an action is in progress and prevents interaction.
|
|
2047
2037
|
*/
|
|
2048
2038
|
loading?: BaseClickableProps['loading'];
|
|
2049
2039
|
/**
|
|
2050
|
-
*
|
|
2051
|
-
*
|
|
2052
|
-
* In this state, onClick will not fire.
|
|
2053
|
-
* If the click event originates from a child element, the event will immediately stop propagating from this element.
|
|
2054
|
-
*
|
|
2055
|
-
* However, items within the clickable can still receive focus and be interacted with.
|
|
2056
|
-
*
|
|
2057
|
-
* This has no impact on the visual state by default,
|
|
2058
|
-
* but developers are encouraged to style the clickable accordingly.
|
|
2040
|
+
* Whether the component is disabled, preventing clicks and focus. When disabled, the `click` event won't fire and click events from child elements stop propagating immediately. Interactive child elements can still receive focus and be interacted with. This doesn't apply visual styling by default. You should apply disabled styling as needed.
|
|
2059
2041
|
*/
|
|
2060
2042
|
disabled?: BaseClickableProps['disabled'];
|
|
2061
2043
|
/**
|
|
2062
|
-
*
|
|
2063
|
-
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
2064
|
-
* [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
|
|
2044
|
+
* The language of the text content within the component. Useful when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label).
|
|
2065
2045
|
*
|
|
2066
2046
|
* @default ''
|
|
2067
2047
|
*/
|
|
@@ -2072,16 +2052,39 @@ interface ClickableChipProps$1
|
|
|
2072
2052
|
GlobalProps,
|
|
2073
2053
|
InteractionProps {
|
|
2074
2054
|
/**
|
|
2075
|
-
*
|
|
2055
|
+
* A callback fired when the chip is clicked.
|
|
2076
2056
|
*/
|
|
2077
2057
|
onClick?: (event: Event) => void;
|
|
2078
2058
|
/**
|
|
2079
|
-
* The URL to
|
|
2080
|
-
*
|
|
2081
|
-
* - If set, it will navigate to the location specified by `href` after executing the `click` event.
|
|
2082
|
-
* - If a `commandFor` is set, the `command` will be executed instead of the navigation.
|
|
2059
|
+
* The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.
|
|
2083
2060
|
*/
|
|
2084
2061
|
href?: string;
|
|
2062
|
+
/**
|
|
2063
|
+
* Whether the chip displays a remove button for dismissal. When clicked, the `remove` callback fires.
|
|
2064
|
+
*
|
|
2065
|
+
* @default false
|
|
2066
|
+
*/
|
|
2067
|
+
removable?: boolean;
|
|
2068
|
+
/**
|
|
2069
|
+
* A callback fired when the chip's remove button is clicked.
|
|
2070
|
+
*/
|
|
2071
|
+
onRemove?: (event: Event) => void;
|
|
2072
|
+
/**
|
|
2073
|
+
* Whether the chip is hidden from view. When using controlled component pattern with `removable` chips, update this property when the `remove` event fires. For non-removable chips, manually toggle this property to show or hide the chip.
|
|
2074
|
+
*
|
|
2075
|
+
* @default false
|
|
2076
|
+
*/
|
|
2077
|
+
hidden?: boolean;
|
|
2078
|
+
/**
|
|
2079
|
+
* Event handler when the chip has fully hidden.
|
|
2080
|
+
*
|
|
2081
|
+
* The `hidden` property will be `true` when this event fires.
|
|
2082
|
+
*
|
|
2083
|
+
* @implementation If implementations animate the hiding of the chip,
|
|
2084
|
+
* this event must fire after the chip has fully hidden.
|
|
2085
|
+
* We can add an `onHide` event in future if we want to provide a hook for the start of the animation.
|
|
2086
|
+
*/
|
|
2087
|
+
onAfterHide?: (event: Event) => void;
|
|
2085
2088
|
/**
|
|
2086
2089
|
* Disables the chip, disallowing any interaction.
|
|
2087
2090
|
*
|
|
@@ -2089,63 +2092,54 @@ interface ClickableChipProps$1
|
|
|
2089
2092
|
*/
|
|
2090
2093
|
disabled?: boolean;
|
|
2091
2094
|
}
|
|
2092
|
-
interface ColorPickerProps$1
|
|
2095
|
+
interface ColorPickerProps$1
|
|
2096
|
+
extends GlobalProps,
|
|
2097
|
+
Omit<InputProps, 'value' | 'defaultValue'> {
|
|
2093
2098
|
/**
|
|
2094
|
-
*
|
|
2099
|
+
* Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors.
|
|
2095
2100
|
*
|
|
2096
2101
|
* @default false
|
|
2097
2102
|
*/
|
|
2098
2103
|
alpha?: boolean;
|
|
2099
2104
|
/**
|
|
2100
|
-
*
|
|
2101
|
-
*
|
|
2102
|
-
* If the `alpha` prop is `true`, `onChange` will emit an 8-value hex (#RRGGBBAA).
|
|
2103
|
-
* If the `alpha` prop is `false`, `onChange` will emit a 6-value hex (#RRGGBB).
|
|
2105
|
+
* A callback that fires when the user finishes selecting a color. The value is always emitted in hexadecimal format: 8-value hex (`#RRGGBBAA`) when `alpha` is `true`, or 6-value hex (`#RRGGBB`) when `alpha` is `false`.
|
|
2104
2106
|
*/
|
|
2105
2107
|
onChange?: InputProps['onChange'];
|
|
2106
2108
|
/**
|
|
2107
|
-
*
|
|
2108
|
-
*
|
|
2109
|
-
* If the `alpha` prop is `true`, `onInput` will emit an 8-value hex (#RRGGBBAA).
|
|
2110
|
-
* If the `alpha` prop is `false`, `onInput` will emit a 6-value hex (#RRGGBB).
|
|
2109
|
+
* A callback that fires when the user makes any change to the color selection. The value is always emitted in hexadecimal format: 8-value hex (`#RRGGBBAA`) when `alpha` is `true`, or 6-value hex (`#RRGGBB`) when `alpha` is `false`.
|
|
2111
2110
|
*/
|
|
2112
2111
|
onInput?: InputProps['onChange'];
|
|
2113
2112
|
/**
|
|
2114
|
-
* The currently selected color.
|
|
2115
|
-
*
|
|
2116
|
-
* Supported formats include:
|
|
2117
|
-
* - HSL @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl
|
|
2118
|
-
* - HSLA @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsla
|
|
2119
|
-
* - RGB @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb
|
|
2120
|
-
* - RGBA @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb
|
|
2121
|
-
* - Hex (3-value, 4-value, 6-value, 8-value) @see https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color
|
|
2122
|
-
*
|
|
2123
|
-
* For RGB and RGBA, both the legacy syntax (comma-separated) and modern syntax (space-separate) are supported.
|
|
2124
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb
|
|
2113
|
+
* The currently selected color value. Accepts multiple input formats:
|
|
2125
2114
|
*
|
|
2126
|
-
*
|
|
2115
|
+
* - Hex: `#RGB`, `#RGBA`, `#RRGGBB`, `#RRGGBBAA` (three, four, six, or eight digits)
|
|
2116
|
+
* - RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated)
|
|
2117
|
+
* - HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)`
|
|
2127
2118
|
*
|
|
2128
|
-
*
|
|
2119
|
+
* Returns an empty string if the value is invalid. The `onChange` handler always emits values in hex format.
|
|
2129
2120
|
*/
|
|
2130
|
-
value?:
|
|
2121
|
+
value?: string;
|
|
2122
|
+
/**
|
|
2123
|
+
* The initial color value when the field first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts interacting, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.
|
|
2124
|
+
*/
|
|
2125
|
+
defaultValue?: string;
|
|
2131
2126
|
}
|
|
2132
2127
|
export interface AutocompleteProps<
|
|
2133
2128
|
AutocompleteField extends AnyAutocompleteField,
|
|
2134
2129
|
> {
|
|
2135
2130
|
/**
|
|
2136
|
-
*
|
|
2137
|
-
*
|
|
2138
|
-
* When set to `on` (the default), this property indicates that the field should support
|
|
2139
|
-
* autofill, but you do not have any more semantic information on the intended
|
|
2140
|
-
* contents.
|
|
2131
|
+
* Controls browser autofill behavior for the field.
|
|
2141
2132
|
*
|
|
2142
|
-
*
|
|
2143
|
-
*
|
|
2133
|
+
* Basic values:
|
|
2134
|
+
* - `on` - Enables autofill without specifying content type (default)
|
|
2135
|
+
* - `off` - Disables autofill for sensitive data or one-time codes
|
|
2144
2136
|
*
|
|
2145
|
-
*
|
|
2146
|
-
*
|
|
2137
|
+
* Specific field values describe the expected data type. You can optionally prefix these with:
|
|
2138
|
+
* - `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)
|
|
2139
|
+
* - `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes
|
|
2140
|
+
* - Both section and group (for example, `section-primary shipping email`)
|
|
2147
2141
|
*
|
|
2148
|
-
*
|
|
2142
|
+
* Providing a specific autofill token helps browsers suggest more relevant saved data. Learn more about [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens).
|
|
2149
2143
|
*
|
|
2150
2144
|
* @default 'tel' for PhoneField
|
|
2151
2145
|
* @default 'email' for EmailField
|
|
@@ -2241,6 +2235,42 @@ export type AnyAutocompleteField =
|
|
|
2241
2235
|
| `${AutocompleteAddressGroup} tel-local-suffix`
|
|
2242
2236
|
| `${AutocompleteAddressGroup} tel-local`
|
|
2243
2237
|
| `${AutocompleteAddressGroup} tel-national`;
|
|
2238
|
+
/**
|
|
2239
|
+
* Represents autocomplete values that are valid for text input fields.
|
|
2240
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for text-based inputs.
|
|
2241
|
+
*
|
|
2242
|
+
* Available values:
|
|
2243
|
+
* - `name` - Full name
|
|
2244
|
+
* - `given-name` - First name
|
|
2245
|
+
* - `additional-name` - Middle name
|
|
2246
|
+
* - `family-name` - Last name
|
|
2247
|
+
* - `nickname` - Nickname or handle
|
|
2248
|
+
* - `username` - Username for login
|
|
2249
|
+
* - `honorific-prefix` - Name prefix (Mr., Mrs., Dr.)
|
|
2250
|
+
* - `honorific-suffix` - Name suffix (Jr., Sr., III)
|
|
2251
|
+
* - `organization` - Company or organization name
|
|
2252
|
+
* - `organization-title` - Job title or position
|
|
2253
|
+
* - `address-line1` - Street address (first line)
|
|
2254
|
+
* - `address-line2` - Street address (second line)
|
|
2255
|
+
* - `address-line3` - Street address (third line)
|
|
2256
|
+
* - `address-level1` - State or province
|
|
2257
|
+
* - `address-level2` - City or town
|
|
2258
|
+
* - `address-level3` - District or locality
|
|
2259
|
+
* - `address-level4` - Neighborhood or suburb
|
|
2260
|
+
* - `street-address` - Complete street address (multi-line)
|
|
2261
|
+
* - `postal-code` - Postal or ZIP code
|
|
2262
|
+
* - `country` - Country code (US, CA, GB)
|
|
2263
|
+
* - `country-name` - Country name (United States, Canada)
|
|
2264
|
+
* - `language` - Preferred language
|
|
2265
|
+
* - `sex` - Gender or sex
|
|
2266
|
+
* - `one-time-code` - One-time codes for authentication
|
|
2267
|
+
* - `transaction-currency` - Currency code (USD, EUR, GBP)
|
|
2268
|
+
* - `cc-name` - Name on credit card
|
|
2269
|
+
* - `cc-given-name` - First name on credit card
|
|
2270
|
+
* - `cc-additional-name` - Middle name on credit card
|
|
2271
|
+
* - `cc-family-name` - Last name on credit card
|
|
2272
|
+
* - `cc-type` - Credit card type (Visa, Mastercard)
|
|
2273
|
+
*/
|
|
2244
2274
|
export type TextAutocompleteField = ExtractStrict<
|
|
2245
2275
|
AnyAutocompleteField,
|
|
2246
2276
|
| 'additional-name'
|
|
@@ -2276,8 +2306,27 @@ export type TextAutocompleteField = ExtractStrict<
|
|
|
2276
2306
|
>;
|
|
2277
2307
|
interface ColorFieldProps$1
|
|
2278
2308
|
extends GlobalProps,
|
|
2279
|
-
BaseTextFieldProps,
|
|
2280
|
-
|
|
2309
|
+
Omit<BaseTextFieldProps, 'value' | 'defaultValue'> {
|
|
2310
|
+
/**
|
|
2311
|
+
* Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors.
|
|
2312
|
+
*
|
|
2313
|
+
* @default false
|
|
2314
|
+
*/
|
|
2315
|
+
alpha?: boolean;
|
|
2316
|
+
/**
|
|
2317
|
+
* The currently selected color value. Accepts multiple input formats:
|
|
2318
|
+
*
|
|
2319
|
+
* - Hex: `#RGB`, `#RGBA`, `#RRGGBB`, `#RRGGBBAA` (three, four, six, or eight digits)
|
|
2320
|
+
* - RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated)
|
|
2321
|
+
* - HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)`
|
|
2322
|
+
*
|
|
2323
|
+
* Returns an empty string if the value is invalid. The `onChange` handler always emits values in hex format.
|
|
2324
|
+
*/
|
|
2325
|
+
value?: string;
|
|
2326
|
+
/**
|
|
2327
|
+
* The initial color value when the field first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts interacting, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.
|
|
2328
|
+
*/
|
|
2329
|
+
defaultValue?: string;
|
|
2281
2330
|
autocomplete?: Extract<
|
|
2282
2331
|
AutocompleteProps<never>['autocomplete'],
|
|
2283
2332
|
'on' | 'off'
|
|
@@ -2285,23 +2334,15 @@ interface ColorFieldProps$1
|
|
|
2285
2334
|
}
|
|
2286
2335
|
interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
|
|
2287
2336
|
/**
|
|
2288
|
-
*
|
|
2289
|
-
*
|
|
2290
|
-
* This value is used until `view` is set, either directly or as a result of user interaction.
|
|
2291
|
-
*
|
|
2292
|
-
* Defaults to the current month in the user's locale.
|
|
2337
|
+
* The default month to display in `YYYY-MM` format. Used until the `view` callback is set by user interaction or programmatically. Defaults to the current month in the user's locale.
|
|
2293
2338
|
*/
|
|
2294
2339
|
defaultView?: string;
|
|
2295
2340
|
/**
|
|
2296
|
-
*
|
|
2297
|
-
*
|
|
2298
|
-
* `onViewChange` is called when this value changes.
|
|
2299
|
-
*
|
|
2300
|
-
* Defaults to `defaultView`.
|
|
2341
|
+
* The currently displayed month in `YYYY-MM` format. When changed, the `viewchange` callback is triggered. Defaults to `defaultView`.
|
|
2301
2342
|
*/
|
|
2302
2343
|
view?: string;
|
|
2303
2344
|
/**
|
|
2304
|
-
*
|
|
2345
|
+
* A callback fired whenever the displayed month changes in the calendar.
|
|
2305
2346
|
*
|
|
2306
2347
|
* @param view The new month to display in `YYYY-MM` format.
|
|
2307
2348
|
*/
|
|
@@ -2317,144 +2358,91 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
|
|
|
2317
2358
|
*/
|
|
2318
2359
|
type?: 'single' | 'multiple' | 'range';
|
|
2319
2360
|
/**
|
|
2320
|
-
*
|
|
2321
|
-
*
|
|
2322
|
-
* A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
|
|
2361
|
+
* Specifies which dates can be selected as a comma-separated list. An empty string (default) allows all dates.
|
|
2323
2362
|
*
|
|
2324
|
-
*
|
|
2363
|
+
* **Formats:**
|
|
2364
|
+
* - `YYYY-MM-DD`: Single date
|
|
2365
|
+
* - `YYYY-MM`: Whole month
|
|
2366
|
+
* - `YYYY`: Whole year
|
|
2367
|
+
* - `start--end`: Date range (inclusive, unbounded if start/end omitted)
|
|
2325
2368
|
*
|
|
2326
|
-
*
|
|
2327
|
-
* -
|
|
2328
|
-
* -
|
|
2329
|
-
* - Ranges are expressed as `start--end`.
|
|
2330
|
-
* - Ranges are inclusive.
|
|
2331
|
-
* - If either `start` or `end` is omitted, the range is unbounded in that direction.
|
|
2332
|
-
* - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.
|
|
2333
|
-
* So `2024--` is equivalent to `2024-01-01--`.
|
|
2334
|
-
* - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.
|
|
2335
|
-
* So `--2024` is equivalent to `--2024-12-31`.
|
|
2336
|
-
* - Whitespace is allowed either side of `--`.
|
|
2369
|
+
* **Examples:**
|
|
2370
|
+
* - `2024-02--2025`: February 2024 through end of 2025
|
|
2371
|
+
* - `2024-05-09, 2024-05-11`: Only May 9th and 11th, 2024
|
|
2337
2372
|
*
|
|
2338
2373
|
* @default ""
|
|
2339
|
-
*
|
|
2340
|
-
* @example
|
|
2341
|
-
* `2024-02--2025` // allow any date from February 2024 to the end of 2025
|
|
2342
|
-
* `2024-02--` // allow any date from February 2024 to the end of the month
|
|
2343
|
-
* `2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024
|
|
2344
2374
|
*/
|
|
2345
2375
|
allow?: string;
|
|
2346
2376
|
/**
|
|
2347
|
-
*
|
|
2348
|
-
*
|
|
2349
|
-
* A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
|
|
2377
|
+
* Specifies which dates can't be selected as a comma-separated list. These dates are excluded from those specified in `allow`. An empty string (default) has no effect.
|
|
2350
2378
|
*
|
|
2351
|
-
*
|
|
2379
|
+
* **Formats:**
|
|
2380
|
+
* - `YYYY-MM-DD`: Single date
|
|
2381
|
+
* - `YYYY-MM`: Whole month
|
|
2382
|
+
* - `YYYY`: Whole year
|
|
2383
|
+
* - `start--end`: Date range (inclusive, unbounded if start/end omitted)
|
|
2352
2384
|
*
|
|
2353
|
-
*
|
|
2354
|
-
* -
|
|
2355
|
-
* -
|
|
2356
|
-
* - Ranges are expressed as `start--end`.
|
|
2357
|
-
* - Ranges are inclusive.
|
|
2358
|
-
* - If either `start` or `end` is omitted, the range is unbounded in that direction.
|
|
2359
|
-
* - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.
|
|
2360
|
-
* So `2024--` is equivalent to `2024-01-01--`.
|
|
2361
|
-
* - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.
|
|
2362
|
-
* So `--2024` is equivalent to `--2024-12-31`.
|
|
2363
|
-
* - Whitespace is allowed either side of `--`.
|
|
2385
|
+
* **Examples:**
|
|
2386
|
+
* - `--2024-02`: All dates before February 2024
|
|
2387
|
+
* - `2024-05-09, 2024-05-11`: May 9th and 11th, 2024
|
|
2364
2388
|
*
|
|
2365
2389
|
* @default ""
|
|
2366
|
-
*
|
|
2367
|
-
* @example
|
|
2368
|
-
* `--2024-02` // disallow any date before February 2024
|
|
2369
|
-
* `2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024
|
|
2370
2390
|
*/
|
|
2371
2391
|
disallow?: string;
|
|
2372
2392
|
/**
|
|
2373
|
-
*
|
|
2374
|
-
*
|
|
2375
|
-
* A comma-separated list of days. Whitespace is allowed after commas.
|
|
2393
|
+
* Specifies which days of the week can be selected as a comma-separated list. Further restricts dates from `allow` and `disallow`. An empty string (default) has no effect.
|
|
2376
2394
|
*
|
|
2377
|
-
*
|
|
2395
|
+
* **Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`
|
|
2378
2396
|
*
|
|
2379
|
-
*
|
|
2397
|
+
* **Example:** `saturday, sunday` (only weekends)
|
|
2380
2398
|
*
|
|
2381
2399
|
* @default ""
|
|
2382
|
-
*
|
|
2383
|
-
* @example
|
|
2384
|
-
* 'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.
|
|
2385
2400
|
*/
|
|
2386
2401
|
allowDays?: string;
|
|
2387
2402
|
/**
|
|
2388
|
-
*
|
|
2389
|
-
*
|
|
2390
|
-
* A comma-separated list of days. Whitespace is allowed after commas.
|
|
2403
|
+
* Specifies which days of the week can't be selected as a comma-separated list. Excludes days from `allowDays` and intersects with `allow` and `disallow`. An empty string (default) has no effect.
|
|
2391
2404
|
*
|
|
2392
|
-
*
|
|
2405
|
+
* **Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`
|
|
2393
2406
|
*
|
|
2394
|
-
*
|
|
2407
|
+
* **Example:** `saturday, sunday` (no weekends)
|
|
2395
2408
|
*
|
|
2396
2409
|
* @default ""
|
|
2397
|
-
*
|
|
2398
|
-
* @example
|
|
2399
|
-
* 'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.
|
|
2400
2410
|
*/
|
|
2401
2411
|
disallowDays?: string;
|
|
2402
2412
|
/**
|
|
2403
|
-
*
|
|
2413
|
+
* The initially selected date(s) when the component first renders. An empty string means no date is initially selected.
|
|
2404
2414
|
*
|
|
2405
|
-
*
|
|
2406
|
-
*
|
|
2407
|
-
* If the provided value is invalid, no date is selected.
|
|
2408
|
-
*
|
|
2409
|
-
* - If `type="single"`, this is a date in `YYYY-MM-DD` format.
|
|
2410
|
-
* - If `type="multiple"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.
|
|
2411
|
-
* - If `type="range"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.
|
|
2415
|
+
* - Single date in `YYYY-MM-DD` format when `type` is set to `"single"`
|
|
2416
|
+
* - Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `"range"`
|
|
2412
2417
|
*
|
|
2413
2418
|
* @default ""
|
|
2414
2419
|
*/
|
|
2415
2420
|
defaultValue?: string;
|
|
2416
2421
|
/**
|
|
2417
|
-
*
|
|
2418
|
-
*
|
|
2419
|
-
* The default means no date is selected.
|
|
2420
|
-
*
|
|
2421
|
-
* If the provided value is invalid, no date is selected.
|
|
2422
|
-
*
|
|
2423
|
-
* Otherwise:
|
|
2422
|
+
* The currently selected date(s). An empty string means no date is selected.
|
|
2424
2423
|
*
|
|
2425
|
-
* -
|
|
2426
|
-
* -
|
|
2427
|
-
* - If `type="range"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.
|
|
2424
|
+
* - Single date in `YYYY-MM-DD` format when `type` is set to `"single"`
|
|
2425
|
+
* - Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `"range"`
|
|
2428
2426
|
*
|
|
2429
2427
|
* @default ""
|
|
2430
2428
|
*/
|
|
2431
2429
|
value?: string;
|
|
2432
2430
|
/**
|
|
2433
|
-
*
|
|
2434
|
-
*
|
|
2435
|
-
* - If `type="single"`, fires when a date is selected and happens before `onChange`.
|
|
2436
|
-
* - If `type="multiple"`, fires when a date is selected before `onChange`.
|
|
2437
|
-
* - 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`.
|
|
2431
|
+
* A callback fired when any date is selected, before `onChange`. When `type` is set to `"range"`, also fires when the first date is selected with a partial value formatted as `YYYY-MM-DD--`.
|
|
2438
2432
|
*/
|
|
2439
2433
|
onInput?: (event: Event) => void;
|
|
2440
2434
|
/**
|
|
2441
|
-
*
|
|
2442
|
-
*
|
|
2443
|
-
* - If `type="single"`, fires when a date is selected after `onInput`.
|
|
2444
|
-
* - If `type="multiple"`, fires when a date is selected after `onInput`.
|
|
2445
|
-
* - If `type="range"`, fires when a range is completed by selecting the end date after `onInput`.
|
|
2435
|
+
* A callback fired when the date selection is committed and complete, after `onInput`. When `type` is set to `"range"`, fires only when the range is completed by selecting the end date.
|
|
2446
2436
|
*/
|
|
2447
2437
|
onChange?: (event: Event) => void;
|
|
2448
2438
|
}
|
|
2449
2439
|
interface DateFieldProps$1
|
|
2450
2440
|
extends GlobalProps,
|
|
2451
|
-
BaseTextFieldProps,
|
|
2441
|
+
Omit<BaseTextFieldProps, 'value' | 'defaultValue'>,
|
|
2452
2442
|
Pick<
|
|
2453
2443
|
DatePickerProps$1,
|
|
2454
2444
|
| 'view'
|
|
2455
2445
|
| 'defaultView'
|
|
2456
|
-
| 'value'
|
|
2457
|
-
| 'defaultValue'
|
|
2458
2446
|
| 'allow'
|
|
2459
2447
|
| 'disallow'
|
|
2460
2448
|
| 'allowDays'
|
|
@@ -2463,18 +2451,27 @@ interface DateFieldProps$1
|
|
|
2463
2451
|
>,
|
|
2464
2452
|
AutocompleteProps<DateAutocompleteField> {
|
|
2465
2453
|
/**
|
|
2466
|
-
*
|
|
2467
|
-
*
|
|
2454
|
+
* The initial date value when the field first renders, in `YYYY-MM-DD` format. An empty string means no date is initially selected.
|
|
2455
|
+
*
|
|
2456
|
+
* @default ""
|
|
2457
|
+
*/
|
|
2458
|
+
defaultValue?: string;
|
|
2459
|
+
/**
|
|
2460
|
+
* The currently selected date in `YYYY-MM-DD` format. An empty string means no date is selected.
|
|
2461
|
+
*
|
|
2462
|
+
* @default ""
|
|
2463
|
+
*/
|
|
2464
|
+
value?: string;
|
|
2465
|
+
/**
|
|
2466
|
+
* A callback fired when the user makes any changes in the field, including when selecting a date using the date picker popup. This fires before `onChange`.
|
|
2468
2467
|
*/
|
|
2469
2468
|
onInput?: (event: Event) => void;
|
|
2470
2469
|
/**
|
|
2471
|
-
*
|
|
2472
|
-
* Also triggered when a date is selected using the date picker popup after `onInput`.
|
|
2470
|
+
* A callback fired when the user has finished editing the field, such as when they blur the field or complete a date selection. This fires after `onInput`.
|
|
2473
2471
|
*/
|
|
2474
2472
|
onChange?: (event: Event) => void;
|
|
2475
2473
|
/**
|
|
2476
|
-
*
|
|
2477
|
-
* This callback will be called, if the date typed is invalid or disabled.
|
|
2474
|
+
* A callback fired when the field contains an invalid date, either because the typed date is malformed, doesn't exist (e.g., February 31st), or is disabled by the `allow`/`disallow` constraints.
|
|
2478
2475
|
*
|
|
2479
2476
|
* Dates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:
|
|
2480
2477
|
* - 2021-02-31: February doesn’t have 31 days
|
|
@@ -2489,6 +2486,19 @@ interface DateFieldProps$1
|
|
|
2489
2486
|
*/
|
|
2490
2487
|
onInvalid?: (event: Event) => void;
|
|
2491
2488
|
}
|
|
2489
|
+
/**
|
|
2490
|
+
* Represents autocomplete values that are valid for date input fields.
|
|
2491
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for date-based inputs.
|
|
2492
|
+
*
|
|
2493
|
+
* Available values:
|
|
2494
|
+
* - `bday` - Complete birthday date
|
|
2495
|
+
* - `bday-day` - Day component of a birthday (1-31)
|
|
2496
|
+
* - `bday-month` - Month component of a birthday (1-12)
|
|
2497
|
+
* - `bday-year` - Year component of a birthday (1990)
|
|
2498
|
+
* - `cc-expiry` - Complete credit card expiration date
|
|
2499
|
+
* - `cc-expiry-month` - Month component of a credit card expiration date (1-12)
|
|
2500
|
+
* - `cc-expiry-year` - Year component of a credit card expiration date (2025)
|
|
2501
|
+
*/
|
|
2492
2502
|
export type DateAutocompleteField = ExtractStrict<
|
|
2493
2503
|
AnyAutocompleteField,
|
|
2494
2504
|
| 'bday'
|
|
@@ -2501,13 +2511,19 @@ export type DateAutocompleteField = ExtractStrict<
|
|
|
2501
2511
|
>;
|
|
2502
2512
|
interface DividerProps$1 extends GlobalProps {
|
|
2503
2513
|
/**
|
|
2504
|
-
*
|
|
2514
|
+
* The orientation of the divider line, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
|
|
2515
|
+
*
|
|
2516
|
+
* - `inline`: Horizontal divider for separating vertically stacked content
|
|
2517
|
+
* - `block`: Vertical divider for separating horizontally arranged content
|
|
2505
2518
|
*
|
|
2506
2519
|
* @default 'inline'
|
|
2507
2520
|
*/
|
|
2508
2521
|
direction?: 'inline' | 'block';
|
|
2509
2522
|
/**
|
|
2510
|
-
*
|
|
2523
|
+
* The visual prominence of the divider line.
|
|
2524
|
+
*
|
|
2525
|
+
* - `base`: Standard divider for most separations (default)
|
|
2526
|
+
* - `strong`: More prominent divider for major section breaks
|
|
2511
2527
|
*
|
|
2512
2528
|
* @default 'base'
|
|
2513
2529
|
*/
|
|
@@ -2549,17 +2565,28 @@ interface EmailFieldProps$1
|
|
|
2549
2565
|
BaseTextFieldProps,
|
|
2550
2566
|
MinMaxLengthProps,
|
|
2551
2567
|
AutocompleteProps<EmailAutocompleteField> {}
|
|
2568
|
+
/**
|
|
2569
|
+
* Represents autocomplete values that are valid for email input fields.
|
|
2570
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for email inputs.
|
|
2571
|
+
*
|
|
2572
|
+
* Available values:
|
|
2573
|
+
* - `email` - Primary email address
|
|
2574
|
+
* - `home email` - Home email address
|
|
2575
|
+
* - `mobile email` - Mobile device email address
|
|
2576
|
+
* - `fax email` - Fax machine email address
|
|
2577
|
+
* - `pager email` - Pager device email address
|
|
2578
|
+
*/
|
|
2552
2579
|
export type EmailAutocompleteField = ExtractStrict<
|
|
2553
2580
|
AnyAutocompleteField,
|
|
2554
2581
|
'email' | `${AutocompleteAddressGroup} email`
|
|
2555
2582
|
>;
|
|
2556
2583
|
interface FormProps$1 extends GlobalProps {
|
|
2557
2584
|
/**
|
|
2558
|
-
* The content
|
|
2585
|
+
* The form fields and content to be wrapped in the form element.
|
|
2559
2586
|
*/
|
|
2560
2587
|
children?: ComponentChildren;
|
|
2561
2588
|
/**
|
|
2562
|
-
* Whether the form
|
|
2589
|
+
* Whether the form can be submitted.
|
|
2563
2590
|
*
|
|
2564
2591
|
* When set to `true`, this will also disable the implicit submit behavior of the form.
|
|
2565
2592
|
*
|
|
@@ -2570,14 +2597,14 @@ interface FormProps$1 extends GlobalProps {
|
|
|
2570
2597
|
*/
|
|
2571
2598
|
disabled?: boolean;
|
|
2572
2599
|
/**
|
|
2573
|
-
* A callback
|
|
2600
|
+
* A callback fired when the form is submitted.
|
|
2574
2601
|
*
|
|
2575
|
-
* Use `event.waitUntil` to signal how long it takes to save the data
|
|
2576
|
-
* and whether
|
|
2602
|
+
* Use `event.waitUntil` to signal how long it takes to save the data
|
|
2603
|
+
* and whether the operation was successful.
|
|
2577
2604
|
*/
|
|
2578
2605
|
onSubmit?: (event: ExtendableEvent) => void;
|
|
2579
2606
|
/**
|
|
2580
|
-
* A callback
|
|
2607
|
+
* A callback fired when the form is reset, typically via a reset button.
|
|
2581
2608
|
*/
|
|
2582
2609
|
onReset?: (event: Event) => void;
|
|
2583
2610
|
}
|
|
@@ -2608,9 +2635,7 @@ export interface FunctionSettingsError extends Error {
|
|
|
2608
2635
|
/**
|
|
2609
2636
|
* A unique identifier describing the “class” of error. These will match
|
|
2610
2637
|
* the GraphQL error codes as closely as possible. For example the enums
|
|
2611
|
-
* returned by the `metafieldsSet` mutation
|
|
2612
|
-
*
|
|
2613
|
-
* @see https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode
|
|
2638
|
+
* returned by the `metafieldsSet` mutation. Learn more about [MetafieldsSetUserErrorCode](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode).
|
|
2614
2639
|
*/
|
|
2615
2640
|
code: string;
|
|
2616
2641
|
name: 'FunctionSettingsError';
|
|
@@ -2618,16 +2643,16 @@ export interface FunctionSettingsError extends Error {
|
|
|
2618
2643
|
export type SpacingKeyword = SizeKeyword | 'none';
|
|
2619
2644
|
export interface GapProps {
|
|
2620
2645
|
/**
|
|
2621
|
-
*
|
|
2646
|
+
* The spacing between child elements.
|
|
2622
2647
|
*
|
|
2623
2648
|
* A single value applies to both axes.
|
|
2624
|
-
* A pair of values (
|
|
2649
|
+
* A pair of values (e.g., `large-100 large-500`) can be used to set the inline and block axes respectively.
|
|
2625
2650
|
*
|
|
2626
2651
|
* @default 'none'
|
|
2627
2652
|
*/
|
|
2628
2653
|
gap?: MaybeResponsive<MaybeTwoValuesShorthandProperty<SpacingKeyword>>;
|
|
2629
2654
|
/**
|
|
2630
|
-
*
|
|
2655
|
+
* The spacing between elements along the block axis (vertical spacing in horizontal writing modes).
|
|
2631
2656
|
*
|
|
2632
2657
|
* This overrides the row value of `gap`.
|
|
2633
2658
|
*
|
|
@@ -2635,7 +2660,7 @@ export interface GapProps {
|
|
|
2635
2660
|
*/
|
|
2636
2661
|
rowGap?: MaybeResponsive<SpacingKeyword | ''>;
|
|
2637
2662
|
/**
|
|
2638
|
-
*
|
|
2663
|
+
* The spacing between elements along the inline axis (horizontal spacing in horizontal writing modes).
|
|
2639
2664
|
*
|
|
2640
2665
|
* This overrides the column value of `gap`.
|
|
2641
2666
|
*
|
|
@@ -2654,9 +2679,7 @@ export type OverflowPosition =
|
|
|
2654
2679
|
| `unsafe ${ContentPosition}`
|
|
2655
2680
|
| `safe ${ContentPosition}`;
|
|
2656
2681
|
/**
|
|
2657
|
-
* Justify items defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis.
|
|
2658
|
-
*
|
|
2659
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
|
|
2682
|
+
* Justify items defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis. Learn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).
|
|
2660
2683
|
*/
|
|
2661
2684
|
export type JustifyItemsKeyword =
|
|
2662
2685
|
| 'normal'
|
|
@@ -2665,9 +2688,7 @@ export type JustifyItemsKeyword =
|
|
|
2665
2688
|
| OverflowPosition
|
|
2666
2689
|
| ContentPosition;
|
|
2667
2690
|
/**
|
|
2668
|
-
* Align items sets the align-self value on all direct children as a group.
|
|
2669
|
-
*
|
|
2670
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
2691
|
+
* Align items sets the align-self value on all direct children as a group. Learn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
|
|
2671
2692
|
*/
|
|
2672
2693
|
export type AlignItemsKeyword =
|
|
2673
2694
|
| 'normal'
|
|
@@ -2676,9 +2697,7 @@ export type AlignItemsKeyword =
|
|
|
2676
2697
|
| OverflowPosition
|
|
2677
2698
|
| ContentPosition;
|
|
2678
2699
|
/**
|
|
2679
|
-
* 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.
|
|
2680
|
-
*
|
|
2681
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
2700
|
+
* 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. Learn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
|
|
2682
2701
|
*/
|
|
2683
2702
|
export type JustifyContentKeyword =
|
|
2684
2703
|
| 'normal'
|
|
@@ -2686,9 +2705,7 @@ export type JustifyContentKeyword =
|
|
|
2686
2705
|
| OverflowPosition
|
|
2687
2706
|
| ContentPosition;
|
|
2688
2707
|
/**
|
|
2689
|
-
*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.
|
|
2690
|
-
*
|
|
2691
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
2708
|
+
*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. Learn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).
|
|
2692
2709
|
*/
|
|
2693
2710
|
export type AlignContentKeyword =
|
|
2694
2711
|
| 'normal'
|
|
@@ -2698,68 +2715,60 @@ export type AlignContentKeyword =
|
|
|
2698
2715
|
| ContentPosition;
|
|
2699
2716
|
interface GridProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
|
|
2700
2717
|
/**
|
|
2701
|
-
Define columns and specify their size.
|
|
2718
|
+
Define columns and specify their size. Learn more about the [grid-template-columns property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns).
|
|
2702
2719
|
|
|
2703
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns
|
|
2704
2720
|
@default 'none'
|
|
2705
2721
|
*/
|
|
2706
2722
|
gridTemplateColumns?: MaybeResponsive<string>;
|
|
2707
2723
|
/**
|
|
2708
|
-
Define rows and specify their size.
|
|
2724
|
+
Define rows and specify their size. Learn more about the [grid-template-rows property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows).
|
|
2709
2725
|
|
|
2710
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows
|
|
2711
2726
|
@default 'none'
|
|
2712
2727
|
*/
|
|
2713
2728
|
gridTemplateRows?: MaybeResponsive<string>;
|
|
2714
2729
|
/**
|
|
2715
|
-
Aligns the grid items along the inline (row) axis.
|
|
2730
|
+
Aligns the grid items along the inline (row) axis. Learn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).
|
|
2716
2731
|
|
|
2717
2732
|
This overrides the inline value of `placeItems`.
|
|
2718
2733
|
|
|
2719
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
|
|
2720
2734
|
@default '' - meaning no override
|
|
2721
2735
|
*/
|
|
2722
2736
|
justifyItems?: MaybeResponsive<JustifyItemsKeyword | ''>;
|
|
2723
2737
|
/**
|
|
2724
|
-
Aligns the grid items along the block (column) axis.
|
|
2738
|
+
Aligns the grid items along the block (column) axis. Learn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
|
|
2725
2739
|
|
|
2726
2740
|
This overrides the block value of `placeItems`.
|
|
2727
2741
|
|
|
2728
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
2729
2742
|
@default '' - meaning no override
|
|
2730
2743
|
*/
|
|
2731
2744
|
alignItems?: MaybeResponsive<AlignItemsKeyword | ''>;
|
|
2732
2745
|
/**
|
|
2733
|
-
A shorthand property for `justify-items` and `align-items`.
|
|
2746
|
+
A shorthand property for `justify-items` and `align-items`. Learn more about the [place-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/place-items).
|
|
2734
2747
|
|
|
2735
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/place-items
|
|
2736
2748
|
@default 'normal normal'
|
|
2737
2749
|
*/
|
|
2738
2750
|
placeItems?: MaybeResponsive<
|
|
2739
2751
|
`${AlignItemsKeyword} ${JustifyItemsKeyword}` | AlignItemsKeyword
|
|
2740
2752
|
>;
|
|
2741
2753
|
/**
|
|
2742
|
-
Aligns the grid along the inline (row) axis.
|
|
2754
|
+
Aligns the grid along the inline (row) axis. Learn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
|
|
2743
2755
|
|
|
2744
2756
|
This overrides the inline value of `placeContent`.
|
|
2745
2757
|
|
|
2746
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
2747
2758
|
@default '' - meaning no override
|
|
2748
2759
|
*/
|
|
2749
2760
|
justifyContent?: MaybeResponsive<JustifyContentKeyword | ''>;
|
|
2750
2761
|
/**
|
|
2751
|
-
Aligns the grid along the block (column) axis.
|
|
2762
|
+
Aligns the grid along the block (column) axis. Learn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).
|
|
2752
2763
|
|
|
2753
2764
|
This overrides the block value of `placeContent`.
|
|
2754
2765
|
|
|
2755
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
2756
2766
|
@default '' - meaning no override
|
|
2757
2767
|
*/
|
|
2758
2768
|
alignContent?: MaybeResponsive<AlignContentKeyword | ''>;
|
|
2759
2769
|
/**
|
|
2760
|
-
A shorthand property for `justify-content` and `align-content`.
|
|
2770
|
+
A shorthand property for `justify-content` and `align-content`. Learn more about the [place-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/place-content).
|
|
2761
2771
|
|
|
2762
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/place-content
|
|
2763
2772
|
@default 'normal normal'
|
|
2764
2773
|
*/
|
|
2765
2774
|
placeContent?: MaybeResponsive<
|
|
@@ -2768,17 +2777,13 @@ interface GridProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
|
|
|
2768
2777
|
}
|
|
2769
2778
|
interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole {
|
|
2770
2779
|
/**
|
|
2771
|
-
*
|
|
2772
|
-
*
|
|
2773
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column
|
|
2780
|
+
* The number of grid columns this item spans across. Learn more about the [grid-column property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).
|
|
2774
2781
|
*
|
|
2775
2782
|
* @default 'auto'
|
|
2776
2783
|
*/
|
|
2777
2784
|
gridColumn?: `span ${number}` | 'auto';
|
|
2778
2785
|
/**
|
|
2779
|
-
*
|
|
2780
|
-
*
|
|
2781
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
|
|
2786
|
+
* The number of grid rows this item spans across. Learn more about the [grid-row property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).
|
|
2782
2787
|
*
|
|
2783
2788
|
* @default 'auto'
|
|
2784
2789
|
*/
|
|
@@ -2786,21 +2791,29 @@ interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole {
|
|
|
2786
2791
|
}
|
|
2787
2792
|
export interface BaseTypographyProps {
|
|
2788
2793
|
/**
|
|
2789
|
-
*
|
|
2794
|
+
* The color intensity of the text. Use `subdued` for less intense, `base` for standard, or `strong` for more intense coloring.
|
|
2790
2795
|
*
|
|
2791
2796
|
* @default 'base'
|
|
2792
2797
|
*/
|
|
2793
2798
|
color?: ColorKeyword;
|
|
2794
2799
|
/**
|
|
2795
|
-
*
|
|
2800
|
+
* The semantic meaning and color treatment of the component.
|
|
2801
|
+
*
|
|
2802
|
+
* - `auto`: Automatically determined based on context.
|
|
2803
|
+
* - `neutral`: General information without specific intent.
|
|
2804
|
+
* - `info`: Informational content or helpful tips.
|
|
2805
|
+
* - `success`: Positive outcomes or successful states.
|
|
2806
|
+
* - `caution`: Advisory notices that need attention.
|
|
2807
|
+
* - `warning`: Important warnings about potential issues.
|
|
2808
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
2809
|
+
* - `accent`: Highlighted or promotional content.
|
|
2810
|
+
* - `custom`: Custom styling controlled by your theme.
|
|
2796
2811
|
*
|
|
2797
2812
|
* @default 'auto'
|
|
2798
2813
|
*/
|
|
2799
2814
|
tone?: ToneKeyword;
|
|
2800
2815
|
/**
|
|
2801
|
-
* Set the numeric properties of the font.
|
|
2802
|
-
*
|
|
2803
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric
|
|
2816
|
+
* Set the numeric properties of the font. Learn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).
|
|
2804
2817
|
*
|
|
2805
2818
|
* @default 'auto' - inherit from the parent element
|
|
2806
2819
|
*/
|
|
@@ -2818,12 +2831,12 @@ export interface BaseTypographyProps {
|
|
|
2818
2831
|
/**
|
|
2819
2832
|
* Indicates the directionality of the element’s text.
|
|
2820
2833
|
*
|
|
2821
|
-
* - `
|
|
2822
|
-
* - `
|
|
2823
|
-
* - `
|
|
2824
|
-
* - `
|
|
2834
|
+
* - `""`: The direction is inherited from parent elements (equivalent to not setting the attribute).
|
|
2835
|
+
* - `auto`: The user agent determines the direction based on the content.
|
|
2836
|
+
* - `ltr`: The languages written from left to right (such as English).
|
|
2837
|
+
* - `rtl`: The languages written from right to left (such as Arabic).
|
|
2825
2838
|
*
|
|
2826
|
-
*
|
|
2839
|
+
* Learn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).
|
|
2827
2840
|
*
|
|
2828
2841
|
* @default ''
|
|
2829
2842
|
*/
|
|
@@ -2831,9 +2844,7 @@ export interface BaseTypographyProps {
|
|
|
2831
2844
|
}
|
|
2832
2845
|
export interface BlockTypographyProps {
|
|
2833
2846
|
/**
|
|
2834
|
-
* Truncates the text content to the specified number of lines.
|
|
2835
|
-
*
|
|
2836
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp
|
|
2847
|
+
* Truncates the text content to the specified number of lines. Learn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).
|
|
2837
2848
|
*
|
|
2838
2849
|
* @default Infinity - no truncation is applied
|
|
2839
2850
|
*/
|
|
@@ -2844,7 +2855,7 @@ interface HeadingProps$1
|
|
|
2844
2855
|
AccessibilityVisibilityProps,
|
|
2845
2856
|
BlockTypographyProps {
|
|
2846
2857
|
/**
|
|
2847
|
-
* The content of the
|
|
2858
|
+
* The content of the heading.
|
|
2848
2859
|
*/
|
|
2849
2860
|
children?: ComponentChildren;
|
|
2850
2861
|
/**
|
|
@@ -2872,67 +2883,69 @@ interface IconProps$1
|
|
|
2872
2883
|
extends GlobalProps,
|
|
2873
2884
|
Pick<InteractionProps, 'interestFor'> {
|
|
2874
2885
|
/**
|
|
2875
|
-
*
|
|
2886
|
+
* The semantic meaning and color treatment of the component.
|
|
2887
|
+
*
|
|
2888
|
+
* - `auto`: Automatically determined based on context.
|
|
2889
|
+
* - `neutral`: General information without specific intent.
|
|
2890
|
+
* - `info`: Informational content or helpful tips.
|
|
2891
|
+
* - `success`: Positive outcomes or successful states.
|
|
2892
|
+
* - `caution`: Advisory notices that need attention.
|
|
2893
|
+
* - `warning`: Important warnings about potential issues.
|
|
2894
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
2876
2895
|
*
|
|
2877
2896
|
* @default 'auto'
|
|
2878
2897
|
*/
|
|
2879
2898
|
tone?: ToneKeyword;
|
|
2880
2899
|
/**
|
|
2881
|
-
*
|
|
2900
|
+
* The color intensity of the icon. Use `subdued` for less intense, `base` for standard, or `strong` for more intense coloring.
|
|
2882
2901
|
*
|
|
2883
2902
|
* @default 'base'
|
|
2884
2903
|
*/
|
|
2885
2904
|
color?: ColorKeyword;
|
|
2886
2905
|
/**
|
|
2887
|
-
*
|
|
2906
|
+
* The size of the icon. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size.
|
|
2888
2907
|
*
|
|
2889
2908
|
* @default 'base'
|
|
2890
2909
|
*/
|
|
2891
2910
|
size?: SizeKeyword;
|
|
2911
|
+
/**
|
|
2912
|
+
* The icon to display. Can be any icon name from the icon library or a custom string identifier.
|
|
2913
|
+
*/
|
|
2892
2914
|
type?: IconType | AnyString;
|
|
2893
2915
|
}
|
|
2894
2916
|
export interface BaseImageProps {
|
|
2895
2917
|
/**
|
|
2896
|
-
*
|
|
2897
|
-
*
|
|
2898
|
-
*
|
|
2899
|
-
*
|
|
2900
|
-
*
|
|
2901
|
-
*
|
|
2902
|
-
*
|
|
2903
|
-
*
|
|
2904
|
-
*
|
|
2905
|
-
*
|
|
2906
|
-
*
|
|
2907
|
-
*
|
|
2908
|
-
*
|
|
2909
|
-
* @default
|
|
2910
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt
|
|
2918
|
+
* Alternative text that describes the image for accessibility.
|
|
2919
|
+
*
|
|
2920
|
+
* Provides a text description of the image for users with assistive technology
|
|
2921
|
+
* and serves as a fallback when the image fails to load. A well-written description
|
|
2922
|
+
* enables people with visual impairments to understand non-text content.
|
|
2923
|
+
*
|
|
2924
|
+
* When a screen reader encounters an image, it reads this description aloud.
|
|
2925
|
+
* When an image fails to load, this text displays on screen, helping all users
|
|
2926
|
+
* understand what content was intended.
|
|
2927
|
+
*
|
|
2928
|
+
* Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4)
|
|
2929
|
+
* and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).
|
|
2930
|
+
*
|
|
2931
|
+
* @default ''
|
|
2911
2932
|
*/
|
|
2912
2933
|
alt?: string;
|
|
2913
2934
|
/**
|
|
2914
|
-
* A set of media conditions and their corresponding sizes.
|
|
2915
|
-
*
|
|
2916
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes
|
|
2935
|
+
* A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).
|
|
2917
2936
|
*/
|
|
2918
2937
|
sizes?: string;
|
|
2919
2938
|
/**
|
|
2920
2939
|
* The image source (either a remote URL or a local file resource).
|
|
2921
2940
|
*
|
|
2922
|
-
* When the image is loading or no `src` is provided, a placeholder
|
|
2941
|
+
* When the image is loading or no `src` is provided, a placeholder is rendered.
|
|
2923
2942
|
*
|
|
2924
2943
|
* @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be
|
|
2925
|
-
* reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare.
|
|
2926
|
-
*
|
|
2927
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src
|
|
2944
|
+
* reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare. Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).
|
|
2928
2945
|
*/
|
|
2929
2946
|
src?: string;
|
|
2930
2947
|
/**
|
|
2931
|
-
* A set of image sources and their width or pixel density descriptors.
|
|
2932
|
-
*
|
|
2933
|
-
* This overrides the `src` property.
|
|
2934
|
-
*
|
|
2935
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset
|
|
2948
|
+
* A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property.
|
|
2936
2949
|
*/
|
|
2937
2950
|
srcSet?: string;
|
|
2938
2951
|
}
|
|
@@ -2942,6 +2955,10 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
|
|
|
2942
2955
|
* the role will be used by assistive technologies to help users
|
|
2943
2956
|
* navigate the page.
|
|
2944
2957
|
*
|
|
2958
|
+
* - `img`: Identifies the element as an image that conveys meaningful information to users.
|
|
2959
|
+
* - `presentation`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.
|
|
2960
|
+
* - `none`: Completely hides the element and its content from assistive technologies.
|
|
2961
|
+
*
|
|
2945
2962
|
* @default 'img'
|
|
2946
2963
|
*
|
|
2947
2964
|
* @implementation The `img` role doesn't need to be applied if
|
|
@@ -2952,14 +2969,14 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
|
|
|
2952
2969
|
| 'img'
|
|
2953
2970
|
| ExtractStrict<AccessibilityRole, 'presentation' | 'none'>;
|
|
2954
2971
|
/**
|
|
2955
|
-
* The
|
|
2972
|
+
* The inline width (horizontal size) of the image.
|
|
2956
2973
|
*
|
|
2957
|
-
* - `fill`:
|
|
2958
|
-
* - `auto`:
|
|
2974
|
+
* - `fill`: The image takes up 100% of the available inline space.
|
|
2975
|
+
* - `auto`: The image is displayed at its natural size.
|
|
2959
2976
|
*
|
|
2960
|
-
*
|
|
2977
|
+
* Learn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width).
|
|
2961
2978
|
*
|
|
2962
|
-
* @
|
|
2979
|
+
* @default 'fill'
|
|
2963
2980
|
*/
|
|
2964
2981
|
inlineSize?: 'fill' | 'auto';
|
|
2965
2982
|
/**
|
|
@@ -2973,20 +2990,18 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
|
|
|
2973
2990
|
* For example, if the value is set as `50 / 100`, the getter returns `50 / 100`.
|
|
2974
2991
|
* If the value is set as `0.5`, the getter returns `0.5 / 1`.
|
|
2975
2992
|
*
|
|
2976
|
-
*
|
|
2993
|
+
* Learn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio).
|
|
2977
2994
|
*
|
|
2978
|
-
* @
|
|
2995
|
+
* @default '1/1'
|
|
2979
2996
|
*/
|
|
2980
2997
|
aspectRatio?:
|
|
2981
2998
|
| `${number}${optionalSpace}/${optionalSpace}${number}`
|
|
2982
2999
|
| `${number}`;
|
|
2983
3000
|
/**
|
|
2984
3001
|
* Determines how the content of the image is resized to fit its container.
|
|
2985
|
-
* The image is positioned in the center of the container.
|
|
3002
|
+
* The image is positioned in the center of the container. Learn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).
|
|
2986
3003
|
*
|
|
2987
3004
|
* @default 'contain'
|
|
2988
|
-
*
|
|
2989
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
2990
3005
|
*/
|
|
2991
3006
|
objectFit?: 'contain' | 'cover';
|
|
2992
3007
|
/**
|
|
@@ -2994,62 +3009,57 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
|
|
|
2994
3009
|
* - `eager`: Immediately loads the image, irrespective of its position within the visible viewport.
|
|
2995
3010
|
* - `lazy`: Delays loading the image until it approaches a specified distance from the viewport.
|
|
2996
3011
|
*
|
|
3012
|
+
* Learn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading).
|
|
3013
|
+
*
|
|
2997
3014
|
* @default 'eager'
|
|
2998
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading
|
|
2999
3015
|
*/
|
|
3000
3016
|
loading?: 'eager' | 'lazy';
|
|
3001
3017
|
/**
|
|
3002
|
-
*
|
|
3003
|
-
*
|
|
3004
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
|
|
3018
|
+
* A callback fired when the image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload).
|
|
3005
3019
|
*/
|
|
3006
3020
|
onLoad?: (event: Event) => void;
|
|
3007
3021
|
/**
|
|
3008
|
-
*
|
|
3009
|
-
*
|
|
3010
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
|
|
3022
|
+
* A callback fired when the image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror).
|
|
3011
3023
|
*/
|
|
3012
3024
|
onError?: (event: Event) => void;
|
|
3013
3025
|
}
|
|
3014
3026
|
interface LinkProps$1 extends GlobalProps, LinkBehaviorProps {
|
|
3015
3027
|
/**
|
|
3016
|
-
* The
|
|
3028
|
+
* The text or elements displayed as the link's content.
|
|
3017
3029
|
*/
|
|
3018
3030
|
children?: ComponentChildren;
|
|
3019
3031
|
/**
|
|
3020
|
-
*
|
|
3032
|
+
* The semantic meaning and color treatment of the component.
|
|
3033
|
+
*
|
|
3034
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
3035
|
+
* - `auto`: Automatically determined based on context.
|
|
3036
|
+
* - `neutral`: General information without specific intent.
|
|
3021
3037
|
*
|
|
3022
3038
|
* @default 'auto'
|
|
3023
3039
|
*/
|
|
3024
3040
|
tone?: ToneKeyword;
|
|
3025
3041
|
/**
|
|
3026
|
-
* A label that describes the purpose or
|
|
3027
|
-
*
|
|
3028
|
-
* Use this when using only an icon or the content of the link is not enough context
|
|
3029
|
-
* for users using assistive technologies.
|
|
3042
|
+
* A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.
|
|
3030
3043
|
*/
|
|
3031
3044
|
accessibilityLabel?: string;
|
|
3032
3045
|
/**
|
|
3033
|
-
*
|
|
3034
|
-
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
3035
|
-
* [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
|
|
3046
|
+
* The language of the link's text content. Use this when the link text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label).
|
|
3036
3047
|
*/
|
|
3037
3048
|
lang?: string;
|
|
3038
3049
|
}
|
|
3039
3050
|
interface ListItemProps$1 extends GlobalProps {
|
|
3040
3051
|
/**
|
|
3041
|
-
* The content
|
|
3052
|
+
* The content displayed within the list item.
|
|
3042
3053
|
*/
|
|
3043
3054
|
children?: ComponentChildren;
|
|
3044
3055
|
}
|
|
3045
3056
|
interface MenuProps$1 extends GlobalProps {
|
|
3046
3057
|
/**
|
|
3047
|
-
* A label that describes the purpose or
|
|
3048
|
-
* it will be announced using assistive technologies and provide additional context.
|
|
3058
|
+
* A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.
|
|
3049
3059
|
*/
|
|
3050
3060
|
accessibilityLabel?: string;
|
|
3051
3061
|
/**
|
|
3052
|
-
* The
|
|
3062
|
+
* The collection of Button components displayed as menu actions. Only Button components are allowed as children, which can perform actions using `onClick` or link to other parts of the application using `href`. Any other component type will be ignored.
|
|
3053
3063
|
*/
|
|
3054
3064
|
children?: ComponentChildren;
|
|
3055
3065
|
}
|
|
@@ -3067,32 +3077,32 @@ interface ModalProps$1
|
|
|
3067
3077
|
*/
|
|
3068
3078
|
accessibilityLabel?: string;
|
|
3069
3079
|
/**
|
|
3070
|
-
* A title that describes the content of the
|
|
3080
|
+
* A title that describes the content of the modal.
|
|
3071
3081
|
*
|
|
3072
3082
|
*/
|
|
3073
3083
|
heading?: string;
|
|
3074
3084
|
/**
|
|
3075
|
-
* Adjust the padding around the
|
|
3085
|
+
* Adjust the padding around the modal content.
|
|
3076
3086
|
*
|
|
3077
3087
|
* `base`: applies padding that is appropriate for the element.
|
|
3078
3088
|
*
|
|
3079
|
-
* `none`: removes all padding from the element. This can be useful when elements inside the
|
|
3080
|
-
* to the edge of the
|
|
3089
|
+
* `none`: removes all padding from the element. This can be useful when elements inside the modal need to span
|
|
3090
|
+
* to the edge of the modal. For example, a full-width image. In this case, rely on box with a padding of 'base'
|
|
3081
3091
|
* to bring back the desired padding for the rest of the content.
|
|
3082
3092
|
*
|
|
3083
3093
|
* @default 'base'
|
|
3084
3094
|
*/
|
|
3085
3095
|
padding?: 'base' | 'none';
|
|
3086
3096
|
/**
|
|
3087
|
-
* Adjust the size of the
|
|
3097
|
+
* Adjust the size of the modal.
|
|
3088
3098
|
*
|
|
3089
|
-
* `max`: expands the
|
|
3099
|
+
* `max`: expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.
|
|
3090
3100
|
*
|
|
3091
3101
|
* @default 'base'
|
|
3092
3102
|
*/
|
|
3093
3103
|
size?: SizeKeyword | 'max';
|
|
3094
3104
|
/**
|
|
3095
|
-
* The content of the
|
|
3105
|
+
* The content of the modal.
|
|
3096
3106
|
*/
|
|
3097
3107
|
children?: ComponentChildren;
|
|
3098
3108
|
}
|
|
@@ -3112,28 +3122,30 @@ interface NumberFieldProps$1
|
|
|
3112
3122
|
NumberConstraintsProps,
|
|
3113
3123
|
FieldDecorationProps {
|
|
3114
3124
|
/**
|
|
3115
|
-
* Sets the virtual keyboard.
|
|
3125
|
+
* Sets the virtual keyboard. Learn more about the [inputmode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).
|
|
3116
3126
|
*
|
|
3117
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
|
|
3118
3127
|
* @default 'decimal'
|
|
3119
3128
|
*/
|
|
3120
3129
|
inputMode?: 'decimal' | 'numeric';
|
|
3121
3130
|
/**
|
|
3122
|
-
* Callback when the user has **finished editing** a field,
|
|
3123
|
-
*
|
|
3124
|
-
* Also fired after `onInput` on every step when interacting with the controls or the keyboard up and down arrows.
|
|
3125
|
-
*
|
|
3126
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
|
|
3131
|
+
* Callback when the user has **finished editing** a field, such as when they blur the field after changing the value.
|
|
3132
|
+
* Also fired after `onInput` on every step when using keyboard up and down arrows. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).
|
|
3127
3133
|
*/
|
|
3128
3134
|
onChange?: (event: Event) => void;
|
|
3129
3135
|
/**
|
|
3130
|
-
*
|
|
3131
|
-
* Also fired before `onChange` on every step when interacting with the controls or the keyboard up and down arrows.
|
|
3132
|
-
*
|
|
3133
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
|
|
3136
|
+
* A callback fired when the user makes any changes to the field value, including when using keyboard up/down arrows. This fires before `onChange`. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
|
|
3134
3137
|
*/
|
|
3135
3138
|
onInput?: (event: Event) => void;
|
|
3136
3139
|
}
|
|
3140
|
+
/**
|
|
3141
|
+
* Represents autocomplete values that are valid for number input fields.
|
|
3142
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for numeric inputs.
|
|
3143
|
+
*
|
|
3144
|
+
* Available values:
|
|
3145
|
+
* - `one-time-code` - One-time codes for authentication (OTP, 2FA codes)
|
|
3146
|
+
* - `cc-number` - Credit card number
|
|
3147
|
+
* - `cc-csc` - Credit card security code (CVV/CVC)
|
|
3148
|
+
*/
|
|
3137
3149
|
export type NumberAutocompleteField = ExtractStrict<
|
|
3138
3150
|
AnyAutocompleteField,
|
|
3139
3151
|
'one-time-code' | 'cc-number' | 'cc-csc'
|
|
@@ -3152,27 +3164,18 @@ interface OptionGroupProps$1 extends GlobalProps {
|
|
|
3152
3164
|
*/
|
|
3153
3165
|
disabled?: boolean;
|
|
3154
3166
|
/**
|
|
3155
|
-
* The
|
|
3167
|
+
* The label text displayed for this group of related options.
|
|
3156
3168
|
*/
|
|
3157
3169
|
label?: string;
|
|
3158
3170
|
/**
|
|
3159
|
-
* The
|
|
3160
|
-
*
|
|
3161
|
-
* Accepts `Option` components.
|
|
3162
|
-
*/
|
|
3163
|
-
children?: ComponentChildren;
|
|
3164
|
-
}
|
|
3165
|
-
interface OrderedListProps$1 extends GlobalProps {
|
|
3166
|
-
/**
|
|
3167
|
-
* The content of the OrderededList.
|
|
3168
|
-
*
|
|
3169
|
-
* Accepts only `ListItem` components.
|
|
3171
|
+
* The collection of option components that users can select from within this group.
|
|
3170
3172
|
*/
|
|
3171
3173
|
children?: ComponentChildren;
|
|
3172
3174
|
}
|
|
3175
|
+
interface OrderedListProps$1 extends GlobalProps {}
|
|
3173
3176
|
interface PageProps$1 extends GlobalProps, ActionSlots {
|
|
3174
3177
|
/**
|
|
3175
|
-
* The content of the
|
|
3178
|
+
* The content of the page.
|
|
3176
3179
|
*/
|
|
3177
3180
|
children?: ComponentChildren;
|
|
3178
3181
|
/**
|
|
@@ -3212,13 +3215,13 @@ interface ParagraphProps$1
|
|
|
3212
3215
|
BlockTypographyProps,
|
|
3213
3216
|
AccessibilityVisibilityProps {
|
|
3214
3217
|
/**
|
|
3215
|
-
* The
|
|
3218
|
+
* The text or elements displayed within the paragraph.
|
|
3216
3219
|
*/
|
|
3217
3220
|
children?: ComponentChildren;
|
|
3218
3221
|
/**
|
|
3219
|
-
*
|
|
3222
|
+
* The semantic type of the paragraph, which provides meaning and default styling.
|
|
3220
3223
|
*
|
|
3221
|
-
* Other presentation properties on
|
|
3224
|
+
* Other presentation properties on the paragraph can override the default styling.
|
|
3222
3225
|
*
|
|
3223
3226
|
* @default 'paragraph'
|
|
3224
3227
|
*/
|
|
@@ -3226,20 +3229,13 @@ interface ParagraphProps$1
|
|
|
3226
3229
|
}
|
|
3227
3230
|
export type ParagraphType =
|
|
3228
3231
|
/**
|
|
3229
|
-
*
|
|
3230
|
-
*
|
|
3231
|
-
* In an HTML host, the text will be rendered in an `<p>` element.
|
|
3232
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p
|
|
3232
|
+
* Indicates the text is a structural grouping of related content. In an HTML host, the text will be rendered in a `<p>` element. Learn more about the [p element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p).
|
|
3233
3233
|
*/
|
|
3234
3234
|
| 'paragraph'
|
|
3235
3235
|
/**
|
|
3236
|
-
* Indicates the text is considered less important than the main content
|
|
3237
|
-
* It can be used for secondary content but also for disclaimers, terms and conditions, or legal information.
|
|
3238
|
-
*
|
|
3239
|
-
* Surfaces should apply a smaller font size than the default size.
|
|
3236
|
+
* Indicates the text is considered less important than the main content but is still necessary for understanding. This can be used for secondary content, disclaimers, terms and conditions, or legal information.
|
|
3240
3237
|
*
|
|
3241
|
-
* In an HTML host, the text will be rendered in a `<small>` element.
|
|
3242
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small
|
|
3238
|
+
* Surfaces should apply a smaller font size than the default. In an HTML host, the text will be rendered in a `<small>` element. Learn more about the [small element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small).
|
|
3243
3239
|
*/
|
|
3244
3240
|
| 'small';
|
|
3245
3241
|
interface PasswordFieldProps$1
|
|
@@ -3247,6 +3243,14 @@ interface PasswordFieldProps$1
|
|
|
3247
3243
|
BaseTextFieldProps,
|
|
3248
3244
|
MinMaxLengthProps,
|
|
3249
3245
|
AutocompleteProps<PasswordAutocompleteField> {}
|
|
3246
|
+
/**
|
|
3247
|
+
* Represents autocomplete values that are valid for password input fields.
|
|
3248
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for password inputs.
|
|
3249
|
+
*
|
|
3250
|
+
* Available values:
|
|
3251
|
+
* - `current-password` - Existing password for login or authentication
|
|
3252
|
+
* - `new-password` - New password when creating an account or changing password
|
|
3253
|
+
*/
|
|
3250
3254
|
export type PasswordAutocompleteField = ExtractStrict<
|
|
3251
3255
|
AnyAutocompleteField,
|
|
3252
3256
|
'new-password' | 'current-password'
|
|
@@ -3262,86 +3266,44 @@ interface PopoverProps$1
|
|
|
3262
3266
|
*/
|
|
3263
3267
|
children?: ComponentChildren;
|
|
3264
3268
|
}
|
|
3265
|
-
interface PressButtonProps$1
|
|
3266
|
-
extends GlobalProps,
|
|
3267
|
-
Pick<
|
|
3268
|
-
ButtonProps$1,
|
|
3269
|
-
| 'accessibilityLabel'
|
|
3270
|
-
| 'children'
|
|
3271
|
-
| 'icon'
|
|
3272
|
-
| 'inlineSize'
|
|
3273
|
-
| 'lang'
|
|
3274
|
-
| 'tone'
|
|
3275
|
-
| 'variant'
|
|
3276
|
-
| 'disabled'
|
|
3277
|
-
| 'loading'
|
|
3278
|
-
| 'onClick'
|
|
3279
|
-
| 'onBlur'
|
|
3280
|
-
| 'onFocus'
|
|
3281
|
-
> {
|
|
3282
|
-
/**
|
|
3283
|
-
* Whether the button is pressed.
|
|
3284
|
-
*
|
|
3285
|
-
* @default false
|
|
3286
|
-
*/
|
|
3287
|
-
pressed?: boolean;
|
|
3288
|
-
/**
|
|
3289
|
-
* Whether the button is pressed by default.
|
|
3290
|
-
*
|
|
3291
|
-
* @default false
|
|
3292
|
-
*
|
|
3293
|
-
* @implementation `defaultPressed` reflects to the `pressed` attribute.
|
|
3294
|
-
*/
|
|
3295
|
-
defaultPressed?: boolean;
|
|
3296
|
-
}
|
|
3297
3269
|
interface QueryContainerProps$1 extends GlobalProps {
|
|
3298
3270
|
/**
|
|
3299
3271
|
* The content of the container.
|
|
3300
3272
|
*/
|
|
3301
3273
|
children?: ComponentChildren;
|
|
3302
3274
|
/**
|
|
3303
|
-
*
|
|
3275
|
+
* An identifier for this container that you can reference in CSS container queries to apply styles based on this specific container's size.
|
|
3304
3276
|
*
|
|
3305
|
-
*
|
|
3277
|
+
* All QueryContainer components automatically receive a container name of `s-default`. You can omit the container name in your queries, so `@container (inline-size <= 300px)` is equivalent to `@container s-default (inline-size <= 300px)`.
|
|
3306
3278
|
*
|
|
3307
|
-
*
|
|
3279
|
+
* When you provide a custom `containerName`, it's added alongside `s-default`. For example, `containerName="product-card"` results in `s-default product-card` being set on the `container-name` CSS property, allowing you to target this container with `@container product-card (inline-size <= 300px)`.
|
|
3308
3280
|
*
|
|
3309
|
-
*
|
|
3281
|
+
* Learn more about the [container-name property](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name).
|
|
3310
3282
|
*
|
|
3311
|
-
* @
|
|
3283
|
+
* @default ''
|
|
3312
3284
|
*
|
|
3313
3285
|
* @implementation You must always have a CSS `container-name` of `s-default` for this component.
|
|
3314
3286
|
*/
|
|
3315
3287
|
containerName?: string;
|
|
3316
3288
|
}
|
|
3317
|
-
export type OverflowKeyword = 'auto' | 'hidden';
|
|
3318
|
-
export type ScrollSnapType = 'none' | 'mandatory' | 'proximity';
|
|
3319
|
-
export type ScrollAccessibilityRole = 'generic' | 'region';
|
|
3320
3289
|
interface SectionProps$1 extends GlobalProps, ActionSlots {
|
|
3321
3290
|
/**
|
|
3322
|
-
* The content of the
|
|
3291
|
+
* The content of the section.
|
|
3323
3292
|
*/
|
|
3324
3293
|
children?: ComponentChildren;
|
|
3325
3294
|
/**
|
|
3326
|
-
* A label
|
|
3327
|
-
*
|
|
3328
|
-
* When no `heading` property is provided or included as a children of the Section, you **must** provide an
|
|
3329
|
-
* `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide
|
|
3330
|
-
* the right context to users.
|
|
3295
|
+
* A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.
|
|
3331
3296
|
*/
|
|
3332
3297
|
accessibilityLabel?: string;
|
|
3333
3298
|
/**
|
|
3334
|
-
*
|
|
3299
|
+
* The heading text displayed at the top of the section. This heading provides a title for the section's content and automatically uses the appropriate semantic heading level (h2, h3, h4) based on nesting depth to maintain proper document structure.
|
|
3335
3300
|
*/
|
|
3336
3301
|
heading?: string;
|
|
3337
3302
|
/**
|
|
3338
|
-
*
|
|
3303
|
+
* The amount of padding applied to all edges of the section.
|
|
3339
3304
|
*
|
|
3340
|
-
* - `base`:
|
|
3341
|
-
*
|
|
3342
|
-
* - `none`: removes all padding from the element. This can be useful when elements inside the Section need to span
|
|
3343
|
-
* to the edge of the Section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base'
|
|
3344
|
-
* to bring back the desired padding for the rest of the content.
|
|
3305
|
+
* - `base`: Applies standard padding appropriate for the section. Note that this might result in no padding if that's the right design decision for the context.
|
|
3306
|
+
* - `none`: Removes all padding, useful when content like images needs to extend to the section's edges. Use Box with `padding="base"` for individual content areas that need padding.
|
|
3345
3307
|
*
|
|
3346
3308
|
* @default 'base'
|
|
3347
3309
|
*/
|
|
@@ -3354,59 +3316,61 @@ interface SelectProps$1
|
|
|
3354
3316
|
Omit<FieldProps, 'defaultValue'>,
|
|
3355
3317
|
FocusEventProps {
|
|
3356
3318
|
/**
|
|
3357
|
-
* The options
|
|
3319
|
+
* The selectable options displayed in the dropdown list.
|
|
3358
3320
|
*
|
|
3359
|
-
* Accepts
|
|
3321
|
+
* Accepts Option components for individual selectable items, and OptionGroup components to organize related options into logical groups with labels.
|
|
3360
3322
|
*/
|
|
3361
3323
|
children?: ComponentChildren;
|
|
3362
3324
|
}
|
|
3363
3325
|
interface SpinnerProps$1 extends GlobalProps {
|
|
3364
3326
|
/**
|
|
3365
|
-
*
|
|
3327
|
+
* The size of the spinner icon. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size.
|
|
3366
3328
|
*
|
|
3367
3329
|
* @default 'base'
|
|
3368
3330
|
*/
|
|
3369
3331
|
size?: SizeKeyword;
|
|
3370
3332
|
/**
|
|
3371
|
-
* A label that describes the purpose of the
|
|
3372
|
-
* it will be announced to users using assistive technologies and will
|
|
3373
|
-
* provide them with more context. Providing an `accessibilityLabel` is
|
|
3374
|
-
* recommended if there is no accompanying text describing that something
|
|
3375
|
-
* is loading.
|
|
3333
|
+
* A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.
|
|
3376
3334
|
*/
|
|
3377
3335
|
accessibilityLabel?: string;
|
|
3378
3336
|
}
|
|
3379
3337
|
interface StackProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
|
|
3380
3338
|
/**
|
|
3381
|
-
* The
|
|
3339
|
+
* The elements arranged within the stack layout.
|
|
3382
3340
|
*/
|
|
3383
3341
|
children?: ComponentChildren;
|
|
3384
3342
|
/**
|
|
3385
|
-
*
|
|
3343
|
+
* The axis along which child elements are arranged, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
|
|
3344
|
+
*
|
|
3345
|
+
* - `block`: Arranges children vertically (in horizontal writing modes). Content does not wrap.
|
|
3346
|
+
* - `inline`: Arranges children horizontally (in horizontal writing modes). Content wraps to the next line if needed.
|
|
3386
3347
|
*
|
|
3387
3348
|
* @default 'block'
|
|
3388
3349
|
*
|
|
3389
|
-
* @implementation
|
|
3350
|
+
* @implementation The content will wrap if the direction is 'inline', and not wrap if the direction is 'block'.
|
|
3390
3351
|
*/
|
|
3391
3352
|
direction?: MaybeResponsive<'block' | 'inline'>;
|
|
3392
3353
|
/**
|
|
3393
|
-
*
|
|
3354
|
+
* Controls the distribution of children along the inline axis (horizontally in horizontal writing modes).
|
|
3355
|
+
*
|
|
3356
|
+
* Use this to position items along the primary axis of the stack - horizontally for inline stacks or vertically for block stacks when wrapped into multiple lines. Learn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
|
|
3394
3357
|
*
|
|
3395
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
3396
3358
|
* @default 'normal'
|
|
3397
3359
|
*/
|
|
3398
3360
|
justifyContent?: MaybeResponsive<JustifyContentKeyword>;
|
|
3399
3361
|
/**
|
|
3400
|
-
*
|
|
3362
|
+
* Controls the alignment of children along the block axis (vertically in horizontal writing modes).
|
|
3363
|
+
*
|
|
3364
|
+
* Use this to align items perpendicular to the stack direction - vertically for inline stacks or horizontally for block stacks. Learn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
|
|
3401
3365
|
*
|
|
3402
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
3403
3366
|
* @default 'normal'
|
|
3404
3367
|
*/
|
|
3405
3368
|
alignItems?: MaybeResponsive<AlignItemsKeyword>;
|
|
3406
3369
|
/**
|
|
3407
|
-
*
|
|
3370
|
+
* Controls the distribution of lines along the block axis when content wraps into multiple lines.
|
|
3371
|
+
*
|
|
3372
|
+
* This property only affects stacks with wrapping content. For single-line stacks, use `alignItems` instead. Learn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).
|
|
3408
3373
|
*
|
|
3409
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
3410
3374
|
* @default 'normal'
|
|
3411
3375
|
*/
|
|
3412
3376
|
alignContent?: MaybeResponsive<AlignContentKeyword>;
|
|
@@ -3425,11 +3389,11 @@ export interface PaginationProps {
|
|
|
3425
3389
|
*/
|
|
3426
3390
|
paginate?: boolean;
|
|
3427
3391
|
/**
|
|
3428
|
-
*
|
|
3392
|
+
* A callback fired when the previous page button is clicked.
|
|
3429
3393
|
*/
|
|
3430
3394
|
onPreviousPage?: (event: Event) => void;
|
|
3431
3395
|
/**
|
|
3432
|
-
*
|
|
3396
|
+
* A callback fired when the next page button is clicked.
|
|
3433
3397
|
*/
|
|
3434
3398
|
onNextPage?: (event: Event) => void;
|
|
3435
3399
|
/**
|
|
@@ -3445,8 +3409,8 @@ export interface PaginationProps {
|
|
|
3445
3409
|
*/
|
|
3446
3410
|
hasPreviousPage?: boolean;
|
|
3447
3411
|
/**
|
|
3448
|
-
* Whether the table is in a loading state, such as initial page load or loading the next page in a paginated table.
|
|
3449
|
-
* When true
|
|
3412
|
+
* Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table.
|
|
3413
|
+
* When `true`, the table might be in an inert state that prevents user interaction.
|
|
3450
3414
|
*
|
|
3451
3415
|
* @default false
|
|
3452
3416
|
*/
|
|
@@ -3454,19 +3418,23 @@ export interface PaginationProps {
|
|
|
3454
3418
|
}
|
|
3455
3419
|
interface TableProps$1 extends GlobalProps, PaginationProps {
|
|
3456
3420
|
/**
|
|
3457
|
-
* The
|
|
3421
|
+
* The table structure defining headers and data rows.
|
|
3422
|
+
*
|
|
3423
|
+
* Accepts table header row (for column headers) and table body (for data rows) components. Structure your table with a table header row first, followed by table body.
|
|
3458
3424
|
*/
|
|
3459
3425
|
children?: ComponentChildren;
|
|
3460
3426
|
/**
|
|
3461
|
-
*
|
|
3427
|
+
* Filter controls displayed above the table.
|
|
3428
|
+
*
|
|
3429
|
+
* Accepts input components like search field or select for filtering table data. These controls appear in a dedicated area above the table content.
|
|
3462
3430
|
*/
|
|
3463
3431
|
filters?: ComponentChildren;
|
|
3464
3432
|
/**
|
|
3465
|
-
*
|
|
3433
|
+
* The layout variant of the table.
|
|
3466
3434
|
*
|
|
3467
|
-
* - `list`:
|
|
3468
|
-
* - `table`:
|
|
3469
|
-
* - `auto`:
|
|
3435
|
+
* - `list`: Always displays as a list layout.
|
|
3436
|
+
* - `table`: Always displays as a traditional table layout.
|
|
3437
|
+
* - `auto`: Automatically displays as a table on wide screens and as a list on narrow screens.
|
|
3470
3438
|
*
|
|
3471
3439
|
* @default 'auto'
|
|
3472
3440
|
*/
|
|
@@ -3474,59 +3442,78 @@ interface TableProps$1 extends GlobalProps, PaginationProps {
|
|
|
3474
3442
|
}
|
|
3475
3443
|
interface TableBodyProps$1 extends GlobalProps {
|
|
3476
3444
|
/**
|
|
3477
|
-
* The
|
|
3445
|
+
* The data rows displayed in the table body.
|
|
3446
|
+
*
|
|
3447
|
+
* Accepts TableRow components, with each row representing a single record or entry in the table.
|
|
3478
3448
|
*/
|
|
3479
3449
|
children?: ComponentChildren;
|
|
3480
3450
|
}
|
|
3481
3451
|
interface TableCellProps$1 extends GlobalProps {
|
|
3482
3452
|
/**
|
|
3483
|
-
* The
|
|
3453
|
+
* The data value displayed in this cell.
|
|
3454
|
+
*
|
|
3455
|
+
* Accepts text content or inline components representing the cell's data value.
|
|
3484
3456
|
*/
|
|
3485
3457
|
children?: ComponentChildren;
|
|
3486
3458
|
}
|
|
3459
|
+
/**
|
|
3460
|
+
* Represents the content designation for table columns when displayed in list variant on mobile devices.
|
|
3461
|
+
*
|
|
3462
|
+
* Available values:
|
|
3463
|
+
* - `primary` - The most important content. Only one column can have this designation.
|
|
3464
|
+
* - `secondary` - Supporting content displayed below primary. Only one column can have this designation.
|
|
3465
|
+
* - `kicker` - Small label displayed above primary content with less visual prominence. Only one column can have this designation.
|
|
3466
|
+
* - `inline` - Content displayed inline with primary content.
|
|
3467
|
+
* - `labeled` - Each column displays as a heading-content pair.
|
|
3468
|
+
*/
|
|
3487
3469
|
export type ListSlotType =
|
|
3488
3470
|
| 'primary'
|
|
3489
3471
|
| 'secondary'
|
|
3490
3472
|
| 'kicker'
|
|
3491
3473
|
| 'inline'
|
|
3492
3474
|
| 'labeled';
|
|
3475
|
+
/**
|
|
3476
|
+
* Represents the format options for table headers that control styling and alignment of column content.
|
|
3477
|
+
*
|
|
3478
|
+
* Available values:
|
|
3479
|
+
* - `base`: Standard format for text columns
|
|
3480
|
+
* - `currency`: Right-aligned format for monetary values
|
|
3481
|
+
* - `numeric`: Right-aligned format for numeric values
|
|
3482
|
+
*/
|
|
3483
|
+
export type HeaderFormat = 'base' | 'currency' | 'numeric';
|
|
3493
3484
|
interface TableHeaderProps$1 extends GlobalProps {
|
|
3494
3485
|
/**
|
|
3495
|
-
* The
|
|
3486
|
+
* The column heading text.
|
|
3487
|
+
*
|
|
3488
|
+
* This text labels the column in table variant and appears as a label for data in list variant.
|
|
3496
3489
|
*/
|
|
3497
3490
|
children?: ComponentChildren;
|
|
3498
3491
|
/**
|
|
3499
|
-
*
|
|
3500
|
-
*
|
|
3501
|
-
* - `primary`: The most important content. Only one column can have this designation.
|
|
3502
|
-
* - `secondary`: The secondary content. Only one column can have this designation.
|
|
3503
|
-
* - `kicker`: Content that is displayed before primary and secondary content, but with less visual prominence. Only one column can have this designation.
|
|
3504
|
-
* - `inline`: Content that is displayed inline.
|
|
3505
|
-
* - `labeled`: Each column with this designation displays as a heading-content pair.
|
|
3492
|
+
* The content designation for this column when the table displays in list variant on mobile devices.
|
|
3506
3493
|
*
|
|
3507
3494
|
* @default 'labeled'
|
|
3508
3495
|
*/
|
|
3509
3496
|
listSlot?: ListSlotType;
|
|
3510
3497
|
/**
|
|
3511
|
-
* The format of the column
|
|
3512
|
-
*
|
|
3513
|
-
* - `base`: The base format for columns.
|
|
3514
|
-
* - `currency`: Formats the column as currency.
|
|
3515
|
-
* - `numeric`: Formats the column as a number.
|
|
3498
|
+
* The format of the column that controls styling and alignment of cell content.
|
|
3516
3499
|
*
|
|
3517
3500
|
* @default 'base'
|
|
3518
3501
|
*/
|
|
3519
|
-
format?:
|
|
3502
|
+
format?: HeaderFormat;
|
|
3520
3503
|
}
|
|
3521
3504
|
interface TableHeaderRowProps$1 extends GlobalProps {
|
|
3522
3505
|
/**
|
|
3523
|
-
*
|
|
3506
|
+
* The column headers displayed in the table header row.
|
|
3507
|
+
*
|
|
3508
|
+
* Accepts TableHeader components, with each header defining a column and providing its label.
|
|
3524
3509
|
*/
|
|
3525
3510
|
children?: ComponentChildren;
|
|
3526
3511
|
}
|
|
3527
3512
|
interface TableRowProps$1 extends GlobalProps {
|
|
3528
3513
|
/**
|
|
3529
|
-
* The
|
|
3514
|
+
* The data cells displayed in this table row.
|
|
3515
|
+
*
|
|
3516
|
+
* Accepts TableCell components, with each cell containing a data value for the corresponding column.
|
|
3530
3517
|
*/
|
|
3531
3518
|
children?: ComponentChildren;
|
|
3532
3519
|
/**
|
|
@@ -3537,7 +3524,7 @@ interface TableRowProps$1 extends GlobalProps {
|
|
|
3537
3524
|
* Which is why the target element must be in the table; so that keyboard and screen reader users can interact with it normally.
|
|
3538
3525
|
*
|
|
3539
3526
|
* @implementation no focus or keyboard affordances are introduced by this property. No aria attributes need to be added to the table row.
|
|
3540
|
-
* @implementation the row and/or delegate should have some affordance that indicates it is clickable. This may be a background color, a border, a hover effect
|
|
3527
|
+
* @implementation the row and/or delegate should have some affordance that indicates it is clickable. This may be a background color, a border, or a hover effect.
|
|
3541
3528
|
*/
|
|
3542
3529
|
clickDelegate?: string;
|
|
3543
3530
|
}
|
|
@@ -3548,11 +3535,11 @@ interface TextProps$1
|
|
|
3548
3535
|
DisplayProps,
|
|
3549
3536
|
Pick<InteractionProps, 'interestFor'> {
|
|
3550
3537
|
/**
|
|
3551
|
-
* The content
|
|
3538
|
+
* The text content or inline elements displayed within the component.
|
|
3552
3539
|
*/
|
|
3553
3540
|
children?: ComponentChildren;
|
|
3554
3541
|
/**
|
|
3555
|
-
*
|
|
3542
|
+
* The semantic type of the text, which provides meaning and default styling.
|
|
3556
3543
|
*
|
|
3557
3544
|
* Other presentation properties on Text override the default styling.
|
|
3558
3545
|
*
|
|
@@ -3568,11 +3555,9 @@ export type TextType =
|
|
|
3568
3555
|
*
|
|
3569
3556
|
* Surfaces may apply styling to this type.
|
|
3570
3557
|
*
|
|
3571
|
-
* In an HTML host, the text will be rendered in an `<address>` element.
|
|
3558
|
+
* In an HTML host, the text will be rendered in an `<address>` element. Learn more about the [address element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address).
|
|
3572
3559
|
*
|
|
3573
3560
|
* @implementation vertical alignment should be `baseline` (`vertical-align: baseline`)
|
|
3574
|
-
*
|
|
3575
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address
|
|
3576
3561
|
*/
|
|
3577
3562
|
| 'address'
|
|
3578
3563
|
/**
|
|
@@ -3580,8 +3565,7 @@ export type TextType =
|
|
|
3580
3565
|
*
|
|
3581
3566
|
* Surfaces should apply styling to this type to suggest its content no longer applies.
|
|
3582
3567
|
*
|
|
3583
|
-
* In an HTML host, the text will be rendered in a `<s>` element.
|
|
3584
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s
|
|
3568
|
+
* In an HTML host, the text will be rendered in a `<s>` element. Learn more about the [s element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s).
|
|
3585
3569
|
*/
|
|
3586
3570
|
| 'redundant'
|
|
3587
3571
|
/**
|
|
@@ -3590,8 +3574,7 @@ export type TextType =
|
|
|
3590
3574
|
*
|
|
3591
3575
|
* Surfaces should apply styling to this type to draw attention to the content.
|
|
3592
3576
|
*
|
|
3593
|
-
* In an HTML host, the text will be rendered in a `<mark>` element.
|
|
3594
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark
|
|
3577
|
+
* In an HTML host, the text will be rendered in a `<mark>` element. Learn more about the [mark element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark).
|
|
3595
3578
|
*/
|
|
3596
3579
|
| 'mark'
|
|
3597
3580
|
/**
|
|
@@ -3599,8 +3582,7 @@ export type TextType =
|
|
|
3599
3582
|
*
|
|
3600
3583
|
* Surfaces should apply styling to this type to distinguish it from surrounding text. Italicization is a common choice, but not required.
|
|
3601
3584
|
*
|
|
3602
|
-
* In an HTML host, the text will be rendered in an `<em>` element.
|
|
3603
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em
|
|
3585
|
+
* In an HTML host, the text will be rendered in an `<em>` element. Learn more about the [em element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em).
|
|
3604
3586
|
*/
|
|
3605
3587
|
| 'emphasis'
|
|
3606
3588
|
/**
|
|
@@ -3610,8 +3592,7 @@ export type TextType =
|
|
|
3610
3592
|
*
|
|
3611
3593
|
* Surfaces should italicize this content by default.
|
|
3612
3594
|
*
|
|
3613
|
-
* In an HTML host, the text will be rendered in a `<i>` tag.
|
|
3614
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i
|
|
3595
|
+
* In an HTML host, the text will be rendered in a `<i>` tag. Learn more about the [i element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i).
|
|
3615
3596
|
*/
|
|
3616
3597
|
| 'offset'
|
|
3617
3598
|
/**
|
|
@@ -3619,8 +3600,7 @@ export type TextType =
|
|
|
3619
3600
|
*
|
|
3620
3601
|
* Surfaces should render this content bold by default.
|
|
3621
3602
|
*
|
|
3622
|
-
* In an HTML host, the text will be rendered in a `<strong>` tag.
|
|
3623
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong
|
|
3603
|
+
* In an HTML host, the text will be rendered in a `<strong>` tag. Learn more about the [strong element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong).
|
|
3624
3604
|
*/
|
|
3625
3605
|
| 'strong'
|
|
3626
3606
|
/**
|
|
@@ -3629,8 +3609,7 @@ export type TextType =
|
|
|
3629
3609
|
*
|
|
3630
3610
|
* Surfaces should apply a smaller font size than the default size.
|
|
3631
3611
|
*
|
|
3632
|
-
* In an HTML host, the text will be rendered in a `<small>` element.
|
|
3633
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small
|
|
3612
|
+
* In an HTML host, the text will be rendered in a `<small>` element. Learn more about the [small element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small).
|
|
3634
3613
|
*/
|
|
3635
3614
|
| 'small'
|
|
3636
3615
|
/**
|
|
@@ -3638,8 +3617,7 @@ export type TextType =
|
|
|
3638
3617
|
*
|
|
3639
3618
|
* Surfaces must not apply any default styling to this type.
|
|
3640
3619
|
*
|
|
3641
|
-
* In an HTML host, the text will be rendered in a `<span>` tag.
|
|
3642
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span
|
|
3620
|
+
* In an HTML host, the text will be rendered in a `<span>` tag. Learn more about the [span element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span).
|
|
3643
3621
|
*/
|
|
3644
3622
|
| 'generic';
|
|
3645
3623
|
interface TextAreaProps$1
|
|
@@ -3648,7 +3626,7 @@ interface TextAreaProps$1
|
|
|
3648
3626
|
MinMaxLengthProps,
|
|
3649
3627
|
AutocompleteProps<TextAutocompleteField> {
|
|
3650
3628
|
/**
|
|
3651
|
-
*
|
|
3629
|
+
* The number of visible text lines displayed in the textarea, which controls its initial height.
|
|
3652
3630
|
*
|
|
3653
3631
|
* @default 2
|
|
3654
3632
|
*/
|
|
@@ -3662,19 +3640,15 @@ interface TextFieldProps$1
|
|
|
3662
3640
|
FieldDecorationProps {}
|
|
3663
3641
|
interface ThumbnailProps$1 extends GlobalProps, BaseImageProps {
|
|
3664
3642
|
/**
|
|
3665
|
-
*
|
|
3666
|
-
*
|
|
3667
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
|
|
3643
|
+
* A callback fired when the thumbnail image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload).
|
|
3668
3644
|
*/
|
|
3669
3645
|
onLoad?: (event: Event) => void;
|
|
3670
3646
|
/**
|
|
3671
|
-
*
|
|
3672
|
-
*
|
|
3673
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
|
|
3647
|
+
* A callback fired when the thumbnail image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror).
|
|
3674
3648
|
*/
|
|
3675
3649
|
onError?: (event: Event) => void;
|
|
3676
3650
|
/**
|
|
3677
|
-
*
|
|
3651
|
+
* The size of the product thumbnail image. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size.
|
|
3678
3652
|
*
|
|
3679
3653
|
* @default 'base'
|
|
3680
3654
|
*/
|
|
@@ -3682,23 +3656,29 @@ interface ThumbnailProps$1 extends GlobalProps, BaseImageProps {
|
|
|
3682
3656
|
}
|
|
3683
3657
|
interface TooltipProps$1 extends GlobalProps {
|
|
3684
3658
|
/**
|
|
3685
|
-
* The
|
|
3686
|
-
*/
|
|
3687
|
-
children?: ComponentChildren;
|
|
3688
|
-
}
|
|
3689
|
-
interface UnorderedListProps$1 extends GlobalProps {
|
|
3690
|
-
/**
|
|
3691
|
-
* The content of the UnorderededList.
|
|
3692
|
-
*
|
|
3693
|
-
* Accepts only `ListItem` components.
|
|
3659
|
+
* The text or elements displayed inside the tooltip popup.
|
|
3694
3660
|
*/
|
|
3695
3661
|
children?: ComponentChildren;
|
|
3696
3662
|
}
|
|
3663
|
+
interface UnorderedListProps$1 extends GlobalProps {}
|
|
3697
3664
|
interface URLFieldProps$1
|
|
3698
3665
|
extends GlobalProps,
|
|
3699
3666
|
BaseTextFieldProps,
|
|
3700
3667
|
MinMaxLengthProps,
|
|
3701
3668
|
AutocompleteProps<URLAutocompleteField> {}
|
|
3669
|
+
/**
|
|
3670
|
+
* Represents autocomplete values that are valid for URL input fields.
|
|
3671
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for URL inputs.
|
|
3672
|
+
*
|
|
3673
|
+
* Available values:
|
|
3674
|
+
* - `url` - General URL or web address
|
|
3675
|
+
* - `photo` - URL to a photo or image
|
|
3676
|
+
* - `impp` - Instant messaging protocol URL
|
|
3677
|
+
* - `home impp` - Home instant messaging protocol URL
|
|
3678
|
+
* - `mobile impp` - Mobile instant messaging protocol URL
|
|
3679
|
+
* - `fax impp` - Fax instant messaging protocol URL
|
|
3680
|
+
* - `pager impp` - Pager instant messaging protocol URL
|
|
3681
|
+
*/
|
|
3702
3682
|
export type URLAutocompleteField = ExtractStrict<
|
|
3703
3683
|
AnyAutocompleteField,
|
|
3704
3684
|
'url' | 'photo' | 'impp' | `${AutocompleteAddressGroup} impp`
|
|
@@ -3713,8 +3693,7 @@ export interface VNode<P = {}> {
|
|
|
3713
3693
|
};
|
|
3714
3694
|
key: Key;
|
|
3715
3695
|
/**
|
|
3716
|
-
* ref is not guaranteed by React.ReactElement
|
|
3717
|
-
* with popular react libs we define it as optional too
|
|
3696
|
+
* The ref is not guaranteed by `React.ReactElement`. For compatibility with popular React libraries, this is defined as optional.
|
|
3718
3697
|
*/
|
|
3719
3698
|
ref?: Ref<any> | null;
|
|
3720
3699
|
/**
|
|
@@ -3862,68 +3841,6 @@ export interface Context<T> extends Provider<T> {
|
|
|
3862
3841
|
Provider: Provider<T>;
|
|
3863
3842
|
displayName?: string;
|
|
3864
3843
|
}
|
|
3865
|
-
export type Styles = string;
|
|
3866
|
-
declare const shadowRootSymbol: unique symbol;
|
|
3867
|
-
export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
|
|
3868
|
-
ShadowRoot: (element: any) => ComponentChildren$1;
|
|
3869
|
-
styles?: Styles;
|
|
3870
|
-
/**
|
|
3871
|
-
* Only needed once in the root element, to inject global shadow CSS for all components.
|
|
3872
|
-
*/
|
|
3873
|
-
globalShadowCSS?: Styles;
|
|
3874
|
-
};
|
|
3875
|
-
export interface ActivationEventEsque {
|
|
3876
|
-
shiftKey: boolean;
|
|
3877
|
-
metaKey: boolean;
|
|
3878
|
-
ctrlKey: boolean;
|
|
3879
|
-
button: number;
|
|
3880
|
-
}
|
|
3881
|
-
export interface ClickOptions {
|
|
3882
|
-
/**
|
|
3883
|
-
* The event you want to influence the synthetic click.
|
|
3884
|
-
*/
|
|
3885
|
-
sourceEvent?: ActivationEventEsque;
|
|
3886
|
-
}
|
|
3887
|
-
declare const BaseClass: typeof globalThis.HTMLElement;
|
|
3888
|
-
export declare abstract class PreactCustomElement extends BaseClass {
|
|
3889
|
-
/** @private */
|
|
3890
|
-
static get observedAttributes(): string[];
|
|
3891
|
-
/** @private */
|
|
3892
|
-
[shadowRootSymbol]: ShadowRoot | null;
|
|
3893
|
-
constructor({
|
|
3894
|
-
styles,
|
|
3895
|
-
ShadowRoot: renderFunction,
|
|
3896
|
-
delegatesFocus,
|
|
3897
|
-
globalShadowCSS,
|
|
3898
|
-
...options
|
|
3899
|
-
}: RenderImpl);
|
|
3900
|
-
|
|
3901
|
-
/** @private */
|
|
3902
|
-
setAttribute(name: string, value: string): void;
|
|
3903
|
-
/** @private */
|
|
3904
|
-
attributeChangedCallback(name: string): void;
|
|
3905
|
-
/** @private */
|
|
3906
|
-
connectedCallback(): void;
|
|
3907
|
-
/** @private */
|
|
3908
|
-
disconnectedCallback(): void;
|
|
3909
|
-
/** @private */
|
|
3910
|
-
adoptedCallback(): void;
|
|
3911
|
-
/**
|
|
3912
|
-
* Queue a run of the render function.
|
|
3913
|
-
* You shouldn't need to call this manually - it should be handled by changes to @property values.
|
|
3914
|
-
* @private
|
|
3915
|
-
*/
|
|
3916
|
-
queueRender(): void;
|
|
3917
|
-
/**
|
|
3918
|
-
* Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
|
|
3919
|
-
*
|
|
3920
|
-
* For example, if the `sourceEvent` was a middle click, or has particular keys held down,
|
|
3921
|
-
* components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
|
|
3922
|
-
* @private
|
|
3923
|
-
* @param options
|
|
3924
|
-
*/
|
|
3925
|
-
click({sourceEvent}?: ClickOptions): void;
|
|
3926
|
-
}
|
|
3927
3844
|
type IconType$1 =
|
|
3928
3845
|
| 'adjust'
|
|
3929
3846
|
| 'affiliate'
|
|
@@ -3935,7 +3852,6 @@ type IconType$1 =
|
|
|
3935
3852
|
| 'alert-octagon'
|
|
3936
3853
|
| 'alert-octagon-filled'
|
|
3937
3854
|
| 'alert-triangle'
|
|
3938
|
-
| 'align-horizontal-centers'
|
|
3939
3855
|
| 'app-extension'
|
|
3940
3856
|
| 'apps'
|
|
3941
3857
|
| 'archive'
|
|
@@ -3995,7 +3911,6 @@ type IconType$1 =
|
|
|
3995
3911
|
| 'catalog-product'
|
|
3996
3912
|
| 'categories'
|
|
3997
3913
|
| 'channels'
|
|
3998
|
-
| 'channels-filled'
|
|
3999
3914
|
| 'chart-cohort'
|
|
4000
3915
|
| 'chart-donut'
|
|
4001
3916
|
| 'chart-funnel'
|
|
@@ -4360,7 +4275,6 @@ type IconType$1 =
|
|
|
4360
4275
|
| 'sort-ascending'
|
|
4361
4276
|
| 'sort-descending'
|
|
4362
4277
|
| 'sound'
|
|
4363
|
-
| 'split'
|
|
4364
4278
|
| 'sports'
|
|
4365
4279
|
| 'star'
|
|
4366
4280
|
| 'star-filled'
|