Sanity Library Reference Docs
    Preparing search index...

    Interface OverlayComponentProps<P>

    interface OverlayComponentProps<
        P extends OverlayElementParent = OverlayElementParent,
    > {
        document: DocumentSchema;
        element: ElementNode;
        field: OverlayElementField;
        focused: boolean;
        node: SanityNode;
        parent: P;
        PointerEvents: FunctionComponent<
            PropsWithChildren<HTMLAttributes<HTMLDivElement>>,
        >;
        targetElement: ElementNode;
        type: string;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    document element field focused node parent PointerEvents targetElement type

    Properties

    document: DocumentSchema

    The resolved field's document schema type

    element: ElementNode

    The element node that the overlay is attached to

    field: OverlayElementField

    The resolved field schema type

    focused: boolean

    Whether the overlay is focused or not

    node: SanityNode

    The Sanity node data that triggered the overlay

    parent: P

    The resolved field's parent schema type

    PointerEvents: FunctionComponent<
        PropsWithChildren<HTMLAttributes<HTMLDivElement>>,
    >
    targetElement: ElementNode

    The element node that the Sanity node data is detected on

    type: string

    A convience property, equal to field.value.type

    Settings

    Member Visibility

    On This Page

    Properties