@shopify/ui-extensions 2.0.0-alpha.2 → 2022.10.0

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

@@ -0,0 +1,97 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+import {Autocomplete} from '../shared';
+
+interface Option {
+  /**
+   * The value that will be passed to the select’s `onChange` callback
+   * when this option is selected.
+   */
+  value: string;
+  /**
+   * The buyer-facing label for this option.
+   */
+  label: string;
+  /**
+   * Whether this option can be selected or not.
+   */
+  disabled?: boolean;
+}
+
+export interface SelectProps {
+  /**
+   * A unique identifier for the field. When no `id` is set,
+   * a globally unique value will be used instead.
+   */
+  id?: string;
+  /**
+   * Content to use as the field label.
+   */
+  label: string;
+  /**
+   * An identifier for the field that is unique within the nearest
+   * containing `Form` component.
+   */
+  name?: string;
+  /**
+   * The active option for the select. This should match to one of the
+   * `value` properties in the `options` prop. When not set,
+   * the value will default to an empty string, which will show the
+   * `placeholder` text as the "selected value".
+   */
+  value?: string;
+  /**
+   * The options a buyer can select from.
+   */
+  options: Option[];
+  /**
+   * Whether the field needs a value. This requirement adds semantic value
+   * to the field, but it will not cause an error to appear automatically.
+   * If you want to present an error when this field is empty, you can do
+   * so with the `error` prop.
+   */
+  required?: boolean;
+  /**
+   * Whether the select can be changed.
+   */
+  disabled?: boolean;
+  /**
+   * Whether the field is read only
+   */
+  readonly?: boolean;
+  /**
+   * Indicate an error to the user. The field will be given a specific stylistic treatment
+   * to communicate problems that have to be resolved immediately.
+   */
+  error?: string;
+  /**
+   * A hint as to the intended content of the field.
+   *
+   * When set to `true`, this property indicates that the field should support
+   * autofill, but you do not have any more semantic information on the intended
+   * contents.
+   *
+   * When set to `false`, you are indicating that this field contains sensitive
+   * information, or contents that are never saved, like one-time codes. Note that
+   * it is impossible to prevent autocomplete in some browsers, so do not depend on
+   * its absence.
+   *
+   * Alternatively, you can provide an `Autocomplete` object, which describes the
+   * specific data you would like to be entered into this field during autocomplete.
+   */
+  autocomplete?: Autocomplete | boolean;
+  /**
+   * A callback that is run whenever the selected option changes. This callback
+   * is called with the string `value` of the selected `option`. This component
+   * is [controlled](https://reactjs.org/docs/forms.html#controlled-components),
+   * so you must store this value in state and reflect it back in the `value`
+   * prop of the select.
+   */
+  onChange?(value: string): void;
+}
+
+/**
+ * Selects let buyers choose one option from an options menu. Consider select
+ * when you have 4 or more options, to avoid cluttering the interface.
+ */
+export const Select = createRemoteComponent<'Select', SelectProps>('Select');

package/src/surfaces/checkout/components/Select/content/guidelines.md

@@ -0,0 +1,4 @@
+## Best practices
+
+- Use this component when customers need to choose between four or more predefined options.
+- Have a default option selected whenever possible. Use **Select** as placeholder text if there’s no logical default option.

package/src/surfaces/checkout/components/Select/examples/basic-select.example.ts

@@ -0,0 +1,36 @@
+import {extend, Select} from '@shopify/checkout-ui-extensions';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const select = root.createComponent(Select, {
+    label: 'Country',
+    value: '2',
+    options: [
+      {
+        value: '1',
+        label: 'Australia',
+      },
+      {
+        value: '2',
+        label: 'Canada',
+      },
+      {
+        value: '3',
+        label: 'France',
+      },
+      {
+        value: '4',
+        label: 'Japan',
+      },
+      {
+        value: '5',
+        label: 'Nigeria',
+      },
+      {
+        value: '6',
+        label: 'United States',
+      },
+    ],
+  });
+
+  root.appendChild(select);
+});

package/src/surfaces/checkout/components/SkeletonImage/README.md

@@ -0,0 +1,13 @@
+# SkeletonImage
+
+SkeletonImage is used to provide a low fidelity representation of an image before it appears on the page.
+
+## Props
+
+optional = ?
+
+| Name         | Type                                                                                                                                                                                | Description                                                                                                                    |
+| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| blockSize?   | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the block size of the skeleton.                                                                                         |
+| inlineSize?  | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the inline size of the skeleton.                                                                                        |
+| aspectRatio? | <code>number</code>                                                                                                                                                                 | Displays the skeleton at the specified aspect ratio (fills the width of the parent container and sets the height accordingly). |

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

