@shopify/ui-extensions 0.0.0-internal-20230622171951

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

@@ -0,0 +1,49 @@
+# TextField
+
+Use a text field to get text input from a customer.
+
+## Props
+
+optional = ?
+
+| Name                      | Type                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
+| 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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| prefix?                   | <code>string</code>                                                                                                                      | Text content to render before the value.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| suffix?                   | <code>string</code>                                                                                                                      | Text content to render at the end of the text field.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| 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 &#124; 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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| controlledValue?          | <code>string &#124; number &#124; undefined</code>                                                                                       | In rare cases, like the PhoneField component, we completely control state. In those cases, there is never a difference between the `value` prop of the field and the current value in the field, and so this component never considers the field to have changed. Use the `controlledValue` prop to provide the value that should be shown to the buyer in those circumstances, but where the `value` prop will continue to be used as the comparison value to determine whether the field has changed. This value will usually be set to the last committed, unformatted value for the controlled input.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| type?                     | <code>"text" &#124; "email" &#124; "number" &#124; "telephone"</code>                                                                    | The content type a buyer will enter into the field. This type is used to provide semantic value to the field and, where possible, will provide the buyer with a better editing experience for the content type.<br /><br />Note that the type property does not change the way the text field’s value will be provided in `onChange` or `onInput`; a text field with a type of `'number'` will still provide the exact user entry, as a string, to those callbacks. The type also does not perform any form of automatic validation. If you want to perform validation, use the `error` property.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| 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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| multiline?                | <code>boolean &#124; number</code>                                                                                                       | Whether the field supports multiple lines of input. Set a `number` to define the default lines of the input.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| 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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| onChange?                 | <code>(value: string &#124; 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: string &#124; 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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | <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/TextField/TextField.ts

@@ -0,0 +1,173 @@
+import {createRemoteComponent, RemoteFragment} from '@remote-ui/core';
+
+import type {Autocomplete} from '../shared';
+import type {IconSource} from '../Icon/Icon';
+
+type Type = 'text' | 'email' | 'number' | 'telephone';
+
+export interface TextFieldProps<T extends string | number | undefined> {
+  /**
+   * A unique identifier for the field. When no `id` is set,
+   * a globally unique value will be used instead.
+   */
+  id?: string;
+  /**
+   * An icon to render at the start or end of the field.
+   * It will render at the start by default.
+   */
+  icon?: IconSource | {source: IconSource; position?: 'start' | 'end'};
+  /**
+   * An identifier for the field that is unique within the nearest
+   * containing `Form` component.
+   */
+  name?: string;
+  /**
+   * Content to use as the field label. This value is also used as the placeholder
+   * when the field is empty.
+   */
+  label: string;
+  /**
+   * Text content to render before the value.
+   */
+  prefix?: string;
+  /**
+   * Text content to render at the end of the text field.
+   */
+  suffix?: string;
+  /**
+   * 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.
+   */
+  accessory?: string | RemoteFragment;
+  /**
+   * A detailed description for screen readers.
+   */
+  accessibilityDescription?: string;
+  /**
+   * The current value for the field. If omitted, the field will be empty. You should
+   * update this value in response to the `onChange` callback.
+   */
+  value?: T;
+  /**
+   * In rare cases, like the PhoneField component, we completely control state.
+   * In those cases, there is never a difference between the `value` prop of the field
+   * and the current value in the field, and so this component never considers the
+   * field to have changed. Use the `controlledValue` prop to provide the value that
+   * should be shown to the buyer in those circumstances, but where the `value` prop
+   * will continue to be used as the comparison value to determine whether the field
+   * has changed. This value will usually be set to the last committed, unformatted value
+   * for the controlled input.
+   */
+  controlledValue?: T;
+  /**
+   * The content type a buyer will enter into the field. This type is used to provide
+   * semantic value to the field and, where possible, will provide the buyer with
+   * a better editing experience for the content type.
+   *
+   * Note that the type property does not change the way the text field’s value will
+   * be provided in `onChange` or `onInput`; a text field with a type of `'number'`
+   * will still provide the exact user entry, as a string, to those callbacks. The
+   * type also does not perform any form of automatic validation. If you want to
+   * perform validation, use the `error` property.
+   */
+  type?: Type;
+  /**
+   * 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;
+  /**
+   * 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;
+  /**
+   * Whether the field supports multiple lines of input.
+   * Set a `number` to define the default lines of the input.
+   */
+  multiline?: boolean | number;
+  /**
+   * 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.
+   *
+   * Alternatively, you can provide an `Autocomplete` object, which describes the
+   * specific data you would like to be entered into this field during autofill.
+   */
+  autocomplete?: Autocomplete | boolean;
+  /**
+   * Whether the field can be modified.
+   */
+  disabled?: boolean;
+  /**
+   * Whether the field is read-only.
+   */
+  readonly?: boolean;
+  /**
+   * Specifies the maximum number of characters allowed.
+   */
+  maxLength?: number;
+  /**
+   * Callback when input is focused.
+   */
+  onFocus?(): void;
+  /**
+   * Callback when focus is removed.
+   */
+  onBlur?(): void;
+  /**
+   * 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.
+   *
+   * 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 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: T): void;
+  /**
+   * 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.
+   *
+   * This callback is called with the current value of the field.
+   */
+  onInput?(value: T): void;
+}
+
+/**
+ * Use a text field to get text input from a customer.
+ */
+export const TextField = createRemoteComponent<
+  'TextField',
+  TextFieldProps<string>
+>('TextField');

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

