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

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

@@ -0,0 +1,87 @@
+# InlineStack
+
+InlineStack is used to lay out a horizontal row of elements. Elements always wrap.
+
+## Props
+
+optional = ?
+
+| Name                | Type                                                                                                                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| accessibilityRole?  | <code><a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a> &#124; [<a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a>, <a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a>]</code>                 | Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help buyers navigate the page.<br /><br />For example:<br /><br />- In an HTML host a `'listItem'` string will render: `&lt;li&gt;`<br /><br />- In an HTML host a `['listItem', 'separator']` tuple will render: `&lt;li role='separator'&gt;`                                                                                                                                                                                                                                                     |
+| accessibilityLabel? | <code>string</code>                                                                                                                                                                                                                                                                                   | A label that describes the purpose or contents of the element. When set, it will be announced to buyers using assistive technologies and will provide them with more context.                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| blockAlignment?     | <code><a href="#blockalignment">BlockAlignment</a> &#124; ConditionalStyle<<wbr><a href="#blockalignment">BlockAlignment</a>, AcceptedConditions<wbr>></code>                                                                                                                                         | Position children along the cross axis<br /><br />Default value: <code>'start'</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| inlineAlignment?    | <code><a href="#inlinealignment">InlineAlignment</a> &#124; ConditionalStyle<<wbr><a href="#inlinealignment">InlineAlignment</a>, AcceptedConditions<wbr>></code>                                                                                                                                     | Position children along the main axis<br /><br />Default value: <code>'start'</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| spacing?            | <code><a href="#spacing">Spacing</a> &#124; ConditionalStyle<<wbr><a href="#spacing">Spacing</a>, AcceptedConditions<wbr>></code>                                                                                                                                                                     | Adjust spacing between children<br /><br />Default value: <code>'base'</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| border?             | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderstyle">BorderStyle</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderstyle">BorderStyle</a><wbr>>, AcceptedConditions<wbr>></code>     | Adjust the border style.<br /><br />To shorten the code, it is possible to specify all the border style properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border styles are `base`<br /><br />- `['base', 'none']` means blockStart and blockEnd border styles are `base`, inlineStart and inlineEnd border styles are `none`<br /><br />- `['base', 'none', 'dotted', 'base']` means blockStart border style is `base`, inlineEnd border style is `none`, blockEnd border style is `dotted` and blockStart border style is `base`         |
+| borderWidth?        | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderwidth">BorderWidth</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderwidth">BorderWidth</a><wbr>>, AcceptedConditions<wbr>></code>     | Adjust the border width.<br /><br />To shorten the code, it is possible to specify all the border width properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border widths are `base`<br /><br />- `['base', 'medium']` means blockStart and blockEnd border widths are `base`, inlineStart and inlineEnd border widths are `medium`<br /><br />- `['base', 'medium', 'medium', 'base']` means blockStart border width is `base`, inlineEnd border width is `medium`, blockEnd border width is `medium` and blockStart border width is `base` |
+| borderRadius?       | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderradius">BorderRadius</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderradius">BorderRadius</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border radius.<br /><br />To shorten the code, it is possible to specify all the border width properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border radii are `base`<br /><br />- `['base', 'none']` means blockStart and blockEnd border radii are `base`, inlineStart and inlineEnd border radii are `none`<br /><br />- `['base', 'none', 'tight', 'base']` means blockStart border radius is `base`, inlineEnd border radius is `none`, blockEnd border radius is `tight` and blockStart border radius is `base`         |
+| maxBlockSize?       | <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 maximum block size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space.                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| maxInlineSize?      | <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 maximum inline size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space.                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| minInlineSize?      | <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 minimum inline size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space.                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| minBlockSize?       | <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.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space.                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| padding?            | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#spacing">Spacing</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#spacing">Spacing</a><wbr>>, AcceptedConditions<wbr>></code>                     | Adjust the padding.<br /><br />To shorten the code, it is possible to specify all the padding properties in one property.<br /><br />Examples:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart paddings are `base`<br /><br />- [`base`, `none`] means blockStart and blockEnd paddings are `base`, inlineStart and inlineEnd paddings are `none`<br /><br />- [`base`, `none`, `loose`, `tight`] means blockStart padding is `base`, inlineEnd padding is `none`, blockEnd padding is `loose` and blockStart padding is `tight`                                                             |
+
+<a name="BorderRadius"></a>
+
+### BorderRadius
+
+<code>"base" &#124; "tight" &#124; "loose" &#124; "fullyRounded" &#124; "none"</code>
+<a name="BorderWidth"></a>
+
+### BorderWidth
+
+<code>"base" &#124; "medium"</code>
+<a name="MaybeShorthandProperty"></a>
+
+### MaybeShorthandProperty
+
+<code>T &#124; <a href="#shorthandproperty">ShorthandProperty</a><<wbr>T<wbr>></code>
+<a name="ShorthandProperty"></a>
+
+### ShorthandProperty
+
+<code>[T, T] &#124; [T, T, T, T]</code>
+<a name="BorderStyle"></a>
+
+### BorderStyle
+
+<code>"base" &#124; "dotted" &#124; "none"</code>
+<a name="Spacing"></a>
+
+### Spacing
+
+<code>"none" &#124; "extraTight" &#124; "tight" &#124; "base" &#124; "loose" &#124; "extraLoose"</code>
+<a name="InlineAlignment"></a>
+
+### InlineAlignment
+
+<code>"start" &#124; "center" &#124; "end"</code>
+<a name="BlockAlignment"></a>
+
+### BlockAlignment
+
+<code><a href="#alignment">Alignment</a> &#124; "baseline"</code>
+<a name="Alignment"></a>
+
+### Alignment
+
+<code>"start" &#124; "center" &#124; "end"</code>
+<a name="NonPresentationalAccessibilityRole"></a>
+
+### NonPresentationalAccessibilityRole
+
+| Value                        | Description                                                                                                            |
+| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| <code>"main"</code>          | Used to indicate the primary content.                                                                                  |
+| <code>"header"</code>        | Used to indicate the component is a header.                                                                            |
+| <code>"footer"</code>        | Used to display information such as copyright information, navigation links, and privacy statements.                   |
+| <code>"section"</code>       | Used to indicate a generic section.                                                                                    |
+| <code>"complementary"</code> | Used to designate a supporting section that relates to the main content.                                               |
+| <code>"navigation"</code>    | Used to identify major groups of links used for navigating.                                                            |
+| <code>"orderedList"</code>   | Used to identify a list of ordered items.                                                                              |
+| <code>"listItem"</code>      | Used to identify an item inside a list of items.                                                                       |
+| <code>"unorderedList"</code> | Used to identify a list of unordered items.                                                                            |
+| <code>"separator"</code>     | Used to indicates the component acts as a divider that separates and distinguishes sections of content.                |
+| <code>"status"</code>        | Used to define a live region containing advisory information for the user that is not important enough to be an alert. |
+| <code>"alert"</code>         | Used for important, and usually time-sensitive, information.                                                           |

