Formatted Name

lightning-formatted-name

Displays a formatted name that can include a salutation and suffix.

For Use In

Lightning Experience, Experience Builder Sites, Salesforce Mobile App, Lightning Out (Beta), Standalone Lightning App, Mobile Offline

::::::tabset{tabs='["Example", "Develop", "Specifications"]'}

:::::tab

::component-playground{component="formattedName" model="lwc" namespace="lightning"}

:::::

:::::tab

A lightning-formatted-name component shows formatted names in a given format and order. The locale you set in the app's user preferences determines how the component formats the names and how it presents the order of the names.

This example specifies "Mr. John Middleton Doe The 3rd Jo" based on the default English United States locale with the long format.

<template>
    <lightning-formatted-name
        first-name="John"
        middle-name="Middleton"
        last-name="Doe"
        informal-name="Jo"
        suffix="The 3rd"
        salutation="Mr."
    >
    </lightning-formatted-name>
</template>

The format attribute determines the length of the name.

Format	Description	Example
short	Shows the first name and last name only.	John Doe
medium	Shows the first name, middle name, and last name only.	John Middleton Doe
long (default)	Shows the name including salutation, first name, middle name, last name, suffix, informal name.	Mr. John Middleton Doe The 3rd Jo

For more information on supported locales, see Supported Locales in the Salesforce Help.

To create a form that takes in user input for names, you can use the lightning-input-name component, which shows a name compound field that supports user input for salutation, suffix, and so on.

Use the Locale Information

In Lightning Experience, the locale value corresponds to the Locale field on the Language & Time Zone page in the user's personal settings.

By default, the org's locale setting determines the order of the name fields. If a user sets their personal locale setting, it overrides the org's locale setting.

For example, if you select "French (France)" in the Locale field, lightning-formatted-name uses fr-FR as the locale.

To enable your component to override the user's personal locale setting, set the locale attribute. Specify any locale code from the list of Supported Number, Name, and Address Formats (ICU).

<template>
    <lightning-formatted-name
          first-name="John"
          middle-name="Middleton"
          last-name="Doe"
          suffix="The 3rd"
          salutation="Mr."
          locale="en-US">
    </lightning-formatted-name>
</template>

If you don't specify the locale, lightning-formatted-name defaults to the user's locale in the org.

<template>
    <h2>User's locale: {userLocale}</h2>
    <!--No locale specified on lightning-formatted-name -->
    <lightning-formatted-name
          lwc:ref="name"
          first-name="John"
          middle-name="Middleton"
          last-name="Doe"
          suffix="The 3rd"
          salutation="Mr.">
    </lightning-formatted-name>
</template>

In this example, the userLocale property returns fr-FR based on the org user's settings.

import { LightningElement } from "lwc";

export default class LocaleExample extends LightningElement {
  userLocale = "";

  renderedCallback() {
    this.userLocale = this.refs.name.locale;
  }
}

If you pass in an invalid locale, the component uses en-US. The locale supports both hyphens and underscores, for example, en-US or en_US.

Formatted Name

Use the Locale Information

See Also