# ConsentPhoneField

Display a phone field for customers to sign up for text message marketing, noting that the phone field value will be automatically saved during checkout.

```tsx
import React from 'react';
import {
  reactExtension,
  ConsentPhoneField,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
  'purchase.checkout.block.render',
  () => <Extension />,
);

function Extension() {
  return (
    <ConsentPhoneField
      label="Phone"
      policy="sms-marketing"
    />
  );
}

```

```js
import {extension, ConsentPhoneField} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root) => {
  const consentPhoneField = root.createComponent(ConsentPhoneField, {
    label: 'Phone',
    policy: 'sms-marketing',
  });

  root.appendChild(consentPhoneField);
});

```

## ConsentPhoneFieldProps

### ConsentPhoneFieldProps

### policy

value: `ConsentPolicy`

  - ConsentPolicy: 'sms-marketing'
The policy for which buyer consent is being collected for.

`sms-marketing`: Represents the policy for SMS marketing consent.

### accessory

value: `string | RemoteFragment<RemoteRoot<any, any>>`

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

value: `string`

A detailed description for screen readers.

### autocomplete

value: `boolean | Autocomplete`

  - Autocomplete: export interface Autocomplete {
  /**
   * The contact information “group” the autocomplete data should be sourced from.
   */
  group?: AutocompleteGroup;
  /**
   * The type of data that should be inserted into a field supporting autocomplete.
   */
  field: AutocompleteField;
}
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.

### disabled

value: `boolean`

Whether the field can be modified.

### error

value: `string`

Indicate an error to the user. The field will be given a specific stylistic treatment
to communicate problems that have to be resolved immediately.

### icon

value: `IconSource | { source: IconSource; position?: "start" | "end"; }`

  - IconSource: 'arrowLeft' | 'arrowRight' | 'arrowUp' | 'arrowUpRight' | 'arrowDown' | 'bag' | 'calendar' | 'camera' | 'caretDown' | 'cart' | 'checkmark' | 'chevronLeft' | 'chevronRight' | 'chevronUp' | 'chevronDown' | 'clock' | 'close' | 'critical' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'email' | 'error' | 'errorFill' | 'external' | 'filter' | 'geolocation' | 'gift' | 'giftFill' | 'grid' | 'hamburger' | 'hollowCircle' | 'horizontalDots' | 'image' | 'info' | 'infoFill' | 'list' | 'lock' | 'magnify' | 'map' | 'marker' | 'minus' | 'mobile' | 'note' | 'orderBox' | 'pen' | 'plus' | 'profile' | 'question' | 'questionFill' | 'reorder' | 'return' | 'savings' | 'store' | 'success' | 'truck' | 'verticalDots' | 'warning' | 'warningFill'
An icon to render at the start or end of the field.
It will render at the start by default.

### id

value: `string`

A unique identifier for the field. When no `id` is set,
a globally unique value will be used instead.

### label

value: `string`

Content to use as the field label. This value is also used as the placeholder
when the field is empty.

### maxLength

value: `number`

Specifies the maximum number of characters allowed.

### name

value: `string`

An identifier for the field that is unique within the nearest
containing `Form` component.

### readonly

value: `boolean`

Whether the field is read-only.

### required

value: `boolean`

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.

### onChange

value: `(value: string) => void`

Callback when the buyer has **finished editing** a field or pressed the country dropdown.
Unlike `onChange` callbacks you may be familiar with from Polaris or other React component libraries,
this callback is **not** run on every change to the input. Phone fields are
“partially controlled” components, which means that while the buyer edits the
field, its state is controlled by the component. Once the buyer has signalled that
they have finished editing the field (typically, by blurring the field), `onChange`
is called if the input actually changed from the most recent `value` property. At
that point, you are expected to store this “committed value” in state, and reflect
it in the phone field’s `value` property.

