Sanity Library Reference Docs
    Preparing search index...

    Interface InitialValueTemplateItem

    Representation of an initial value template item Used by the structure.StructureBuilder class to determine which initial value templates should be available for a structure node, such as a list pane.

    interface InitialValueTemplateItem {
        icon?: Element | ElementType<any, (keyof IntrinsicElements)>;
        id: string;
        parameters?: { [key: string]: any };
        schemaType: string;
        templateId: string;
        title?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    icon? id parameters? schemaType templateId title?

    Properties

    icon?: Element | ElementType<any, (keyof IntrinsicElements)>

    React icon for the item, if any. Defaults to the icon for the associated template.

    id: string

    ID for this template item

    parameters?: { [key: string]: any }

    Parameters for the template - an object of any JSON-serializable values

    schemaType: string

    Initial value template schema type

    templateId: string

    ID for the template. Must be unique within the set of templates.

    title?: string

    Title for the item. Defaults to the title of the associated template.

    Settings

    Member Visibility

    On This Page

    Properties