A token which can be used in an autocomplete hint to tell clients what kind of data is expected. This can enable the user agent or assistive technologies to automatically suggest or fill in information specific to the user.
Please note that not all values will work on all platforms. For the most benefit, it is helpful to combine controls with autocomplete hint - i.e a common pattern is to have password control on string schemas that can be combined with PASSWORD or NEW_PASSWORD autocomplete hints for the best possible user experience.
| Value | Description |
|---|---|
additional-name | An additional (or middle) name. For example: "John" |
address-level-1 | Describes the address in terms of increasing levels of precision within the country in which the address is located. Each country has its own system of administrative levels, and may arrange the levels in different orders when addresses are written. This is the broadest administrative level in the address, i.e. the province within which the locality is found; for example, in the US, this would be the state; in the UK, the post-town. For example: "MA" |
address-level-2 | The second administrative level, in addresses with two or more administrative levels; in the countries with two administrative levels, this would typically be the city, town, village, or other locality within which the relevant street address is found. For example: "Cambridge" |
address-level-3 | The third administrative level, in addresses with three or more administrative levels. |
address-level-4 | The most fine-grained administrative level, in addresses with four administrative levels. |
billing | A modifier that can be combined with other tokens (e.g. FULL_STREET_ADDRESS), to indicate that the field is part of the billing address or contact information. |
birthdate | A birthdate, as a full date. For example: "1955-06-08" |
birthdate-day | The day of the month of a birthdate. For example: "8" |
birthdate-month | The month of the year of a birthdate. For example: "6" |
birthdate-year | The year of a birthdate. For example: "1955" |
country-code | Valid ISO 3166-1-alpha-2 country codes. For example: "US" |
country-name | A country or territory name (could be the same as COUNTRY_CODE or the full name). For example: "United States" |
credit-card-expiration | A payment method expiration date. For example: "2014-12" |
credit-card-expiration-month | The month in which the payment method expires. For example: "12" |
credit-card-expiration-year | The year in which the payment method expires. For example: "2023" |
credit-card-family-name | A family name, as given on a credit card. For example: "Berners-Lee" |
credit-card-given-name | A given (first) name as given on a payment instrument like a credit card. For example: "Tim" |
credit-card-middle-name | A middle name as given on a payment instrument or credit card. For example: "John" |
credit-card-name | The full name as printed on or associated with a payment instrument such as a credit card. For example: "Tim Berners-Lee" |
credit-card-number | A credit card number or other number identifying a payment method, such as an account number. For example: "4114360123456785" |
credit-card-security-code | The security code for the payment instrument; on credit cards, this is the 3-digit verification number on the back of the card. For example: "443" |
credit-card-type | The type of payment instrument. For example: "Visa" |
email | An email address. For example: "timbl@w3.org" |
family-name | A family (or "last") name. For example: "Berners-Lee" |
fax | A modifier that can be combined with other tokens (e.g. PHONE_NUMBER), to indicate that the field describes a fax machine's contact details |
full-street-address | A street address. This can be multiple lines of text, and should fully identify the location of the address within its second administrative level (typically a city or town), but should not include the city name, ZIP or postal code, or country name. For example: "32 Vassar Street MIT Room 32-G524" |
gender | A gender identity (e.g. "Female", "Fa'afafine" or "Nonbinary"). For example: "Male" |
given-name | A given (or "first") name. For example: "Timothy" |
home | A modifier that can be combined with other tokens (e.g. PHONE_NUMBER), to indicate that the field is for contacting someone at their residence. |
impp | URL representing an instant messaging protocol endpoint (for example, "aim:goim?screenname=example" or "xmpp:fred@example.net") For example: "irc://example.org/timbl,isuser" |
job-title | A job title, or the title a person has within an organization. For example: "Professor" |
language | A preferred language, given as a valid BCP 47 language tag. For example: "en" |
mobile | A modifier that can be combined with other tokens (e.g. PHONE_NUMBER), to indicate that the field is for contacting someone regardless of location. |
name | A person's full name. For example: "Sir Timothy John Berners-Lee, OM, KBE, FRS, FREng, FRSA" |
name-prefix | A prefix or title, such as "Mrs.", "Mr.", "Miss", "Ms.", "Dr.", or "Mlle.". For example: "Sir" |
name-suffix | A name suffix, such as "Jr.", "B.Sc.", "PhD.", "MBASW", or "IV". For example: "OM, KBE, FRS, FREng, FRSA" |
new-password | A new password. For example: "GUMFXbadyrS3" |
new-username | A newly created username or account name. For example: "timblee" |
nickname | A nickname or handle. For example: "Tim" |
on | Let the user agent provide the user with autocompletion values, but do not provide any further information about what kind of data the user might be expected to enter. The user agent would have to use heuristics to decide what autocompletion values to suggest. This is not recommended. It is preferable to use a specific value instead. |
one-time-code | A one-time password (OTP). For example: "1234" |
organization-name | A company or organisation name. For example: "World Wide Web Consortium" |
pager | A modifier that can be combined with other tokens (e.g. PHONE_NUMBER), to indicate that the field describes a pager's or beeper's contact details |
password | The user's current password. For example: "qwerty" |
phone-area-code | The area code, with any country-internal prefix applied if appropriate. For example: "617" |
phone-country-code | The country code, such as "1" for the United States, Canada, and other areas in North America and parts of the Caribbean. For example: "+1" |
phone-extension | A phone extension code within the phone number, such as a room or suite number in a hotel or an office extension in a company. For example: "1000" |
phone-local | The phone number without the country or area code. For example: "2535702" |
phone-local-prefix | First part of the component of the phone number that follows the area code, when that component is split into two components. For example: "253" |
phone-local-suffix | Second part of the component of the phone number that follows the area code, when that component is split into two components. For example: "5702" |
phone-national | The entire phone number without the country code component, including a country-internal prefix. For the phone number "1-855-555-6502", this field's value would be "855-555-6502". For example: "617 253 5702" |
phone-number | A full phone number, including the country code. For example: "+1 617 253 5702" |
photo | The URL of an image representing the person, company, or contact information given in the other fields in the form. For example: "https://www.w3.org/Press/Stock/Berners-Lee/2001-europaeum-eighth.jpg" |
postal-code | Postal code, post code, ZIP code, CEDEX code (if CEDEX, append "CEDEX", and the arrondissement, if relevant, to the ADDRESS_LEVEL_2 field). For example: "02139" |
shipping | A modifier that can be combined with other tokens (e.g. FULL_STREET_ADDRESS), to indicate that the field is part of the shipping address or contact information. |
street-address-line-1 | Individual line of the street address. This should only be present if FULL_STREET_ADDRESS is not present. For example: "32 Vassar Street" |
street-address-line-2 | Individual line of the street address. This should only be present if FULL_STREET_ADDRESS is not present. For example: "MIT Room 32-G524" |
street-address-line-3 | Individual line of the street address. This should only be present if FULL_STREET_ADDRESS is not present. |
transaction-amount | The amount, given in the currency specified by TRANSACTION_CURRENCY, of the transaction, for a payment form. For example: "401.95" |
transaction-currency | The currency in which the transaction is to take place. For example: "GBP" |
url | A URL, such as a home page or company website address as appropriate given the context of the other fields in the form. For example: "https://www.w3.org/People/Berners-Lee/" |
username | A username or account name. For example: "timbl" |
work | A modifier that can be combined with other tokens (e.g. PHONE_NUMBER), to indicate that the field is for contacting someone at their workplace. |