This state management model is important given how UI Extensions are rendered. UI Extension components
run on a separate thread from the UI, so they can’t respond to input synchronously.
A pattern popularized by [controlled React components](https://reactjs.org/docs/forms.html#controlled-components)
is to have the component be the source of truth for the input `value`, and update
the `value` on every user input. The delay in responding to events from a UI
extension is only a few milliseconds, but attempting to strictly store state with
this delay can cause issues if a user types quickly, or if the buyer is using a
lower-powered device. Having the UI thread take ownership for “in progress” input,
and only synchronizing when the user is finished with a field, avoids this risk.

It can still sometimes be useful to be notified when the user makes any input in
the field. If you need this capability, you can use the `onInput` prop. However,
never use that property to create tightly controlled state for the `value`.

This callback is called with the current formatted value of the field. If the value
of a field is the same as the current `value` prop provided to the field,
the `onChange` callback will not be run.

### onInput

value: `(value: string) => void`

Callback when the user makes any changes in the field including selecting a country
in the dropdown. As noted in the documentation for `onChange`, you must not use
this to update `state` — use the `onChange` callback for that purpose.
Use the `onInput` prop when you need to do something as soon as the buyer makes a change,
like clearing validation errors that apply to the field as soon as the user begins
making the necessary adjustments.

This callback is called with the current formatted value.

### onFocus

value: `() => void`

Callback when input is focused.

### onBlur

value: `() => void`

Callback when focus is removed.

### 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.

### group

value: `AutocompleteGroup`

  - Autocomplete: export interface Autocomplete {
  /**
   * The contact information “group” the autocomplete data should be sourced from.
   */
  group?: AutocompleteGroup;
  /**
   * The type of data that should be inserted into a field supporting autocomplete.
   */
  field: AutocompleteField;
}
  - AutocompleteGroup: 'shipping' | 'billing' | 'location'
The contact information “group” the autocomplete data should be sourced from.

### field

value: `AutocompleteField`

  - Autocomplete: export interface Autocomplete {
  /**
   * The contact information “group” the autocomplete data should be sourced from.
   */
  group?: AutocompleteGroup;
  /**
   * The type of data that should be inserted into a field supporting autocomplete.
   */
  field: AutocompleteField;
}
  - AutocompleteField: 'name' | 'honorific-prefix' | 'given-name' | 'additional-name' | 'family-name' | 'honorific-suffix' | 'nickname' | 'username' | 'new-password' | 'current-password' | 'one-time-code' | 'organization-title' | 'organization' | 'street-address' | 'address-line1' | 'address-line2' | 'address-line3' | 'address-level4' | 'address-level3' | 'address-level2' | 'address-level1' | 'country' | 'country-name' | 'postal-code' | 'credit-card-name' | 'credit-card-given-name' | 'credit-card-additional-name' | 'credit-card-family-name' | 'credit-card-number' | 'credit-card-expiry' | 'credit-card-expiry-month' | 'credit-card-expiry-year' | 'credit-card-security-code' | 'credit-card-type' | 'transaction-currency' | 'transaction-amount' | 'language' | 'birthday' | 'birthday-day' | 'birthday-month' | 'birthday-year' | 'sex' | 'url' | 'photo' | 'telephone' | 'telephone-country-code' | 'telephone-national' | 'telephone-area-code' | 'telephone-local' | 'telephone-local-prefix' | 'telephone-local-suffix' | 'telephone-extension' | 'email' | 'instant-message' | 'home telephone' | 'home telephone-country-code' | 'home telephone-national' | 'home telephone-area-code' | 'home telephone-local' | 'home telephone-local-prefix' | 'home telephone-local-suffix' | 'home telephone-extension' | 'home email' | 'home instant-message' | 'work telephone' | 'work telephone-country-code' | 'work telephone-national' | 'work telephone-area-code' | 'work telephone-local' | 'work telephone-local-prefix' | 'work telephone-local-suffix' | 'work telephone-extension' | 'work email' | 'work instant-message' | 'mobile telephone' | 'mobile telephone-country-code' | 'mobile telephone-national' | 'mobile telephone-area-code' | 'mobile telephone-local' | 'mobile telephone-local-prefix' | 'mobile telephone-local-suffix' | 'mobile telephone-extension' | 'mobile email' | 'mobile instant-message' | 'fax telephone' | 'fax telephone-country-code' | 'fax telephone-national' | 'fax telephone-area-code' | 'fax telephone-local' | 'fax telephone-local-prefix' | 'fax telephone-local-suffix' | 'fax telephone-extension' | 'fax email' | 'fax instant-message' | 'pager telephone' | 'pager telephone-country-code' | 'pager telephone-national' | 'pager telephone-area-code' | 'pager telephone-local' | 'pager telephone-local-prefix' | 'pager telephone-local-suffix' | 'pager telephone-extension' | 'pager email' | 'pager instant-message'
The type of data that should be inserted into a field supporting autocomplete.

## Related

- [ConsentCheckbox](consent-checkbox)

## Examples

Display a phone field for customers to sign up for text message marketing, noting that the phone field value will be automatically saved during checkout.



```tsx
import React from 'react';
import {
  reactExtension,
  BlockStack,
  ConsentCheckbox,
  ConsentPhoneField,
  InlineStack,
  InlineSpacer,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
  'purchase.checkout.block.render',
  () => <Extension />,
);

function Extension() {
  return (
    <BlockStack>
      <ConsentCheckbox policy="sms-marketing">
        Text me with news and offers
      </ConsentCheckbox>
      <InlineStack
        inlineAlignment="start"
        padding={[
          'none',
          'none',
          'none',
          'tight',
        ]}
      >
        <InlineSpacer spacing="extraTight" />
        <ConsentPhoneField
          label="Phone"
          policy="sms-marketing"
        />
      </InlineStack>
    </BlockStack>
  );
}

```

```js
import {
  extension,
  BlockStack,
  ConsentCheckbox,
  ConsentPhoneField,
  InlineStack,
  InlineSpacer,
} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root) => {
  const consentCheckbox = root.createComponent(
    ConsentCheckbox,
    {
      policy: 'sms-marketing',
    },
    'Text me with news and offers',
  );

  const inlineSpacer = root.createComponent(InlineSpacer, {
    spacing: 'extraTight',
  });

  const consentPhoneField = root.createComponent(ConsentPhoneField, {
    label: 'Phone',
    policy: 'sms-marketing',
  });

  const inlineStack = root.createComponent(
    InlineStack,
    {
      inlineAlignment: 'start',
      padding: ['none', 'none', 'none', 'tight'],
    },
    [inlineSpacer, consentPhoneField],
  );

  const layout = root.createComponent(BlockStack, undefined, [
    consentCheckbox,
    inlineStack,
  ]);

  root.appendChild(layout);
});

```

## Examples

Display a phone field for customers to sign up for text message marketing, noting that the phone field value will be automatically saved during checkout.



```tsx
import React from 'react';
import {
  reactExtension,
  BlockStack,
  ConsentCheckbox,
  ConsentPhoneField,
  InlineStack,
  InlineSpacer,
} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(
  'purchase.checkout.block.render',
  () => <Extension />,
);

function Extension() {
  return (
    <BlockStack>
      <ConsentCheckbox policy="sms-marketing">
        Text me with news and offers
      </ConsentCheckbox>
      <InlineStack
        inlineAlignment="start"
        padding={[
          'none',
          'none',
          'none',
          'tight',
        ]}
      >
        <InlineSpacer spacing="extraTight" />
        <ConsentPhoneField
          label="Phone"
          policy="sms-marketing"
        />
      </InlineStack>
    </BlockStack>
  );
}

```

```js
import {
  extension,
  BlockStack,
  ConsentCheckbox,
  ConsentPhoneField,
  InlineStack,
  InlineSpacer,
} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root) => {
  const consentCheckbox = root.createComponent(
    ConsentCheckbox,
    {
      policy: 'sms-marketing',
    },
    'Text me with news and offers',
  );

  const inlineSpacer = root.createComponent(InlineSpacer, {
    spacing: 'extraTight',
  });

  const consentPhoneField = root.createComponent(ConsentPhoneField, {
    label: 'Phone',
    policy: 'sms-marketing',
  });

  const inlineStack = root.createComponent(
    InlineStack,
    {
      inlineAlignment: 'start',
      padding: ['none', 'none', 'none', 'tight'],
    },
    [inlineSpacer, consentPhoneField],
  );

  const layout = root.createComponent(BlockStack, undefined, [
    consentCheckbox,
    inlineStack,
  ]);

  root.appendChild(layout);
});

```