BardField

The Bard field type used in Statamic.

Type Definition

Rich content editor that stores a string, an array of custom records, or null.

type BardField
<T
 extends BardFieldSet
<{ type
: string }> = BardFieldSet
<{ type
: string }>> =
    (T
 extends BardFieldSet
<infer U
>
        ? U
[]
        : string) | null;

T

BardFieldSet<{ type: string }>

Union of custom Bard item types.
Must have a type property.

Define custom Bard content with specific block types

type MyBardSets =
    | BardFieldSet<{ type: "text"; text: string }>
    | BardFieldSet<{ type: "button", label: string, url: string, }>
    | BardFieldSet<{ type: "image", src: string, alt: string, }>;

type MyBardField = BardField<MyBardSets>;
// Result: string | null | MyBardSets[]

Helper Types

BardFieldSet

Structure for Bard set instances.

Will always require a type property.

type BardFieldSet
<T
 extends (Record
<string, any> & { type
: string }) = (Record
<string, any> & { type
: string })> = {
    type
: string;
} & T
;

T

Record<string, any> & { type: string }

Any properties you want to add to the item.
Must always have a type property.

Union of custom Bard item types

type MyBardSets =
    | BardFieldSet<{ type: "text"; text: string }>
    | BardFieldSet<{ type: "button", label: string, url: string, }>
    | BardFieldSet<{ type: "image", src: string, alt: string, }>;

AssetsField

The Assets field type used in Statamic.

ButtonGroupField

The ButtonGroup field type used in Statamic.