Skip to main content

Home > @jsplumbtoolkit/browser-ui-react-drop > SurfaceDropProps

SurfaceDropProps interface

Props for SurfaceDropComponent

Signature:

export interface SurfaceDropProps 

Properties

PropertyModifiersTypeDescription
allowDropOnCanvas?string(Optional) Whether or not to allow drop on whitespace in the canvas. Defaults to true.
allowDropOnEdge?string(Optional) Whether or not to allow drop on edge. Defaults to false.
allowDropOnGroup?string(Optional) Whether or not to allow drop on existing vertices. Defaults to true.
containerElementThe DOM element inside which to look for draggable elements.
dataGenerator?DataGeneratorFunction<any>(Optional) Function to use to get a dataset for an item that is being dragged.
groupIdentifier?(d: any, el: Element) => boolean(Optional) Function to use to determine whether an item that is being dragged represents a group.
selectorstringCSS 3 selector identifying what child elements of container are draggable.
surfaceSurfaceSurface to attach to
typeGenerator?(el: Element) => string(Optional) Function to use to get the type of an item that is being dragged.