@shopify/ui-extensions 2023.7.2 → 2024.1.0

package/src/surfaces/checkout/components/PaymentIcon/PaymentIcon.ts

@@ -0,0 +1,481 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+// Copied from https://github.com/Shopify/ui-api-design/blob/main/components/PaymentIcon/PaymentIcon.ts
+export type PaymentMethod =
+  | 'visa'
+  | 'master'
+  | 'discover'
+  | 'american-express'
+  | 'diners-club'
+  | 'cartes-bancaires'
+  | 'ing-homepay'
+  | 'jcb'
+  | 'rupay'
+  | 'ethereum'
+  | 'bitcoin'
+  | 'monero'
+  | 'dogecoin'
+  | 'litecoin'
+  | 'bitcoin-cash'
+  | 'dash'
+  | 'eos'
+  | 'dai'
+  | 'usdc'
+  | 'apecoin'
+  | 'solanapay'
+  | 'bnbchain'
+  | 'polygon'
+  | 'depay'
+  | 'busd'
+  | 'gusd'
+  | 'shib'
+  | 'usdp'
+  | 'wbtc'
+  | 'xrp'
+  | 'amazon'
+  | 'boleto'
+  | 'kbc-cbc'
+  | 'sepa-bank-transfer'
+  | 'dankort'
+  | 'belfius'
+  | 'dwolla'
+  | 'tensile'
+  | 'forbrugsforeningen'
+  | 'giropay'
+  | 'google-pay'
+  | 'google-wallet'
+  | 'opay'
+  | 'laser'
+  | 'paypal'
+  | 'venmo'
+  | 'sofort'
+  | 'maestro'
+  | 'unionpay'
+  | 'visa-electron'
+  | 'payfast-instant-eft'
+  | 'mobicred'
+  | 'payd'
+  | 'airtel-money'
+  | 'freecharge'
+  | 'ola-money'
+  | 'paytm'
+  | 'mobikwik'
+  | 'payzapp'
+  | 'netbanking'
+  | 'paysera'
+  | 'citadele'
+  | 'danske-bank'
+  | 'krediidipank'
+  | 'lhv'
+  | 'op'
+  | 'nordea'
+  | 'seb'
+  | 'swedbank'
+  | 'dnb'
+  | 'pps'
+  | 'pivo'
+  | 'masterpass'
+  | 'mobilepay'
+  | 'viabill'
+  | 'novuna'
+  | 'divido'
+  | 'duologi'
+  | 'klarna'
+  | 'klarna-pay-now'
+  | 'klarna-pay-later'
+  | 'klarna-slice-it'
+  | 'santander'
+  | 'flexiti'
+  | 'elv'
+  | 'astrapay'
+  | 'ideal'
+  | 'interac'
+  | 'arvato'
+  | 'swish'
+  | 'ratepay'
+  | 'przelew24'
+  | 'epayments'
+  | 'paysafecard'
+  | 'laybuy'
+  | 'sezzle'
+  | 'familymart'
+  | '7-eleven'
+  | 'lawson'
+  | 'circle-k'
+  | 'ministop'
+  | 'sunkus'
+  | 'daily-yamazaki'
+  | 'mondido'
+  | 'collector-bank'
+  | 'apple-pay'
+  | 'shopify-pay'
+  | 'trustly'
+  | 'ambank'
+  | 'cimb'
+  | 'hong-leong-bank'
+  | 'maybank'
+  | 'public-bank'
+  | 'rhb-bank'
+  | 'paymark-online-eftpos'
+  | 'esr-paymentslip-switzerland'
+  | 'twint'
+  | 'elo'
+  | 'hyper'
+  | 'hypercard'
+  | 'fpx'
+  | 'atm-bersama'
+  | 'bancnet'
+  | 'eghl'
+  | 'unipay'
+  | 'mash'
+  | 'jousto'
+  | 'vipps'
+  | 'krungsri'
+  | 'uob'
+  | 'siam-commercial'
+  | 'enets'
+  | 'grabpay'
+  | 'eft-secure'
+  | 'mpesa'
+  | 'ovo'
+  | 'mode'
+  | 'wechat-pay'
+  | 'spraypay'
+  | 'bancontact'
+  | 'in3'
+  | 'v-pay'
+  | 'ebucks'
+  | 'pagoefectivo'
+  | 'ozow'
+  | 'eps'
+  | 'affin-bank'
+  | 'alliance-bank'
+  | 'atobaraidotcom'
+  | 'bank-islam'
+  | 'bank-muamalat'
+  | 'bank-rakyat'
+  | 'bsn'
+  | 'cimb-clicks'
+  | 'deutsche-bank'
+  | 'hong-leong-connect'
+  | 'hsbc'
+  | 'kuwait-finance-house'
+  | 'maybankm2u'
+  | 'ocbc-bank'
+  | 'publicbank-pbe'
+  | 'rhb-now'
+  | 'standard-chartered'
+  | 'afterpay'
+  | 'clearpay'
+  | 'cash-app-pay'
+  | 'smartpay'
+  | 'zapper'
+  | 'payconiq'
+  | 'paidy'
+  | 'twig-pay'
+  | 'stc-pay'
+  | 'paynow'
+  | 'bc-card'
+  | 'hana-card'
+  | 'hyundai-card'
+  | 'kb-card'
+  | 'lotte-card'
+  | 'nh-card'
+  | 'samsung-card'
+  | 'shinhan-card'
+  | 'kakao-pay'
+  | 'kakebaraidotcom'
+  | 'naver-pay'
+  | 'payco'
+  | 'samsung-pay'
+  | 'toss'
+  | 'coop'
+  | 'luminor'
+  | 'bdo'
+  | 'bpi'
+  | 'gcash'
+  | 'afterpay-paynl-version'
+  | 'naps'
+  | 'benefit'
+  | 'sadad'
+  | 'mada'
+  | 'kfast'
+  | 'knet'
+  | 'uae-visa'
+  | 'fps'
+  | 'line-pay'
+  | 'rakuten-pay'
+  | 'pay-easy'
+  | 'merpay'
+  | 'softbank'
+  | 'givacard'
+  | 'ymobile'
+  | 'mtn-mobile-money'
+  | 'fashioncheque'
+  | 'airteltigo-mobile-money'
+  | 'tendopay'
+  | 'coinsph'
+  | 'payu'
+  | 'd-barai'
+  | 'docomo-barai'
+  | 'pay-pay'
+  | 'blik'
+  | 'billink'
+  | 'au-kantan-kessai'
+  | 'mb-way'
+  | 'latitude-creditline-au'
+  | 'latitude-gem-au'
+  | 'latitude-gem-nz'
+  | 'latitude-go-au'
+  | 'mb'
+  | 'bogus-app-coin'
+  | 'postfinance-card'
+  | 'postfinance-efinance'
+  | 'alipay'
+  | 'alipay-hk'
+  | 'ask'
+  | 'paymaya'
+  | 'maya'
+  | 'maya-bank'
+  | 'qr-promptpay'
+  | 'rcs'
+  | 'bangkok-bank'
+  | 'kasikornbank'
+  | 'krungthai-bank'
+  | 'thanachart-bank'
+  | 'uob-thai'
+  | 'bigc'
+  | 'boost'
+  | 'ecpay'
+  | 'maybank-qrpay'
+  | 'mcash'
+  | 'rabbit-line-pay'
+  | 'tesco-lotus'
+  | 'touch-n-go'
+  | 'payme'
+  | 'payflex'
+  | 'maxima'
+  | 'alfamart'
+  | 'alfamidi'
+  | 'dan-dan'
+  | 'indomaret'
+  | 'dana'
+  | 'linkaja'
+  | 'shopeepay'
+  | 'gopay'
+  | 'bca'
+  | 'bni'
+  | 'bri'
+  | 'mandiri'
+  | 'permata'
+  | 'bri-direct-debit'
+  | 'octo-clicks'
+  | 'brimo'
+  | 'danamon-online'
+  | 'bca-klikpay'
+  | 'akulaku'
+  | 'satispay'
+  | 'qrph'
+  | 'arhaus'
+  | 'generalfinancing'
+  | 'ubp'
+  | 'farmlands'
+  | 'qris'
+  | 'axs'
+  | 'sam'
+  | 'facebook-pay'
+  | 'meta-pay'
+  | 'kueski-pay'
+  | 'bread'
+  | 'bread-pay'
+  | 'payplan'
+  | 'nelo'
+  | 'vvv-giftcard'
+  | 'kunst-en-cultuur-cadeaukaart'
+  | 'nationale-bioscoopbon'
+  | 'nationale-entertainmentcard'
+  | 'podium-cadeaukaart'
+  | 'webshop-giftcard'
+  | 'billease'
+  | 'lku'
+  | 'rietumu'
+  | 'affirm'
+  | 'splitit'
+  | 'zip'
+  | 'humm'
+  | 'synchrony'
+  | 'satisfi'
+  | 'checkout-finance'
+  | 'n26'
+  | 'echelon-financing'
+  | 'acima-leasing'
+  | 'synchrony-pay'
+  | 'truemoney-pay'
+  | 'gmo-postpay'
+  | 'giftcard'
+  | 'siauliu-bankas'
+  | 'medicinos-bankas'
+  | 'epospay'
+  | 'poli'
+  | 'perlasfinance'
+  | 'directpay'
+  | 'latitudepay'
+  | 'genoapay'
+  | 'poppankki'
+  | 'revolut'
+  | 'aktia'
+  | 'saastopankki'
+  | 'spankki'
+  | 'walley'
+  | 'atone'
+  | 'addi'
+  | 'omasp'
+  | 'handelsbanken'
+  | 'alandsbanken'
+  | 'siirto'
+  | 'scalapay'
+  | 'aplazo'
+  | 'paybylink'
+  | 'snap-checkout'
+  | 'fairstone-payments'
+  | 'upi'
+  | 'sveaeramaksu'
+  | 'svea-part-payment'
+  | 'svea-delbetalning'
+  | 'svea-lasku'
+  | 'svea-invoice'
+  | 'svea-faktura'
+  | 'svea-yrityslasku'
+  | 'svea-b2b-invoice'
+  | 'svea-b2b-faktura'
+  | 'pix'
+  | 'wegetfinancing'
+  | 'anyday'
+  | 'cleverpay'
+  | 'payid'
+  | 'uangme'
+  | 'grailpay'
+  | 'payto'
+  | 'zinia'
+  | 'fortiva'
+  | 'fintecture'
+  | 'hello-clever'
+  | 'credit-key'
+  | 'palawa'
+  | 'palawan'
+  | 'kredivo'
+  | 'uob-ez-pay'
+  | 'akulaku-paylater'
+  | 'tandympayment'
+  | 'paytomorrow'
+  | 'bsi'
+  | 'clave-telered'
+  | 'credix'
+  | 'sinpe-movil'
+  | 'laybuy-heart'
+  | 'lydia'
+  | 'atome'
+  | 'creditclick-paynl-version'
+  | 'dropp'
+  | 'cebuana'
+  | 'futurepay-mytab'
+  | 'biercheque-paynl-version'
+  | 'swiftpay'
+  | 'linkpay'
+  | 'riverty-paynl-version'
+  | 'wechat-paynl-version'
+  | 'vvv-cadeaukaart-paynl-version'
+  | 'przelewy24-paynl-version'
+  | 'paysafecard-paynl-version'
+  | 'gezondheidsbon-paynl-version'
+  | 'fashion-giftcard-paynlversion'
+  | 'alipay-paynl-version'
+  | 'aftee'
+  | 'momopay'
+  | 'zalopay'
+  | 'finloup'
+  | 'billink-method'
+  | 'oxxo'
+  | 'spei'
+  | 'bbva-cie'
+  | 'alma'
+  | 'svea-ostukonto'
+  | 'svea-credit-account'
+  | 'biller-paynl-version'
+  | 'swissbilling'
+  | 'bizum'
+  | 'rcbc'
+  | 'inbank'
+  | 'ivy'
+  | 'zoodpay'
+  | 'valu'
+  | 'tabby'
+  | 'cliq'
+  | 'postpay'
+  | 'urpay'
+  | 'hypercash'
+  | 'fawry'
+  | 'spotii'
+  | 'tamara'
+  | 'aqsat'
+  | 'careem-pay'
+  | 'billie'
+  | 'sbpl'
+  | 'coppel-pay'
+  | 'sequra'
+  | 'aeropay'
+  | 'catch-payments'
+  | 'openpay'
+  | 'lbc'
+  | 'atrato'
+  | 'bss'
+  | 'gmo-bank-transfer'
+  | 'trevipay'
+  | 'paypo'
+  | 'younited-pay'
+  | 'tabit'
+  | 'etika'
+  | 'mokka'
+  | 'myfatoorah'
+  | 'meeza'
+  | 'paysafecash'
+  | 'tbi-bank'
+  | 'skrill-digital-wallet'
+  | 'pei'
+  | 'rapid-transfer'
+  | 'neteller'
+  | 'cetelem'
+  | 'paid';
+
+export interface PaymentIconProps {
+  /**
+   * The name of the payment method.
+   *
+   * Check the list of available payment methods [here](/docs/api/checkout-ui-extensions/components/media/paymenticon#paymentmethod).
+   */
+  name: PaymentMethod | string;
+
+  /**
+   * A label that describes the purpose or contents of the icon.
+   *
+   * When set, it will be announced to users using assistive technologies and will provide them with more context.
+   * This should only be used if the icon requires an alternative internationalised label
+   * or if it is otherwise inappropriate to make use of the default label included with the icon.
+   */
+  accessibilityLabel?: string;
+
+  /**
+   * Changes the visibility of the icon to assistive technologies.
+   *
+   * `hidden` hides the component from assistive technology (for example,
+   * a screen reader) but remains visually visible.
+   *
+   * @defaultValue 'visible'
+   */
+  accessibilityVisibility?: 'hidden' | 'visible';
+}
+
+export const PaymentIcon = createRemoteComponent<
+  'PaymentIcon',
+  PaymentIconProps
+>('PaymentIcon');

