@shopify/ui-extensions 2025.10.13 → 2025.10.14
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/esm/surfaces/checkout/shared.mjs +1 -10
- package/build/esnext/surfaces/checkout/shared.esnext +1 -10
- package/build/ts/api.d.ts +23 -26
- package/build/ts/api.d.ts.map +1 -1
- package/build/ts/docs/shared/component-definitions.d.ts +32 -0
- package/build/ts/docs/shared/component-definitions.d.ts.map +1 -0
- 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/Sheet.d.ts +4 -0
- package/build/ts/docs/shared/components/Sheet.d.ts.map +1 -0
- 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/extension.d.ts +21 -0
- package/build/ts/extension.d.ts.map +1 -1
- package/build/ts/shared.d.ts +7 -5
- package/build/ts/shared.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/action/action.d.ts +7 -4
- package/build/ts/surfaces/admin/api/action/action.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/action/action.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/block/block.d.ts +12 -6
- package/build/ts/surfaces/admin/api/block/block.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/block/block.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/checkout-rules/launch-options.d.ts +21 -10
- package/build/ts/surfaces/admin/api/checkout-rules/launch-options.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts +32 -0
- package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.d.ts +5 -1
- package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts +18 -6
- package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.d.ts +5 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts +22 -4
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/metafields.d.ts +32 -0
- package/build/ts/surfaces/admin/api/discount-function-settings/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/intents/intents.d.ts +30 -35
- package/build/ts/surfaces/admin/api/intents/intents.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/intents/intents.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/order-routing-rule/data.d.ts +20 -0
- package/build/ts/surfaces/admin/api/order-routing-rule/data.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts +23 -0
- package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.d.ts +5 -0
- package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/picker/picker.d.ts +44 -16
- package/build/ts/surfaces/admin/api/picker/picker.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/picker/picker.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/print-action/print-action.d.ts +6 -3
- package/build/ts/surfaces/admin/api/print-action/print-action.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/print-action/print-action.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts +36 -0
- package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts +36 -0
- package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/purchase-options-card-action.d.ts +7 -0
- package/build/ts/surfaces/admin/api/purchase-options-card-action.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/purchase-options-card-action.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/resource-picker/resource-picker.d.ts +181 -21
- package/build/ts/surfaces/admin/api/resource-picker/resource-picker.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/resource-picker/resource-picker.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/shared.d.ts +7 -1
- package/build/ts/surfaces/admin/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/should-render/should-render.d.ts +8 -1
- package/build/ts/surfaces/admin/api/should-render/should-render.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/should-render/should-render.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/standard/standard.d.ts +20 -10
- package/build/ts/surfaces/admin/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/standard/standard.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/standard/storage.d.ts +21 -27
- package/build/ts/surfaces/admin/api/standard/storage.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ActionExtensionComponents.d.ts +3 -0
- package/build/ts/surfaces/admin/components/ActionExtensionComponents.d.ts.map +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 +53 -3
- package/build/ts/surfaces/admin/components/AdminBlock/AdminBlock.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminBlock.d.ts +49 -1
- package/build/ts/surfaces/admin/components/AdminPrintAction/AdminPrintAction.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminPrintAction.d.ts +45 -1
- package/build/ts/surfaces/admin/components/Avatar/Avatar.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Avatar.d.ts +110 -10
- package/build/ts/surfaces/admin/components/Badge/Badge.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Badge.d.ts +155 -8
- package/build/ts/surfaces/admin/components/Banner/Banner.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Banner.d.ts +101 -10
- package/build/ts/surfaces/admin/components/BlockExtensionComponents.d.ts +3 -0
- package/build/ts/surfaces/admin/components/BlockExtensionComponents.d.ts.map +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 +203 -75
- package/build/ts/surfaces/admin/components/Button/Button.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Button.d.ts +244 -16
- package/build/ts/surfaces/admin/components/ButtonGroup/ButtonGroup.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ButtonGroup.d.ts +96 -11
- package/build/ts/surfaces/admin/components/Checkbox/Checkbox.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Checkbox.d.ts +133 -4
- 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 +68 -11
- package/build/ts/surfaces/admin/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ChoiceList.d.ts +102 -6
- package/build/ts/surfaces/admin/components/Clickable/Clickable.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Clickable.d.ts +142 -41
- package/build/ts/surfaces/admin/components/ClickableChip/ClickableChip.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ClickableChip.d.ts +115 -19
- package/build/ts/surfaces/admin/components/ColorField/ColorField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ColorField.d.ts +177 -18
- package/build/ts/surfaces/admin/components/ColorPicker/ColorPicker.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/ColorPicker.d.ts +100 -5
- package/build/ts/surfaces/admin/components/DateField/DateField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/DateField.d.ts +195 -22
- package/build/ts/surfaces/admin/components/DatePicker/DatePicker.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/DatePicker.d.ts +141 -4
- package/build/ts/surfaces/admin/components/Divider/Divider.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Divider.d.ts +88 -6
- 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 +159 -7
- package/build/ts/surfaces/admin/components/Form/Form.ext.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Form.d.ts +65 -5
- package/build/ts/surfaces/admin/components/FormExtensionComponents.d.ts +3 -0
- package/build/ts/surfaces/admin/components/FormExtensionComponents.d.ts.map +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 +78 -8
- package/build/ts/surfaces/admin/components/FunctionSettingsComponents.d.ts +3 -0
- package/build/ts/surfaces/admin/components/FunctionSettingsComponents.d.ts.map +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 +249 -69
- package/build/ts/surfaces/admin/components/GridItem.d.ts +212 -33
- package/build/ts/surfaces/admin/components/Heading/Heading.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Heading.d.ts +66 -7
- package/build/ts/surfaces/admin/components/Icon/Icon.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Icon.d.ts +113 -11
- package/build/ts/surfaces/admin/components/Image/Image.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Image.d.ts +235 -36
- package/build/ts/surfaces/admin/components/Link/Link.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Link.d.ts +76 -16
- package/build/ts/surfaces/admin/components/ListItem.d.ts +59 -7
- package/build/ts/surfaces/admin/components/Menu/Menu.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Menu.d.ts +101 -21
- package/build/ts/surfaces/admin/components/MoneyField/MoneyField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/MoneyField.d.ts +158 -7
- package/build/ts/surfaces/admin/components/NumberField/NumberField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/NumberField.d.ts +170 -7
- package/build/ts/surfaces/admin/components/Option.d.ts +62 -5
- package/build/ts/surfaces/admin/components/OptionGroup.d.ts +56 -7
- package/build/ts/surfaces/admin/components/OrderedList/OrderedList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/OrderedList.d.ts +57 -9
- package/build/ts/surfaces/admin/components/Paragraph/Paragraph.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Paragraph.d.ts +100 -11
- package/build/ts/surfaces/admin/components/PasswordField/PasswordField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/PasswordField.d.ts +166 -14
- package/build/ts/surfaces/admin/components/PrintActionExtensionComponents.d.ts +3 -0
- package/build/ts/surfaces/admin/components/PrintActionExtensionComponents.d.ts.map +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 +65 -7
- package/build/ts/surfaces/admin/components/SearchField/SearchField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/SearchField.d.ts +150 -4
- package/build/ts/surfaces/admin/components/Section/Section.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Section.d.ts +81 -8
- package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Select.d.ts +145 -6
- package/build/ts/surfaces/admin/components/Spinner/Spinner.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Spinner.d.ts +67 -5
- package/build/ts/surfaces/admin/components/Stack/Stack.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Stack.d.ts +239 -61
- package/build/ts/surfaces/admin/components/StandardComponents.d.ts +3 -0
- package/build/ts/surfaces/admin/components/StandardComponents.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Switch/Switch.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Switch.d.ts +124 -4
- package/build/ts/surfaces/admin/components/Table/Table.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Table.d.ts +144 -13
- package/build/ts/surfaces/admin/components/TableBody.d.ts +62 -7
- package/build/ts/surfaces/admin/components/TableCell.d.ts +66 -7
- package/build/ts/surfaces/admin/components/TableHeader.d.ts +77 -7
- package/build/ts/surfaces/admin/components/TableHeaderRow.d.ts +62 -7
- package/build/ts/surfaces/admin/components/TableRow.d.ts +65 -7
- package/build/ts/surfaces/admin/components/Text/Text.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Text.d.ts +129 -9
- package/build/ts/surfaces/admin/components/TextArea/TextArea.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/TextArea.d.ts +157 -7
- package/build/ts/surfaces/admin/components/TextField/TextField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/TextField.d.ts +170 -19
- package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Thumbnail.d.ts +103 -10
- package/build/ts/surfaces/admin/components/Tooltip/Tooltip.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Tooltip.d.ts +98 -21
- package/build/ts/surfaces/admin/components/URLField/URLField.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/URLField.d.ts +171 -14
- package/build/ts/surfaces/admin/components/UnorderedList/UnorderedList.doc.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/UnorderedList.d.ts +57 -9
- package/build/ts/surfaces/admin/components/shared.d.ts +842 -772
- package/build/ts/surfaces/admin/extension-targets.d.ts +85 -169
- package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -1
- 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 +353 -318
- 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/point-of-sale/api/pin-pad-api.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/Badge/Badge.doc.d.ts.map +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/EmailField.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/Icon/Icon.doc.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/Image/Image.doc.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/Modal/Modal.doc.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/Page/Page.doc.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/Stack/Stack.doc.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +10 -10
- package/build/ts/surfaces/point-of-sale/components/Text/Text.doc.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/Text.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/TextArea.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/Tile/Tile.doc.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +11 -11
- 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/api.ts +23 -26
- package/src/docs/shared/component-definitions.ts +200 -0
- 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 +1 -1
- 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 +5 -4
- package/src/docs/shared/components/Page.ts +2 -2
- 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 +1 -1
- 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 +14 -0
- 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 +4 -3
- package/src/docs/shared/components/URLField.ts +4 -3
- package/src/docs/shared/components/UnorderedList.ts +5 -4
- package/src/extension.ts +21 -0
- package/src/shared.ts +7 -5
- package/src/surfaces/admin/api/action/action.ts +7 -4
- package/src/surfaces/admin/api/action/examples/handle-errors.jsx +47 -0
- package/src/surfaces/admin/api/action/examples/process-selected-products.jsx +33 -0
- package/src/surfaces/admin/api/action/examples/select-additional-resources.jsx +46 -0
- package/src/surfaces/admin/api/block/block.ts +12 -6
- package/src/surfaces/admin/api/block/examples/display-product-info.jsx +46 -0
- package/src/surfaces/admin/api/block/examples/navigate-to-action.jsx +50 -0
- package/src/surfaces/admin/api/block/examples/select-related-products.jsx +46 -0
- package/src/surfaces/admin/api/checkout-rules/examples/configure-shipping-restrictions.jsx +52 -0
- package/src/surfaces/admin/api/checkout-rules/examples/load-validation-config.jsx +55 -0
- package/src/surfaces/admin/api/checkout-rules/examples/set-minimum-quantity.jsx +40 -0
- package/src/surfaces/admin/api/checkout-rules/launch-options.ts +22 -10
- package/src/surfaces/admin/api/checkout-rules/metafields.ts +35 -0
- package/src/surfaces/admin/api/checkout-rules/validation-settings.ts +5 -1
- package/src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts +19 -7
- package/src/surfaces/admin/api/customer-segment-template/examples/abandoned-cart-recovery.jsx +30 -0
- package/src/surfaces/admin/api/customer-segment-template/examples/birthday-this-month.jsx +32 -0
- package/src/surfaces/admin/api/customer-segment-template/examples/high-value-customers.jsx +27 -0
- package/src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts +5 -1
- package/src/surfaces/admin/api/discount-function-settings/examples/configure-discount-threshold.jsx +39 -0
- package/src/surfaces/admin/api/discount-function-settings/examples/configure-eligibility-rules.jsx +45 -0
- package/src/surfaces/admin/api/discount-function-settings/examples/load-existing-settings.jsx +45 -0
- package/src/surfaces/admin/api/discount-function-settings/launch-options.ts +22 -4
- package/src/surfaces/admin/api/discount-function-settings/metafields.ts +35 -0
- package/src/surfaces/admin/api/intents/examples/create-article.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-catalog.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-collection.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-customer.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-discount.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-market.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-menu.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-metafield-definition.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-metaobject-definition.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-metaobject.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-page.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/create-product.jsx +37 -0
- package/src/surfaces/admin/api/intents/examples/create-variant.jsx +35 -0
- package/src/surfaces/admin/api/intents/examples/edit-article.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-catalog.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-collection.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-customer.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-discount.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-market.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-menu.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-metafield-definition.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-metaobject-definition.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-metaobject.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-page.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-product.jsx +41 -0
- package/src/surfaces/admin/api/intents/examples/edit-variant.jsx +41 -0
- package/src/surfaces/admin/api/intents/intents.ts +30 -35
- package/src/surfaces/admin/api/order-routing-rule/data.ts +20 -0
- package/src/surfaces/admin/api/order-routing-rule/examples/configure-location-priority.jsx +46 -0
- package/src/surfaces/admin/api/order-routing-rule/examples/remove-deprecated-settings.jsx +35 -0
- package/src/surfaces/admin/api/order-routing-rule/examples/set-routing-criteria.jsx +57 -0
- package/src/surfaces/admin/api/order-routing-rule/metafields.ts +24 -0
- package/src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts +5 -0
- package/src/surfaces/admin/api/picker/examples/direct-api.jsx +42 -0
- package/src/surfaces/admin/api/picker/examples/disabled.jsx +23 -0
- package/src/surfaces/admin/api/picker/examples/minimal.jsx +37 -0
- package/src/surfaces/admin/api/picker/examples/multiple-limit.jsx +26 -0
- package/src/surfaces/admin/api/picker/examples/multiple-true.jsx +25 -0
- package/src/surfaces/admin/api/picker/examples/preselected.jsx +23 -0
- package/src/surfaces/admin/api/picker/examples/template-picker.jsx +58 -0
- package/src/surfaces/admin/api/picker/picker.ts +46 -16
- package/src/surfaces/admin/api/print-action/examples/custom-product-labels.jsx +47 -0
- package/src/surfaces/admin/api/print-action/examples/generate-packing-slip.jsx +34 -0
- package/src/surfaces/admin/api/print-action/examples/shipping-manifest.jsx +57 -0
- package/src/surfaces/admin/api/print-action/print-action.ts +6 -3
- package/src/surfaces/admin/api/product-configuration/examples/create-variant-component.jsx +56 -0
- package/src/surfaces/admin/api/product-configuration/examples/load-bundle-config.jsx +47 -0
- package/src/surfaces/admin/api/product-configuration/examples/load-variant-bundle-config.jsx +54 -0
- package/src/surfaces/admin/api/product-configuration/examples/navigate-to-component.jsx +27 -0
- package/src/surfaces/admin/api/product-configuration/examples/select-bundle-components.jsx +50 -0
- package/src/surfaces/admin/api/product-configuration/examples/select-variant-components.jsx +50 -0
- package/src/surfaces/admin/api/product-configuration/product-details-configuration.ts +36 -6
- package/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts +36 -6
- package/src/surfaces/admin/api/purchase-options-card/examples/manage-subscription.jsx +45 -0
- package/src/surfaces/admin/api/purchase-options-card/examples/remove-from-plan.jsx +44 -0
- package/src/surfaces/admin/api/purchase-options-card/examples/validate-selling-plan.jsx +47 -0
- package/src/surfaces/admin/api/purchase-options-card-action.ts +11 -1
- package/src/surfaces/admin/api/resource-picker/examples/action.jsx +25 -0
- package/src/surfaces/admin/api/resource-picker/examples/collection-picker.jsx +22 -0
- package/src/surfaces/admin/api/resource-picker/examples/filter-query.jsx +22 -0
- package/src/surfaces/admin/api/resource-picker/examples/filters.jsx +27 -0
- package/src/surfaces/admin/api/resource-picker/examples/multiple-limited.jsx +25 -0
- package/src/surfaces/admin/api/resource-picker/examples/multiple-unlimited.jsx +25 -0
- package/src/surfaces/admin/api/resource-picker/examples/product-picker.jsx +22 -0
- package/src/surfaces/admin/api/resource-picker/examples/product-variant-picker.jsx +22 -0
- package/src/surfaces/admin/api/resource-picker/examples/query.jsx +25 -0
- package/src/surfaces/admin/api/resource-picker/examples/selection-ids.jsx +28 -0
- package/src/surfaces/admin/api/resource-picker/examples/selection.jsx +22 -0
- package/src/surfaces/admin/api/resource-picker/resource-picker.ts +181 -21
- package/src/surfaces/admin/api/shared.ts +7 -1
- package/src/surfaces/admin/api/should-render/examples/bulk-selection-check.jsx +8 -0
- package/src/surfaces/admin/api/should-render/examples/check-order-status.jsx +7 -0
- package/src/surfaces/admin/api/should-render/examples/check-product-tag.jsx +7 -0
- package/src/surfaces/admin/api/should-render/should-render.ts +8 -1
- package/src/surfaces/admin/api/standard/examples/authenticate-backend-request.jsx +40 -0
- package/src/surfaces/admin/api/standard/examples/persist-settings.jsx +43 -0
- package/src/surfaces/admin/api/standard/examples/query-and-mutate.jsx +75 -0
- package/src/surfaces/admin/api/standard/standard.ts +20 -10
- package/src/surfaces/admin/api/standard/storage.ts +21 -27
- package/src/surfaces/admin/components/ActionExtensionComponents.ts +3 -0
- 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 +53 -3
- 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 +49 -1
- 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 +45 -1
- package/src/surfaces/admin/components/Avatar.d.ts +110 -10
- package/src/surfaces/admin/components/Badge.d.ts +155 -8
- package/src/surfaces/admin/components/Banner.d.ts +101 -10
- package/src/surfaces/admin/components/BlockExtensionComponents.ts +3 -0
- 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 +203 -75
- 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 +244 -16
- package/src/surfaces/admin/components/ButtonGroup.d.ts +96 -11
- 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 +133 -4
- 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 +68 -11
- 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 +102 -6
- package/src/surfaces/admin/components/Clickable.d.ts +142 -41
- package/src/surfaces/admin/components/ClickableChip.d.ts +115 -19
- 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 +177 -18
- package/src/surfaces/admin/components/ColorPicker/examples/default.html +1 -1
- package/src/surfaces/admin/components/ColorPicker.d.ts +100 -5
- package/src/surfaces/admin/components/DateField.d.ts +195 -22
- package/src/surfaces/admin/components/DatePicker.d.ts +141 -4
- package/src/surfaces/admin/components/Divider.d.ts +88 -6
- 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 +159 -7
- 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 +65 -5
- package/src/surfaces/admin/components/FormExtensionComponents.ts +3 -0
- 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 +78 -8
- package/src/surfaces/admin/components/FunctionSettingsComponents.ts +3 -0
- package/src/surfaces/admin/components/Grid.d.ts +249 -69
- package/src/surfaces/admin/components/GridItem.d.ts +212 -33
- package/src/surfaces/admin/components/Heading.d.ts +66 -7
- package/src/surfaces/admin/components/Icon.d.ts +113 -11
- package/src/surfaces/admin/components/Image/examples/basic-usage.html +15 -4
- package/src/surfaces/admin/components/Image.d.ts +235 -36
- package/src/surfaces/admin/components/Link/examples/default.html +1 -1
- package/src/surfaces/admin/components/Link.d.ts +76 -16
- package/src/surfaces/admin/components/ListItem.d.ts +59 -7
- 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 +101 -21
- package/src/surfaces/admin/components/MoneyField/examples/basic-field.html +0 -1
- package/src/surfaces/admin/components/MoneyField.d.ts +158 -7
- 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 +170 -7
- package/src/surfaces/admin/components/Option.d.ts +62 -5
- package/src/surfaces/admin/components/OptionGroup.d.ts +56 -7
- package/src/surfaces/admin/components/OrderedList/examples/default.html +3 -3
- package/src/surfaces/admin/components/OrderedList.d.ts +57 -9
- 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 +100 -11
- package/src/surfaces/admin/components/PasswordField.d.ts +166 -14
- package/src/surfaces/admin/components/PrintActionExtensionComponents.ts +3 -0
- package/src/surfaces/admin/components/QueryContainer.d.ts +65 -7
- package/src/surfaces/admin/components/SearchField.d.ts +150 -4
- package/src/surfaces/admin/components/Section.d.ts +81 -8
- 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 +145 -6
- package/src/surfaces/admin/components/Spinner/examples/spinner-sizes.html +5 -0
- package/src/surfaces/admin/components/Spinner.d.ts +67 -5
- package/src/surfaces/admin/components/Stack.d.ts +239 -61
- package/src/surfaces/admin/components/StandardComponents.ts +3 -0
- 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 +124 -4
- package/src/surfaces/admin/components/Table/examples/{basic-usage.jsx → with-filters.html} +2 -13
- package/src/surfaces/admin/components/Table.d.ts +144 -13
- package/src/surfaces/admin/components/TableBody.d.ts +62 -7
- package/src/surfaces/admin/components/TableCell.d.ts +66 -7
- package/src/surfaces/admin/components/TableHeader.d.ts +77 -7
- package/src/surfaces/admin/components/TableHeaderRow.d.ts +62 -7
- package/src/surfaces/admin/components/TableRow.d.ts +65 -7
- package/src/surfaces/admin/components/Text.d.ts +129 -9
- package/src/surfaces/admin/components/TextArea/examples/disabled-and-read-only.html +15 -0
- package/src/surfaces/admin/components/TextArea.d.ts +157 -7
- package/src/surfaces/admin/components/TextField/examples/disabled-and-read-only.html +13 -0
- package/src/surfaces/admin/components/TextField.d.ts +170 -19
- 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 +103 -10
- 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 +98 -21
- 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 +171 -14
- package/src/surfaces/admin/components/UnorderedList.d.ts +57 -9
- package/src/surfaces/admin/components/shared.d.ts +842 -772
- package/src/surfaces/admin/components.d.ts +2550 -1100
- package/src/surfaces/admin/extension-targets.ts +85 -169
- 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 +360 -318
- 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/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/EmailField.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/TextArea.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 +11 -11
- package/src/surfaces/point-of-sale/components.d.ts +43 -43
- package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +23 -2
- package/src/surfaces/admin/api/intents/examples/create-article.js +0 -9
- package/src/surfaces/admin/api/intents/examples/create-catalog.js +0 -9
- package/src/surfaces/admin/api/intents/examples/create-collection.js +0 -9
- package/src/surfaces/admin/api/intents/examples/create-customer.js +0 -9
- package/src/surfaces/admin/api/intents/examples/create-discount.js +0 -11
- package/src/surfaces/admin/api/intents/examples/create-market.js +0 -9
- package/src/surfaces/admin/api/intents/examples/create-menu.js +0 -9
- package/src/surfaces/admin/api/intents/examples/create-metafield-definition.js +0 -11
- package/src/surfaces/admin/api/intents/examples/create-metaobject-definition.js +0 -9
- package/src/surfaces/admin/api/intents/examples/create-metaobject.js +0 -11
- package/src/surfaces/admin/api/intents/examples/create-page.js +0 -9
- package/src/surfaces/admin/api/intents/examples/create-product.js +0 -9
- package/src/surfaces/admin/api/intents/examples/create-variant.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-article.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-catalog.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-collection.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-customer.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-discount.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-market.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-menu.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-metafield-definition.js +0 -12
- package/src/surfaces/admin/api/intents/examples/edit-metaobject-definition.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-metaobject.js +0 -12
- package/src/surfaces/admin/api/intents/examples/edit-page.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-product.js +0 -11
- package/src/surfaces/admin/api/intents/examples/edit-variant.js +0 -12
- package/src/surfaces/admin/api/picker/examples/direct-api.js +0 -73
- package/src/surfaces/admin/api/picker/examples/disabled.js +0 -16
- package/src/surfaces/admin/api/picker/examples/minimal.js +0 -16
- package/src/surfaces/admin/api/picker/examples/multiple-limit.js +0 -21
- package/src/surfaces/admin/api/picker/examples/multiple-true.js +0 -21
- package/src/surfaces/admin/api/picker/examples/preselected.js +0 -16
- package/src/surfaces/admin/api/picker/examples/template-picker.js +0 -37
- package/src/surfaces/admin/api/resource-picker/examples/action.js +0 -4
- package/src/surfaces/admin/api/resource-picker/examples/collection-picker.js +0 -1
- package/src/surfaces/admin/api/resource-picker/examples/filter-query.js +0 -6
- package/src/surfaces/admin/api/resource-picker/examples/filters.js +0 -9
- package/src/surfaces/admin/api/resource-picker/examples/multiple-limited.js +0 -4
- package/src/surfaces/admin/api/resource-picker/examples/multiple-unlimited.js +0 -4
- package/src/surfaces/admin/api/resource-picker/examples/product-picker.js +0 -3
- package/src/surfaces/admin/api/resource-picker/examples/product-variant-picker.js +0 -1
- package/src/surfaces/admin/api/resource-picker/examples/query.js +0 -4
- package/src/surfaces/admin/api/resource-picker/examples/selection-ids.js +0 -16
- package/src/surfaces/admin/api/resource-picker/examples/selection.js +0 -7
- 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/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/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/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
|
@@ -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
|
*/
|
|
@@ -814,12 +827,35 @@ export type IconType = (typeof privateIconArray)[number];
|
|
|
814
827
|
* Like `Extract`, but ensures that the extracted type is a strict subtype of the input type.
|
|
815
828
|
*/
|
|
816
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
|
+
*/
|
|
817
839
|
export type MaybeAllValuesShorthandProperty<T extends string> =
|
|
818
840
|
| T
|
|
819
841
|
| `${T} ${T}`
|
|
820
842
|
| `${T} ${T} ${T}`
|
|
821
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
|
+
*/
|
|
822
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
|
+
*/
|
|
823
859
|
export type MaybeResponsive<T> = T | `@container${string}`;
|
|
824
860
|
/**
|
|
825
861
|
* Prevents widening string literal types in a union to `string`.
|
|
@@ -839,33 +875,45 @@ export type AnyString = string & {};
|
|
|
839
875
|
export type optionalSpace = '' | ' ';
|
|
840
876
|
interface BadgeProps$1 extends GlobalProps {
|
|
841
877
|
/**
|
|
842
|
-
* The
|
|
878
|
+
* The text or elements displayed inside the badge component.
|
|
843
879
|
*/
|
|
844
880
|
children?: ComponentChildren;
|
|
845
881
|
/**
|
|
846
|
-
*
|
|
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.
|
|
847
891
|
*
|
|
848
892
|
* @default 'auto'
|
|
849
893
|
*/
|
|
850
894
|
tone?: ToneKeyword;
|
|
851
895
|
/**
|
|
852
|
-
*
|
|
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.
|
|
853
900
|
*
|
|
854
901
|
* @default 'base'
|
|
855
902
|
*/
|
|
856
903
|
color?: ColorKeyword;
|
|
857
904
|
/**
|
|
858
|
-
*
|
|
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.
|
|
859
907
|
*
|
|
860
908
|
* @default ''
|
|
861
909
|
*/
|
|
862
910
|
icon?: IconType | AnyString;
|
|
863
911
|
/**
|
|
864
|
-
* 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.
|
|
865
913
|
*/
|
|
866
914
|
iconPosition?: 'start' | 'end';
|
|
867
915
|
/**
|
|
868
|
-
*
|
|
916
|
+
* The size of the badge. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size.
|
|
869
917
|
*
|
|
870
918
|
* @default 'base'
|
|
871
919
|
*/
|
|
@@ -873,42 +921,42 @@ interface BadgeProps$1 extends GlobalProps {
|
|
|
873
921
|
}
|
|
874
922
|
interface BannerProps$1 extends GlobalProps, ActionSlots {
|
|
875
923
|
/**
|
|
876
|
-
* The
|
|
924
|
+
* The heading text displayed at the top of the banner to summarize the message or alert.
|
|
877
925
|
*
|
|
878
926
|
* @default ''
|
|
879
927
|
*/
|
|
880
928
|
heading?: string;
|
|
881
929
|
/**
|
|
882
|
-
* The content
|
|
930
|
+
* The main content displayed within the banner component, typically descriptive text or other elements providing details about the message or alert.
|
|
883
931
|
*/
|
|
884
932
|
children?: ComponentChildren;
|
|
885
933
|
/**
|
|
886
|
-
*
|
|
887
|
-
*
|
|
888
|
-
* The banner is a live region and the type of status will be dictated by the Tone selected.
|
|
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
|
-
* - `
|
|
891
|
-
* - `neutral
|
|
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.
|
|
892
943
|
*
|
|
893
|
-
*
|
|
894
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role
|
|
895
|
-
* @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.
|
|
896
945
|
*
|
|
897
946
|
* @default 'auto'
|
|
898
947
|
*/
|
|
899
948
|
tone?: ToneKeyword;
|
|
900
949
|
/**
|
|
901
|
-
*
|
|
902
|
-
* 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.
|
|
903
951
|
*
|
|
904
952
|
* @default false
|
|
905
953
|
*/
|
|
906
954
|
collapsible?: boolean;
|
|
907
955
|
/**
|
|
908
|
-
*
|
|
956
|
+
* Whether the banner displays a close button that allows users to dismiss it.
|
|
909
957
|
*
|
|
910
958
|
* When the close button is pressed, the `dismiss` event will fire,
|
|
911
|
-
* then `hidden` will be true
|
|
959
|
+
* then `hidden` will be set to `true`,
|
|
912
960
|
* any animation will complete,
|
|
913
961
|
* and the `afterhide` event will fire.
|
|
914
962
|
*
|
|
@@ -916,17 +964,17 @@ interface BannerProps$1 extends GlobalProps, ActionSlots {
|
|
|
916
964
|
*/
|
|
917
965
|
dismissible?: boolean;
|
|
918
966
|
/**
|
|
919
|
-
*
|
|
967
|
+
* A callback that fires when the banner is dismissed by the user clicking the close button.
|
|
920
968
|
*
|
|
921
|
-
* This
|
|
969
|
+
* This doesn't fire when setting `hidden` manually.
|
|
922
970
|
*
|
|
923
|
-
* The `hidden` property
|
|
971
|
+
* The `hidden` property is `false` when this event fires.
|
|
924
972
|
*/
|
|
925
973
|
onDismiss?: (event: Event) => void;
|
|
926
974
|
/**
|
|
927
|
-
*
|
|
975
|
+
* A callback that fires when the banner has fully hidden, including after any hide animations have completed.
|
|
928
976
|
*
|
|
929
|
-
* The `hidden` property
|
|
977
|
+
* The `hidden` property is `true` when this event fires.
|
|
930
978
|
*
|
|
931
979
|
* @implementation If implementations animate the hiding of the banner,
|
|
932
980
|
* this event must fire after the banner has fully hidden.
|
|
@@ -934,13 +982,12 @@ interface BannerProps$1 extends GlobalProps, ActionSlots {
|
|
|
934
982
|
*/
|
|
935
983
|
onAfterHide?: (event: Event) => void;
|
|
936
984
|
/**
|
|
937
|
-
*
|
|
985
|
+
* Controls whether the banner is visible or hidden.
|
|
938
986
|
*
|
|
939
|
-
*
|
|
940
|
-
*
|
|
941
|
-
* 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.
|
|
942
989
|
*
|
|
943
|
-
*
|
|
990
|
+
* You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.
|
|
944
991
|
*
|
|
945
992
|
* @default false
|
|
946
993
|
*/
|
|
@@ -953,7 +1000,8 @@ export interface DisplayProps {
|
|
|
953
1000
|
* - `auto`: the component’s initial value. The actual value depends on the component and context.
|
|
954
1001
|
* - `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
|
|
955
1002
|
*
|
|
956
|
-
*
|
|
1003
|
+
* Learn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).
|
|
1004
|
+
*
|
|
957
1005
|
* @default 'auto'
|
|
958
1006
|
*/
|
|
959
1007
|
display?: MaybeResponsive<'auto' | 'none'>;
|
|
@@ -971,6 +1019,36 @@ export interface AccessibilityRoleProps {
|
|
|
971
1019
|
*/
|
|
972
1020
|
accessibilityRole?: AccessibilityRole;
|
|
973
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
|
+
*/
|
|
974
1052
|
export type AccessibilityRole =
|
|
975
1053
|
/**
|
|
976
1054
|
* Used to indicate the primary content.
|
|
@@ -995,7 +1073,7 @@ export type AccessibilityRole =
|
|
|
995
1073
|
| 'footer'
|
|
996
1074
|
/**
|
|
997
1075
|
* Used to indicate a generic section.
|
|
998
|
-
* Sections should always have a
|
|
1076
|
+
* Sections should always have a heading or an accessible name provided in the `accessibilityLabel` property.
|
|
999
1077
|
*
|
|
1000
1078
|
* In an HTML host `section` will render a `<section>` element.
|
|
1001
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.
|
|
@@ -1088,11 +1166,11 @@ export type AccessibilityRole =
|
|
|
1088
1166
|
| 'none';
|
|
1089
1167
|
export interface AccessibilityVisibilityProps {
|
|
1090
1168
|
/**
|
|
1091
|
-
*
|
|
1169
|
+
* Controls the visibility of the element for both visual and assistive technology users.
|
|
1092
1170
|
*
|
|
1093
|
-
* - `visible`:
|
|
1094
|
-
* - `hidden`:
|
|
1095
|
-
* - `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.
|
|
1096
1174
|
*
|
|
1097
1175
|
* @default 'visible'
|
|
1098
1176
|
*/
|
|
@@ -1100,10 +1178,13 @@ export interface AccessibilityVisibilityProps {
|
|
|
1100
1178
|
}
|
|
1101
1179
|
export interface LabelAccessibilityVisibilityProps {
|
|
1102
1180
|
/**
|
|
1103
|
-
*
|
|
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.
|
|
1104
1185
|
*
|
|
1105
|
-
*
|
|
1106
|
-
*
|
|
1186
|
+
* Use `exclusive` when the surrounding context makes the label redundant visually,
|
|
1187
|
+
* but screen reader users still need it for clarity.
|
|
1107
1188
|
*
|
|
1108
1189
|
* @default 'visible'
|
|
1109
1190
|
*/
|
|
@@ -1112,35 +1193,38 @@ export interface LabelAccessibilityVisibilityProps {
|
|
|
1112
1193
|
'visible' | 'exclusive'
|
|
1113
1194
|
>;
|
|
1114
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
|
+
*/
|
|
1115
1202
|
export type PaddingKeyword = SizeKeyword | 'none';
|
|
1116
1203
|
export interface PaddingProps {
|
|
1117
1204
|
/**
|
|
1118
|
-
*
|
|
1119
|
-
*
|
|
1120
|
-
* [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
|
|
1121
|
-
* 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.
|
|
1122
1206
|
*
|
|
1123
|
-
* -
|
|
1124
|
-
* -
|
|
1125
|
-
* - 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)
|
|
1126
1212
|
*
|
|
1127
|
-
*
|
|
1128
|
-
* - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
|
|
1129
|
-
* - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
|
|
1130
|
-
* - `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`.
|
|
1131
|
-
* - `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`
|
|
1132
1214
|
*
|
|
1133
|
-
*
|
|
1215
|
+
* Use `auto` to inherit padding from the nearest container with removed padding.
|
|
1134
1216
|
*
|
|
1135
1217
|
* @default 'none'
|
|
1136
1218
|
*/
|
|
1137
1219
|
padding?: MaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>;
|
|
1138
1220
|
/**
|
|
1139
|
-
*
|
|
1221
|
+
* The block-direction padding (top and bottom in horizontal writing modes).
|
|
1140
1222
|
*
|
|
1141
|
-
* -
|
|
1223
|
+
* Accepts a single value for both sides or two space-separated values for block-start and block-end.
|
|
1142
1224
|
*
|
|
1143
|
-
*
|
|
1225
|
+
* **Example:** `large none` applies `large` to the top and `none` to the bottom.
|
|
1226
|
+
*
|
|
1227
|
+
* Overrides the block value from `padding`.
|
|
1144
1228
|
*
|
|
1145
1229
|
* @default '' - meaning no override
|
|
1146
1230
|
*/
|
|
@@ -1148,27 +1232,29 @@ export interface PaddingProps {
|
|
|
1148
1232
|
MaybeTwoValuesShorthandProperty<PaddingKeyword> | ''
|
|
1149
1233
|
>;
|
|
1150
1234
|
/**
|
|
1151
|
-
*
|
|
1235
|
+
* The block-start padding (top in horizontal writing modes).
|
|
1152
1236
|
*
|
|
1153
|
-
*
|
|
1237
|
+
* Overrides the block-start value from `paddingBlock`.
|
|
1154
1238
|
*
|
|
1155
1239
|
* @default '' - meaning no override
|
|
1156
1240
|
*/
|
|
1157
1241
|
paddingBlockStart?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1158
1242
|
/**
|
|
1159
|
-
*
|
|
1243
|
+
* The block-end padding (bottom in horizontal writing modes).
|
|
1160
1244
|
*
|
|
1161
|
-
*
|
|
1245
|
+
* Overrides the block-end value from `paddingBlock`.
|
|
1162
1246
|
*
|
|
1163
1247
|
* @default '' - meaning no override
|
|
1164
1248
|
*/
|
|
1165
1249
|
paddingBlockEnd?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1166
1250
|
/**
|
|
1167
|
-
*
|
|
1251
|
+
* The inline-direction padding (left and right in horizontal writing modes).
|
|
1252
|
+
*
|
|
1253
|
+
* Accepts a single value for both sides or two space-separated values for inline-start and inline-end.
|
|
1168
1254
|
*
|
|
1169
|
-
*
|
|
1255
|
+
* **Example:** `large none` applies `large` to the left and `none` to the right.
|
|
1170
1256
|
*
|
|
1171
|
-
*
|
|
1257
|
+
* Overrides the inline value from `padding`.
|
|
1172
1258
|
*
|
|
1173
1259
|
* @default '' - meaning no override
|
|
1174
1260
|
*/
|
|
@@ -1176,70 +1262,83 @@ export interface PaddingProps {
|
|
|
1176
1262
|
MaybeTwoValuesShorthandProperty<PaddingKeyword> | ''
|
|
1177
1263
|
>;
|
|
1178
1264
|
/**
|
|
1179
|
-
*
|
|
1265
|
+
* The inline-start padding (left in LTR writing modes, right in RTL).
|
|
1180
1266
|
*
|
|
1181
|
-
*
|
|
1267
|
+
* Overrides the inline-start value from `paddingInline`.
|
|
1182
1268
|
*
|
|
1183
1269
|
* @default '' - meaning no override
|
|
1184
1270
|
*/
|
|
1185
1271
|
paddingInlineStart?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1186
1272
|
/**
|
|
1187
|
-
*
|
|
1273
|
+
* The inline-end padding (right in LTR writing modes, left in RTL).
|
|
1188
1274
|
*
|
|
1189
|
-
*
|
|
1275
|
+
* Overrides the inline-end value from `paddingInline`.
|
|
1190
1276
|
*
|
|
1191
1277
|
* @default '' - meaning no override
|
|
1192
1278
|
*/
|
|
1193
1279
|
paddingInlineEnd?: MaybeResponsive<PaddingKeyword | ''>;
|
|
1194
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
|
+
*/
|
|
1195
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
|
+
*/
|
|
1196
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
|
+
*/
|
|
1197
1302
|
export type SizeUnitsOrNone = SizeUnits | 'none';
|
|
1198
1303
|
export interface SizingProps {
|
|
1199
1304
|
/**
|
|
1200
|
-
*
|
|
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).
|
|
1201
1306
|
*
|
|
1202
|
-
*
|
|
1307
|
+
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1308
|
+
* - `auto`: Automatically sizes based on content and layout constraints.
|
|
1203
1309
|
*
|
|
1204
1310
|
* @default 'auto'
|
|
1205
1311
|
*/
|
|
1206
1312
|
blockSize?: MaybeResponsive<SizeUnitsOrAuto>;
|
|
1207
1313
|
/**
|
|
1208
|
-
*
|
|
1209
|
-
*
|
|
1210
|
-
* @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).
|
|
1211
1315
|
*
|
|
1212
1316
|
* @default '0'
|
|
1213
1317
|
*/
|
|
1214
1318
|
minBlockSize?: MaybeResponsive<SizeUnits>;
|
|
1215
1319
|
/**
|
|
1216
|
-
*
|
|
1217
|
-
*
|
|
1218
|
-
* @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).
|
|
1219
1321
|
*
|
|
1220
1322
|
* @default 'none'
|
|
1221
1323
|
*/
|
|
1222
1324
|
maxBlockSize?: MaybeResponsive<SizeUnitsOrNone>;
|
|
1223
1325
|
/**
|
|
1224
|
-
*
|
|
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).
|
|
1225
1327
|
*
|
|
1226
|
-
*
|
|
1328
|
+
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1329
|
+
* - `auto`: Automatically sizes based on content and layout constraints.
|
|
1227
1330
|
*
|
|
1228
1331
|
* @default 'auto'
|
|
1229
1332
|
*/
|
|
1230
1333
|
inlineSize?: MaybeResponsive<SizeUnitsOrAuto>;
|
|
1231
1334
|
/**
|
|
1232
|
-
*
|
|
1233
|
-
*
|
|
1234
|
-
* @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).
|
|
1235
1336
|
*
|
|
1236
1337
|
* @default '0'
|
|
1237
1338
|
*/
|
|
1238
1339
|
minInlineSize?: MaybeResponsive<SizeUnits>;
|
|
1239
1340
|
/**
|
|
1240
|
-
*
|
|
1241
|
-
*
|
|
1242
|
-
* @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).
|
|
1243
1342
|
*
|
|
1244
1343
|
* @default 'none'
|
|
1245
1344
|
*/
|
|
@@ -1251,6 +1350,12 @@ export type BorderStyleKeyword =
|
|
|
1251
1350
|
| 'dashed'
|
|
1252
1351
|
| 'dotted'
|
|
1253
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
|
+
*/
|
|
1254
1359
|
export type BorderSizeKeyword = SizeKeyword | 'none';
|
|
1255
1360
|
export type BorderRadiusKeyword = SizeKeyword | 'max' | 'none';
|
|
1256
1361
|
/**
|
|
@@ -1262,15 +1367,12 @@ export type BorderShorthand =
|
|
|
1262
1367
|
| `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`;
|
|
1263
1368
|
export interface BorderProps {
|
|
1264
1369
|
/**
|
|
1265
|
-
*
|
|
1266
|
-
*
|
|
1267
|
-
* This can be a size, optionally followed by a color, optionally followed by a style.
|
|
1268
|
-
*
|
|
1269
|
-
* 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.
|
|
1270
1371
|
*
|
|
1271
|
-
*
|
|
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`.
|
|
1272
1374
|
*
|
|
1273
|
-
*
|
|
1375
|
+
* Individual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.
|
|
1274
1376
|
*
|
|
1275
1377
|
* @example
|
|
1276
1378
|
* // The following are equivalent:
|
|
@@ -1281,64 +1383,61 @@ export interface BorderProps {
|
|
|
1281
1383
|
*/
|
|
1282
1384
|
border?: BorderShorthand;
|
|
1283
1385
|
/**
|
|
1284
|
-
*
|
|
1386
|
+
* Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
|
|
1285
1387
|
*
|
|
1286
|
-
*
|
|
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.
|
|
1287
1394
|
*
|
|
1288
|
-
*
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1291
|
-
*
|
|
1292
|
-
*
|
|
1293
|
-
*
|
|
1294
|
-
* If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
|
|
1295
|
-
*
|
|
1296
|
-
* 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
|
|
1297
1400
|
*
|
|
1298
1401
|
* @default '' - meaning no override
|
|
1299
1402
|
*/
|
|
1300
1403
|
borderWidth?: MaybeAllValuesShorthandProperty<BorderSizeKeyword> | '';
|
|
1301
1404
|
/**
|
|
1302
|
-
*
|
|
1303
|
-
*
|
|
1304
|
-
* If set, it takes precedence over the `border` property's style.
|
|
1305
|
-
*
|
|
1306
|
-
* Like CSS, up to 4 values can be specified.
|
|
1307
|
-
*
|
|
1308
|
-
* If one value is specified, it applies to all sides.
|
|
1309
|
-
*
|
|
1310
|
-
* If two values are specified, they apply to the block sides and inline sides respectively.
|
|
1405
|
+
* Controls the visual style of the border on all sides, such as solid, dashed, or dotted.
|
|
1311
1406
|
*
|
|
1312
|
-
*
|
|
1407
|
+
* When set, this overrides the style value specified in the `border` property.
|
|
1313
1408
|
*
|
|
1314
|
-
*
|
|
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
|
|
1315
1414
|
*
|
|
1316
1415
|
* @default '' - meaning no override
|
|
1317
1416
|
*/
|
|
1318
1417
|
borderStyle?: MaybeAllValuesShorthandProperty<BorderStyleKeyword> | '';
|
|
1319
1418
|
/**
|
|
1320
|
-
*
|
|
1419
|
+
* Controls the color of the border using the design system's color scale.
|
|
1321
1420
|
*
|
|
1322
|
-
*
|
|
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.
|
|
1323
1423
|
*
|
|
1324
1424
|
* @default '' - meaning no override
|
|
1325
1425
|
*/
|
|
1326
1426
|
borderColor?: ColorKeyword | '';
|
|
1327
1427
|
/**
|
|
1328
|
-
*
|
|
1428
|
+
* Controls the roundedness of the element's corners using the design system's radius scale.
|
|
1329
1429
|
*
|
|
1330
|
-
* [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box)
|
|
1331
|
-
*
|
|
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
|
|
1332
1435
|
*
|
|
1333
|
-
*
|
|
1334
|
-
* -
|
|
1335
|
-
* -
|
|
1336
|
-
*
|
|
1337
|
-
*
|
|
1338
|
-
* - `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.
|
|
1339
|
-
* - `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.
|
|
1340
|
-
* - `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.
|
|
1341
|
-
* - `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.
|
|
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
|
|
1342
1441
|
*
|
|
1343
1442
|
* @defaultValue 'none'
|
|
1344
1443
|
*/
|
|
@@ -1348,10 +1447,10 @@ export interface OverflowProps {
|
|
|
1348
1447
|
/**
|
|
1349
1448
|
* Sets the overflow behavior of the element.
|
|
1350
1449
|
*
|
|
1450
|
+
* - `visible`: the content that extends beyond the element’s container is visible.
|
|
1351
1451
|
* - `hidden`: clips the content when it is larger than the element’s container.
|
|
1352
1452
|
* The element will not be scrollable and the users will not be able
|
|
1353
1453
|
* to access the clipped content by dragging or using a scroll wheel on a mouse.
|
|
1354
|
-
* - `visible`: the content that extends beyond the element’s container is visible.
|
|
1355
1454
|
*
|
|
1356
1455
|
* @default 'visible'
|
|
1357
1456
|
*/
|
|
@@ -1366,14 +1465,11 @@ export interface BaseBoxProps
|
|
|
1366
1465
|
BorderProps,
|
|
1367
1466
|
OverflowProps {
|
|
1368
1467
|
/**
|
|
1369
|
-
* The content of the
|
|
1468
|
+
* The content of the box.
|
|
1370
1469
|
*/
|
|
1371
1470
|
children?: ComponentChildren;
|
|
1372
1471
|
/**
|
|
1373
|
-
* A label that describes the purpose or
|
|
1374
|
-
* When set, it will be announced to users using assistive technologies and will provide them with more context.
|
|
1375
|
-
*
|
|
1376
|
-
* 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.
|
|
1377
1473
|
*/
|
|
1378
1474
|
accessibilityLabel?: string;
|
|
1379
1475
|
}
|
|
@@ -1383,34 +1479,29 @@ export interface BaseBoxPropsWithRole
|
|
|
1383
1479
|
interface BoxProps$1 extends BaseBoxPropsWithRole, GlobalProps {}
|
|
1384
1480
|
export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
|
|
1385
1481
|
/**
|
|
1386
|
-
* The
|
|
1482
|
+
* The behavioral type of the button component, which determines what action it performs when activated.
|
|
1387
1483
|
*
|
|
1388
|
-
* - `submit`:
|
|
1389
|
-
* - `button`:
|
|
1390
|
-
* - `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.
|
|
1391
1487
|
*
|
|
1392
|
-
* This property is ignored if
|
|
1488
|
+
* This property is ignored if `href` or `commandFor`/`command` is set.
|
|
1393
1489
|
*
|
|
1394
1490
|
* @default 'button'
|
|
1395
1491
|
*/
|
|
1396
1492
|
type?: 'submit' | 'button' | 'reset';
|
|
1397
1493
|
/**
|
|
1398
|
-
*
|
|
1399
|
-
* This will be called before the action indicated by `type`.
|
|
1400
|
-
*
|
|
1401
|
-
* @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).
|
|
1402
1495
|
*/
|
|
1403
1496
|
onClick?: (event: Event) => void;
|
|
1404
1497
|
/**
|
|
1405
|
-
*
|
|
1498
|
+
* Whether the button is disabled, preventing it from being clicked or receiving focus.
|
|
1406
1499
|
*
|
|
1407
1500
|
* @default false
|
|
1408
1501
|
*/
|
|
1409
1502
|
disabled?: boolean;
|
|
1410
1503
|
/**
|
|
1411
|
-
*
|
|
1412
|
-
*
|
|
1413
|
-
* 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.
|
|
1414
1505
|
*
|
|
1415
1506
|
* @default false
|
|
1416
1507
|
*/
|
|
@@ -1418,18 +1509,19 @@ export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
|
|
|
1418
1509
|
}
|
|
1419
1510
|
export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
|
|
1420
1511
|
/**
|
|
1421
|
-
* The URL to
|
|
1422
|
-
*
|
|
1423
|
-
* - If set, it will navigate to the location specified by `href` after executing the `click` event.
|
|
1424
|
-
* - 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.
|
|
1425
1513
|
*/
|
|
1426
1514
|
href?: string;
|
|
1427
1515
|
/**
|
|
1428
1516
|
* Specifies where to display the linked URL.
|
|
1429
1517
|
*
|
|
1430
|
-
*
|
|
1518
|
+
* Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).
|
|
1431
1519
|
*
|
|
1432
|
-
*
|
|
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`.
|
|
1433
1525
|
*
|
|
1434
1526
|
* @implementation Surfaces can set specific rules on how they handle each URL.
|
|
1435
1527
|
* @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases.
|
|
@@ -1439,46 +1531,35 @@ export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
|
|
|
1439
1531
|
*/
|
|
1440
1532
|
target?: 'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString;
|
|
1441
1533
|
/**
|
|
1442
|
-
*
|
|
1443
|
-
* Download only works for same-origin URLs or the `blob:` and `data:` schemes.
|
|
1444
|
-
* @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).
|
|
1445
1535
|
*/
|
|
1446
1536
|
download?: string;
|
|
1447
1537
|
/**
|
|
1448
|
-
*
|
|
1449
|
-
* This will be called before navigating to the location specified by `href`.
|
|
1450
|
-
*
|
|
1451
|
-
* @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).
|
|
1452
1539
|
*/
|
|
1453
1540
|
onClick?: (event: Event) => void;
|
|
1454
1541
|
}
|
|
1455
1542
|
export interface InteractionProps {
|
|
1456
1543
|
/**
|
|
1457
|
-
* ID of
|
|
1458
|
-
*
|
|
1459
|
-
* See `command` for how to control the behavior of the target.
|
|
1460
|
-
*
|
|
1461
|
-
* @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).
|
|
1462
1545
|
*/
|
|
1463
1546
|
commandFor?: string;
|
|
1464
1547
|
/**
|
|
1465
|
-
*
|
|
1548
|
+
* The action that the `commandFor` target should take when this component is activated. The supported actions vary by target component type.
|
|
1466
1549
|
*
|
|
1467
|
-
*
|
|
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.
|
|
1468
1555
|
*
|
|
1469
|
-
*
|
|
1470
|
-
* - `--show`: shows the target component.
|
|
1471
|
-
* - `--hide`: hides the target component.
|
|
1472
|
-
* - `--toggle`: toggles the target component.
|
|
1473
|
-
* - `--copy`: copies the target ClipboardItem.
|
|
1556
|
+
* Learn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).
|
|
1474
1557
|
*
|
|
1475
1558
|
* @default '--auto'
|
|
1476
|
-
*
|
|
1477
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command
|
|
1478
1559
|
*/
|
|
1479
1560
|
command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';
|
|
1480
1561
|
/**
|
|
1481
|
-
* 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.
|
|
1482
1563
|
*/
|
|
1483
1564
|
interestFor?: string;
|
|
1484
1565
|
}
|
|
@@ -1487,63 +1568,65 @@ export interface BaseClickableProps
|
|
|
1487
1568
|
LinkBehaviorProps {}
|
|
1488
1569
|
interface ButtonProps$1 extends GlobalProps, BaseClickableProps {
|
|
1489
1570
|
/**
|
|
1490
|
-
* A label that describes the purpose or
|
|
1491
|
-
*
|
|
1492
|
-
* Use this when using only an icon or the Button text is not enough context
|
|
1493
|
-
* 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.
|
|
1494
1572
|
*/
|
|
1495
1573
|
accessibilityLabel?: string;
|
|
1496
1574
|
/**
|
|
1497
|
-
* The content
|
|
1575
|
+
* The content displayed within the button component.
|
|
1498
1576
|
*/
|
|
1499
1577
|
children?: ComponentChildren;
|
|
1500
1578
|
/**
|
|
1501
|
-
*
|
|
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.
|
|
1502
1582
|
*
|
|
1503
1583
|
* @default ''
|
|
1504
1584
|
*/
|
|
1505
1585
|
icon?: IconType | AnyString;
|
|
1506
1586
|
/**
|
|
1507
|
-
* The
|
|
1587
|
+
* The inline width (horizontal size) of the button component.
|
|
1508
1588
|
*
|
|
1509
|
-
* - `auto`:
|
|
1510
|
-
* - `fill`:
|
|
1511
|
-
* - `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.
|
|
1512
1592
|
*
|
|
1513
1593
|
* @default 'auto'
|
|
1514
1594
|
*/
|
|
1515
1595
|
inlineSize?: 'auto' | 'fill' | 'fit-content';
|
|
1516
1596
|
/**
|
|
1517
|
-
*
|
|
1597
|
+
* The visual style variant of the button component, which controls its prominence and emphasis in the interface.
|
|
1518
1598
|
*
|
|
1519
|
-
* @default 'auto' - the variant is automatically determined by the
|
|
1599
|
+
* @default 'auto' - the variant is automatically determined by the button's context
|
|
1520
1600
|
*/
|
|
1521
1601
|
variant?: 'auto' | 'primary' | 'secondary' | 'tertiary';
|
|
1522
1602
|
/**
|
|
1523
|
-
*
|
|
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.
|
|
1524
1608
|
*
|
|
1525
1609
|
* @default 'auto'
|
|
1526
1610
|
*/
|
|
1527
1611
|
tone?: ToneKeyword;
|
|
1528
1612
|
/**
|
|
1529
|
-
*
|
|
1530
|
-
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
1531
|
-
* [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).
|
|
1532
1614
|
*/
|
|
1533
1615
|
lang?: string;
|
|
1534
1616
|
}
|
|
1535
1617
|
interface ButtonGroupProps$1 extends GlobalProps, ActionSlots {
|
|
1536
1618
|
/**
|
|
1537
|
-
* The content of the
|
|
1619
|
+
* The content of the button group, typically a collection of button or link components.
|
|
1538
1620
|
*/
|
|
1539
1621
|
children?: ComponentChildren;
|
|
1540
1622
|
/**
|
|
1541
|
-
* The
|
|
1623
|
+
* The spacing between button elements within the group.
|
|
1624
|
+
*
|
|
1542
1625
|
* @default 'base'
|
|
1543
1626
|
*/
|
|
1544
1627
|
gap?: 'base' | 'none';
|
|
1545
1628
|
/**
|
|
1546
|
-
*
|
|
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.
|
|
1547
1630
|
*
|
|
1548
1631
|
* @implementation Used as a hidden heading or an aria-label on the wrapping element.
|
|
1549
1632
|
*/
|
|
@@ -1551,11 +1634,11 @@ interface ButtonGroupProps$1 extends GlobalProps, ActionSlots {
|
|
|
1551
1634
|
}
|
|
1552
1635
|
export interface BaseInputProps {
|
|
1553
1636
|
/**
|
|
1554
|
-
*
|
|
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.
|
|
1555
1638
|
*/
|
|
1556
1639
|
name?: string;
|
|
1557
1640
|
/**
|
|
1558
|
-
*
|
|
1641
|
+
* Whether the field is disabled, preventing any user interaction.
|
|
1559
1642
|
*
|
|
1560
1643
|
* @default false
|
|
1561
1644
|
*/
|
|
@@ -1563,23 +1646,19 @@ export interface BaseInputProps {
|
|
|
1563
1646
|
}
|
|
1564
1647
|
export interface InputProps extends BaseInputProps {
|
|
1565
1648
|
/**
|
|
1566
|
-
*
|
|
1567
|
-
*
|
|
1568
|
-
* @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).
|
|
1569
1650
|
*/
|
|
1570
1651
|
onChange?: (event: Event) => void;
|
|
1571
1652
|
/**
|
|
1572
|
-
*
|
|
1573
|
-
*
|
|
1574
|
-
* @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).
|
|
1575
1654
|
*/
|
|
1576
1655
|
onInput?: (event: Event) => void;
|
|
1577
1656
|
/**
|
|
1578
|
-
* 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.
|
|
1579
1658
|
*/
|
|
1580
1659
|
value?: string;
|
|
1581
1660
|
/**
|
|
1582
|
-
* 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.
|
|
1583
1662
|
*
|
|
1584
1663
|
* @implementation `defaultValue` reflects to the `value` attribute.
|
|
1585
1664
|
*/
|
|
@@ -1587,39 +1666,33 @@ export interface InputProps extends BaseInputProps {
|
|
|
1587
1666
|
}
|
|
1588
1667
|
export interface MultipleInputProps extends BaseInputProps {
|
|
1589
1668
|
/**
|
|
1590
|
-
*
|
|
1591
|
-
*
|
|
1592
|
-
* @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).
|
|
1593
1670
|
*/
|
|
1594
1671
|
onChange?: (event: Event) => void;
|
|
1595
1672
|
/**
|
|
1596
|
-
*
|
|
1597
|
-
*
|
|
1598
|
-
* @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).
|
|
1599
1674
|
*/
|
|
1600
1675
|
onInput?: (event: Event) => void;
|
|
1601
1676
|
/**
|
|
1602
|
-
* An array of
|
|
1677
|
+
* An array of `value` attributes for the currently selected options.
|
|
1603
1678
|
*
|
|
1604
|
-
*
|
|
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.
|
|
1605
1680
|
*/
|
|
1606
1681
|
values?: string[];
|
|
1607
1682
|
}
|
|
1608
1683
|
export interface FileInputProps extends BaseInputProps {
|
|
1609
1684
|
/**
|
|
1610
|
-
*
|
|
1685
|
+
* A callback fired when the user has finished selecting one or more files.
|
|
1611
1686
|
*/
|
|
1612
1687
|
onChange?: (event: Event) => void;
|
|
1613
1688
|
/**
|
|
1614
|
-
*
|
|
1689
|
+
* A callback fired when the user makes any changes to the file selection.
|
|
1615
1690
|
*/
|
|
1616
1691
|
onInput?: (event: Event) => void;
|
|
1617
1692
|
/**
|
|
1618
1693
|
* A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string ("").
|
|
1619
1694
|
* When the user selected multiple files, the value represents the first file in the list of files they selected.
|
|
1620
|
-
* The value is always the file's name prefixed with "C:\fakepath\", which isn't the real path of the file.
|
|
1621
|
-
*
|
|
1622
|
-
* @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).
|
|
1623
1696
|
*
|
|
1624
1697
|
* @default ''
|
|
1625
1698
|
*/
|
|
@@ -1636,8 +1709,7 @@ export interface FileInputProps extends BaseInputProps {
|
|
|
1636
1709
|
}
|
|
1637
1710
|
export interface FieldErrorProps {
|
|
1638
1711
|
/**
|
|
1639
|
-
*
|
|
1640
|
-
* 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.
|
|
1641
1713
|
*/
|
|
1642
1714
|
error?: string;
|
|
1643
1715
|
}
|
|
@@ -1645,26 +1717,19 @@ export interface BasicFieldProps
|
|
|
1645
1717
|
extends FieldErrorProps,
|
|
1646
1718
|
LabelAccessibilityVisibilityProps {
|
|
1647
1719
|
/**
|
|
1648
|
-
* Whether the field
|
|
1649
|
-
* to the field, but it will not cause an error to appear automatically.
|
|
1650
|
-
* If you want to present an error when this field is empty, you can do
|
|
1651
|
-
* 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.
|
|
1652
1721
|
*
|
|
1653
1722
|
* @default false
|
|
1654
1723
|
*/
|
|
1655
1724
|
required?: boolean;
|
|
1656
1725
|
/**
|
|
1657
|
-
*
|
|
1726
|
+
* The text label displayed above or alongside the field to describe its purpose.
|
|
1658
1727
|
*/
|
|
1659
1728
|
label?: string;
|
|
1660
1729
|
}
|
|
1661
1730
|
export interface FieldDetailsProps {
|
|
1662
1731
|
/**
|
|
1663
|
-
* Additional text to provide context or
|
|
1664
|
-
* This text is displayed along with the field and its label
|
|
1665
|
-
* to offer more information or instructions to the user.
|
|
1666
|
-
*
|
|
1667
|
-
* 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.
|
|
1668
1733
|
*/
|
|
1669
1734
|
details?: string;
|
|
1670
1735
|
}
|
|
@@ -1674,13 +1739,13 @@ export interface FieldProps
|
|
|
1674
1739
|
FocusEventProps,
|
|
1675
1740
|
FieldDetailsProps {
|
|
1676
1741
|
/**
|
|
1677
|
-
*
|
|
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.
|
|
1678
1743
|
*/
|
|
1679
1744
|
placeholder?: string;
|
|
1680
1745
|
}
|
|
1681
1746
|
export interface BaseTextFieldProps extends FieldProps {
|
|
1682
1747
|
/**
|
|
1683
|
-
*
|
|
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.
|
|
1684
1749
|
*
|
|
1685
1750
|
* @default false
|
|
1686
1751
|
*/
|
|
@@ -1688,27 +1753,17 @@ export interface BaseTextFieldProps extends FieldProps {
|
|
|
1688
1753
|
}
|
|
1689
1754
|
export interface FieldDecorationProps {
|
|
1690
1755
|
/**
|
|
1691
|
-
* A
|
|
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 `%`.
|
|
1692
1757
|
*
|
|
1693
|
-
* This
|
|
1694
|
-
*
|
|
1695
|
-
* This cannot be edited by the user, and it isn't included in the value of the field.
|
|
1696
|
-
*
|
|
1697
|
-
* It may not be displayed until the user has interacted with the input.
|
|
1698
|
-
* 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.
|
|
1699
1759
|
*
|
|
1700
1760
|
* @default ''
|
|
1701
1761
|
*/
|
|
1702
1762
|
suffix?: string;
|
|
1703
1763
|
/**
|
|
1704
|
-
* A
|
|
1705
|
-
*
|
|
1706
|
-
* This is useful for displaying an implied part of the value, such as "https://" or "+353".
|
|
1707
|
-
*
|
|
1708
|
-
* 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`.
|
|
1709
1765
|
*
|
|
1710
|
-
*
|
|
1711
|
-
* 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.
|
|
1712
1767
|
*
|
|
1713
1768
|
* @default ''
|
|
1714
1769
|
*/
|
|
@@ -1720,28 +1775,25 @@ export interface FieldDecorationProps {
|
|
|
1720
1775
|
*/
|
|
1721
1776
|
icon?: IconType | AnyString;
|
|
1722
1777
|
/**
|
|
1723
|
-
* Additional content
|
|
1724
|
-
*
|
|
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.
|
|
1725
1781
|
*/
|
|
1726
1782
|
accessory?: ComponentChildren;
|
|
1727
1783
|
}
|
|
1728
1784
|
export interface NumberConstraintsProps {
|
|
1729
1785
|
/**
|
|
1730
|
-
* The highest decimal or integer
|
|
1731
|
-
* 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.
|
|
1732
1787
|
*
|
|
1733
|
-
*
|
|
1734
|
-
* 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.
|
|
1735
1789
|
*
|
|
1736
1790
|
* @default Infinity
|
|
1737
1791
|
*/
|
|
1738
1792
|
max?: number;
|
|
1739
1793
|
/**
|
|
1740
|
-
* The lowest decimal or integer
|
|
1741
|
-
* 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.
|
|
1742
1795
|
*
|
|
1743
|
-
*
|
|
1744
|
-
* 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.
|
|
1745
1797
|
*
|
|
1746
1798
|
* @default -Infinity
|
|
1747
1799
|
*/
|
|
@@ -1769,13 +1821,13 @@ export interface NumberConstraintsProps {
|
|
|
1769
1821
|
}
|
|
1770
1822
|
export interface MinMaxLengthProps {
|
|
1771
1823
|
/**
|
|
1772
|
-
*
|
|
1824
|
+
* The maximum number of characters allowed in the field.
|
|
1773
1825
|
*
|
|
1774
1826
|
* @default Infinity
|
|
1775
1827
|
*/
|
|
1776
1828
|
maxLength?: number;
|
|
1777
1829
|
/**
|
|
1778
|
-
*
|
|
1830
|
+
* The minimum number of characters required in the field.
|
|
1779
1831
|
*
|
|
1780
1832
|
* @default 0
|
|
1781
1833
|
*/
|
|
@@ -1783,30 +1835,29 @@ export interface MinMaxLengthProps {
|
|
|
1783
1835
|
}
|
|
1784
1836
|
export interface BaseSelectableProps {
|
|
1785
1837
|
/**
|
|
1786
|
-
* A label
|
|
1787
|
-
* 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.
|
|
1788
1839
|
*/
|
|
1789
1840
|
accessibilityLabel?: string;
|
|
1790
1841
|
/**
|
|
1791
|
-
*
|
|
1842
|
+
* Whether the control is disabled, preventing any user interaction.
|
|
1792
1843
|
*
|
|
1793
1844
|
* @default false
|
|
1794
1845
|
*/
|
|
1795
1846
|
disabled?: boolean;
|
|
1796
1847
|
/**
|
|
1797
|
-
* The value
|
|
1848
|
+
* The value submitted with form data when the control is checked or selected.
|
|
1798
1849
|
*/
|
|
1799
1850
|
value?: string;
|
|
1800
1851
|
}
|
|
1801
1852
|
export interface BaseOptionProps extends BaseSelectableProps {
|
|
1802
1853
|
/**
|
|
1803
|
-
* Whether the
|
|
1854
|
+
* Whether the option is currently selected.
|
|
1804
1855
|
*
|
|
1805
1856
|
* @default false
|
|
1806
1857
|
*/
|
|
1807
1858
|
selected?: boolean;
|
|
1808
1859
|
/**
|
|
1809
|
-
* Whether the
|
|
1860
|
+
* Whether the option is selected by default when first rendered.
|
|
1810
1861
|
*
|
|
1811
1862
|
* @implementation `defaultSelected` reflects to the `selected` attribute.
|
|
1812
1863
|
*
|
|
@@ -1818,17 +1869,17 @@ export interface BaseCheckableProps
|
|
|
1818
1869
|
extends BaseSelectableProps,
|
|
1819
1870
|
InteractionProps {
|
|
1820
1871
|
/**
|
|
1821
|
-
*
|
|
1872
|
+
* The visual text label displayed alongside the control to describe its purpose.
|
|
1822
1873
|
*/
|
|
1823
1874
|
label?: string;
|
|
1824
1875
|
/**
|
|
1825
|
-
* Whether the control is
|
|
1876
|
+
* Whether the control is currently checked (for checkboxes) or toggled on (for switches).
|
|
1826
1877
|
*
|
|
1827
1878
|
* @default false
|
|
1828
1879
|
*/
|
|
1829
1880
|
checked?: boolean;
|
|
1830
1881
|
/**
|
|
1831
|
-
* Whether the control is
|
|
1882
|
+
* Whether the control is checked by default when first rendered.
|
|
1832
1883
|
*
|
|
1833
1884
|
* @implementation `defaultChecked` reflects to the `checked` attribute.
|
|
1834
1885
|
*
|
|
@@ -1836,20 +1887,15 @@ export interface BaseCheckableProps
|
|
|
1836
1887
|
*/
|
|
1837
1888
|
defaultChecked?: boolean;
|
|
1838
1889
|
/**
|
|
1839
|
-
*
|
|
1840
|
-
* 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.
|
|
1841
1891
|
*/
|
|
1842
1892
|
name?: string;
|
|
1843
1893
|
/**
|
|
1844
|
-
* A callback
|
|
1845
|
-
*
|
|
1846
|
-
* @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).
|
|
1847
1895
|
*/
|
|
1848
1896
|
onChange?: (event: Event) => void;
|
|
1849
1897
|
/**
|
|
1850
|
-
* A callback
|
|
1851
|
-
*
|
|
1852
|
-
* @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).
|
|
1853
1899
|
*/
|
|
1854
1900
|
onInput?: (event: Event) => void;
|
|
1855
1901
|
}
|
|
@@ -1859,22 +1905,21 @@ interface CheckboxProps$1
|
|
|
1859
1905
|
FieldErrorProps,
|
|
1860
1906
|
FieldDetailsProps {
|
|
1861
1907
|
/**
|
|
1862
|
-
* Whether
|
|
1908
|
+
* Whether the checkbox displays in an indeterminate state (neither checked nor unchecked), typically used to indicate partial selection in hierarchical lists.
|
|
1863
1909
|
*
|
|
1864
|
-
*
|
|
1865
|
-
*
|
|
1866
|
-
* 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.
|
|
1867
1912
|
*
|
|
1868
|
-
* If `indeterminate` has not been explicitly set
|
|
1869
|
-
*
|
|
1913
|
+
* If `indeterminate` has not been explicitly set and hasn't been modified by user interaction,
|
|
1914
|
+
* it returns the value of `defaultIndeterminate`.
|
|
1870
1915
|
*
|
|
1871
1916
|
* @implementation The `indeterminate` property doesn't reflect to any attribute.
|
|
1872
1917
|
*/
|
|
1873
1918
|
indeterminate?: boolean;
|
|
1874
1919
|
/**
|
|
1875
|
-
* Whether the checkbox is in an
|
|
1920
|
+
* Whether the checkbox is in an indeterminate state by default when first rendered.
|
|
1876
1921
|
*
|
|
1877
|
-
* 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.
|
|
1878
1923
|
*
|
|
1879
1924
|
* @implementation `defaultIndeterminate` reflects to the `indeterminate` attribute.
|
|
1880
1925
|
*
|
|
@@ -1882,10 +1927,7 @@ interface CheckboxProps$1
|
|
|
1882
1927
|
*/
|
|
1883
1928
|
defaultIndeterminate?: boolean;
|
|
1884
1929
|
/**
|
|
1885
|
-
* Whether the
|
|
1886
|
-
* to the field, but it will not cause an error to appear automatically.
|
|
1887
|
-
* If you want to present an error when this field is empty, you can do
|
|
1888
|
-
* 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.
|
|
1889
1931
|
*
|
|
1890
1932
|
* @default false
|
|
1891
1933
|
*/
|
|
@@ -1893,21 +1935,21 @@ interface CheckboxProps$1
|
|
|
1893
1935
|
}
|
|
1894
1936
|
export interface ChipProps$1 extends GlobalProps {
|
|
1895
1937
|
/**
|
|
1896
|
-
* The content
|
|
1938
|
+
* The text content displayed within the chip.
|
|
1897
1939
|
*/
|
|
1898
1940
|
children?: ComponentChildren;
|
|
1899
1941
|
/**
|
|
1900
|
-
* The graphic
|
|
1942
|
+
* The graphic element (typically an icon) displayed inside the chip.
|
|
1901
1943
|
*
|
|
1902
1944
|
* @implementation Only `s-icon` is supported.
|
|
1903
1945
|
*/
|
|
1904
1946
|
graphic?: ComponentChildren;
|
|
1905
1947
|
/**
|
|
1906
|
-
* 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.
|
|
1907
1949
|
*/
|
|
1908
1950
|
accessibilityLabel?: string;
|
|
1909
1951
|
/**
|
|
1910
|
-
*
|
|
1952
|
+
* The color intensity of the chip. Use `subdued` for less intense, `base` for standard, or `strong` for more intense coloring.
|
|
1911
1953
|
*
|
|
1912
1954
|
* @default 'base'
|
|
1913
1955
|
*/
|
|
@@ -1916,7 +1958,7 @@ export interface ChipProps$1 extends GlobalProps {
|
|
|
1916
1958
|
interface ChipProps$2 extends ChipProps$1, GlobalProps {}
|
|
1917
1959
|
interface ChoiceProps$1 extends GlobalProps, BaseOptionProps {
|
|
1918
1960
|
/**
|
|
1919
|
-
*
|
|
1961
|
+
* The content displayed as the choice label.
|
|
1920
1962
|
*
|
|
1921
1963
|
* @implementation (StringChildren) The label is produced by extracting and
|
|
1922
1964
|
* concatenating the text nodes from the provided content; any markup or
|
|
@@ -1928,28 +1970,23 @@ interface ChoiceProps$1 extends GlobalProps, BaseOptionProps {
|
|
|
1928
1970
|
*/
|
|
1929
1971
|
children?: ComponentChildren | StringChildren;
|
|
1930
1972
|
/**
|
|
1931
|
-
* Additional text to provide context or
|
|
1932
|
-
*
|
|
1933
|
-
* This text is displayed along with the input and its label
|
|
1934
|
-
* 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.
|
|
1935
1974
|
*
|
|
1936
1975
|
* @implementation this content should be linked to the input with an `aria-describedby` attribute.
|
|
1937
1976
|
*/
|
|
1938
1977
|
details?: ComponentChildren;
|
|
1939
1978
|
/**
|
|
1940
|
-
*
|
|
1979
|
+
* Whether this choice should be associated with an error state from the parent ChoiceList.
|
|
1941
1980
|
*
|
|
1942
1981
|
* @default false
|
|
1943
1982
|
*/
|
|
1944
1983
|
error?: boolean;
|
|
1945
1984
|
/**
|
|
1946
|
-
* Secondary content
|
|
1985
|
+
* Secondary descriptive content displayed beneath the choice label.
|
|
1947
1986
|
*/
|
|
1948
1987
|
secondaryContent?: ComponentChildren;
|
|
1949
1988
|
/**
|
|
1950
|
-
* Content
|
|
1951
|
-
*
|
|
1952
|
-
* 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.
|
|
1953
1990
|
*/
|
|
1954
1991
|
selectedContent?: ComponentChildren;
|
|
1955
1992
|
}
|
|
@@ -1959,36 +1996,33 @@ interface ChoiceListProps$1
|
|
|
1959
1996
|
MultipleInputProps,
|
|
1960
1997
|
FieldDetailsProps {
|
|
1961
1998
|
/**
|
|
1962
|
-
* Whether multiple choices
|
|
1999
|
+
* Whether users can select multiple choices simultaneously (checkboxes) or only one choice at a time (radio buttons).
|
|
1963
2000
|
*
|
|
1964
2001
|
* @default false
|
|
1965
2002
|
*/
|
|
1966
2003
|
multiple?: boolean;
|
|
1967
2004
|
/**
|
|
1968
|
-
* The
|
|
1969
|
-
*
|
|
1970
|
-
* Accepts `Choice` components.
|
|
2005
|
+
* The collection of Choice components that users can select from.
|
|
1971
2006
|
*/
|
|
1972
2007
|
children?: ComponentChildren;
|
|
1973
2008
|
/**
|
|
1974
|
-
*
|
|
2009
|
+
* Whether the entire choice list is disabled, preventing any user interaction.
|
|
1975
2010
|
*
|
|
1976
|
-
* `disabled` on
|
|
2011
|
+
* When `true`, the `disabled` property on individual child Choice components is ignored.
|
|
1977
2012
|
*
|
|
1978
2013
|
* @default false
|
|
1979
2014
|
*/
|
|
1980
2015
|
disabled?: MultipleInputProps['disabled'];
|
|
1981
2016
|
/**
|
|
1982
|
-
* The variant
|
|
2017
|
+
* The layout variant for displaying the choices.
|
|
1983
2018
|
*
|
|
1984
|
-
* - `auto`: The variant is determined by the context.
|
|
1985
|
-
* - `list`: The choices are displayed in a list.
|
|
1986
|
-
* - `inline`: The choices are
|
|
1987
|
-
* - `block`: The choices are
|
|
1988
|
-
* - `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.
|
|
1989
2024
|
*
|
|
1990
|
-
* @implementation The `block`, `inline` and `grid` variants are more suitable for button
|
|
1991
|
-
* 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.
|
|
1992
2026
|
*
|
|
1993
2027
|
* @default 'auto'
|
|
1994
2028
|
*/
|
|
@@ -1999,27 +2033,15 @@ interface ClickableProps$1
|
|
|
1999
2033
|
BaseBoxProps,
|
|
2000
2034
|
BaseClickableProps {
|
|
2001
2035
|
/**
|
|
2002
|
-
*
|
|
2003
|
-
*
|
|
2004
|
-
* 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.
|
|
2005
2037
|
*/
|
|
2006
2038
|
loading?: BaseClickableProps['loading'];
|
|
2007
2039
|
/**
|
|
2008
|
-
*
|
|
2009
|
-
*
|
|
2010
|
-
* In this state, onClick will not fire.
|
|
2011
|
-
* If the click event originates from a child element, the event will immediately stop propagating from this element.
|
|
2012
|
-
*
|
|
2013
|
-
* However, items within the clickable can still receive focus and be interacted with.
|
|
2014
|
-
*
|
|
2015
|
-
* This has no impact on the visual state by default,
|
|
2016
|
-
* 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.
|
|
2017
2041
|
*/
|
|
2018
2042
|
disabled?: BaseClickableProps['disabled'];
|
|
2019
2043
|
/**
|
|
2020
|
-
*
|
|
2021
|
-
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
2022
|
-
* [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).
|
|
2023
2045
|
*
|
|
2024
2046
|
* @default ''
|
|
2025
2047
|
*/
|
|
@@ -2030,16 +2052,39 @@ interface ClickableChipProps$1
|
|
|
2030
2052
|
GlobalProps,
|
|
2031
2053
|
InteractionProps {
|
|
2032
2054
|
/**
|
|
2033
|
-
*
|
|
2055
|
+
* A callback fired when the chip is clicked.
|
|
2034
2056
|
*/
|
|
2035
2057
|
onClick?: (event: Event) => void;
|
|
2036
2058
|
/**
|
|
2037
|
-
* The URL to
|
|
2038
|
-
*
|
|
2039
|
-
* - If set, it will navigate to the location specified by `href` after executing the `click` event.
|
|
2040
|
-
* - 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.
|
|
2041
2060
|
*/
|
|
2042
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;
|
|
2043
2088
|
/**
|
|
2044
2089
|
* Whether the chip is removable.
|
|
2045
2090
|
*
|
|
@@ -2079,63 +2124,54 @@ interface ClickableChipProps$1
|
|
|
2079
2124
|
*/
|
|
2080
2125
|
disabled?: boolean;
|
|
2081
2126
|
}
|
|
2082
|
-
interface ColorPickerProps$1
|
|
2127
|
+
interface ColorPickerProps$1
|
|
2128
|
+
extends GlobalProps,
|
|
2129
|
+
Omit<InputProps, 'value' | 'defaultValue'> {
|
|
2083
2130
|
/**
|
|
2084
|
-
*
|
|
2131
|
+
* Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors.
|
|
2085
2132
|
*
|
|
2086
2133
|
* @default false
|
|
2087
2134
|
*/
|
|
2088
2135
|
alpha?: boolean;
|
|
2089
2136
|
/**
|
|
2090
|
-
*
|
|
2091
|
-
*
|
|
2092
|
-
* If the `alpha` prop is `true`, `onChange` will emit an 8-value hex (#RRGGBBAA).
|
|
2093
|
-
* If the `alpha` prop is `false`, `onChange` will emit a 6-value hex (#RRGGBB).
|
|
2137
|
+
* 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`.
|
|
2094
2138
|
*/
|
|
2095
2139
|
onChange?: InputProps['onChange'];
|
|
2096
2140
|
/**
|
|
2097
|
-
*
|
|
2098
|
-
*
|
|
2099
|
-
* If the `alpha` prop is `true`, `onInput` will emit an 8-value hex (#RRGGBBAA).
|
|
2100
|
-
* If the `alpha` prop is `false`, `onInput` will emit a 6-value hex (#RRGGBB).
|
|
2141
|
+
* 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`.
|
|
2101
2142
|
*/
|
|
2102
2143
|
onInput?: InputProps['onChange'];
|
|
2103
2144
|
/**
|
|
2104
|
-
* The currently selected color.
|
|
2145
|
+
* The currently selected color value. Accepts multiple input formats:
|
|
2105
2146
|
*
|
|
2106
|
-
*
|
|
2107
|
-
* -
|
|
2108
|
-
* - HSLA
|
|
2109
|
-
* - RGB @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb
|
|
2110
|
-
* - RGBA @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb
|
|
2111
|
-
* - Hex (3-value, 4-value, 6-value, 8-value) @see https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color
|
|
2147
|
+
* - Hex: `#RGB`, `#RGBA`, `#RRGGBB`, `#RRGGBBAA` (three, four, six, or eight digits)
|
|
2148
|
+
* - RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated)
|
|
2149
|
+
* - HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)`
|
|
2112
2150
|
*
|
|
2113
|
-
*
|
|
2114
|
-
|
|
2115
|
-
|
|
2116
|
-
|
|
2117
|
-
*
|
|
2118
|
-
* Note that the `onChange` handler will emit the value in hex.
|
|
2151
|
+
* Returns an empty string if the value is invalid. The `onChange` handler always emits values in hex format.
|
|
2152
|
+
*/
|
|
2153
|
+
value?: string;
|
|
2154
|
+
/**
|
|
2155
|
+
* 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.
|
|
2119
2156
|
*/
|
|
2120
|
-
|
|
2157
|
+
defaultValue?: string;
|
|
2121
2158
|
}
|
|
2122
2159
|
export interface AutocompleteProps<
|
|
2123
2160
|
AutocompleteField extends AnyAutocompleteField,
|
|
2124
2161
|
> {
|
|
2125
2162
|
/**
|
|
2126
|
-
*
|
|
2127
|
-
*
|
|
2128
|
-
* When set to `on` (the default), this property indicates that the field should support
|
|
2129
|
-
* autofill, but you do not have any more semantic information on the intended
|
|
2130
|
-
* contents.
|
|
2163
|
+
* Controls browser autofill behavior for the field.
|
|
2131
2164
|
*
|
|
2132
|
-
*
|
|
2133
|
-
*
|
|
2165
|
+
* Basic values:
|
|
2166
|
+
* - `on` - Enables autofill without specifying content type (default)
|
|
2167
|
+
* - `off` - Disables autofill for sensitive data or one-time codes
|
|
2134
2168
|
*
|
|
2135
|
-
*
|
|
2136
|
-
*
|
|
2169
|
+
* Specific field values describe the expected data type. You can optionally prefix these with:
|
|
2170
|
+
* - `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)
|
|
2171
|
+
* - `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes
|
|
2172
|
+
* - Both section and group (for example, `section-primary shipping email`)
|
|
2137
2173
|
*
|
|
2138
|
-
*
|
|
2174
|
+
* 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).
|
|
2139
2175
|
*
|
|
2140
2176
|
* @default 'tel' for PhoneField
|
|
2141
2177
|
* @default 'email' for EmailField
|
|
@@ -2231,6 +2267,42 @@ export type AnyAutocompleteField =
|
|
|
2231
2267
|
| `${AutocompleteAddressGroup} tel-local-suffix`
|
|
2232
2268
|
| `${AutocompleteAddressGroup} tel-local`
|
|
2233
2269
|
| `${AutocompleteAddressGroup} tel-national`;
|
|
2270
|
+
/**
|
|
2271
|
+
* Represents autocomplete values that are valid for text input fields.
|
|
2272
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for text-based inputs.
|
|
2273
|
+
*
|
|
2274
|
+
* Available values:
|
|
2275
|
+
* - `name` - Full name
|
|
2276
|
+
* - `given-name` - First name
|
|
2277
|
+
* - `additional-name` - Middle name
|
|
2278
|
+
* - `family-name` - Last name
|
|
2279
|
+
* - `nickname` - Nickname or handle
|
|
2280
|
+
* - `username` - Username for login
|
|
2281
|
+
* - `honorific-prefix` - Name prefix (Mr., Mrs., Dr.)
|
|
2282
|
+
* - `honorific-suffix` - Name suffix (Jr., Sr., III)
|
|
2283
|
+
* - `organization` - Company or organization name
|
|
2284
|
+
* - `organization-title` - Job title or position
|
|
2285
|
+
* - `address-line1` - Street address (first line)
|
|
2286
|
+
* - `address-line2` - Street address (second line)
|
|
2287
|
+
* - `address-line3` - Street address (third line)
|
|
2288
|
+
* - `address-level1` - State or province
|
|
2289
|
+
* - `address-level2` - City or town
|
|
2290
|
+
* - `address-level3` - District or locality
|
|
2291
|
+
* - `address-level4` - Neighborhood or suburb
|
|
2292
|
+
* - `street-address` - Complete street address (multi-line)
|
|
2293
|
+
* - `postal-code` - Postal or ZIP code
|
|
2294
|
+
* - `country` - Country code (US, CA, GB)
|
|
2295
|
+
* - `country-name` - Country name (United States, Canada)
|
|
2296
|
+
* - `language` - Preferred language
|
|
2297
|
+
* - `sex` - Gender or sex
|
|
2298
|
+
* - `one-time-code` - One-time codes for authentication
|
|
2299
|
+
* - `transaction-currency` - Currency code (USD, EUR, GBP)
|
|
2300
|
+
* - `cc-name` - Name on credit card
|
|
2301
|
+
* - `cc-given-name` - First name on credit card
|
|
2302
|
+
* - `cc-additional-name` - Middle name on credit card
|
|
2303
|
+
* - `cc-family-name` - Last name on credit card
|
|
2304
|
+
* - `cc-type` - Credit card type (Visa, Mastercard)
|
|
2305
|
+
*/
|
|
2234
2306
|
export type TextAutocompleteField = ExtractStrict<
|
|
2235
2307
|
AnyAutocompleteField,
|
|
2236
2308
|
| 'additional-name'
|
|
@@ -2266,8 +2338,27 @@ export type TextAutocompleteField = ExtractStrict<
|
|
|
2266
2338
|
>;
|
|
2267
2339
|
interface ColorFieldProps$1
|
|
2268
2340
|
extends GlobalProps,
|
|
2269
|
-
BaseTextFieldProps,
|
|
2270
|
-
|
|
2341
|
+
Omit<BaseTextFieldProps, 'value' | 'defaultValue'> {
|
|
2342
|
+
/**
|
|
2343
|
+
* Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors.
|
|
2344
|
+
*
|
|
2345
|
+
* @default false
|
|
2346
|
+
*/
|
|
2347
|
+
alpha?: boolean;
|
|
2348
|
+
/**
|
|
2349
|
+
* The currently selected color value. Accepts multiple input formats:
|
|
2350
|
+
*
|
|
2351
|
+
* - Hex: `#RGB`, `#RGBA`, `#RRGGBB`, `#RRGGBBAA` (three, four, six, or eight digits)
|
|
2352
|
+
* - RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated)
|
|
2353
|
+
* - HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)`
|
|
2354
|
+
*
|
|
2355
|
+
* Returns an empty string if the value is invalid. The `onChange` handler always emits values in hex format.
|
|
2356
|
+
*/
|
|
2357
|
+
value?: string;
|
|
2358
|
+
/**
|
|
2359
|
+
* 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.
|
|
2360
|
+
*/
|
|
2361
|
+
defaultValue?: string;
|
|
2271
2362
|
autocomplete?: Extract<
|
|
2272
2363
|
AutocompleteProps<never>['autocomplete'],
|
|
2273
2364
|
'on' | 'off'
|
|
@@ -2275,23 +2366,15 @@ interface ColorFieldProps$1
|
|
|
2275
2366
|
}
|
|
2276
2367
|
interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
|
|
2277
2368
|
/**
|
|
2278
|
-
*
|
|
2279
|
-
*
|
|
2280
|
-
* This value is used until `view` is set, either directly or as a result of user interaction.
|
|
2281
|
-
*
|
|
2282
|
-
* Defaults to the current month in the user's locale.
|
|
2369
|
+
* 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.
|
|
2283
2370
|
*/
|
|
2284
2371
|
defaultView?: string;
|
|
2285
2372
|
/**
|
|
2286
|
-
*
|
|
2287
|
-
*
|
|
2288
|
-
* `onViewChange` is called when this value changes.
|
|
2289
|
-
*
|
|
2290
|
-
* Defaults to `defaultView`.
|
|
2373
|
+
* The currently displayed month in `YYYY-MM` format. When changed, the `viewchange` callback is triggered. Defaults to `defaultView`.
|
|
2291
2374
|
*/
|
|
2292
2375
|
view?: string;
|
|
2293
2376
|
/**
|
|
2294
|
-
*
|
|
2377
|
+
* A callback fired whenever the displayed month changes in the calendar.
|
|
2295
2378
|
*
|
|
2296
2379
|
* @param view The new month to display in `YYYY-MM` format.
|
|
2297
2380
|
*/
|
|
@@ -2307,144 +2390,91 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
|
|
|
2307
2390
|
*/
|
|
2308
2391
|
type?: 'single' | 'multiple' | 'range';
|
|
2309
2392
|
/**
|
|
2310
|
-
*
|
|
2311
|
-
*
|
|
2312
|
-
* A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
|
|
2393
|
+
* Specifies which dates can be selected as a comma-separated list. An empty string (default) allows all dates.
|
|
2313
2394
|
*
|
|
2314
|
-
*
|
|
2395
|
+
* **Formats:**
|
|
2396
|
+
* - `YYYY-MM-DD`: Single date
|
|
2397
|
+
* - `YYYY-MM`: Whole month
|
|
2398
|
+
* - `YYYY`: Whole year
|
|
2399
|
+
* - `start--end`: Date range (inclusive, unbounded if start/end omitted)
|
|
2315
2400
|
*
|
|
2316
|
-
*
|
|
2317
|
-
* -
|
|
2318
|
-
* -
|
|
2319
|
-
* - Ranges are expressed as `start--end`.
|
|
2320
|
-
* - Ranges are inclusive.
|
|
2321
|
-
* - If either `start` or `end` is omitted, the range is unbounded in that direction.
|
|
2322
|
-
* - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.
|
|
2323
|
-
* So `2024--` is equivalent to `2024-01-01--`.
|
|
2324
|
-
* - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.
|
|
2325
|
-
* So `--2024` is equivalent to `--2024-12-31`.
|
|
2326
|
-
* - Whitespace is allowed either side of `--`.
|
|
2401
|
+
* **Examples:**
|
|
2402
|
+
* - `2024-02--2025`: February 2024 through end of 2025
|
|
2403
|
+
* - `2024-05-09, 2024-05-11`: Only May 9th and 11th, 2024
|
|
2327
2404
|
*
|
|
2328
2405
|
* @default ""
|
|
2329
|
-
*
|
|
2330
|
-
* @example
|
|
2331
|
-
* `2024-02--2025` // allow any date from February 2024 to the end of 2025
|
|
2332
|
-
* `2024-02--` // allow any date from February 2024 to the end of the month
|
|
2333
|
-
* `2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024
|
|
2334
2406
|
*/
|
|
2335
2407
|
allow?: string;
|
|
2336
2408
|
/**
|
|
2337
|
-
*
|
|
2409
|
+
* 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.
|
|
2338
2410
|
*
|
|
2339
|
-
*
|
|
2411
|
+
* **Formats:**
|
|
2412
|
+
* - `YYYY-MM-DD`: Single date
|
|
2413
|
+
* - `YYYY-MM`: Whole month
|
|
2414
|
+
* - `YYYY`: Whole year
|
|
2415
|
+
* - `start--end`: Date range (inclusive, unbounded if start/end omitted)
|
|
2340
2416
|
*
|
|
2341
|
-
*
|
|
2342
|
-
*
|
|
2343
|
-
* -
|
|
2344
|
-
* - Dates in `YYYY-MM` format disallow a whole month.
|
|
2345
|
-
* - Dates in `YYYY` format disallow a whole year.
|
|
2346
|
-
* - Ranges are expressed as `start--end`.
|
|
2347
|
-
* - Ranges are inclusive.
|
|
2348
|
-
* - If either `start` or `end` is omitted, the range is unbounded in that direction.
|
|
2349
|
-
* - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.
|
|
2350
|
-
* So `2024--` is equivalent to `2024-01-01--`.
|
|
2351
|
-
* - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.
|
|
2352
|
-
* So `--2024` is equivalent to `--2024-12-31`.
|
|
2353
|
-
* - Whitespace is allowed either side of `--`.
|
|
2417
|
+
* **Examples:**
|
|
2418
|
+
* - `--2024-02`: All dates before February 2024
|
|
2419
|
+
* - `2024-05-09, 2024-05-11`: May 9th and 11th, 2024
|
|
2354
2420
|
*
|
|
2355
2421
|
* @default ""
|
|
2356
|
-
*
|
|
2357
|
-
* @example
|
|
2358
|
-
* `--2024-02` // disallow any date before February 2024
|
|
2359
|
-
* `2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024
|
|
2360
2422
|
*/
|
|
2361
2423
|
disallow?: string;
|
|
2362
2424
|
/**
|
|
2363
|
-
*
|
|
2425
|
+
* 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.
|
|
2364
2426
|
*
|
|
2365
|
-
*
|
|
2427
|
+
* **Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`
|
|
2366
2428
|
*
|
|
2367
|
-
*
|
|
2368
|
-
*
|
|
2369
|
-
* Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.
|
|
2429
|
+
* **Example:** `saturday, sunday` (only weekends)
|
|
2370
2430
|
*
|
|
2371
2431
|
* @default ""
|
|
2372
|
-
*
|
|
2373
|
-
* @example
|
|
2374
|
-
* 'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.
|
|
2375
2432
|
*/
|
|
2376
2433
|
allowDays?: string;
|
|
2377
2434
|
/**
|
|
2378
|
-
*
|
|
2379
|
-
*
|
|
2380
|
-
* A comma-separated list of days. Whitespace is allowed after commas.
|
|
2435
|
+
* 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.
|
|
2381
2436
|
*
|
|
2382
|
-
*
|
|
2437
|
+
* **Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`
|
|
2383
2438
|
*
|
|
2384
|
-
*
|
|
2439
|
+
* **Example:** `saturday, sunday` (no weekends)
|
|
2385
2440
|
*
|
|
2386
2441
|
* @default ""
|
|
2387
|
-
*
|
|
2388
|
-
* @example
|
|
2389
|
-
* 'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.
|
|
2390
2442
|
*/
|
|
2391
2443
|
disallowDays?: string;
|
|
2392
2444
|
/**
|
|
2393
|
-
*
|
|
2445
|
+
* The initially selected date(s) when the component first renders. An empty string means no date is initially selected.
|
|
2394
2446
|
*
|
|
2395
|
-
*
|
|
2396
|
-
*
|
|
2397
|
-
* If the provided value is invalid, no date is selected.
|
|
2398
|
-
*
|
|
2399
|
-
* - If `type="single"`, this is a date in `YYYY-MM-DD` format.
|
|
2400
|
-
* - If `type="multiple"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.
|
|
2401
|
-
* - If `type="range"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.
|
|
2447
|
+
* - Single date in `YYYY-MM-DD` format when `type` is set to `"single"`
|
|
2448
|
+
* - Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `"range"`
|
|
2402
2449
|
*
|
|
2403
2450
|
* @default ""
|
|
2404
2451
|
*/
|
|
2405
2452
|
defaultValue?: string;
|
|
2406
2453
|
/**
|
|
2407
|
-
*
|
|
2408
|
-
*
|
|
2409
|
-
* The default means no date is selected.
|
|
2410
|
-
*
|
|
2411
|
-
* If the provided value is invalid, no date is selected.
|
|
2412
|
-
*
|
|
2413
|
-
* Otherwise:
|
|
2454
|
+
* The currently selected date(s). An empty string means no date is selected.
|
|
2414
2455
|
*
|
|
2415
|
-
* -
|
|
2416
|
-
* -
|
|
2417
|
-
* - If `type="range"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.
|
|
2456
|
+
* - Single date in `YYYY-MM-DD` format when `type` is set to `"single"`
|
|
2457
|
+
* - Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `"range"`
|
|
2418
2458
|
*
|
|
2419
2459
|
* @default ""
|
|
2420
2460
|
*/
|
|
2421
2461
|
value?: string;
|
|
2422
2462
|
/**
|
|
2423
|
-
*
|
|
2424
|
-
*
|
|
2425
|
-
* - If `type="single"`, fires when a date is selected and happens before `onChange`.
|
|
2426
|
-
* - If `type="multiple"`, fires when a date is selected before `onChange`.
|
|
2427
|
-
* - 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`.
|
|
2463
|
+
* 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--`.
|
|
2428
2464
|
*/
|
|
2429
2465
|
onInput?: (event: Event) => void;
|
|
2430
2466
|
/**
|
|
2431
|
-
*
|
|
2432
|
-
*
|
|
2433
|
-
* - If `type="single"`, fires when a date is selected after `onInput`.
|
|
2434
|
-
* - If `type="multiple"`, fires when a date is selected after `onInput`.
|
|
2435
|
-
* - If `type="range"`, fires when a range is completed by selecting the end date after `onInput`.
|
|
2467
|
+
* 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.
|
|
2436
2468
|
*/
|
|
2437
2469
|
onChange?: (event: Event) => void;
|
|
2438
2470
|
}
|
|
2439
2471
|
interface DateFieldProps$1
|
|
2440
2472
|
extends GlobalProps,
|
|
2441
|
-
BaseTextFieldProps,
|
|
2473
|
+
Omit<BaseTextFieldProps, 'value' | 'defaultValue'>,
|
|
2442
2474
|
Pick<
|
|
2443
2475
|
DatePickerProps$1,
|
|
2444
2476
|
| 'view'
|
|
2445
2477
|
| 'defaultView'
|
|
2446
|
-
| 'value'
|
|
2447
|
-
| 'defaultValue'
|
|
2448
2478
|
| 'allow'
|
|
2449
2479
|
| 'disallow'
|
|
2450
2480
|
| 'allowDays'
|
|
@@ -2453,18 +2483,27 @@ interface DateFieldProps$1
|
|
|
2453
2483
|
>,
|
|
2454
2484
|
AutocompleteProps<DateAutocompleteField> {
|
|
2455
2485
|
/**
|
|
2456
|
-
*
|
|
2457
|
-
*
|
|
2486
|
+
* The initial date value when the field first renders, in `YYYY-MM-DD` format. An empty string means no date is initially selected.
|
|
2487
|
+
*
|
|
2488
|
+
* @default ""
|
|
2489
|
+
*/
|
|
2490
|
+
defaultValue?: string;
|
|
2491
|
+
/**
|
|
2492
|
+
* The currently selected date in `YYYY-MM-DD` format. An empty string means no date is selected.
|
|
2493
|
+
*
|
|
2494
|
+
* @default ""
|
|
2495
|
+
*/
|
|
2496
|
+
value?: string;
|
|
2497
|
+
/**
|
|
2498
|
+
* 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`.
|
|
2458
2499
|
*/
|
|
2459
2500
|
onInput?: (event: Event) => void;
|
|
2460
2501
|
/**
|
|
2461
|
-
*
|
|
2462
|
-
* Also triggered when a date is selected using the date picker popup after `onInput`.
|
|
2502
|
+
* 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`.
|
|
2463
2503
|
*/
|
|
2464
2504
|
onChange?: (event: Event) => void;
|
|
2465
2505
|
/**
|
|
2466
|
-
*
|
|
2467
|
-
* This callback will be called, if the date typed is invalid or disabled.
|
|
2506
|
+
* 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.
|
|
2468
2507
|
*
|
|
2469
2508
|
* Dates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:
|
|
2470
2509
|
* - 2021-02-31: February doesn’t have 31 days
|
|
@@ -2479,6 +2518,19 @@ interface DateFieldProps$1
|
|
|
2479
2518
|
*/
|
|
2480
2519
|
onInvalid?: (event: Event) => void;
|
|
2481
2520
|
}
|
|
2521
|
+
/**
|
|
2522
|
+
* Represents autocomplete values that are valid for date input fields.
|
|
2523
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for date-based inputs.
|
|
2524
|
+
*
|
|
2525
|
+
* Available values:
|
|
2526
|
+
* - `bday` - Complete birthday date
|
|
2527
|
+
* - `bday-day` - Day component of a birthday (1-31)
|
|
2528
|
+
* - `bday-month` - Month component of a birthday (1-12)
|
|
2529
|
+
* - `bday-year` - Year component of a birthday (1990)
|
|
2530
|
+
* - `cc-expiry` - Complete credit card expiration date
|
|
2531
|
+
* - `cc-expiry-month` - Month component of a credit card expiration date (1-12)
|
|
2532
|
+
* - `cc-expiry-year` - Year component of a credit card expiration date (2025)
|
|
2533
|
+
*/
|
|
2482
2534
|
export type DateAutocompleteField = ExtractStrict<
|
|
2483
2535
|
AnyAutocompleteField,
|
|
2484
2536
|
| 'bday'
|
|
@@ -2491,13 +2543,19 @@ export type DateAutocompleteField = ExtractStrict<
|
|
|
2491
2543
|
>;
|
|
2492
2544
|
interface DividerProps$1 extends GlobalProps {
|
|
2493
2545
|
/**
|
|
2494
|
-
*
|
|
2546
|
+
* The orientation of the divider line, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
|
|
2547
|
+
*
|
|
2548
|
+
* - `inline`: Horizontal divider for separating vertically stacked content
|
|
2549
|
+
* - `block`: Vertical divider for separating horizontally arranged content
|
|
2495
2550
|
*
|
|
2496
2551
|
* @default 'inline'
|
|
2497
2552
|
*/
|
|
2498
2553
|
direction?: 'inline' | 'block';
|
|
2499
2554
|
/**
|
|
2500
|
-
*
|
|
2555
|
+
* The visual prominence of the divider line.
|
|
2556
|
+
*
|
|
2557
|
+
* - `base`: Standard divider for most separations (default)
|
|
2558
|
+
* - `strong`: More prominent divider for major section breaks
|
|
2501
2559
|
*
|
|
2502
2560
|
* @default 'base'
|
|
2503
2561
|
*/
|
|
@@ -2539,17 +2597,28 @@ interface EmailFieldProps$1
|
|
|
2539
2597
|
BaseTextFieldProps,
|
|
2540
2598
|
MinMaxLengthProps,
|
|
2541
2599
|
AutocompleteProps<EmailAutocompleteField> {}
|
|
2600
|
+
/**
|
|
2601
|
+
* Represents autocomplete values that are valid for email input fields.
|
|
2602
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for email inputs.
|
|
2603
|
+
*
|
|
2604
|
+
* Available values:
|
|
2605
|
+
* - `email` - Primary email address
|
|
2606
|
+
* - `home email` - Home email address
|
|
2607
|
+
* - `mobile email` - Mobile device email address
|
|
2608
|
+
* - `fax email` - Fax machine email address
|
|
2609
|
+
* - `pager email` - Pager device email address
|
|
2610
|
+
*/
|
|
2542
2611
|
export type EmailAutocompleteField = ExtractStrict<
|
|
2543
2612
|
AnyAutocompleteField,
|
|
2544
2613
|
'email' | `${AutocompleteAddressGroup} email`
|
|
2545
2614
|
>;
|
|
2546
2615
|
interface FormProps$1 extends GlobalProps {
|
|
2547
2616
|
/**
|
|
2548
|
-
* The content
|
|
2617
|
+
* The form fields and content to be wrapped in the form element.
|
|
2549
2618
|
*/
|
|
2550
2619
|
children?: ComponentChildren;
|
|
2551
2620
|
/**
|
|
2552
|
-
* Whether the form
|
|
2621
|
+
* Whether the form can be submitted.
|
|
2553
2622
|
*
|
|
2554
2623
|
* When set to `true`, this will also disable the implicit submit behavior of the form.
|
|
2555
2624
|
*
|
|
@@ -2560,14 +2629,14 @@ interface FormProps$1 extends GlobalProps {
|
|
|
2560
2629
|
*/
|
|
2561
2630
|
disabled?: boolean;
|
|
2562
2631
|
/**
|
|
2563
|
-
* A callback
|
|
2632
|
+
* A callback fired when the form is submitted.
|
|
2564
2633
|
*
|
|
2565
|
-
* Use `event.waitUntil` to signal how long it takes to save the data
|
|
2566
|
-
* and whether
|
|
2634
|
+
* Use `event.waitUntil` to signal how long it takes to save the data
|
|
2635
|
+
* and whether the operation was successful.
|
|
2567
2636
|
*/
|
|
2568
2637
|
onSubmit?: (event: ExtendableEvent) => void;
|
|
2569
2638
|
/**
|
|
2570
|
-
* A callback
|
|
2639
|
+
* A callback fired when the form is reset, typically via a reset button.
|
|
2571
2640
|
*/
|
|
2572
2641
|
onReset?: (event: Event) => void;
|
|
2573
2642
|
}
|
|
@@ -2598,9 +2667,7 @@ export interface FunctionSettingsError extends Error {
|
|
|
2598
2667
|
/**
|
|
2599
2668
|
* A unique identifier describing the “class” of error. These will match
|
|
2600
2669
|
* the GraphQL error codes as closely as possible. For example the enums
|
|
2601
|
-
* returned by the `metafieldsSet` mutation
|
|
2602
|
-
*
|
|
2603
|
-
* @see https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode
|
|
2670
|
+
* returned by the `metafieldsSet` mutation. Learn more about [MetafieldsSetUserErrorCode](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode).
|
|
2604
2671
|
*/
|
|
2605
2672
|
code: string;
|
|
2606
2673
|
name: 'FunctionSettingsError';
|
|
@@ -2608,16 +2675,16 @@ export interface FunctionSettingsError extends Error {
|
|
|
2608
2675
|
export type SpacingKeyword = SizeKeyword | 'none';
|
|
2609
2676
|
export interface GapProps {
|
|
2610
2677
|
/**
|
|
2611
|
-
*
|
|
2678
|
+
* The spacing between child elements.
|
|
2612
2679
|
*
|
|
2613
2680
|
* A single value applies to both axes.
|
|
2614
|
-
* A pair of values (
|
|
2681
|
+
* A pair of values (e.g., `large-100 large-500`) can be used to set the inline and block axes respectively.
|
|
2615
2682
|
*
|
|
2616
2683
|
* @default 'none'
|
|
2617
2684
|
*/
|
|
2618
2685
|
gap?: MaybeResponsive<MaybeTwoValuesShorthandProperty<SpacingKeyword>>;
|
|
2619
2686
|
/**
|
|
2620
|
-
*
|
|
2687
|
+
* The spacing between elements along the block axis (vertical spacing in horizontal writing modes).
|
|
2621
2688
|
*
|
|
2622
2689
|
* This overrides the row value of `gap`.
|
|
2623
2690
|
*
|
|
@@ -2625,7 +2692,7 @@ export interface GapProps {
|
|
|
2625
2692
|
*/
|
|
2626
2693
|
rowGap?: MaybeResponsive<SpacingKeyword | ''>;
|
|
2627
2694
|
/**
|
|
2628
|
-
*
|
|
2695
|
+
* The spacing between elements along the inline axis (horizontal spacing in horizontal writing modes).
|
|
2629
2696
|
*
|
|
2630
2697
|
* This overrides the column value of `gap`.
|
|
2631
2698
|
*
|
|
@@ -2644,9 +2711,7 @@ export type OverflowPosition =
|
|
|
2644
2711
|
| `unsafe ${ContentPosition}`
|
|
2645
2712
|
| `safe ${ContentPosition}`;
|
|
2646
2713
|
/**
|
|
2647
|
-
* 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.
|
|
2648
|
-
*
|
|
2649
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
|
|
2714
|
+
* 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).
|
|
2650
2715
|
*/
|
|
2651
2716
|
export type JustifyItemsKeyword =
|
|
2652
2717
|
| 'normal'
|
|
@@ -2655,9 +2720,7 @@ export type JustifyItemsKeyword =
|
|
|
2655
2720
|
| OverflowPosition
|
|
2656
2721
|
| ContentPosition;
|
|
2657
2722
|
/**
|
|
2658
|
-
* Align items sets the align-self value on all direct children as a group.
|
|
2659
|
-
*
|
|
2660
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
2723
|
+
* 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).
|
|
2661
2724
|
*/
|
|
2662
2725
|
export type AlignItemsKeyword =
|
|
2663
2726
|
| 'normal'
|
|
@@ -2666,9 +2729,7 @@ export type AlignItemsKeyword =
|
|
|
2666
2729
|
| OverflowPosition
|
|
2667
2730
|
| ContentPosition;
|
|
2668
2731
|
/**
|
|
2669
|
-
* 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.
|
|
2670
|
-
*
|
|
2671
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
2732
|
+
* 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).
|
|
2672
2733
|
*/
|
|
2673
2734
|
export type JustifyContentKeyword =
|
|
2674
2735
|
| 'normal'
|
|
@@ -2676,9 +2737,7 @@ export type JustifyContentKeyword =
|
|
|
2676
2737
|
| OverflowPosition
|
|
2677
2738
|
| ContentPosition;
|
|
2678
2739
|
/**
|
|
2679
|
-
*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.
|
|
2680
|
-
*
|
|
2681
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
2740
|
+
*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).
|
|
2682
2741
|
*/
|
|
2683
2742
|
export type AlignContentKeyword =
|
|
2684
2743
|
| 'normal'
|
|
@@ -2688,68 +2747,60 @@ export type AlignContentKeyword =
|
|
|
2688
2747
|
| ContentPosition;
|
|
2689
2748
|
interface GridProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
|
|
2690
2749
|
/**
|
|
2691
|
-
Define columns and specify their size.
|
|
2750
|
+
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).
|
|
2692
2751
|
|
|
2693
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns
|
|
2694
2752
|
@default 'none'
|
|
2695
2753
|
*/
|
|
2696
2754
|
gridTemplateColumns?: MaybeResponsive<string>;
|
|
2697
2755
|
/**
|
|
2698
|
-
Define rows and specify their size.
|
|
2756
|
+
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).
|
|
2699
2757
|
|
|
2700
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows
|
|
2701
2758
|
@default 'none'
|
|
2702
2759
|
*/
|
|
2703
2760
|
gridTemplateRows?: MaybeResponsive<string>;
|
|
2704
2761
|
/**
|
|
2705
|
-
Aligns the grid items along the inline (row) axis.
|
|
2762
|
+
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).
|
|
2706
2763
|
|
|
2707
2764
|
This overrides the inline value of `placeItems`.
|
|
2708
2765
|
|
|
2709
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
|
|
2710
2766
|
@default '' - meaning no override
|
|
2711
2767
|
*/
|
|
2712
2768
|
justifyItems?: MaybeResponsive<JustifyItemsKeyword | ''>;
|
|
2713
2769
|
/**
|
|
2714
|
-
Aligns the grid items along the block (column) axis.
|
|
2770
|
+
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).
|
|
2715
2771
|
|
|
2716
2772
|
This overrides the block value of `placeItems`.
|
|
2717
2773
|
|
|
2718
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
2719
2774
|
@default '' - meaning no override
|
|
2720
2775
|
*/
|
|
2721
2776
|
alignItems?: MaybeResponsive<AlignItemsKeyword | ''>;
|
|
2722
2777
|
/**
|
|
2723
|
-
A shorthand property for `justify-items` and `align-items`.
|
|
2778
|
+
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).
|
|
2724
2779
|
|
|
2725
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/place-items
|
|
2726
2780
|
@default 'normal normal'
|
|
2727
2781
|
*/
|
|
2728
2782
|
placeItems?: MaybeResponsive<
|
|
2729
2783
|
`${AlignItemsKeyword} ${JustifyItemsKeyword}` | AlignItemsKeyword
|
|
2730
2784
|
>;
|
|
2731
2785
|
/**
|
|
2732
|
-
Aligns the grid along the inline (row) axis.
|
|
2786
|
+
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).
|
|
2733
2787
|
|
|
2734
2788
|
This overrides the inline value of `placeContent`.
|
|
2735
2789
|
|
|
2736
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
2737
2790
|
@default '' - meaning no override
|
|
2738
2791
|
*/
|
|
2739
2792
|
justifyContent?: MaybeResponsive<JustifyContentKeyword | ''>;
|
|
2740
2793
|
/**
|
|
2741
|
-
Aligns the grid along the block (column) axis.
|
|
2794
|
+
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).
|
|
2742
2795
|
|
|
2743
2796
|
This overrides the block value of `placeContent`.
|
|
2744
2797
|
|
|
2745
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
2746
2798
|
@default '' - meaning no override
|
|
2747
2799
|
*/
|
|
2748
2800
|
alignContent?: MaybeResponsive<AlignContentKeyword | ''>;
|
|
2749
2801
|
/**
|
|
2750
|
-
A shorthand property for `justify-content` and `align-content`.
|
|
2802
|
+
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).
|
|
2751
2803
|
|
|
2752
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/place-content
|
|
2753
2804
|
@default 'normal normal'
|
|
2754
2805
|
*/
|
|
2755
2806
|
placeContent?: MaybeResponsive<
|
|
@@ -2758,17 +2809,13 @@ interface GridProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
|
|
|
2758
2809
|
}
|
|
2759
2810
|
interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole {
|
|
2760
2811
|
/**
|
|
2761
|
-
*
|
|
2762
|
-
*
|
|
2763
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column
|
|
2812
|
+
* 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).
|
|
2764
2813
|
*
|
|
2765
2814
|
* @default 'auto'
|
|
2766
2815
|
*/
|
|
2767
2816
|
gridColumn?: `span ${number}` | 'auto';
|
|
2768
2817
|
/**
|
|
2769
|
-
*
|
|
2770
|
-
*
|
|
2771
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
|
|
2818
|
+
* 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).
|
|
2772
2819
|
*
|
|
2773
2820
|
* @default 'auto'
|
|
2774
2821
|
*/
|
|
@@ -2776,21 +2823,29 @@ interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole {
|
|
|
2776
2823
|
}
|
|
2777
2824
|
export interface BaseTypographyProps {
|
|
2778
2825
|
/**
|
|
2779
|
-
*
|
|
2826
|
+
* The color intensity of the text. Use `subdued` for less intense, `base` for standard, or `strong` for more intense coloring.
|
|
2780
2827
|
*
|
|
2781
2828
|
* @default 'base'
|
|
2782
2829
|
*/
|
|
2783
2830
|
color?: ColorKeyword;
|
|
2784
2831
|
/**
|
|
2785
|
-
*
|
|
2832
|
+
* The semantic meaning and color treatment of the component.
|
|
2833
|
+
*
|
|
2834
|
+
* - `auto`: Automatically determined based on context.
|
|
2835
|
+
* - `neutral`: General information without specific intent.
|
|
2836
|
+
* - `info`: Informational content or helpful tips.
|
|
2837
|
+
* - `success`: Positive outcomes or successful states.
|
|
2838
|
+
* - `caution`: Advisory notices that need attention.
|
|
2839
|
+
* - `warning`: Important warnings about potential issues.
|
|
2840
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
2841
|
+
* - `accent`: Highlighted or promotional content.
|
|
2842
|
+
* - `custom`: Custom styling controlled by your theme.
|
|
2786
2843
|
*
|
|
2787
2844
|
* @default 'auto'
|
|
2788
2845
|
*/
|
|
2789
2846
|
tone?: ToneKeyword;
|
|
2790
2847
|
/**
|
|
2791
|
-
* Set the numeric properties of the font.
|
|
2792
|
-
*
|
|
2793
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric
|
|
2848
|
+
* 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).
|
|
2794
2849
|
*
|
|
2795
2850
|
* @default 'auto' - inherit from the parent element
|
|
2796
2851
|
*/
|
|
@@ -2808,12 +2863,12 @@ export interface BaseTypographyProps {
|
|
|
2808
2863
|
/**
|
|
2809
2864
|
* Indicates the directionality of the element’s text.
|
|
2810
2865
|
*
|
|
2811
|
-
* - `
|
|
2812
|
-
* - `
|
|
2813
|
-
* - `
|
|
2814
|
-
* - `
|
|
2866
|
+
* - `""`: The direction is inherited from parent elements (equivalent to not setting the attribute).
|
|
2867
|
+
* - `auto`: The user agent determines the direction based on the content.
|
|
2868
|
+
* - `ltr`: The languages written from left to right (such as English).
|
|
2869
|
+
* - `rtl`: The languages written from right to left (such as Arabic).
|
|
2815
2870
|
*
|
|
2816
|
-
*
|
|
2871
|
+
* Learn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).
|
|
2817
2872
|
*
|
|
2818
2873
|
* @default ''
|
|
2819
2874
|
*/
|
|
@@ -2821,9 +2876,7 @@ export interface BaseTypographyProps {
|
|
|
2821
2876
|
}
|
|
2822
2877
|
export interface BlockTypographyProps {
|
|
2823
2878
|
/**
|
|
2824
|
-
* Truncates the text content to the specified number of lines.
|
|
2825
|
-
*
|
|
2826
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp
|
|
2879
|
+
* 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).
|
|
2827
2880
|
*
|
|
2828
2881
|
* @default Infinity - no truncation is applied
|
|
2829
2882
|
*/
|
|
@@ -2834,7 +2887,7 @@ interface HeadingProps$1
|
|
|
2834
2887
|
AccessibilityVisibilityProps,
|
|
2835
2888
|
BlockTypographyProps {
|
|
2836
2889
|
/**
|
|
2837
|
-
* The content of the
|
|
2890
|
+
* The content of the heading.
|
|
2838
2891
|
*/
|
|
2839
2892
|
children?: ComponentChildren;
|
|
2840
2893
|
/**
|
|
@@ -2862,67 +2915,69 @@ interface IconProps$1
|
|
|
2862
2915
|
extends GlobalProps,
|
|
2863
2916
|
Pick<InteractionProps, 'interestFor'> {
|
|
2864
2917
|
/**
|
|
2865
|
-
*
|
|
2918
|
+
* The semantic meaning and color treatment of the component.
|
|
2919
|
+
*
|
|
2920
|
+
* - `auto`: Automatically determined based on context.
|
|
2921
|
+
* - `neutral`: General information without specific intent.
|
|
2922
|
+
* - `info`: Informational content or helpful tips.
|
|
2923
|
+
* - `success`: Positive outcomes or successful states.
|
|
2924
|
+
* - `caution`: Advisory notices that need attention.
|
|
2925
|
+
* - `warning`: Important warnings about potential issues.
|
|
2926
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
2866
2927
|
*
|
|
2867
2928
|
* @default 'auto'
|
|
2868
2929
|
*/
|
|
2869
2930
|
tone?: ToneKeyword;
|
|
2870
2931
|
/**
|
|
2871
|
-
*
|
|
2932
|
+
* The color intensity of the icon. Use `subdued` for less intense, `base` for standard, or `strong` for more intense coloring.
|
|
2872
2933
|
*
|
|
2873
2934
|
* @default 'base'
|
|
2874
2935
|
*/
|
|
2875
2936
|
color?: ColorKeyword;
|
|
2876
2937
|
/**
|
|
2877
|
-
*
|
|
2938
|
+
* The size of the icon. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size.
|
|
2878
2939
|
*
|
|
2879
2940
|
* @default 'base'
|
|
2880
2941
|
*/
|
|
2881
2942
|
size?: SizeKeyword;
|
|
2943
|
+
/**
|
|
2944
|
+
* The icon to display. Can be any icon name from the icon library or a custom string identifier.
|
|
2945
|
+
*/
|
|
2882
2946
|
type?: IconType | AnyString;
|
|
2883
2947
|
}
|
|
2884
2948
|
export interface BaseImageProps {
|
|
2885
2949
|
/**
|
|
2886
|
-
*
|
|
2887
|
-
*
|
|
2888
|
-
*
|
|
2889
|
-
*
|
|
2890
|
-
*
|
|
2891
|
-
*
|
|
2892
|
-
*
|
|
2893
|
-
*
|
|
2894
|
-
*
|
|
2895
|
-
*
|
|
2896
|
-
*
|
|
2897
|
-
*
|
|
2898
|
-
*
|
|
2899
|
-
* @default
|
|
2900
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt
|
|
2950
|
+
* Alternative text that describes the image for accessibility.
|
|
2951
|
+
*
|
|
2952
|
+
* Provides a text description of the image for users with assistive technology
|
|
2953
|
+
* and serves as a fallback when the image fails to load. A well-written description
|
|
2954
|
+
* enables people with visual impairments to understand non-text content.
|
|
2955
|
+
*
|
|
2956
|
+
* When a screen reader encounters an image, it reads this description aloud.
|
|
2957
|
+
* When an image fails to load, this text displays on screen, helping all users
|
|
2958
|
+
* understand what content was intended.
|
|
2959
|
+
*
|
|
2960
|
+
* Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4)
|
|
2961
|
+
* and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).
|
|
2962
|
+
*
|
|
2963
|
+
* @default ''
|
|
2901
2964
|
*/
|
|
2902
2965
|
alt?: string;
|
|
2903
2966
|
/**
|
|
2904
|
-
* A set of media conditions and their corresponding sizes.
|
|
2905
|
-
*
|
|
2906
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes
|
|
2967
|
+
* 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).
|
|
2907
2968
|
*/
|
|
2908
2969
|
sizes?: string;
|
|
2909
2970
|
/**
|
|
2910
2971
|
* The image source (either a remote URL or a local file resource).
|
|
2911
2972
|
*
|
|
2912
|
-
* When the image is loading or no `src` is provided, a placeholder
|
|
2973
|
+
* When the image is loading or no `src` is provided, a placeholder is rendered.
|
|
2913
2974
|
*
|
|
2914
2975
|
* @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be
|
|
2915
|
-
* reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare.
|
|
2916
|
-
*
|
|
2917
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src
|
|
2976
|
+
* 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).
|
|
2918
2977
|
*/
|
|
2919
2978
|
src?: string;
|
|
2920
2979
|
/**
|
|
2921
|
-
* A set of image sources and their width or pixel density descriptors.
|
|
2922
|
-
*
|
|
2923
|
-
* This overrides the `src` property.
|
|
2924
|
-
*
|
|
2925
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset
|
|
2980
|
+
* 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.
|
|
2926
2981
|
*/
|
|
2927
2982
|
srcSet?: string;
|
|
2928
2983
|
}
|
|
@@ -2932,6 +2987,10 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
|
|
|
2932
2987
|
* the role will be used by assistive technologies to help users
|
|
2933
2988
|
* navigate the page.
|
|
2934
2989
|
*
|
|
2990
|
+
* - `img`: Identifies the element as an image that conveys meaningful information to users.
|
|
2991
|
+
* - `presentation`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.
|
|
2992
|
+
* - `none`: Completely hides the element and its content from assistive technologies.
|
|
2993
|
+
*
|
|
2935
2994
|
* @default 'img'
|
|
2936
2995
|
*
|
|
2937
2996
|
* @implementation The `img` role doesn't need to be applied if
|
|
@@ -2942,14 +3001,14 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
|
|
|
2942
3001
|
| 'img'
|
|
2943
3002
|
| ExtractStrict<AccessibilityRole, 'presentation' | 'none'>;
|
|
2944
3003
|
/**
|
|
2945
|
-
* The
|
|
3004
|
+
* The inline width (horizontal size) of the image.
|
|
2946
3005
|
*
|
|
2947
|
-
* - `fill`:
|
|
2948
|
-
* - `auto`:
|
|
3006
|
+
* - `fill`: The image takes up 100% of the available inline space.
|
|
3007
|
+
* - `auto`: The image is displayed at its natural size.
|
|
2949
3008
|
*
|
|
2950
|
-
*
|
|
3009
|
+
* Learn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width).
|
|
2951
3010
|
*
|
|
2952
|
-
* @
|
|
3011
|
+
* @default 'fill'
|
|
2953
3012
|
*/
|
|
2954
3013
|
inlineSize?: 'fill' | 'auto';
|
|
2955
3014
|
/**
|
|
@@ -2963,20 +3022,18 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
|
|
|
2963
3022
|
* For example, if the value is set as `50 / 100`, the getter returns `50 / 100`.
|
|
2964
3023
|
* If the value is set as `0.5`, the getter returns `0.5 / 1`.
|
|
2965
3024
|
*
|
|
2966
|
-
*
|
|
3025
|
+
* Learn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio).
|
|
2967
3026
|
*
|
|
2968
|
-
* @
|
|
3027
|
+
* @default '1/1'
|
|
2969
3028
|
*/
|
|
2970
3029
|
aspectRatio?:
|
|
2971
3030
|
| `${number}${optionalSpace}/${optionalSpace}${number}`
|
|
2972
3031
|
| `${number}`;
|
|
2973
3032
|
/**
|
|
2974
3033
|
* Determines how the content of the image is resized to fit its container.
|
|
2975
|
-
* The image is positioned in the center of the container.
|
|
3034
|
+
* 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).
|
|
2976
3035
|
*
|
|
2977
3036
|
* @default 'contain'
|
|
2978
|
-
*
|
|
2979
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
|
|
2980
3037
|
*/
|
|
2981
3038
|
objectFit?: 'contain' | 'cover';
|
|
2982
3039
|
/**
|
|
@@ -2984,62 +3041,57 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
|
|
|
2984
3041
|
* - `eager`: Immediately loads the image, irrespective of its position within the visible viewport.
|
|
2985
3042
|
* - `lazy`: Delays loading the image until it approaches a specified distance from the viewport.
|
|
2986
3043
|
*
|
|
3044
|
+
* Learn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading).
|
|
3045
|
+
*
|
|
2987
3046
|
* @default 'eager'
|
|
2988
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading
|
|
2989
3047
|
*/
|
|
2990
3048
|
loading?: 'eager' | 'lazy';
|
|
2991
3049
|
/**
|
|
2992
|
-
*
|
|
2993
|
-
*
|
|
2994
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
|
|
3050
|
+
* 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).
|
|
2995
3051
|
*/
|
|
2996
3052
|
onLoad?: (event: Event) => void;
|
|
2997
3053
|
/**
|
|
2998
|
-
*
|
|
2999
|
-
*
|
|
3000
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
|
|
3054
|
+
* 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).
|
|
3001
3055
|
*/
|
|
3002
3056
|
onError?: (event: Event) => void;
|
|
3003
3057
|
}
|
|
3004
3058
|
interface LinkProps$1 extends GlobalProps, LinkBehaviorProps {
|
|
3005
3059
|
/**
|
|
3006
|
-
* The
|
|
3060
|
+
* The text or elements displayed as the link's content.
|
|
3007
3061
|
*/
|
|
3008
3062
|
children?: ComponentChildren;
|
|
3009
3063
|
/**
|
|
3010
|
-
*
|
|
3064
|
+
* The semantic meaning and color treatment of the component.
|
|
3065
|
+
*
|
|
3066
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
3067
|
+
* - `auto`: Automatically determined based on context.
|
|
3068
|
+
* - `neutral`: General information without specific intent.
|
|
3011
3069
|
*
|
|
3012
3070
|
* @default 'auto'
|
|
3013
3071
|
*/
|
|
3014
3072
|
tone?: ToneKeyword;
|
|
3015
3073
|
/**
|
|
3016
|
-
* A label that describes the purpose or
|
|
3017
|
-
*
|
|
3018
|
-
* Use this when using only an icon or the content of the link is not enough context
|
|
3019
|
-
* for users using assistive technologies.
|
|
3074
|
+
* 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.
|
|
3020
3075
|
*/
|
|
3021
3076
|
accessibilityLabel?: string;
|
|
3022
3077
|
/**
|
|
3023
|
-
*
|
|
3024
|
-
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
3025
|
-
* [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
|
|
3078
|
+
* 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).
|
|
3026
3079
|
*/
|
|
3027
3080
|
lang?: string;
|
|
3028
3081
|
}
|
|
3029
3082
|
interface ListItemProps$1 extends GlobalProps {
|
|
3030
3083
|
/**
|
|
3031
|
-
* The content
|
|
3084
|
+
* The content displayed within the list item.
|
|
3032
3085
|
*/
|
|
3033
3086
|
children?: ComponentChildren;
|
|
3034
3087
|
}
|
|
3035
3088
|
interface MenuProps$1 extends GlobalProps {
|
|
3036
3089
|
/**
|
|
3037
|
-
* A label that describes the purpose or
|
|
3038
|
-
* it will be announced using assistive technologies and provide additional context.
|
|
3090
|
+
* 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.
|
|
3039
3091
|
*/
|
|
3040
3092
|
accessibilityLabel?: string;
|
|
3041
3093
|
/**
|
|
3042
|
-
* The
|
|
3094
|
+
* 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.
|
|
3043
3095
|
*/
|
|
3044
3096
|
children?: ComponentChildren;
|
|
3045
3097
|
}
|
|
@@ -3057,32 +3109,32 @@ interface ModalProps$1
|
|
|
3057
3109
|
*/
|
|
3058
3110
|
accessibilityLabel?: string;
|
|
3059
3111
|
/**
|
|
3060
|
-
* A title that describes the content of the
|
|
3112
|
+
* A title that describes the content of the modal.
|
|
3061
3113
|
*
|
|
3062
3114
|
*/
|
|
3063
3115
|
heading?: string;
|
|
3064
3116
|
/**
|
|
3065
|
-
* Adjust the padding around the
|
|
3117
|
+
* Adjust the padding around the modal content.
|
|
3066
3118
|
*
|
|
3067
3119
|
* `base`: applies padding that is appropriate for the element.
|
|
3068
3120
|
*
|
|
3069
|
-
* `none`: removes all padding from the element. This can be useful when elements inside the
|
|
3070
|
-
* to the edge of the
|
|
3121
|
+
* `none`: removes all padding from the element. This can be useful when elements inside the modal need to span
|
|
3122
|
+
* to the edge of the modal. For example, a full-width image. In this case, rely on box with a padding of 'base'
|
|
3071
3123
|
* to bring back the desired padding for the rest of the content.
|
|
3072
3124
|
*
|
|
3073
3125
|
* @default 'base'
|
|
3074
3126
|
*/
|
|
3075
3127
|
padding?: 'base' | 'none';
|
|
3076
3128
|
/**
|
|
3077
|
-
* Adjust the size of the
|
|
3129
|
+
* Adjust the size of the modal.
|
|
3078
3130
|
*
|
|
3079
|
-
* `max`: expands the
|
|
3131
|
+
* `max`: expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.
|
|
3080
3132
|
*
|
|
3081
3133
|
* @default 'base'
|
|
3082
3134
|
*/
|
|
3083
3135
|
size?: SizeKeyword | 'max';
|
|
3084
3136
|
/**
|
|
3085
|
-
* The content of the
|
|
3137
|
+
* The content of the modal.
|
|
3086
3138
|
*/
|
|
3087
3139
|
children?: ComponentChildren;
|
|
3088
3140
|
}
|
|
@@ -3102,28 +3154,30 @@ interface NumberFieldProps$1
|
|
|
3102
3154
|
NumberConstraintsProps,
|
|
3103
3155
|
FieldDecorationProps {
|
|
3104
3156
|
/**
|
|
3105
|
-
* Sets the virtual keyboard.
|
|
3157
|
+
* Sets the virtual keyboard. Learn more about the [inputmode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).
|
|
3106
3158
|
*
|
|
3107
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
|
|
3108
3159
|
* @default 'decimal'
|
|
3109
3160
|
*/
|
|
3110
3161
|
inputMode?: 'decimal' | 'numeric';
|
|
3111
3162
|
/**
|
|
3112
|
-
* Callback when the user has **finished editing** a field,
|
|
3113
|
-
*
|
|
3114
|
-
* Also fired after `onInput` on every step when interacting with the controls or the keyboard up and down arrows.
|
|
3115
|
-
*
|
|
3116
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
|
|
3163
|
+
* Callback when the user has **finished editing** a field, such as when they blur the field after changing the value.
|
|
3164
|
+
* 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).
|
|
3117
3165
|
*/
|
|
3118
3166
|
onChange?: (event: Event) => void;
|
|
3119
3167
|
/**
|
|
3120
|
-
*
|
|
3121
|
-
* Also fired before `onChange` on every step when interacting with the controls or the keyboard up and down arrows.
|
|
3122
|
-
*
|
|
3123
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
|
|
3168
|
+
* 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).
|
|
3124
3169
|
*/
|
|
3125
3170
|
onInput?: (event: Event) => void;
|
|
3126
3171
|
}
|
|
3172
|
+
/**
|
|
3173
|
+
* Represents autocomplete values that are valid for number input fields.
|
|
3174
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for numeric inputs.
|
|
3175
|
+
*
|
|
3176
|
+
* Available values:
|
|
3177
|
+
* - `one-time-code` - One-time codes for authentication (OTP, 2FA codes)
|
|
3178
|
+
* - `cc-number` - Credit card number
|
|
3179
|
+
* - `cc-csc` - Credit card security code (CVV/CVC)
|
|
3180
|
+
*/
|
|
3127
3181
|
export type NumberAutocompleteField = ExtractStrict<
|
|
3128
3182
|
AnyAutocompleteField,
|
|
3129
3183
|
'one-time-code' | 'cc-number' | 'cc-csc'
|
|
@@ -3142,20 +3196,18 @@ interface OptionGroupProps$1 extends GlobalProps {
|
|
|
3142
3196
|
*/
|
|
3143
3197
|
disabled?: boolean;
|
|
3144
3198
|
/**
|
|
3145
|
-
* The
|
|
3199
|
+
* The label text displayed for this group of related options.
|
|
3146
3200
|
*/
|
|
3147
3201
|
label?: string;
|
|
3148
3202
|
/**
|
|
3149
|
-
* The
|
|
3150
|
-
*
|
|
3151
|
-
* Accepts `Option` components.
|
|
3203
|
+
* The collection of option components that users can select from within this group.
|
|
3152
3204
|
*/
|
|
3153
3205
|
children?: ComponentChildren;
|
|
3154
3206
|
}
|
|
3155
3207
|
interface OrderedListProps$1 extends GlobalProps {}
|
|
3156
3208
|
interface PageProps$1 extends GlobalProps, ActionSlots {
|
|
3157
3209
|
/**
|
|
3158
|
-
* The content of the
|
|
3210
|
+
* The content of the page.
|
|
3159
3211
|
*/
|
|
3160
3212
|
children?: ComponentChildren;
|
|
3161
3213
|
/**
|
|
@@ -3195,13 +3247,13 @@ interface ParagraphProps$1
|
|
|
3195
3247
|
BlockTypographyProps,
|
|
3196
3248
|
AccessibilityVisibilityProps {
|
|
3197
3249
|
/**
|
|
3198
|
-
* The
|
|
3250
|
+
* The text or elements displayed within the paragraph.
|
|
3199
3251
|
*/
|
|
3200
3252
|
children?: ComponentChildren;
|
|
3201
3253
|
/**
|
|
3202
|
-
*
|
|
3254
|
+
* The semantic type of the paragraph, which provides meaning and default styling.
|
|
3203
3255
|
*
|
|
3204
|
-
* Other presentation properties on
|
|
3256
|
+
* Other presentation properties on the paragraph can override the default styling.
|
|
3205
3257
|
*
|
|
3206
3258
|
* @default 'paragraph'
|
|
3207
3259
|
*/
|
|
@@ -3209,20 +3261,13 @@ interface ParagraphProps$1
|
|
|
3209
3261
|
}
|
|
3210
3262
|
export type ParagraphType =
|
|
3211
3263
|
/**
|
|
3212
|
-
*
|
|
3213
|
-
*
|
|
3214
|
-
* In an HTML host, the text will be rendered in an `<p>` element.
|
|
3215
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p
|
|
3264
|
+
* 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).
|
|
3216
3265
|
*/
|
|
3217
3266
|
| 'paragraph'
|
|
3218
3267
|
/**
|
|
3219
|
-
* Indicates the text is considered less important than the main content
|
|
3220
|
-
* It can be used for secondary content but also for disclaimers, terms and conditions, or legal information.
|
|
3268
|
+
* 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.
|
|
3221
3269
|
*
|
|
3222
|
-
* Surfaces should apply a smaller font size than the default
|
|
3223
|
-
*
|
|
3224
|
-
* In an HTML host, the text will be rendered in a `<small>` element.
|
|
3225
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small
|
|
3270
|
+
* 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).
|
|
3226
3271
|
*/
|
|
3227
3272
|
| 'small';
|
|
3228
3273
|
interface PasswordFieldProps$1
|
|
@@ -3230,6 +3275,14 @@ interface PasswordFieldProps$1
|
|
|
3230
3275
|
BaseTextFieldProps,
|
|
3231
3276
|
MinMaxLengthProps,
|
|
3232
3277
|
AutocompleteProps<PasswordAutocompleteField> {}
|
|
3278
|
+
/**
|
|
3279
|
+
* Represents autocomplete values that are valid for password input fields.
|
|
3280
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for password inputs.
|
|
3281
|
+
*
|
|
3282
|
+
* Available values:
|
|
3283
|
+
* - `current-password` - Existing password for login or authentication
|
|
3284
|
+
* - `new-password` - New password when creating an account or changing password
|
|
3285
|
+
*/
|
|
3233
3286
|
export type PasswordAutocompleteField = ExtractStrict<
|
|
3234
3287
|
AnyAutocompleteField,
|
|
3235
3288
|
'new-password' | 'current-password'
|
|
@@ -3251,15 +3304,15 @@ interface QueryContainerProps$1 extends GlobalProps {
|
|
|
3251
3304
|
*/
|
|
3252
3305
|
children?: ComponentChildren;
|
|
3253
3306
|
/**
|
|
3254
|
-
*
|
|
3307
|
+
* An identifier for this container that you can reference in CSS container queries to apply styles based on this specific container's size.
|
|
3255
3308
|
*
|
|
3256
|
-
*
|
|
3309
|
+
* 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)`.
|
|
3257
3310
|
*
|
|
3258
|
-
*
|
|
3311
|
+
* 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)`.
|
|
3259
3312
|
*
|
|
3260
|
-
*
|
|
3313
|
+
* Learn more about the [container-name property](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name).
|
|
3261
3314
|
*
|
|
3262
|
-
* @
|
|
3315
|
+
* @default ''
|
|
3263
3316
|
*
|
|
3264
3317
|
* @implementation You must always have a CSS `container-name` of `s-default` for this component.
|
|
3265
3318
|
*/
|
|
@@ -3267,29 +3320,22 @@ interface QueryContainerProps$1 extends GlobalProps {
|
|
|
3267
3320
|
}
|
|
3268
3321
|
interface SectionProps$1 extends GlobalProps, ActionSlots {
|
|
3269
3322
|
/**
|
|
3270
|
-
* The content of the
|
|
3323
|
+
* The content of the section.
|
|
3271
3324
|
*/
|
|
3272
3325
|
children?: ComponentChildren;
|
|
3273
3326
|
/**
|
|
3274
|
-
* A label
|
|
3275
|
-
*
|
|
3276
|
-
* When no `heading` property is provided or included as a children of the Section, you **must** provide an
|
|
3277
|
-
* `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide
|
|
3278
|
-
* the right context to users.
|
|
3327
|
+
* 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.
|
|
3279
3328
|
*/
|
|
3280
3329
|
accessibilityLabel?: string;
|
|
3281
3330
|
/**
|
|
3282
|
-
*
|
|
3331
|
+
* 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.
|
|
3283
3332
|
*/
|
|
3284
3333
|
heading?: string;
|
|
3285
3334
|
/**
|
|
3286
|
-
*
|
|
3335
|
+
* The amount of padding applied to all edges of the section.
|
|
3287
3336
|
*
|
|
3288
|
-
* - `base`:
|
|
3289
|
-
*
|
|
3290
|
-
* - `none`: removes all padding from the element. This can be useful when elements inside the Section need to span
|
|
3291
|
-
* to the edge of the Section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base'
|
|
3292
|
-
* to bring back the desired padding for the rest of the content.
|
|
3337
|
+
* - `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.
|
|
3338
|
+
* - `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.
|
|
3293
3339
|
*
|
|
3294
3340
|
* @default 'base'
|
|
3295
3341
|
*/
|
|
@@ -3302,59 +3348,61 @@ interface SelectProps$1
|
|
|
3302
3348
|
Omit<FieldProps, 'defaultValue'>,
|
|
3303
3349
|
FocusEventProps {
|
|
3304
3350
|
/**
|
|
3305
|
-
* The options
|
|
3351
|
+
* The selectable options displayed in the dropdown list.
|
|
3306
3352
|
*
|
|
3307
|
-
* Accepts
|
|
3353
|
+
* Accepts Option components for individual selectable items, and OptionGroup components to organize related options into logical groups with labels.
|
|
3308
3354
|
*/
|
|
3309
3355
|
children?: ComponentChildren;
|
|
3310
3356
|
}
|
|
3311
3357
|
interface SpinnerProps$1 extends GlobalProps {
|
|
3312
3358
|
/**
|
|
3313
|
-
*
|
|
3359
|
+
* The size of the spinner icon. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size.
|
|
3314
3360
|
*
|
|
3315
3361
|
* @default 'base'
|
|
3316
3362
|
*/
|
|
3317
3363
|
size?: SizeKeyword;
|
|
3318
3364
|
/**
|
|
3319
|
-
* A label that describes the purpose of the
|
|
3320
|
-
* it will be announced to users using assistive technologies and will
|
|
3321
|
-
* provide them with more context. Providing an `accessibilityLabel` is
|
|
3322
|
-
* recommended if there is no accompanying text describing that something
|
|
3323
|
-
* is loading.
|
|
3365
|
+
* 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.
|
|
3324
3366
|
*/
|
|
3325
3367
|
accessibilityLabel?: string;
|
|
3326
3368
|
}
|
|
3327
3369
|
interface StackProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
|
|
3328
3370
|
/**
|
|
3329
|
-
* The
|
|
3371
|
+
* The elements arranged within the stack layout.
|
|
3330
3372
|
*/
|
|
3331
3373
|
children?: ComponentChildren;
|
|
3332
3374
|
/**
|
|
3333
|
-
*
|
|
3375
|
+
* 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).
|
|
3376
|
+
*
|
|
3377
|
+
* - `block`: Arranges children vertically (in horizontal writing modes). Content does not wrap.
|
|
3378
|
+
* - `inline`: Arranges children horizontally (in horizontal writing modes). Content wraps to the next line if needed.
|
|
3334
3379
|
*
|
|
3335
3380
|
* @default 'block'
|
|
3336
3381
|
*
|
|
3337
|
-
* @implementation
|
|
3382
|
+
* @implementation The content will wrap if the direction is 'inline', and not wrap if the direction is 'block'.
|
|
3338
3383
|
*/
|
|
3339
3384
|
direction?: MaybeResponsive<'block' | 'inline'>;
|
|
3340
3385
|
/**
|
|
3341
|
-
*
|
|
3386
|
+
* Controls the distribution of children along the inline axis (horizontally in horizontal writing modes).
|
|
3387
|
+
*
|
|
3388
|
+
* 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).
|
|
3342
3389
|
*
|
|
3343
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
3344
3390
|
* @default 'normal'
|
|
3345
3391
|
*/
|
|
3346
3392
|
justifyContent?: MaybeResponsive<JustifyContentKeyword>;
|
|
3347
3393
|
/**
|
|
3348
|
-
*
|
|
3394
|
+
* Controls the alignment of children along the block axis (vertically in horizontal writing modes).
|
|
3395
|
+
*
|
|
3396
|
+
* 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).
|
|
3349
3397
|
*
|
|
3350
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
3351
3398
|
* @default 'normal'
|
|
3352
3399
|
*/
|
|
3353
3400
|
alignItems?: MaybeResponsive<AlignItemsKeyword>;
|
|
3354
3401
|
/**
|
|
3355
|
-
*
|
|
3402
|
+
* Controls the distribution of lines along the block axis when content wraps into multiple lines.
|
|
3403
|
+
*
|
|
3404
|
+
* 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).
|
|
3356
3405
|
*
|
|
3357
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
3358
3406
|
* @default 'normal'
|
|
3359
3407
|
*/
|
|
3360
3408
|
alignContent?: MaybeResponsive<AlignContentKeyword>;
|
|
@@ -3373,11 +3421,11 @@ export interface PaginationProps {
|
|
|
3373
3421
|
*/
|
|
3374
3422
|
paginate?: boolean;
|
|
3375
3423
|
/**
|
|
3376
|
-
*
|
|
3424
|
+
* A callback fired when the previous page button is clicked.
|
|
3377
3425
|
*/
|
|
3378
3426
|
onPreviousPage?: (event: Event) => void;
|
|
3379
3427
|
/**
|
|
3380
|
-
*
|
|
3428
|
+
* A callback fired when the next page button is clicked.
|
|
3381
3429
|
*/
|
|
3382
3430
|
onNextPage?: (event: Event) => void;
|
|
3383
3431
|
/**
|
|
@@ -3393,8 +3441,8 @@ export interface PaginationProps {
|
|
|
3393
3441
|
*/
|
|
3394
3442
|
hasPreviousPage?: boolean;
|
|
3395
3443
|
/**
|
|
3396
|
-
* Whether the table is in a loading state, such as initial page load or loading the next page in a paginated table.
|
|
3397
|
-
* When true
|
|
3444
|
+
* Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table.
|
|
3445
|
+
* When `true`, the table might be in an inert state that prevents user interaction.
|
|
3398
3446
|
*
|
|
3399
3447
|
* @default false
|
|
3400
3448
|
*/
|
|
@@ -3402,19 +3450,23 @@ export interface PaginationProps {
|
|
|
3402
3450
|
}
|
|
3403
3451
|
interface TableProps$1 extends GlobalProps, PaginationProps {
|
|
3404
3452
|
/**
|
|
3405
|
-
* The
|
|
3453
|
+
* The table structure defining headers and data rows.
|
|
3454
|
+
*
|
|
3455
|
+
* 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.
|
|
3406
3456
|
*/
|
|
3407
3457
|
children?: ComponentChildren;
|
|
3408
3458
|
/**
|
|
3409
|
-
*
|
|
3459
|
+
* Filter controls displayed above the table.
|
|
3460
|
+
*
|
|
3461
|
+
* Accepts input components like search field or select for filtering table data. These controls appear in a dedicated area above the table content.
|
|
3410
3462
|
*/
|
|
3411
3463
|
filters?: ComponentChildren;
|
|
3412
3464
|
/**
|
|
3413
|
-
*
|
|
3465
|
+
* The layout variant of the table.
|
|
3414
3466
|
*
|
|
3415
|
-
* - `list`:
|
|
3416
|
-
* - `table`:
|
|
3417
|
-
* - `auto`:
|
|
3467
|
+
* - `list`: Always displays as a list layout.
|
|
3468
|
+
* - `table`: Always displays as a traditional table layout.
|
|
3469
|
+
* - `auto`: Automatically displays as a table on wide screens and as a list on narrow screens.
|
|
3418
3470
|
*
|
|
3419
3471
|
* @default 'auto'
|
|
3420
3472
|
*/
|
|
@@ -3422,59 +3474,78 @@ interface TableProps$1 extends GlobalProps, PaginationProps {
|
|
|
3422
3474
|
}
|
|
3423
3475
|
interface TableBodyProps$1 extends GlobalProps {
|
|
3424
3476
|
/**
|
|
3425
|
-
* The
|
|
3477
|
+
* The data rows displayed in the table body.
|
|
3478
|
+
*
|
|
3479
|
+
* Accepts TableRow components, with each row representing a single record or entry in the table.
|
|
3426
3480
|
*/
|
|
3427
3481
|
children?: ComponentChildren;
|
|
3428
3482
|
}
|
|
3429
3483
|
interface TableCellProps$1 extends GlobalProps {
|
|
3430
3484
|
/**
|
|
3431
|
-
* The
|
|
3485
|
+
* The data value displayed in this cell.
|
|
3486
|
+
*
|
|
3487
|
+
* Accepts text content or inline components representing the cell's data value.
|
|
3432
3488
|
*/
|
|
3433
3489
|
children?: ComponentChildren;
|
|
3434
3490
|
}
|
|
3491
|
+
/**
|
|
3492
|
+
* Represents the content designation for table columns when displayed in list variant on mobile devices.
|
|
3493
|
+
*
|
|
3494
|
+
* Available values:
|
|
3495
|
+
* - `primary` - The most important content. Only one column can have this designation.
|
|
3496
|
+
* - `secondary` - Supporting content displayed below primary. Only one column can have this designation.
|
|
3497
|
+
* - `kicker` - Small label displayed above primary content with less visual prominence. Only one column can have this designation.
|
|
3498
|
+
* - `inline` - Content displayed inline with primary content.
|
|
3499
|
+
* - `labeled` - Each column displays as a heading-content pair.
|
|
3500
|
+
*/
|
|
3435
3501
|
export type ListSlotType =
|
|
3436
3502
|
| 'primary'
|
|
3437
3503
|
| 'secondary'
|
|
3438
3504
|
| 'kicker'
|
|
3439
3505
|
| 'inline'
|
|
3440
3506
|
| 'labeled';
|
|
3507
|
+
/**
|
|
3508
|
+
* Represents the format options for table headers that control styling and alignment of column content.
|
|
3509
|
+
*
|
|
3510
|
+
* Available values:
|
|
3511
|
+
* - `base`: Standard format for text columns
|
|
3512
|
+
* - `currency`: Right-aligned format for monetary values
|
|
3513
|
+
* - `numeric`: Right-aligned format for numeric values
|
|
3514
|
+
*/
|
|
3515
|
+
export type HeaderFormat = 'base' | 'currency' | 'numeric';
|
|
3441
3516
|
interface TableHeaderProps$1 extends GlobalProps {
|
|
3442
3517
|
/**
|
|
3443
|
-
* The
|
|
3518
|
+
* The column heading text.
|
|
3519
|
+
*
|
|
3520
|
+
* This text labels the column in table variant and appears as a label for data in list variant.
|
|
3444
3521
|
*/
|
|
3445
3522
|
children?: ComponentChildren;
|
|
3446
3523
|
/**
|
|
3447
|
-
*
|
|
3448
|
-
*
|
|
3449
|
-
* - `primary`: The most important content. Only one column can have this designation.
|
|
3450
|
-
* - `secondary`: The secondary content. Only one column can have this designation.
|
|
3451
|
-
* - `kicker`: Content that is displayed before primary and secondary content, but with less visual prominence. Only one column can have this designation.
|
|
3452
|
-
* - `inline`: Content that is displayed inline.
|
|
3453
|
-
* - `labeled`: Each column with this designation displays as a heading-content pair.
|
|
3524
|
+
* The content designation for this column when the table displays in list variant on mobile devices.
|
|
3454
3525
|
*
|
|
3455
3526
|
* @default 'labeled'
|
|
3456
3527
|
*/
|
|
3457
3528
|
listSlot?: ListSlotType;
|
|
3458
3529
|
/**
|
|
3459
|
-
* The format of the column
|
|
3460
|
-
*
|
|
3461
|
-
* - `base`: The base format for columns.
|
|
3462
|
-
* - `currency`: Formats the column as currency.
|
|
3463
|
-
* - `numeric`: Formats the column as a number.
|
|
3530
|
+
* The format of the column that controls styling and alignment of cell content.
|
|
3464
3531
|
*
|
|
3465
3532
|
* @default 'base'
|
|
3466
3533
|
*/
|
|
3467
|
-
format?:
|
|
3534
|
+
format?: HeaderFormat;
|
|
3468
3535
|
}
|
|
3469
3536
|
interface TableHeaderRowProps$1 extends GlobalProps {
|
|
3470
3537
|
/**
|
|
3471
|
-
*
|
|
3538
|
+
* The column headers displayed in the table header row.
|
|
3539
|
+
*
|
|
3540
|
+
* Accepts TableHeader components, with each header defining a column and providing its label.
|
|
3472
3541
|
*/
|
|
3473
3542
|
children?: ComponentChildren;
|
|
3474
3543
|
}
|
|
3475
3544
|
interface TableRowProps$1 extends GlobalProps {
|
|
3476
3545
|
/**
|
|
3477
|
-
* The
|
|
3546
|
+
* The data cells displayed in this table row.
|
|
3547
|
+
*
|
|
3548
|
+
* Accepts TableCell components, with each cell containing a data value for the corresponding column.
|
|
3478
3549
|
*/
|
|
3479
3550
|
children?: ComponentChildren;
|
|
3480
3551
|
/**
|
|
@@ -3485,7 +3556,7 @@ interface TableRowProps$1 extends GlobalProps {
|
|
|
3485
3556
|
* Which is why the target element must be in the table; so that keyboard and screen reader users can interact with it normally.
|
|
3486
3557
|
*
|
|
3487
3558
|
* @implementation no focus or keyboard affordances are introduced by this property. No aria attributes need to be added to the table row.
|
|
3488
|
-
* @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
|
|
3559
|
+
* @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.
|
|
3489
3560
|
*/
|
|
3490
3561
|
clickDelegate?: string;
|
|
3491
3562
|
}
|
|
@@ -3496,11 +3567,11 @@ interface TextProps$1
|
|
|
3496
3567
|
DisplayProps,
|
|
3497
3568
|
Pick<InteractionProps, 'interestFor'> {
|
|
3498
3569
|
/**
|
|
3499
|
-
* The content
|
|
3570
|
+
* The text content or inline elements displayed within the component.
|
|
3500
3571
|
*/
|
|
3501
3572
|
children?: ComponentChildren;
|
|
3502
3573
|
/**
|
|
3503
|
-
*
|
|
3574
|
+
* The semantic type of the text, which provides meaning and default styling.
|
|
3504
3575
|
*
|
|
3505
3576
|
* Other presentation properties on Text override the default styling.
|
|
3506
3577
|
*
|
|
@@ -3516,11 +3587,9 @@ export type TextType =
|
|
|
3516
3587
|
*
|
|
3517
3588
|
* Surfaces may apply styling to this type.
|
|
3518
3589
|
*
|
|
3519
|
-
* In an HTML host, the text will be rendered in an `<address>` element.
|
|
3590
|
+
* 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).
|
|
3520
3591
|
*
|
|
3521
3592
|
* @implementation vertical alignment should be `baseline` (`vertical-align: baseline`)
|
|
3522
|
-
*
|
|
3523
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address
|
|
3524
3593
|
*/
|
|
3525
3594
|
| 'address'
|
|
3526
3595
|
/**
|
|
@@ -3528,8 +3597,7 @@ export type TextType =
|
|
|
3528
3597
|
*
|
|
3529
3598
|
* Surfaces should apply styling to this type to suggest its content no longer applies.
|
|
3530
3599
|
*
|
|
3531
|
-
* In an HTML host, the text will be rendered in a `<s>` element.
|
|
3532
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s
|
|
3600
|
+
* 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).
|
|
3533
3601
|
*/
|
|
3534
3602
|
| 'redundant'
|
|
3535
3603
|
/**
|
|
@@ -3538,8 +3606,7 @@ export type TextType =
|
|
|
3538
3606
|
*
|
|
3539
3607
|
* Surfaces should apply styling to this type to draw attention to the content.
|
|
3540
3608
|
*
|
|
3541
|
-
* In an HTML host, the text will be rendered in a `<mark>` element.
|
|
3542
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark
|
|
3609
|
+
* 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).
|
|
3543
3610
|
*/
|
|
3544
3611
|
| 'mark'
|
|
3545
3612
|
/**
|
|
@@ -3547,8 +3614,7 @@ export type TextType =
|
|
|
3547
3614
|
*
|
|
3548
3615
|
* Surfaces should apply styling to this type to distinguish it from surrounding text. Italicization is a common choice, but not required.
|
|
3549
3616
|
*
|
|
3550
|
-
* In an HTML host, the text will be rendered in an `<em>` element.
|
|
3551
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em
|
|
3617
|
+
* 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).
|
|
3552
3618
|
*/
|
|
3553
3619
|
| 'emphasis'
|
|
3554
3620
|
/**
|
|
@@ -3558,8 +3624,7 @@ export type TextType =
|
|
|
3558
3624
|
*
|
|
3559
3625
|
* Surfaces should italicize this content by default.
|
|
3560
3626
|
*
|
|
3561
|
-
* In an HTML host, the text will be rendered in a `<i>` tag.
|
|
3562
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i
|
|
3627
|
+
* 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).
|
|
3563
3628
|
*/
|
|
3564
3629
|
| 'offset'
|
|
3565
3630
|
/**
|
|
@@ -3567,8 +3632,7 @@ export type TextType =
|
|
|
3567
3632
|
*
|
|
3568
3633
|
* Surfaces should render this content bold by default.
|
|
3569
3634
|
*
|
|
3570
|
-
* In an HTML host, the text will be rendered in a `<strong>` tag.
|
|
3571
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong
|
|
3635
|
+
* 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).
|
|
3572
3636
|
*/
|
|
3573
3637
|
| 'strong'
|
|
3574
3638
|
/**
|
|
@@ -3577,8 +3641,7 @@ export type TextType =
|
|
|
3577
3641
|
*
|
|
3578
3642
|
* Surfaces should apply a smaller font size than the default size.
|
|
3579
3643
|
*
|
|
3580
|
-
* In an HTML host, the text will be rendered in a `<small>` element.
|
|
3581
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small
|
|
3644
|
+
* 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).
|
|
3582
3645
|
*/
|
|
3583
3646
|
| 'small'
|
|
3584
3647
|
/**
|
|
@@ -3586,8 +3649,7 @@ export type TextType =
|
|
|
3586
3649
|
*
|
|
3587
3650
|
* Surfaces must not apply any default styling to this type.
|
|
3588
3651
|
*
|
|
3589
|
-
* In an HTML host, the text will be rendered in a `<span>` tag.
|
|
3590
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span
|
|
3652
|
+
* 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).
|
|
3591
3653
|
*/
|
|
3592
3654
|
| 'generic';
|
|
3593
3655
|
interface TextAreaProps$1
|
|
@@ -3596,7 +3658,7 @@ interface TextAreaProps$1
|
|
|
3596
3658
|
MinMaxLengthProps,
|
|
3597
3659
|
AutocompleteProps<TextAutocompleteField> {
|
|
3598
3660
|
/**
|
|
3599
|
-
*
|
|
3661
|
+
* The number of visible text lines displayed in the textarea, which controls its initial height.
|
|
3600
3662
|
*
|
|
3601
3663
|
* @default 2
|
|
3602
3664
|
*/
|
|
@@ -3610,19 +3672,15 @@ interface TextFieldProps$1
|
|
|
3610
3672
|
FieldDecorationProps {}
|
|
3611
3673
|
interface ThumbnailProps$1 extends GlobalProps, BaseImageProps {
|
|
3612
3674
|
/**
|
|
3613
|
-
*
|
|
3614
|
-
*
|
|
3615
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
|
|
3675
|
+
* 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).
|
|
3616
3676
|
*/
|
|
3617
3677
|
onLoad?: (event: Event) => void;
|
|
3618
3678
|
/**
|
|
3619
|
-
*
|
|
3620
|
-
*
|
|
3621
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
|
|
3679
|
+
* 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).
|
|
3622
3680
|
*/
|
|
3623
3681
|
onError?: (event: Event) => void;
|
|
3624
3682
|
/**
|
|
3625
|
-
*
|
|
3683
|
+
* The size of the product thumbnail image. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size.
|
|
3626
3684
|
*
|
|
3627
3685
|
* @default 'base'
|
|
3628
3686
|
*/
|
|
@@ -3630,7 +3688,7 @@ interface ThumbnailProps$1 extends GlobalProps, BaseImageProps {
|
|
|
3630
3688
|
}
|
|
3631
3689
|
interface TooltipProps$1 extends GlobalProps {
|
|
3632
3690
|
/**
|
|
3633
|
-
* The
|
|
3691
|
+
* The text or elements displayed inside the tooltip popup.
|
|
3634
3692
|
*/
|
|
3635
3693
|
children?: ComponentChildren;
|
|
3636
3694
|
}
|
|
@@ -3640,6 +3698,19 @@ interface URLFieldProps$1
|
|
|
3640
3698
|
BaseTextFieldProps,
|
|
3641
3699
|
MinMaxLengthProps,
|
|
3642
3700
|
AutocompleteProps<URLAutocompleteField> {}
|
|
3701
|
+
/**
|
|
3702
|
+
* Represents autocomplete values that are valid for URL input fields.
|
|
3703
|
+
* This is a subset of `AnyAutocompleteField` containing only fields suitable for URL inputs.
|
|
3704
|
+
*
|
|
3705
|
+
* Available values:
|
|
3706
|
+
* - `url` - General URL or web address
|
|
3707
|
+
* - `photo` - URL to a photo or image
|
|
3708
|
+
* - `impp` - Instant messaging protocol URL
|
|
3709
|
+
* - `home impp` - Home instant messaging protocol URL
|
|
3710
|
+
* - `mobile impp` - Mobile instant messaging protocol URL
|
|
3711
|
+
* - `fax impp` - Fax instant messaging protocol URL
|
|
3712
|
+
* - `pager impp` - Pager instant messaging protocol URL
|
|
3713
|
+
*/
|
|
3643
3714
|
export type URLAutocompleteField = ExtractStrict<
|
|
3644
3715
|
AnyAutocompleteField,
|
|
3645
3716
|
'url' | 'photo' | 'impp' | `${AutocompleteAddressGroup} impp`
|
|
@@ -3654,8 +3725,7 @@ export interface VNode<P = {}> {
|
|
|
3654
3725
|
};
|
|
3655
3726
|
key: Key;
|
|
3656
3727
|
/**
|
|
3657
|
-
* ref is not guaranteed by React.ReactElement
|
|
3658
|
-
* with popular react libs we define it as optional too
|
|
3728
|
+
* The ref is not guaranteed by `React.ReactElement`. For compatibility with popular React libraries, this is defined as optional.
|
|
3659
3729
|
*/
|
|
3660
3730
|
ref?: Ref<any> | null;
|
|
3661
3731
|
/**
|