The definition for a field to be included in a SchemaDefinition
Extends
Properties
constraints?
optional constraints: FieldConstraintDefinition[];
Inherited from
default?
optional default: SerializedFieldType;
If defined, the default value for this field
description?
optional description: string;
Additional information we can provide to users, e.g. as a hover tooltip
displayOptions?
Experimental
optional displayOptions: readonly DisplayMultiUserEditDisplayOptionDefinition[];
If specified, a list of options indicating how the field should be displayed
in the UI. This is particularly useful when collection enums are of a certain
data type that should be rendered differently.
Inherited from
FieldDefinition.displayOptions
label
label: string;
The label to display in the UI
mapping?
optional mapping: readonly LucidFields[] | readonly SemanticFields[] | readonly SemanticKind[];
Inherited from
name
name: string;
Inherited from
options?
optional options: string | ExtensionCardFieldOption[];
If specified, the list of options available to choose from, or the name
of a registered action that returns the list of options (either directly
or as a Promise).
search?
optional search: string;
If specified, an action that takes the search text and input so far, and
returns the list of options that should be displayed. This is useful when
there are too many possible options to reasonably use the "options"
option for options.
truncatedLabel?
optional truncatedLabel: string;
If specified, an truncated label will be shown for responsiveness
type
type: FieldTypeDefinition;
Inherited from
unsetFieldsWhenChanged?
optional unsetFieldsWhenChanged: string[];
If set, when this field is changed, selections for any of the fields in
this list will be unset.
This is useful if changing this field invalidates the values of other fields.