@@ -0,0 +1,27 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+import {MaybeResponsiveConditionalStyle} from '../../style';
+
+export interface SkeletonImageProps {
+  /**
+   * Adjust the block size of the skeleton.
+   */
+
+  blockSize?: MaybeResponsiveConditionalStyle<number | `${number}%` | 'fill'>;
+  /**
+   * Adjust the inline size of the skeleton.
+   */
+  inlineSize?: MaybeResponsiveConditionalStyle<number | `${number}%` | 'fill'>;
+  /**
+   * Displays the skeleton at the specified aspect ratio (fills the width of the
+   * parent container and sets the height accordingly).
+   */
+  aspectRatio?: number;
+}
+/**
+ * SkeletonImage is used to provide a low fidelity representation of an image before it appears on the page.
+ */
+export const SkeletonImage = createRemoteComponent<
+  'SkeletonImage',
+  SkeletonImageProps
+>('SkeletonImage');

package/src/surfaces/checkout/components/SkeletonImage/examples/basic-skeletonimage.example.ts

@@ -0,0 +1,10 @@
+import {extend, SkeletonImage} from '@shopify/checkout-ui-extensions';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const skeletonImage = root.createComponent(SkeletonImage, {
+    inlineSize: 300,
+    blockSize: 300,
+  });
+
+  root.appendChild(skeletonImage);
+});

package/src/surfaces/checkout/components/SkeletonText/README.md

@@ -0,0 +1,13 @@
+# SkeletonText
+
+SkeletonText is used to provide a low fidelity representation of text content before it appears on the page.
+
+## Props
+
+optional = ?
+
+| Name        | Type                                                                                                      | Description                                                |
+| ----------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
+| emphasis?   | <code>"bold"</code>                                                                                       | Use to emphasize a word or a group of words.               |
+| inlineSize? | <code>"small" &#124; "base" &#124; "large"</code>                                                         | Adjust the length of the text when no children are passed. |
+| size?       | <code>"extraSmall" &#124; "small" &#124; "base" &#124; "large" &#124; "extraLarge" &#124; "medium"</code> | Size of the text                                           |

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

@@ -0,0 +1,23 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+import type {Size} from '../shared';
+import type {TextProps} from '../Text/Text';
+
+export interface SkeletonTextProps extends Pick<TextProps, 'size'> {
+  /**
+   * Use to emphasize a word or a group of words.
+   */
+  emphasis?: 'bold';
+  /**
+   * Adjust the length of the text when no children are passed.
+   */
+  inlineSize?: Extract<Size, 'small' | 'base' | 'large'>;
+}
+
+/**
+ * SkeletonText is used to provide a low fidelity representation of text content before it appears on the page.
+ */
+export const SkeletonText = createRemoteComponent<
+  'SkeletonText',
+  SkeletonTextProps
+>('SkeletonText');

package/src/surfaces/checkout/components/SkeletonText/examples/basic-skeletontext.example.ts

@@ -0,0 +1,7 @@
+import {extend, SkeletonText} from '@shopify/checkout-ui-extensions';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const skeletonText = root.createComponent(SkeletonText);
+
+  root.appendChild(skeletonText);
+});

package/src/surfaces/checkout/components/SkeletonTextBlock/README.md

@@ -0,0 +1,13 @@
+# SkeletonTextBlock
+
+SkeletonTextBlock is used to provide a low fidelity representation of a block of text before it appears on the page.
+
+## Props
+
+optional = ?
+
+| Name      | Type                                                                                                      | Description                                                                                      |
+| --------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
+| emphasis? | <code>"bold"</code>                                                                                       | Use to emphasize a word or a group of words.                                                     |
+| lines?    | <code>number</code>                                                                                       | Number of lines to display when no children are passed.<br /><br />Default value: <code>1</code> |
+| size?     | <code>"extraSmall" &#124; "small" &#124; "base" &#124; "large" &#124; "extraLarge" &#124; "medium"</code> | Size of the text                                                                                 |

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

