ExtensionCardFieldDefinition

The definition for a field to be included in a SchemaDefinition

Extends


Properties

constraints?

optional constraints: FieldConstraintDefinition[];

Inherited from

FieldDefinition.constraints


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


label

label: string;

The label to display in the UI


mapping?

optional mapping: readonly LucidFields[] | readonly SemanticFields[] | readonly SemanticKind[];

Inherited from

FieldDefinition.mapping


name

name: string;

Inherited from

FieldDefinition.name


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.


type

type: FieldTypeDefinition;

Inherited from

FieldDefinition.type