TermsField
The Terms field type used in Statamic.
Type Definition
Taxonomy term selector.
type TermsField<T extends Record<string, any> = Record<string, any>> = (TermsFieldSingle<T>) | (TermsFieldSingle<T>)[];
T
Record<string, any>
Extended term properties beyond the base TermReference
Extended term properties
type MainTerm = TermsField<{ color: string }>;
// Result: {
// id: string;
// url: string;
// slug: string;
// permalink: string;
// color: string;
// } | {
// id: string;
// url: string;
// slug: string;
// permalink: string;
// color: string;
// }[]
Helper Types
TermsFieldSingle
Single term relationship field.
type TermsFieldSingle<T extends Record<string, any> = Record<string, any>> = (TermReference & T);
T
string
Extended term properties beyond the base TermReference
Example Terms field
type MainTerm = TermsFieldSingle<{ color: string }>;
// Result: {
// id: string;
// url: string;
// slug: string;
// permalink: string;
// color: string;
// }