Sanity Library Reference Docs
    Preparing search index...

    Interface ArrayOptions<V>

    BaseOptions applies to all type options.

    It can be extended by interface declaration merging in plugins to provide generic options to all types and fields.

    interface ArrayOptions<V = unknown> {
        direction?: "horizontal" | "vertical";
        disableActions?: ArrayActionName[];
        insertMenu?: InsertMenuOptions;
        treeEditing?: boolean;
    }

    Type Parameters

    • V = unknown

    Hierarchy (View Summary)

    Index

    Properties

    direction? disableActions? insertMenu? treeEditing?

    Properties

    direction?: "horizontal" | "vertical"

    This option does not have any effect anymore

    disableActions?: ArrayActionName[]

    A list of array actions to disable Possible options are defined by ArrayActionName

    insertMenu?: InsertMenuOptions

    This API may change

    treeEditing?: boolean

    A boolean flag to enable or disable tree editing for the array. If there are any nested arrays, they will inherit this value.

    tree editing beta feature has been disabled

    Settings

    Member Visibility

    On This Page

    Properties