showPhoneNumberEditor

client.showPhoneNumberEditor({
  container: HTMLElement|id,
  accessToken: string,
  // Optional arguments
  showLabels: boolean,
  countryCode: string,
  onReady: function,
  theme: object,
  i18n: object,
  phoneNumberOptions:  object
})

See the example

Description

Show the widget allowing the current profile to change his phone number after authentication.

The SMS feature must be enabled on your ReachFive account.

Examples

const accessToken = // Here paste the authorization token of the profile retrieved after login

client.showPhoneNumberEditor({
  container: 'phone-number-editor-container',
  accessToken,
  showLabels: true,
  countryCode: 'US',
  onReady: instance => {
    // Destroy the widget
    // if (...) instance.destroy()
  },
  theme: {
      primaryColor: '#274890',
      borderRadius: '#374890'
  },
  i18n: {
      'phoneNumberEditor.verification.intro': 'Please enter the verification code we sent you by SMS.',
      'phoneNumber': 'Your new phone number'
  }
})

Widget

showPhoneNumberEditor

Country dropdown

View when withCountrySelect is set to true.

widget phone select country

Parameters

container HTMLElement id

The DOM element or the id of a DOM element in which the widget should be embedded.

accessToken string

The authorization credential JSON Web Token (JWT) used to access the ReachFive API, less than five minutes old.

showLabels boolean

Boolean for whether the signup form fields' labels are displayed on the login view.

Defaults to false. If set to true, the labels are shown which includes an asterisk (*) next to required fields.

countryCode string

The ISO country code useful to format phone numbers.

Defaults to the predefined country code in your account settings or FR.

onReady function

Callback function called after the widget has been successfully loaded and rendered inside the container. The callback is called with the widget instance.

theme object

The options to set up to customize the appearance of the widget.

Below is an example of some of the theme attributes.

For a full list, see theme attributes.

primaryColor string

The button and link default color.

Defaults to #229955.

borderRadius string

The radius of the social login button and other input (in px).

This can be used to make inline and/or circle social login buttons.

Defaults to 3.

socialButton object

Social button theming options.

Parameters

  • inline- Boolean that specifies if the buttons are inline (horizonally-aligned).

  • textVisible - Boolean that specifies if the text is visible.

  • fontWeight - Specifies the font-weight (such as normal, bold, or 900).

  • fontSize - Specifies the font-size.

  • lineHeight - Specifies the line-height.

  • paddingX - Specifies the padding for the x axis. (left and right)

  • paddingY - Specifies the padding for the y axis. (top and bottom)

  • borderRadius - Specifies the border-radius.

  • borderWidth - Specifies the border-width.

  • focusBoxShadow - Boolean that specifies if there is a box shadow on the button or not.

i18n object

Widget labels and error messages to override. Falls back to the default wordings in en, fr, es, it and nl.

You might re-word the socialAccounts.linkNewAccount or change the way other wordings display to the user while leaving the remaining text on the widget intact.

phoneNumberOptions object

Object that lets you set display options for the phone number field.

Options

  • withCountrySelect: boolean that lets you display the option to select the country for a phone number. Defaults to false.

theme attributes

base

attribute

animateWidgetEntrance

fontSize

smallTextFontSize

lineHeight

headingColor

textColor

mutedTextColor

borderRadius

borderColor

borderWidth

backgroundColor

primaryColor

dangerColor

warningColor

successColor

lightBackgroundColor

maxWidth

paddingY

paddingX

spacing

_absoluteLineHeight

_blockInnerHeight

_blockHeight

link

color

decoration

hoverColor

hoverDecoration

input

color

placeholderColor

background

disabledBackground

boxShadow

focusBoxShadow

fontSize

lineHeight

paddingX

paddingY

borderRadius

borderColor

borderWidth

focusBorderColor

height

button

fontWeight

fontSize

lineHeight

paddingX

paddingY

borderRadius

borderWidth

focusBoxShadow

height

socialButton

inline

textVisible

fontWeight

fontSize

lineHeight

paddingX

paddingY

borderRadius

borderWidth

focusBoxShadow

height

passwordStrengthValidator

color0

color1

color2

color3

color4