package/src/surfaces/checkout/components/PaymentIcon/examples/basic-paymenticon.example.ts

@@ -0,0 +1,7 @@
+import {extension, PaymentIcon} from '@shopify/ui-extensions/checkout';
+
+export default extension('purchase.checkout.block.render', (root) => {
+  const paymentIcon = root.createComponent(PaymentIcon, {name: 'shop-pay'});
+
+  root.appendChild(paymentIcon);
+});

package/src/surfaces/checkout/components/Pressable/Pressable.ts

@@ -13,10 +13,12 @@ import type {
   DisclosureActivatorProps,
   CornerProps,
   Opacity,
+  BackgroundProps,
 } from '../shared';
 
 export interface PressableProps
-  extends BorderProps,
+  extends Pick<BackgroundProps, 'background'>,
+    BorderProps,
     CornerProps,
     SizingProps,
     SpacingProps,

package/src/surfaces/checkout/components/ProductThumbnail/ProductThumbnail.doc.ts

@@ -0,0 +1,50 @@
+import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
+
+const data: ReferenceEntityTemplateSchema = {
+  name: 'ProductThumbnail',
+  description:
+    'Product thumbnail is a representation of a product image. It provides a visual preview of the item, so buyers can quickly identify products.',
+  thumbnail: 'productthumbnail-thumbnail.png',
+  requires: '',
+  isVisualComponent: true,
+  type: '',
+  definitions: [
+    {
+      title: 'ProductThumbnailProps',
+      description: '',
+      type: 'ProductThumbnailProps',
+    },
+  ],
+  category: 'Components',
+  subCategory: 'Media',
+  defaultExample: {
+    image: 'productthumbnail-default.png',
+    codeblock: {
+      title: 'Basic ProductThumbnail',
+      tabs: [
+        {
+          title: 'React',
+          code: '../../../../../../ui-extensions-react/src/surfaces/checkout/components/ProductThumbnail/examples/basic-productthumbnail.example.tsx',
+          language: 'tsx',
+        },
+        {
+          title: 'JS',
+          code: './examples/basic-productthumbnail.example.ts',
+          language: 'js',
+        },
+      ],
+    },
+  },
+  subSections: [
+    {
+      type: 'Generic',
+      anchorLink: 'best-practices',
+      title: 'Best Practices',
+      sectionContent:
+        '**High-quality images and consistent aspect ratio**\n\n- Use optimized product images that ensure visual clarity and loading speed. Maintain a consistent aspect ratio for product thumbnails to avoid distortion or stretching of the images.\n\n**Consistent visual style and appropriate sizes**\n\n- Keep a consistent visual style for product thumbnails throughout your store. Use appropriate size for product thumbnails depending on the layout and use case. This consistency helps buyers recognize and associate the thumbnails with your product offerings.\n\n**Accessibility considerations**\n\n- Ensure product thumbnails are accessible with descriptive alternative text (alt text).',
+    },
+  ],
+  related: [],
+};
+
+export default data;