package/src/surfaces/checkout/components/InlineStack/examples/basic-inlinestack.example.ts

@@ -0,0 +1,18 @@
+import {extend, InlineStack, View} from '@shopify/checkout-ui-extensions';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const inlineStack = root.createComponent(
+    InlineStack,
+    {
+      spacing: 'base',
+    },
+    [
+      root.createComponent(View, {border: 'base', padding: 'base'}, 'View'),
+      root.createComponent(View, {border: 'base', padding: 'base'}, 'View'),
+      root.createComponent(View, {border: 'base', padding: 'base'}, 'View'),
+      root.createComponent(View, {border: 'base', padding: 'base'}, 'View'),
+    ],
+  );
+
+  root.appendChild(inlineStack);
+});

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

@@ -0,0 +1,49 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+import type {Appearance, OverlayActivatorProps} from '../shared';
+
+export interface LinkProps extends OverlayActivatorProps {
+  /**
+   * Destination to navigate to. You must provide either this property, `onPress`,
+   * or both.
+   */
+  to?: string;
+  /**
+   * Open the link in a new window or tab
+   */
+  external?: boolean;
+  /**
+   * Unique identifier.
+   *
+   * Typically used as a target for another component’s controls
+   * to associate an accessible label with an action.
+   */
+  id?: string;
+  /**
+   * Indicate the text language. Useful when the text is in a different language than the rest of the page.
+   * It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
+   * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
+   */
+  language?: string;
+  /**
+   * 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.
+   */
+  accessibilityLabel?: string;
+  /**
+   * Specify the color of the link.
+   * `monochrome` will take the color of its parent.
+   */
+  appearance?: Extract<Appearance, 'monochrome'>;
+  /**
+   * Callback when pressed. If `to` is set, it will execute the callback and
+   * then navigate to the location specified by `to`.
+   */
+  onPress?(): void;
+}
+
+/**
+ * Link makes text interactive so customers can perform an action, such as navigating to another location.
+ */
+export const Link = createRemoteComponent<'Link', LinkProps>('Link');

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

