Back to Draggable

README

src/Draggable/Plugins/Mirror/MirrorEvent/README.md

1.2.15.4 KB
Original Source

MirrorEvent

The base mirror event for all Mirror events that Draggable emits.

InterfaceMirrorEvent
Cancelablefalse
Cancel action-
typemirror

API

mirrorEvent.source: HTMLElement
Read-only property for the source element. This is a straight copy of the originalSource element, which can be moved around in the DOM.

mirrorEvent.originalSource: HTMLElement
Read-only property for the original source element that was picked up. This element never moves in the DOM and gets hidden on drag:start.

mirrorEvent.sourceContainer: HTMLElement
Read-only property for the source elements container. This would be one of the containers that was passed into Draggable.

mirrorEvent.sensorEvent: SensorEvent
Read-only property for the original sensor event that triggered this event.

mirrorEvent.originalEvent: SensorEvent
Read-only property for the original event that triggered the sensor event.

MirrorCreateEvent

MirrorCreateEvent gets triggered by Draggable before the mirror element gets created.

SpecificationMirrorEvent
InterfaceMirrorCreateEvent
Cancelabletrue
Cancel actionCancels the creation of the mirror element
typemirror:create

MirrorCreatedEvent

MirrorCreatedEvent gets triggered by Draggable when the mirror element has been created.

SpecificationMirrorEvent
InterfaceMirrorCreatedEvent
Cancelablefalse
Cancel action-
typemirror:created

API

mirrorEvent.mirror: HTMLElement
Read-only property for the mirror element, which is also a copy of the originalSource element. The mirror follows your mouse/touch movements.

MirrorAttachedEvent

MirrorAttachedEvent gets triggered when the mirror has been appended to the DOM.

SpecificationMirrorEvent
InterfaceMirrorAttachedEvent
Cancelablefalse
Cancel action-
typemirror:attached

API

mirrorEvent.mirror: HTMLElement
Read-only property for the mirror element, which is also a copy of the originalSource element. The mirror follows your mouse/touch movements.

MirrorMoveEvent

MirrorMoveEvent gets triggered when moving the mirror around.

SpecificationMirrorEvent
InterfaceMirrorMoveEvent
Cancelabletrue
Cancel actionStops mirror movement
typemirror:move

API

mirrorEvent.mirror: HTMLElement
Read-only property for the mirror element, which is also a copy of the originalSource element. The mirror follows your mouse/touch movements.

mirrorEvent.passedThreshX: Booolean
Read-only property for whether or not the mirror's threshold has been exceeded in the x axis.

mirrorEvent.passedThreshY: Booolean
Read-only property for whether or not the mirror's threshold has been exceeded in the y axis.

MirrorMovedEvent

MirrorMovedEvent gets triggered when the mirror:move event was done.

SpecificationMirrorEvent
InterfaceMirrorMovedEvent
Cancelablefalse
Cancel action-
typemirror:moved

API

mirrorEvent.mirror: HTMLElement
Read-only property for the mirror element, which is also a copy of the originalSource element. The mirror follows your mouse/touch movements.

mirrorEvent.passedThreshX: Booolean
Read-only property for whether or not the mirror's threshold has been exceeded in the x axis.

mirrorEvent.passedThreshY: Booolean
Read-only property for whether or not the mirror's threshold has been exceeded in the y axis.

MirrorDestroyEvent

MirrorDestroyEvent gets triggered before the mirror gets removed from the DOM.

SpecificationMirrorEvent
InterfaceMirrorDestroyEvent
Cancelabletrue
Cancel actionCancels the removal of the mirror from the DOM
typemirror:destroy

API

mirrorEvent.mirror: HTMLElement
Read-only property for the mirror element, which is also a copy of the originalSource element. The mirror follows your mouse/touch movements.