package/src/surfaces/checkout/components/ProductThumbnail/ProductThumbnail.ts

@@ -0,0 +1,86 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+import {MaybeConditionalStyle, ResolutionCondition} from '../../style';
+import {Size} from '../shared';
+
+export interface ProductThumbnailProps {
+  /**
+   * An alternative text description that describe the image for the reader to
+   * understand what it is about. It is extremely useful for both users using
+   * assistive technology and sighted users. A well written description
+   * provides people with visual impairments the ability to participate in
+   * consuming non-text content. When a screen readers encounters an `Image`,
+   * the description is read and announced aloud. If an image fails to load,
+   * potentially due to a poor connection, the description is displayed on
+   * screen instead. This has the benefit of letting a sighted buyer know an
+   * image was meant to load here, but as an alternative, they’re still able to
+   * consume the text content. Read
+   * [considerations when writing alternative text](https://ux.shopify.com/considerations-when-writing-alt-text-a9c1985a8204)
+   * to learn more.
+   *
+   * This property is an alias for `accessibilityLabel` for compatibility with the HTML
+   * specification. When both are specified `accessibilityLabel` takes precedence.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt
+   */
+  alt?: string;
+
+  /**
+   * An alternative text description that describe the image for the reader to
+   * understand what it is about. It is extremely useful for both users using
+   * assistive technology and sighted users. A well written description
+   * provides people with visual impairments the ability to participate in
+   * consuming non-text content. When a screen readers encounters an `Image`,
+   * the description is read and announced aloud. If an image fails to load,
+   * potentially due to a poor connection, the description is displayed on
+   * screen instead. This has the benefit of letting a sighted buyer know an
+   * image was meant to load here, but as an alternative, they’re still able to
+   * consume the text content. Read
+   * [considerations when writing alternative text](https://ux.shopify.com/considerations-when-writing-alt-text-a9c1985a8204)
+   * to learn more.
+   *
+   * An `alt` property is available as an alias for this for compatibility with the HTML
+   * specification. When both are specified, `accessibilityLabel` takes precedence.
+   *
+   * @defaultValue `''`
+   * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt
+   */
+  accessibilityLabel?: string;
+
+  /**
+   * The image source (either a remote URL or a local file resource).
+   *
+   * A `src` property is available as an alias for this for compatibility with the HTML
+   * specification. When both are specified, `source` takes precedence.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src
+   */
+  source?: MaybeConditionalStyle<string, ResolutionCondition>;
+
+  /**
+   * The image source (either a remote URL or a local file resource).
+   *
+   * This property is available as an alias for `source` for compatibility with the HTML
+   * specification. When both are specified, `source` takes precedence.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src
+   */
+  src?: MaybeConditionalStyle<string, ResolutionCondition>;
+
+  /**
+   * Decorates the product thumbnail with the quantity of the product.
+   */
+  badge?: number;
+
+  /**
+   * Adjusts the size the product thumbnail image.
+   *
+   * @defaultValue 'base'
+   */
+  size?: Extract<Size, 'base' | 'small'>;
+}
+
+export const ProductThumbnail = createRemoteComponent<
+  'ProductThumbnail',
+  ProductThumbnailProps
+>('ProductThumbnail');