@@ -0,0 +1,5 @@
+## Best practices
+
+- Clearly label text fields so that it's obvious what customers should enter.
+- Label text fields as **Optional** when input isn’t required. For example, use the label **First name (optional)**.
+- Don't have optional fields pass `true` to the `required` property.

package/src/surfaces/checkout/components/TextField/examples/basic-textfield.example.ts

@@ -0,0 +1,9 @@
+import {extend, TextField} from '@shopify/ui-extensions/checkout';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const textfield = root.createComponent(TextField, {
+    label: 'Last name',
+  });
+
+  root.appendChild(textfield);
+});

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

@@ -0,0 +1,8 @@
+# Tooltip
+
+Tooltips are floating labels that briefly explain the function of a user interface element.
+They must be specified inside the `overlay` prop of an activator component.
+Currently, activator components are `Button`, `Link`, and `Pressable`.
+
+The library takes care of applying the WAI-ARIA Tooltip Widget pattern automatically for the activator
+and the tooltip content. Expect screen readers to read the tooltip content when the user focuses the activator.

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

@@ -0,0 +1,15 @@
+import {createRemoteComponent} from '@remote-ui/core';
+
+export interface TooltipProps {}
+
+/**
+ * Tooltips are floating labels that briefly explain the function of a user interface element.
+ * They must be specified inside the `overlay` prop of an activator component.
+ * Currently, activator components are `Button`, `Link`, and `Pressable`.
+ *
+ * The library takes care of applying the WAI-ARIA Tooltip Widget pattern automatically for the activator
+ * and the tooltip content. Expect screen readers to read the tooltip content when the user focuses the activator.
+ */
+export const Tooltip = createRemoteComponent<'Tooltip', TooltipProps>(
+  'Tooltip',
+);

package/src/surfaces/checkout/components/Tooltip/examples/basic-tooltip.example.ts

@@ -0,0 +1,23 @@
+import {
+  extend,
+  Icon,
+  Pressable,
+  Tooltip,
+} from '@shopify/ui-extensions/checkout';
+
+extend('Checkout::Dynamic::Render', (root) => {
+  const tooltipFragment = root.createFragment();
+  const tooltip = root.createComponent(
+    Tooltip,
+    {},
+    'In case we need to contact you about your order',
+  );
+  tooltipFragment.appendChild(tooltip);
+  const pressable = root.createComponent(
+    Pressable,
+    {overlay: tooltipFragment},
+    [root.createComponent(Icon, {source: 'questionFill'})],
+  );
+
+  root.appendChild(pressable);
+});

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