@@ -0,0 +1,18 @@
+# Link
+
+Link makes text interactive so customers can perform an action, such as navigating to another location.
+
+## Props
+
+optional = ?
+
+| Name                | Type                        | Description                                                                                                                                                                                                                                                                                                                                |
+| ------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| to?                 | <code>string</code>         | Destination to navigate to. You must provide either this property, `onPress`, or both.                                                                                                                                                                                                                                                     |
+| external?           | <code>boolean</code>        | Open the link in a new window or tab                                                                                                                                                                                                                                                                                                       |
+| id?                 | <code>string</code>         | Unique identifier.<br /><br />Typically used as a target for another component’s controls to associate an accessible label with an action.                                                                                                                                                                                                 |
+| language?           | <code>string</code>         | Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (&#34;subtag&#34; label) |
+| 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.                                                                                                                              |
+| appearance?         | <code>"monochrome"</code>   | Specify the color of the link. `monochrome` will take the color of its parent.<br /><br /><code>"monochrome"</code>: Will take the color of its parent                                                                                                                                                                                     |
+| onPress?            | <code>() => void</code>     | Callback when pressed. If `to` is set, it will execute the callback and then navigate to the location specified by `to`.                                                                                                                                                                                                                   |
+| overlay?            | <code>RemoteFragment</code> | An overlay component to render when the user interacts with the component.                                                                                                                                                                                                                                                                 |

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

@@ -0,0 +1,9 @@
+## Best practices
+
+- If the link isn’t in a paragraph, then consider using a plain button instead for a larger hit area.
+- Use links primarily for navigation and use buttons primarily for actions.
+- The HTML that renders for the [`Button`](https://github.com/Shopify/ui-extensions/tree/main/packages/checkout-ui-extensions/src/components/Button) and `Link` components includes style and accessibility information. Use these components intentionally and consistently to provide a more inclusive experience for assistive technology users and a more cohesive visual experience for sighted users.
+
+## Related components
+
+- [`Button`](https://github.com/Shopify/ui-extensions/tree/main/packages/checkout-ui-extensions/src/components/Button): Buttons are used for actions, such as **Add**, **Continue**, or **Pay now**, or **Save**.

package/src/surfaces/checkout/components/Link/examples/basic-link.example.ts

@@ -0,0 +1,11 @@
+import {extend, Link} from '@shopify/checkout-ui-extensions';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const link = root.createComponent(
+    Link,
+    {to: 'https://www.shopify.ca/climate/sustainability-fund'},
+    'Sustainability fund',
+  );
+
+  root.appendChild(link);
+});

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

@@ -0,0 +1,32 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+import type {Spacing} from '../shared';
+import type {MaybeResponsiveConditionalStyle} from '../../style';
+
+export type Marker = 'none' | 'bullet' | 'number';
+
+export interface ListProps {
+  /**
+   * Adjust spacing between list items
+   *
+   * @defaultValue 'base'
+   */
+  spacing?: MaybeResponsiveConditionalStyle<Spacing>;
+  /**
+   * Type of marker to display
+   *
+   * @defaultValue 'bullet'
+   */
+  marker?: Marker;
+  /**
+   * A label that describes the purpose or contents of the list. When set,
+   * it will be announced to buyers using assistive technologies and will
+   * provide them with more context.
+   */
+  accessibilityLabel?: string;
+}
+
+/**
+ * Lists display a set of related content. Each list item usually begins with a bullet or a number.
+ */
+export const List = createRemoteComponent<'List', ListProps>('List');

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

@@ -0,0 +1,19 @@
+# List
+
+Lists display a set of related content. Each list item usually begins with a bullet or a number.
+
+## Props
+
+optional = ?
+
+| Name                | Type                                                                                                                              | Description                                                                                                                                                                |
+| ------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| spacing?            | <code><a href="#spacing">Spacing</a> &#124; ConditionalStyle<<wbr><a href="#spacing">Spacing</a>, AcceptedConditions<wbr>></code> | Adjust spacing between list items<br /><br />Default value: <code>'base'</code>                                                                                            |
+| marker?             | <code>"none" &#124; "bullet" &#124; "number"</code>                                                                               | Type of marker to display<br /><br />Default value: <code>'bullet'</code>                                                                                                  |
+| accessibilityLabel? | <code>string</code>                                                                                                               | A label that describes the purpose or contents of the list. When set, it will be announced to buyers using assistive technologies and will provide them with more context. |
+
+<a name="Spacing"></a>
+
+### Spacing
+
+<code>"none" &#124; "extraTight" &#124; "tight" &#124; "base" &#124; "loose" &#124; "extraLoose"</code>

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

@@ -0,0 +1,11 @@
+## Best practices
+
+- Use lists to break up chunks of related content to make the information easier for customers to scan.
+- Phrase list items consistently. Try to start each item with a noun or a verb and be consistent with each item.
+- Use bullets for a text-only list of related items that don’t need to be in a specific order.
+- Use numbers for a text-only list of related items when you need to communicate order, priority, or sequence.
+- Don't use a marker when only the semantic value of a list matters, such as with a list of links.
+
+## Related components
+
+- [`ListItem`](https://github.com/Shopify/ui-extensions/tree/main/packages/checkout-ui-extensions/src/components/ListItem): Used as children of the `List` component.

package/src/surfaces/checkout/components/List/examples/basic-list.example.ts

@@ -0,0 +1,11 @@
+import {extend, List, ListItem} from '@shopify/checkout-ui-extensions';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const list = root.createComponent(List, undefined, [
+    root.createComponent(ListItem, undefined, '100% organic cotton'),
+    root.createComponent(ListItem, undefined, 'Made in Canada'),
+    root.createComponent(ListItem, undefined, 'Machine washable'),
+  ]);
+
+  root.appendChild(list);
+});

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

