import Snappable from '@shopify/draggable/src/Plugins/Snappable/Snappable.js'

public class | source

Snappable

Extends:

* → Snappable

Snappable plugin which snaps draggable elements into place

Constructor Summary

Public Constructor
public	constructor(draggable: Draggable) Snappable constructor.

Member Summary

Public Members
public	firstSource: * Keeps track of the first source element
public	mirror: * Keeps track of the mirror element

Method Summary

Public Methods
public	attach() Attaches plugins event listeners
public	detach() Detaches plugins event listeners

Private Methods
private	[onDragOut](event: DragOutEvent \| DroppableOutEvent) Drag out handler
private	[onDragOver](event: DragOverEvent \| DroppableOverEvent) Drag over handler
private	[onDragStart](event: DragStartEvent) Drag start handler
private	[onDragStop](event: DragStopEvent) Drag stop handler
private	[onMirrorCreated](mirrorEvent: MirrorCreatedEvent) Mirror created handler
private	[onMirrorDestroy](mirrorEvent: MirrorDestroyEvent) Mirror destroy handler

Public Constructors

public constructor(draggable: Draggable) source

Snappable constructor.

Params:

Name	Type	Attribute	Description
draggable	Draggable		Draggable instance

Public Members

public firstSource: * source

Keeps track of the first source element

Properties:

Name	Type	Attribute	Description
firstSource	HTMLElement \| null

public mirror: * source

Keeps track of the mirror element

Properties:

Name	Type	Attribute	Description
mirror	HTMLElement

Public Methods

public attach() source

Attaches plugins event listeners

public detach() source

Detaches plugins event listeners

Private Methods

private [onDragOut](event: DragOutEvent | DroppableOutEvent) source

Drag out handler

Params:

Name	Type	Attribute	Description
event	DragOutEvent \| DroppableOutEvent		Drag out event

private [onDragOver](event: DragOverEvent | DroppableOverEvent) source

Drag over handler

Params:

Name	Type	Attribute	Description
event	DragOverEvent \| DroppableOverEvent		Drag over event

private [onDragStart](event: DragStartEvent) source

Drag start handler

Params:

Name	Type	Attribute	Description
event	DragStartEvent		Drag start event

private [onDragStop](event: DragStopEvent) source

Drag stop handler

Params:

Name	Type	Attribute	Description
event	DragStopEvent		Drag stop event

private [onMirrorCreated](mirrorEvent: MirrorCreatedEvent) source

Mirror created handler

Params:

Name	Type	Attribute	Description
mirrorEvent	MirrorCreatedEvent

private [onMirrorDestroy](mirrorEvent: MirrorDestroyEvent) source

Mirror destroy handler

Params:

Name	Type	Attribute	Description
mirrorEvent	MirrorDestroyEvent