@@ -0,0 +1,24 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+import type {TextBlockProps} from '../TextBlock/TextBlock';
+
+export interface SkeletonTextBlockProps extends Pick<TextBlockProps, 'size'> {
+  /**
+   * Use to emphasize a word or a group of words.
+   */
+  emphasis?: 'bold';
+  /**
+   * Number of lines to display when no children are passed.
+   *
+   * @defaultValue 1
+   */
+  lines?: number;
+}
+
+/**
+ * SkeletonTextBlock is used to provide a low fidelity representation of a block of text before it appears on the page.
+ */
+export const SkeletonTextBlock = createRemoteComponent<
+  'SkeletonTextBlock',
+  SkeletonTextBlockProps
+>('SkeletonTextBlock');

package/src/surfaces/checkout/components/SkeletonTextBlock/examples/basic-skeletontextblock.example.ts

@@ -0,0 +1,7 @@
+import {extend, SkeletonTextBlock} from '@shopify/checkout-ui-extensions';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const skeletonTextBlock = root.createComponent(SkeletonTextBlock);
+
+  root.appendChild(skeletonTextBlock);
+});

package/src/surfaces/checkout/components/Spinner/README.md

@@ -0,0 +1,14 @@
+# Spinner
+
+Spinner is used to notify buyers that their action is being processed.
+The Spinner is usually used when sending or receiving data from a server.
+
+## Props
+
+optional = ?
+
+| Name                | Type                                                                                | Description                                                                                                                                                                                                                                                                         |
+| ------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| size?               | <code>"extraSmall" &#124; "small" &#124; "base" &#124; "large" &#124; "fill"</code> | Adjusts the size of the icon.<br /><br />Default value: <code>'base'</code>                                                                                                                                                                                                         |
+| appearance?         | <code>"accent" &#124; "monochrome"</code>                                           | Sets the appearance (color) of the icon.<br /><br /><code>"accent"</code>: Use to convey emphasis and draw attention to the icon.<br /><br /><code>"monochrome"</code>: Will take the color of its parent<br /><br />Default value: <code>'accent'</code>                           |
+| accessibilityLabel? | <code>string</code>                                                                 | A label to use for the Spinner that will be used for buyers using assistive technologies like screen readers. If will also be used to replace the animated loading indicator when buyers prefers reduced motion. If not included, it will use the loading indicator for all buyers. |

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

@@ -0,0 +1,35 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+import type {Size, Appearance} from '../shared';
+
+export interface SpinnerProps {
+  /**
+   * Adjusts the size of the icon.
+   *
+   * @defaultValue 'base'
+   */
+  size?: Extract<Size, 'extraSmall' | 'small' | 'base' | 'large' | 'fill'>;
+
+  /**
+   * Sets the appearance (color) of the icon.
+   *
+   * @defaultValue 'accent'
+   */
+  appearance?: Extract<Appearance, 'accent' | 'monochrome'>;
+
+  /**
+   * A label to use for the Spinner that will be used for buyers using
+   * assistive technologies like screen readers. If will also be used to replace
+   * the animated loading indicator when buyers prefers reduced motion. If not included,
+   * it will use the loading indicator for all buyers.
+   */
+  accessibilityLabel?: string;
+}
+
+/**
+ * Spinner is used to notify buyers that their action is being processed.
+ * The Spinner is usually used when sending or receiving data from a server.
+ */
+export const Spinner = createRemoteComponent<'Spinner', SpinnerProps>(
+  'Spinner',
+);

package/src/surfaces/checkout/components/Spinner/examples/basic-spinner.example.ts

@@ -0,0 +1,7 @@
+import {extend, Spinner} from '@shopify/checkout-ui-extensions';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const spinner = root.createComponent(Spinner);
+
+  root.appendChild(spinner);
+});

package/src/surfaces/checkout/components/Stepper/README.md