@@ -0,0 +1,97 @@
+# View
+
+View is a generic container component. Its contents will always be their
+“natural” size, so this component can be useful in layout components (like `Grid`,
+`BlockStack`, `InlineStack`) that would otherwise stretch their children to fit.
+
+Note: View’s box model related properties like `padding`, `border`, `borderRadius`, and `borderColor` are implemented as
+[CSS Logical Properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Logical_Properties/Basic_concepts).
+
+## Props
+
+optional = ?
+
+| Name                     | Type                                                                                                                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| accessibilityVisibility? | <code>"hidden"</code>                                                                                                                                                                                                                                                                                 | Changes the visibility of the element to assistive technologies.<br /><br />`hidden` hides the component from assistive technology (for example, a screen reader) but remains visually visible.                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| display?                 | <code>"block" &#124; "inline"</code>                                                                                                                                                                                                                                                                  | Changes the display of the View.<br /><br />`inline` follows the direction of words in a sentence based on the document’s writing mode.<br /><br />`block` follows the direction of paragraphs based on the document’s writing mode.<br /><br />Default value: <code>'block'</code>                                                                                                                                                                                                                                                                                                                                    |
+| id?                      | <code>string</code>                                                                                                                                                                                                                                                                                   | A unique identifier for the View.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| opacity?                 | <code>10 &#124; 20 &#124; 30 &#124; 40 &#124; 50 &#124; 60 &#124; 70 &#124; 80 &#124; 90</code>                                                                                                                                                                                                       | Sets the opacity of the View. The opacity will be applied to the background as well as all the children of the View. Use carefully as this could decrease the contrast ratio between the background and foreground elements, resulting in unreadable and inaccessible text.                                                                                                                                                                                                                                                                                                                                            |
+| 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.                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| 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', 'separator']` tuple will render: &lt;li role='separator'&gt;<br /><br />- In an HTML host a `listItem` string will render: &lt;li&gt;                                                                                                                                                                                                                                                           |
+| position?                | <code>Position &#124; ConditionalStyle<<wbr>Position, AcceptedConditions<wbr>></code>                                                                                                                                                                                                                 | Changes how the View is positioned.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| translate?               | <code><a href="#translate">Translate</a> &#124; ConditionalStyle<<wbr><a href="#translate">Translate</a>, AcceptedConditions<wbr>></code>                                                                                                                                                             | Specifies a two-dimensional translation of the View.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| blockAlignment?          | <code>"start" &#124; "center" &#124; "end" &#124; ConditionalStyle<<wbr>"start" &#124; "center" &#124; "end", AcceptedConditions<wbr>></code>                                                                                                                                                         | Position children along the cross axis                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| inlineAlignment?         | <code><a href="#inlinealignment">InlineAlignment</a> &#124; ConditionalStyle<<wbr><a href="#inlinealignment">InlineAlignment</a>, AcceptedConditions<wbr>></code>                                                                                                                                     | Position children along the main axis                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| inlineSize?              | <code>"fill" &#124; ConditionalStyle<<wbr>"fill", AcceptedConditions<wbr>></code>                                                                                                                                                                                                                     | Adjust the inline size.<br /><br />`fill`: takes all the available space.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| 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`                                                             |
+| visibility?              | <code>"hidden"</code>                                                                                                                                                                                                                                                                                 | Changes the visibility of the element.<br /><br />`hidden` visually hides the component while keeping it accessible to assistive technology, such as screen readers. Hidden elements don't take any visual space contrary to CSS visibility: hidden;                                                                                                                                                                                                                                                                                                                                                                   |
+
+<a name="Spacing"></a>
+
+### Spacing
+
+<code>"none" &#124; "extraTight" &#124; "tight" &#124; "base" &#124; "loose" &#124; "extraLoose"</code>
+<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="InlineAlignment"></a>
+
+### InlineAlignment
+
+<code>"start" &#124; "center" &#124; "end"</code><a name="Translate"></a>
+
+### Translate
+
+| Name    | Type                                                   | Description                                                                                                   |
+| ------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
+| block?  | <code>number &#124; &#96;&dollar;{number}%&#96;</code> | Adjust the translation on the cross axis.<br /><br />A percentage value refers to the block size of the View. |
+| inline? | <code>number &#124; &#96;&dollar;{number}%&#96;</code> | Adjust the translation on the main axis.<br /><br />A percentage value refers to the inline size of the View. |
+
+<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.                                                           |