@@ -0,0 +1,12 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+export interface ListItemProps {}
+
+/**
+ * List items are used as children of the `List` component.
+ *
+ * They usually begins with a bullet or a number.
+ */
+export const ListItem = createRemoteComponent<'ListItem', ListItemProps>(
+  'ListItem',
+);

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

@@ -0,0 +1,5 @@
+# ListItem
+
+List items are used as children of the `List` component.
+
+They usually begins with a bullet or a number.

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

@@ -0,0 +1,3 @@
+## Related components
+
+- [`List`](https://github.com/Shopify/ui-extensions/tree/main/packages/checkout-ui-extensions/src/components/List): Displays a set of related content. Each list item usually begins with a bullet or a number.

package/src/surfaces/checkout/components/ListItem/examples/basic-listitem.example.ts

@@ -0,0 +1,9 @@
+import {extend, List, ListItem} from '@shopify/checkout-ui-extensions';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const list = root.createComponent(List, undefined, [
+    root.createComponent(ListItem, undefined, '100% organic cotton'),
+  ]);
+
+  root.appendChild(list);
+});

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

@@ -0,0 +1,77 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+import type {TextFieldProps} from '../TextField/TextField';
+
+export interface PhoneFieldProps
+  extends Pick<
+    TextFieldProps<string>,
+    | 'autocomplete'
+    | 'id'
+    | 'icon'
+    | 'accessory'
+    | 'name'
+    | 'label'
+    | 'accessibilityDescription'
+    | 'value'
+    | 'required'
+    | 'error'
+    | 'disabled'
+    | 'readonly'
+    | 'onFocus'
+    | 'onBlur'
+    | 'maxLength'
+  > {
+  /**
+   * Callback when the buyer has **finished editing** a field or pressed the country dropdown.
+   * 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. Phone 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 phone field’s `value` property.
+   *
+   * 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.
+   *
+   * 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`.
+   *
+   * This callback is called with the current formatted 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.
+   */
+  onChange?(value: string): void;
+  /**
+   * Callback when the user makes any changes in the field including selecting a country
+   * in the dropdown. 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.
+   *
+   * This callback is called with the current formatted value.
+   */
+  onInput?(value: string): void;
+}
+
+/**
+ * A PhoneField is an input field that merchants can type into optimized
+ * for phone numbers with a country code base auto-formatting.
+ * The country code is required for the initial render of the field but
+ * it can be overriden later by the user either by selecting a country
+ * in the country selection dropdown or by manually editing the country phone code
+ * directly in the text field.
+ */
+export const PhoneField = createRemoteComponent<'PhoneField', PhoneFieldProps>(
+  'PhoneField',
+);

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