@@ -0,0 +1,28 @@
+# Stepper
+
+Use a stepper to increase or decrease a value, like changing the quantity from 1 to 2.
+
+## Props
+
+optional = ?
+
+| Name                      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| icon?                     | <code>"arrowLeft" &#124; "arrowRight" &#124; "arrowUp" &#124; "arrowUpRight" &#124; "arrowDown" &#124; "bag" &#124; "calendar" &#124; "camera" &#124; "caretDown" &#124; "cart" &#124; "checkmark" &#124; "chevronDown" &#124; "chevronUp" &#124; "chevronRight" &#124; "chevronLeft" &#124; "close" &#124; "critical" &#124; "discount" &#124; "delivered" &#124; "delivery" &#124; "disabled" &#124; "email" &#124; "errorFill" &#124; "geolocation" &#124; "grid" &#124; "hamburger" &#124; "horizontalDots" &#124; "info" &#124; "infoFill" &#124; "list" &#124; "lock" &#124; "magnify" &#124; "map" &#124; "marker" &#124; "minus" &#124; "mobile" &#124; "note" &#124; "pen" &#124; "verticalDots" &#124; "plus" &#124; "questionFill" &#124; "reorder" &#124; "store" &#124; "success" &#124; "truck" &#124; "warning" &#124; "warningFill" &#124; "giftFill" &#124; "external" &#124; "profile"</code> | An icon to render at the start of the field.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| max?                      | <code>number</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | The highest decimal or integer to be accepted for the stepper field. When used with `step` the value will round down to the max number. Note: a buyer will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| min?                      | <code>number</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | The lowest decimal or integer to be accepted for the stepper field. When used with `step` the value will round up to the min number. Note: a buyer will still be able to use the keyboard to input a number lower than the min. It is up to the developer to add appropriate validation.<br /><br />Default value: <code>0</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| step?                     | <code>number</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | The amount the value can increase or decrease by. This can be an integer or decimal. If a `max` or `min` is specified with `step` when increasing/decreasing the value via the stepper buttons the final value will always round to the `max` or `min` rather than the closest valid amount.<br /><br />Default value: <code>1</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| id?                       | <code>string</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | A unique identifier for the field. When no `id` is set, a globally unique value will be used instead.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| name?                     | <code>string</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | An identifier for the field that is unique within the nearest containing `Form` component.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| label                     | <code>string</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Content to use as the field label. This value is also used as the placeholder when the field is empty.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| prefix?                   | <code>string</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Text content to render before the value.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| accessibilityDescription? | <code>string</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | A detailed description for screen readers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| value?                    | <code>number &#124; undefined</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | The current value for the field. If omitted, the field will be empty. You should update this value in response to the `onChange` callback.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| required?                 | <code>boolean</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` prop.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| error?                    | <code>string</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| disabled?                 | <code>boolean</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Whether the field can be modified.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| readonly?                 | <code>boolean</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Whether the field is read-only.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| onFocus?                  | <code>() => void</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Callback when input is focused.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| onBlur?                   | <code>() => void</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Callback when focus is removed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| onChange?                 | <code>(value: number &#124; undefined) => void</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Callback when the buyer has **finished editing** a field. Unlike `onChange` callbacks you may be familiar with from Polaris or other React component libraries, this callback is **not** run on every change to the input. Text fields are “partially controlled” components, which means that while the buyer edits the field, its state is controlled by the component. Once the buyer has signalled that they have finished editing the field (typically, by blurring the field), `onChange` is called if the input actually changed from the most recent `value` property. At that point, you are expected to store this “committed value” in state, and reflect it in the text field’s `value` property.<br /><br />This state management model is important given how UI Extensions are rendered. UI Extension components run on a separate thread from the UI, so they can’t respond to input synchronously. A pattern popularized by [controlled React components](https://reactjs.org/docs/forms.html#controlled-components) is to have the component be the source of truth for the input `value`, and update the `value` on every user input. The delay in responding to events from a UI extension is only a few milliseconds, but attempting to strictly store state with this delay can cause issues if a user types quickly, or if the buyer is using a lower-powered device. Having the UI thread take ownership for “in progress” input, and only synchronizing when the user is finished with a field, avoids this risk.<br /><br />It can still sometimes be useful to be notified when the user makes any input in the field. If you need this capability, you can use the `onInput` prop. However, never use that property to create tightly controlled state for the `value`.<br /><br />This callback is called with the current value of the field. If the value of a field is the same as the current `value` prop provided to the field, the `onChange` callback will not be run. |
+| onInput?                  | <code>(value: number &#124; undefined) => void</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Callback when the user makes any changes in the field. As noted in the documentation for `onChange`, you **must not** use this to update `state` — use the `onChange` callback for that purpose. Use the `onInput` prop when you need to do something as soon as the buyer makes a change, like clearing validation errors that apply to the field as soon as the user begins making the necessary adjustments.<br /><br />This callback is called with the current value of the field.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

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

@@ -0,0 +1,63 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+import type {TextFieldProps} from '../TextField/TextField';
+import type {IconSource} from '../Icon/Icon';
+
+export interface StepperProps
+  extends Pick<
+    TextFieldProps<number | undefined>,
+    | 'id'
+    | 'name'
+    | 'label'
+    | 'prefix'
+    | 'accessibilityDescription'
+    | 'required'
+    | 'error'
+    | 'disabled'
+    | 'readonly'
+    | 'value'
+    | 'onFocus'
+    | 'onBlur'
+    | 'onInput'
+    | 'onChange'
+  > {
+  /**
+   * An icon to render at the start of the field.
+   */
+  icon?: IconSource;
+
+  /**
+   * The highest decimal or integer to be accepted for the stepper field.
+   * When used with `step` the value will round down to the max number.
+   * Note: a buyer will still be able to use the keyboard to input a number higher than
+   * the max. It is up to the developer to add appropriate validation.
+   */
+  max?: number;
+
+  /**
+   * The lowest decimal or integer to be accepted for the stepper field.
+   * When used with `step` the value will round up to the min number.
+   * Note: a buyer will still be able to use the keyboard to input a number lower than
+   * the min. It is up to the developer to add appropriate validation.
+   *
+   * @defaultValue 0
+   */
+  min?: number;
+
+  /**
+   * The amount the value can increase or decrease by. This can be an integer or decimal.
+   * If a `max` or `min` is specified with `step` when increasing/decreasing the value
+   * via the stepper buttons the final value will always round to the `max` or `min`
+   * rather than the closest valid amount.
+   *
+   * @defaultValue 1
+   */
+  step?: number;
+}
+
+/**
+ * Use a stepper to increase or decrease a value, like changing the quantity from 1 to 2.
+ */
+export const Stepper = createRemoteComponent<'Stepper', StepperProps>(
+  'Stepper',
+);

package/src/surfaces/checkout/components/Stepper/content/guidelines.md

@@ -0,0 +1,4 @@
+## Best practices
+
+- Use this component when customers are likely to choose a number within a small range, such as when changing a quantity from one to three.
+- If there’s no default number, then consider choosing another component such as a [`TextField`](https://github.com/Shopify/ui-extensions/tree/main/packages/checkout-ui-extensions/src/components/TextField) or [`Select`](https://github.com/Shopify/ui-extensions/tree/main/packages/checkout-ui-extensions/src/components/Select).

package/src/surfaces/checkout/components/Stepper/examples/basic-stepper.example.ts

@@ -0,0 +1,10 @@
+import {extend, Stepper} from '@shopify/checkout-ui-extensions';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const stepper = root.createComponent(Stepper, {
+    label: 'Quantity',
+    value: 1,
+  });
+
+  root.appendChild(stepper);
+});

