Sanity Library Reference Docs
    Preparing search index...

    Interface CanvasAppOptions

    Options for configuring how Canvas app interfaces with the type or field.

    interface CanvasAppOptions {
        exclude?: boolean;
        purpose?: string;
    }
    Index

    Properties

    Properties

    exclude?: boolean

    Set to true to exclude a type or field from appearing in Canvas

    purpose?: string

    A short description of what the type or field is used for. Purpose can be used to improve how and when content mapping uses the field.