Sanity Library Reference Docs
    Preparing search index...

    Interface StructureToolOptions

    The params for the structureTool api. See structureTool

    interface StructureToolOptions {
        defaultDocumentNode?: DefaultDocumentNodeResolver;
        icon?: ComponentType;
        name?: string;
        source?: string;
        structure?: StructureResolver;
        title?: string;
    }
    Index

    Properties

    defaultDocumentNode? icon? name? source? structure? title?

    Properties

    defaultDocumentNode?: DefaultDocumentNodeResolver

    A resolver function used to return the default document node used when editing documents. See DefaultDocumentNodeResolver

    icon?: ComponentType
    name?: string
    source?: string

    A workspace can have different "sources". These sources were meant to allow using multiple datasets within the same workspace, for instance. This is not supported yet, but the API is still here.

    structure?: StructureResolver

    A structure resolver function. See StructureResolver

    title?: string

    The title that will be displayed for the tool. Defaults to Structure

    Settings

    Member Visibility

    On This Page

    Properties