package/src/surfaces/checkout/components/ProductThumbnail/examples/basic-productthumbnail.example.ts

@@ -0,0 +1,11 @@
+import {extension, ProductThumbnail} from '@shopify/ui-extensions/checkout';
+
+export default extension('purchase.checkout.block.render', (root) => {
+  const paymentIcon = root.createComponent(ProductThumbnail, {
+    source:
+      'https://shopify.dev/assets/api/checkout-extensions/checkout/components/product-thumbnail-example-code.png',
+    badge: 2,
+  });
+
+  root.appendChild(paymentIcon);
+});

package/src/surfaces/checkout/components/ScrollView/ScrollView.ts

@@ -1,6 +1,12 @@
 import {createRemoteComponent} from '@remote-ui/core';
 
-import {BorderProps, CornerProps, SizingProps, SpacingProps} from '../shared';
+import {
+  BackgroundProps,
+  BorderProps,
+  CornerProps,
+  SizingProps,
+  SpacingProps,
+} from '../shared';
 
 export interface ScrollViewEvent {
   /**
@@ -24,7 +30,8 @@ export interface ScrollViewEvent {
 }
 
 export interface ScrollViewProps
-  extends BorderProps,
+  extends Pick<BackgroundProps, 'background'>,
+    BorderProps,
     CornerProps,
     SizingProps,
     SpacingProps {

package/src/surfaces/checkout/components/Select/Select.doc.ts

@@ -44,6 +44,32 @@ const data: ReferenceEntityTemplateSchema = {
         '- Use this component when customers need to choose between four or more predefined options.\n\n- Have a default option selected whenever possible. Use Select as placeholder text if there’s no logical default option.',
     },
   ],
+  examples: {
+    description: '',
+    examples: [
+      {
+        image: 'select-time-picking.png',
+        description:
+          'The Select component is a great choice for displaying a long list of time choices, as it helps conserve valuable space. If the number of options is less than or equal to 5, we recommend using the [ChoiceList](/docs/api/checkout-ui-extensions/components/forms/choicelist) component. This allows buyers to see all options immediately without the need for clicking into the select.',
+        codeblock: {
+          tabs: [
+            {
+              title: 'React',
+              code: '../../../../../../ui-extensions-react/src/surfaces/checkout/components/Select/examples/time-picking-select.example.tsx',
+              language: 'tsx',
+            },
+            {
+              title: 'JS',
+              code: './examples/time-picking-select.example.ts',
+              language: 'js',
+            },
+          ],
+          title:
+            'Using the Select component to display a long list of time choices',
+        },
+      },
+    ],
+  },
   related: [],
 };