Skip to content

DropResult

Unofficial

Result returned from a drop handler indicating the outcome of a drop operation.

Import:

import type { DropResult } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface DropResult

Properties

Property Type Description
action null | string Action identifier describing what happened on drop (e.g. "link", "move").
dropEffect 'copy' | 'link' | 'move' | 'none' The drop effect to apply to the drag event.
hoverClass? string CSS class to apply to the hover target element.
hoverEl? HTMLElement | null Element to highlight as the current drop target.

Links to this page: