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