Type Alias DndOptionsType

DndOptionsType: {
    autoExpandMS?: 1500;
    drag?: null | (e: DragEventType) => void;
    dragEnd?: null | (e: DragEventType) => void;
    dragEnter?:
        | null
        | (e: DropEventType) => DropRegionType | DropRegionTypeSet | boolean;
    dragExpand?: null | (e: DropEventType) => boolean;
    dragLeave?: null | (e: DropEventType) => void;
    dragOver?: null | (e: DropEventType) => void;
    dragStart?: null | (e: DragEventType) => boolean;
    drop?:
        | null
        | (
            e: WbNodeEventType & {
                event: DragEvent;
                region: DropRegionType;
                sourceNode: WunderbaumNode;
                sourceNodeData: WbNodeData | null;
                suggestedDropEffect: DropEffectType;
                suggestedDropMode: InsertNodeType;
            },
        ) => void;
    dropEffectDefault?: DropEffectType;
    effectAllowed?: DropEffectAllowedType;
    guessDropEffect: boolean;
    multiSource?: false;
    preventForeignNodes?: boolean;
    preventLazyParents?: boolean;
    preventNonNodes?: boolean;
    preventRecursion?: boolean;
    preventSameParent?: boolean;
    preventVoidMoves?: boolean;
    scroll?: boolean;
    scrollSensitivity?: 20;
    scrollSpeed?: 5;
    serializeClipboardData?: | boolean
    | (nodeData: WbNodeData, node: WunderbaumNode) => string;
    sourceCopyHook?: null;
}

Type declaration

  • OptionalautoExpandMS?: 1500

    Expand nodes after n milliseconds of hovering

    1500
    
  • Optionaldrag?: null | (e: DragEventType) => void

    Callback(sourceNode, data)

    null
    
  • OptionaldragEnd?: null | (e: DragEventType) => void

    Callback(sourceNode, data)

    null
    
  • OptionaldragEnter?: null | (e: DropEventType) => DropRegionType | DropRegionTypeSet | boolean

    Callback(targetNode, data), return true, to enable dnd drop

    null
    
  • OptionaldragExpand?: null | (e: DropEventType) => boolean

    Callback(targetNode, data), return false to prevent autoExpand

    null
    
  • OptionaldragLeave?: null | (e: DropEventType) => void

    Callback(targetNode, data)

    null
    
  • OptionaldragOver?: null | (e: DropEventType) => void

    Callback(targetNode, data)

    null
    
  • OptionaldragStart?: null | (e: DragEventType) => boolean

    Callback(sourceNode, data), return true, to enable dnd drag

    null
    
  • Optionaldrop?:
        | null
        | (
            e: WbNodeEventType & {
                event: DragEvent;
                region: DropRegionType;
                sourceNode: WunderbaumNode;
                sourceNodeData: WbNodeData | null;
                suggestedDropEffect: DropEffectType;
                suggestedDropMode: InsertNodeType;
            },
        ) => void

    Callback(targetNode, data)

    null
    
  • OptionaldropEffectDefault?: DropEffectType

    Default dropEffect ('copy', 'link', or 'move') when no modifier is pressed. Overidable in the dragEnter or dragOver event.

    "move"
    
  • OptionaleffectAllowed?: DropEffectAllowedType

    Restrict the possible cursor shapes and modifier operations (can also be set in the dragStart event)

    "all"
    
  • guessDropEffect: boolean

    Use opinionated heuristics to determine the dropEffect ('copy', 'link', or 'move') based on effectAllowed, dropEffectDefault, and modifier keys. This is recalculated before each dragEnter and dragOver event and can be overridden there.

    true
    
  • OptionalmultiSource?: false

    true: Drag multiple (i.e. selected) nodes. Also a callback() is allowed

    false
    
  • OptionalpreventForeignNodes?: boolean

    Prevent dropping nodes from different Wunderbaum trees

    false
    
  • OptionalpreventLazyParents?: boolean

    Prevent dropping items on unloaded lazy Wunderbaum tree nodes

    true
    
  • OptionalpreventNonNodes?: boolean

    Prevent dropping items other than Wunderbaum tree nodes

    false
    
  • OptionalpreventRecursion?: boolean

    Prevent dropping nodes on own descendants

    true
    
  • OptionalpreventSameParent?: boolean

    Prevent dropping nodes under same direct parent

    false
    
  • OptionalpreventVoidMoves?: boolean

    Prevent dropping nodes 'before self', etc. (move only)

    true
    
  • Optionalscroll?: boolean

    Enable auto-scrolling while dragging

    true
    
  • OptionalscrollSensitivity?: 20

    Active top/bottom margin in pixel

    20
    
  • OptionalscrollSpeed?: 5

    Pixel per event

    5
    
  • OptionalserializeClipboardData?: boolean | (nodeData: WbNodeData, node: WunderbaumNode) => string

    Serialize Node Data to datatransfer object

    true
    
  • OptionalsourceCopyHook?: null

    Optional callback passed to toDict on dragStart

    null