SelectField
The Select field type used in Statamic.
Type Definition
Dropdown select input.
type SelectField<T extends FieldValue> = SelectFieldSingle<T> | SelectFieldSingle<T>[];
The value type for the select input
Example single Select field
type Category = SelectField<"news" | "blog" | "events">;
// Result: {
// value: "news" | "blog" | "events",
// label: string,
// key: "news" | "blog" | "events"
// }[] | []
Example multiple Select field
type Tags = SelectField<string>;
// Result: {
// value: string,
// label: string,
// key: string
// }[] | []
Helper Types
SelectFieldSingle
Structure for Select field single instances.
type SelectFieldSingle<T extends FieldValue> = LabeledValue<T>;
The value type for the select single input
Example single Select field
type Category = SelectFieldSingle<"news" | "blog" | "events">;
// Result: {
// value: "news" | "blog" | "events",
// label: string,
// key: "news" | "blog" | "events"
// }
Example multiple Select field
type Tags = SelectFieldSingle<string>;
// Result: {
// value: string,
// label: string,
// key: string
// }