Field storage settings¶
Name field storage settings live on NameItem and are built from
NameFieldSettingsTrait and NameAdditionalPreferredTrait. Widget and formatter
plugins can override some presentation settings per display; see
Widget examples and
Formatter examples.
Component visibility and validation¶
| Key | Purpose |
|---|---|
components |
Per-component checkboxes (title, given, middle, family, generational, credentials). |
minimum_components |
Which components are required for a complete name value. |
allow_family_or_given |
When enabled, filling either given or family satisfies both minimums. |
component_layout |
Reading-order layout: default, asian, eastern, or german. |
Per-component input¶
| Key | Purpose |
|---|---|
max_length |
Maximum character length per component (1–255). |
field_type |
text, select, or autocomplete per component. |
title_options |
Line-based title select options; supports -- empty prompts and [vocabulary:machine_name]. |
generational_options |
Same conventions as title_options for generational suffixes. |
sort_options |
When enabled per component, option lists are sorted alphabetically. |
See Options Provider for how options are resolved at runtime.
Autocomplete¶
| Key | Purpose |
|---|---|
autocomplete_source |
Per-component enabled sources: title, generational, data. |
autocomplete_separator |
Separator when editors type multi-part autocomplete input. |
autocomplete_match |
Default match mode: starts_with or contains. |
autocomplete_match_overrides |
Optional per-component override of the default match mode. |
Stored config for the generational component may use the legacy checkbox value
generation in defaults while the field settings UI labels the option
generational. See Autocomplete Service.
Preferred and alternative sources (field level)¶
These keys come from NameAdditionalPreferredTrait on the field type. They
supply preferred and alternative tokens during formatting when referenced
from name format patterns:
| Key | Purpose |
|---|---|
preferred_field_reference |
Entity field, _self, or _self_property:* source for preferred given name. |
preferred_field_reference_separator |
Separator when the source field is multi-value. |
alternative_field_reference |
Same options for alternative name data. |
alternative_field_reference_separator |
Separator for multi-value alternative sources. |
The formatter plugin has its own preferred/alternative settings for display output; field-level settings apply during formatting regardless of view mode.
See Additional Component Service.
User display name override¶
On user bundles only:
| Key | Purpose |
|---|---|
override_format |
Name format machine name used when this field drives the account display name. |
Enabling Use this field to override the user's login name? updates
name.settings:user_preferred. See User integration.