package/src/surfaces/checkout/components/Tag/README.md

@@ -0,0 +1,14 @@
+# Tag
+
+A Tag is used to help label, organize or categorize objects. It is commonly used in Checkout to display the discounts applied to a cart.
+
+## Props
+
+optional = ?
+
+| Name                | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Description                                                                                                                                                                                                   |
+| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| children?           | <code>string</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |                                                                                                                                                                                                               |
+| icon?               | <code>"arrowLeft" &#124; "arrowRight" &#124; "arrowUp" &#124; "arrowUpRight" &#124; "arrowDown" &#124; "bag" &#124; "calendar" &#124; "camera" &#124; "caretDown" &#124; "cart" &#124; "checkmark" &#124; "chevronDown" &#124; "chevronUp" &#124; "chevronRight" &#124; "chevronLeft" &#124; "close" &#124; "critical" &#124; "discount" &#124; "delivered" &#124; "delivery" &#124; "disabled" &#124; "email" &#124; "errorFill" &#124; "geolocation" &#124; "grid" &#124; "hamburger" &#124; "horizontalDots" &#124; "info" &#124; "infoFill" &#124; "list" &#124; "lock" &#124; "magnify" &#124; "map" &#124; "marker" &#124; "minus" &#124; "mobile" &#124; "note" &#124; "pen" &#124; "verticalDots" &#124; "plus" &#124; "questionFill" &#124; "reorder" &#124; "store" &#124; "success" &#124; "truck" &#124; "warning" &#124; "warningFill" &#124; "giftFill" &#124; "external" &#124; "profile"</code> | Icon source                                                                                                                                                                                                   |
+| accessibilityLabel? | <code>string</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | A label used for buyers using assistive technologies. When set, any `children` supplied to this component are hidden from being seen for accessibility purposes to prevent duplicate content from being read. |
+| onRemove?           | <code>() => void</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Callback when tag is removed                                                                                                                                                                                  |