@@ -0,0 +1,49 @@
+# PhoneField
+
+A PhoneField is an input field that merchants can type into optimized
+for phone numbers with a country code base auto-formatting.
+The country code is required for the initial render of the field but
+it can be overriden later by the user either by selecting a country
+in the country selection dropdown or by manually editing the country phone code
+directly in the text field.
+
+## Props
+
+optional = ?
+
+| Name                      | Type                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
+| onChange?                 | <code>(value: string) => void</code>                                                                                                     | Callback when the buyer has **finished editing** a field or pressed the country dropdown. 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. Phone 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 phone 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 formatted 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: string) => void</code>                                                                                                     | Callback when the user makes any changes in the field including selecting a country in the dropdown. 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 formatted value.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| id?                       | <code>string</code>                                                                                                                      | A unique identifier for the field. When no `id` is set, a globally unique value will be used instead.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| icon?                     | <code><a href="#iconsource">IconSource</a> &#124; {source: <a href="#iconsource">IconSource</a>, position?: "start" &#124; "end"}</code> | An icon to render at the start or end of the field. It will render at the start by default.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| 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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| accessory?                | <code>string &#124; RemoteFragment</code>                                                                                                | Any content to render at the end of the text field. Commonly used to display an icon that opens a tooltip providing more information about the field.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| accessibilityDescription? | <code>string</code>                                                                                                                      | A detailed description for screen readers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| value?                    | <code>string</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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| autocomplete?             | <code><a href="#autocomplete">Autocomplete</a> &#124; boolean</code>                                                                     | A hint as to the intended content of the field.<br /><br />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.<br /><br />When set to `false`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.<br /><br />Alternatively, you can provide an `Autocomplete` object, which describes the specific data you would like to be entered into this field during autofill.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| disabled?                 | <code>boolean</code>                                                                                                                     | Whether the field can be modified.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| readonly?                 | <code>boolean</code>                                                                                                                     | Whether the field is read-only.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| maxLength?                | <code>number</code>                                                                                                                      | Specifies the maximum number of characters allowed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| onFocus?                  | <code>() => void</code>                                                                                                                  | Callback when input is focused.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| onBlur?                   | <code>() => void</code>                                                                                                                  | Callback when focus is removed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | <a name="Autocomplete"></a> |
+
+### Autocomplete
+
+A descriptor for selecting the data a field would like to receive during
+autocomplete. This attribute is modeled off of a limited set of the autocomplete
+values supported in browsers.
+
+| Name   | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Description                                                                    |
+| ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
+| group? | <code>"shipping" &#124; "billing" &#124; "location"</code>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | The contact information “group” the autocomplete data should be sourced from.  |
+| field  | <code>"name" &#124; "honorific-prefix" &#124; "given-name" &#124; "additional-name" &#124; "family-name" &#124; "honorific-suffix" &#124; "nickname" &#124; "username" &#124; "new-password" &#124; "current-password" &#124; "one-time-code" &#124; "organization-title" &#124; "organization" &#124; "street-address" &#124; "address-line1" &#124; "address-line2" &#124; "address-line3" &#124; "address-level4" &#124; "address-level3" &#124; "address-level2" &#124; "address-level1" &#124; "country" &#124; "country-name" &#124; "postal-code" &#124; "credit-card-name" &#124; "credit-card-given-name" &#124; "credit-card-additional-name" &#124; "credit-card-family-name" &#124; "credit-card-number" &#124; "credit-card-expiry" &#124; "credit-card-expiry-month" &#124; "credit-card-expiry-year" &#124; "credit-card-security-code" &#124; "credit-card-type" &#124; "transaction-currency" &#124; "transaction-amount" &#124; "language" &#124; "birthday" &#124; "birthday-day" &#124; "birthday-month" &#124; "birthday-year" &#124; "sex" &#124; "url" &#124; "photo" &#124; "telephone" &#124; "telephone-country-code" &#124; "telephone-national" &#124; "telephone-area-code" &#124; "telephone-local" &#124; "telephone-local-prefix" &#124; "telephone-local-suffix" &#124; "telephone-extension" &#124; "email" &#124; "instant-message" &#124; "home telephone" &#124; "home telephone-country-code" &#124; "home telephone-national" &#124; "home telephone-area-code" &#124; "home telephone-local" &#124; "home telephone-local-prefix" &#124; "home telephone-local-suffix" &#124; "home telephone-extension" &#124; "home email" &#124; "home instant-message" &#124; "work telephone" &#124; "work telephone-country-code" &#124; "work telephone-national" &#124; "work telephone-area-code" &#124; "work telephone-local" &#124; "work telephone-local-prefix" &#124; "work telephone-local-suffix" &#124; "work telephone-extension" &#124; "work email" &#124; "work instant-message" &#124; "mobile telephone" &#124; "mobile telephone-country-code" &#124; "mobile telephone-national" &#124; "mobile telephone-area-code" &#124; "mobile telephone-local" &#124; "mobile telephone-local-prefix" &#124; "mobile telephone-local-suffix" &#124; "mobile telephone-extension" &#124; "mobile email" &#124; "mobile instant-message" &#124; "fax telephone" &#124; "fax telephone-country-code" &#124; "fax telephone-national" &#124; "fax telephone-area-code" &#124; "fax telephone-local" &#124; "fax telephone-local-prefix" &#124; "fax telephone-local-suffix" &#124; "fax telephone-extension" &#124; "fax email" &#124; "fax instant-message" &#124; "pager telephone" &#124; "pager telephone-country-code" &#124; "pager telephone-national" &#124; "pager telephone-area-code" &#124; "pager telephone-local" &#124; "pager telephone-local-prefix" &#124; "pager telephone-local-suffix" &#124; "pager telephone-extension" &#124; "pager email" &#124; "pager instant-message"</code> | The type of data that should be inserted into a field supporting autocomplete. |
+
+<a name="IconSource"></a>
+
+### IconSource
+
+<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>

package/src/surfaces/checkout/components/PhoneField/examples/basic-phonefield.example.ts

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