archive-gh-me/draggable
1
0
Fork 0
mirror of https://github.com/Shopify/draggable.git synced 2026-02-01 16:46:56 +00:00
Code Issues Projects Releases Wiki Activity

Fix MirrorEvent documentation attribute types

Browse Source 
Three attributes listed in the documentation as String types are actually HTML Elements. This updates the documentation to reflect the correct event attribute types.
This commit is contained in:
Jack Jennings 2017-11-13 00:24:52 -08:00 committed by GitHub
parent 400ae09859
commit c7ba7fda04
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/Draggable/MirrorEvent/README.md
View File

@ -15,15 +15,15 @@ The base mirror event for all Mirror events that `Draggable` emits.
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: String`**
**`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.mirror: String`**
**`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.sourceContainer: String`**
**`mirrorEvent.sourceContainer: HTMLElement`**
Read-only property for the source elements container. This would be one of the containers that
was passed into Draggable.