ReplicatorField
The Replicator field type used in Statamic.
Type Definition
Flexible content builder with repeatable sets.
type ReplicatorField<T extends Record<string, any> = Record<string, any>> = ReplicatorFieldSet<T>[];
Union of set types (must include
Must always have a
type and id properties)Must always have a
type and id property.Define custom Replicator content with specific set types
type TextBlock = ReplicatorFieldSet<{ type: "text"; content: Text }>;
type ImageBlock = ReplicatorFieldSet<{ type: "image"; image: Asset; caption: Text }>;
type ButtonBlock = ReplicatorFieldSet<{ type: "button"; label: Text; url: Text }>;
type ContentBlocks = ReplicatorField<TextBlock | ImageBlock | ButtonBlock>;
// Result: (TextBlock | ImageBlock | ButtonBlock)[]
Helper Types
ReplicatorFieldSet
Structure for Replicator set instances.
Will always require a type and id property.
type ReplicatorFieldSet<T extends Record<string, any> = Record<string, any>> = { type: string; id: string } & T;
T
Record<string, any> & { type: string, id: string }
Any properties you want to add to the item.
Must always have a
Must always have a
type and id property.Union of custom Replicator set types
type MyReplicatorSets =
| ReplicatorFieldSet<{ type: "text"; content: Text }>
| ReplicatorFieldSet<{ type: "image"; image: Asset; caption: Text }>
| ReplicatorFieldSet<{ type: "button"; label: Text; url: Text }>;