Sanity Library Reference Docs
    Preparing search index...

    Interface CreateVariantDefinitionActionBeta

    Creates a new system.variant definition document.

    interface CreateVariantDefinitionAction {
        actionType: "sanity.action.variant.definition.create";
        conditions?: ClientVariantConditions;
        metadata?: Record<string, any>;
        priority?: number;
        variantId: string;
    }
    Index

    Properties

    actionType: "sanity.action.variant.definition.create"

    Conditions used to select this variant.

    metadata?: Record<string, any>
    priority?: number

    Selection priority. Higher values are preferred when multiple variants match.

    Defaults to 0.

    variantId: string

    Name of the variant definition to create, as in _.variants.{variantName}. Must be a bare name, not a full document ID.