Skip to content

getUIFieldKeys

getUIFieldKeys(props): string[]

Defined in: packages/core/src/fields/utils.ts:635

Collects every ui() field’s resolved key, reachable by hoisting through tabs()/row()/collapsible() nesting — the general counterpart of getUIFieldsWithCell (which additionally requires an admin.components.Cell, for list-column generation specifically). A caller that needs to know about EVERY ui() field a collection declares — not just the ones with a list column — uses this instead (access-system-fields plan: UI fields are gateable in a FieldPermissionMap “under the same rule” as data fields, so a caller counting hidden fields, e.g. the Inspect peek’s own notice, needs the FULL set, Cell or not).

Same scope/traversal as getUIFieldsWithCell: does not descend into group()/array()/blocks() (their own ui() sub-fields never surface as a top-level column OR a top-level peek row either — both consumers only ever ask about TOP-LEVEL UI fields); a named tab’s ui() field is keyed "<tabName>.<key>", matching how a DATA field in the same named tab is addressed (getDataFields’s own group-shaped key).

Record<string, AdminField>

string[]

Every ui() field’s resolved key.

getUIFieldsWithCell for the Cell-only counterpart this mirrors.