TaxonomiesField
The Taxonomies field type used in Statamic.
Type Definition
Taxonomy selector.
type TaxonomiesField<
T extends string = string,
F extends Record<string, any> = Record<string, any>,
> = (TaxonomyReference<T> & F) | (TaxonomyReference<T> & F)[];
Single taxonomy handle
type MainTaxonomy = TaxonomiesField<"main">;
// Result: {
// handle: "main";
// title: string;
// url: string;
// uri: string;
// permalink: string;
// color: string;
// } | {
// handle: "main";
// title: string;
// url: string;
// uri: string;
// permalink: string;
// color: string;
// }[]
Multiple taxonomy handles
type AllTaxonomies = TaxonomiesField<"main" | "secondary">;
// Result: {
// handle: "main" | "secondary";
// title: string;
// url: string;
// uri: string;
// permalink: string;
// color: string;
// } | {
// handle: "main" | "secondary";
// title: string;
// url: string;
// uri: string;
// permalink: string;
// color: string;
// }[]
Extended taxonomy properties
type MainTaxonomy = TaxonomiesField<"main", { color: string }>;
// Result: {
// handle: "main";
// title: string;
// url: string;
// uri: string;
// permalink: string;
// color: string;
// } | {
// handle: "main";
// title: string;
// url: string;
// uri: string;
// permalink: string;
// color: string;
// }[]