mirror/webslides
1
0
Fork 0
mirror of https://github.com/webslides/WebSlides.git synced 2025-09-25 20:29:36 +02:00
Code Issues Releases Wiki Activity

Updated Core API (markdown)

Antonio Laguna
2017-04-19 18:15:50 +02:00
parent dec5384b14
commit 4d127b3d80
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Core-API.md

@@ -168,47 +168,47 @@ Hides the node and removes the class that makes it "active".
<a name="show"></a> <a name="show"></a>
### slide.show() ### `slide.show()`
Shows the node and adds the class that makes it "active". Shows the node and adds the class that makes it "active".
<a name="moveAfterLast"></a> <a name="moveAfterLast"></a>
### slide.moveAfterLast() ### `slide.moveAfterLast()`
Moves the section to the bottom of the section's list. Moves the section to the bottom of the section's list.
**Emits**: <code>dom:leave</code>, <code>dom:enter</code> **Emits**: <code>dom:leave</code>, <code>dom:enter</code>
<a name="moveBeforeFirst"></a> <a name="moveBeforeFirst"></a>
### slide.moveBeforeFirst() ### `slide.moveBeforeFirst()`
Moves the section to the top of the section's list. Moves the section to the top of the section's list.
**Emits**: <code>dom:leave</code>, <code>dom:enter</code> **Emits**: <code>dom:leave</code>, <code>dom:enter</code>
<a name="enable"></a> <a name="enable"></a>
### slide.enable() ### `slide.enable()`
Fires an enable event. Fires an enable event.
**Emits**: <code>slide:enable</code> **Emits**: <code>slide:enable</code>
<a name="disable"></a> <a name="disable"></a>
### slide.disable() ### `slide.disable()`
Fires a disable event. Fires a disable event.
**Emits**: <code>slide:disable</code> **Emits**: <code>slide:disable</code>
<a name="Slide.isCandidate"></a> <a name="Slide.isCandidate"></a>
### Slide.isCandidate(el) ⇒ <code>boolean</code> ### `Slide.isCandidate(el)` ⇒ <code>boolean</code>
Checks whether an element is a valid candidate to be a slide by ensuring it's a "section" element. Checks whether an element is a valid candidate to be a slide by ensuring it's a "section" element.
**Returns**: <code>boolean</code> - Whether is candidate or not. **Returns**: <code>boolean</code> - Whether is candidate or not.
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| el | <code>Element</code> | Element to be checked. | | `el` | <code>Element</code> | Element to be checked. |
<a name="Slide.getSectionFromEl"></a> <a name="Slide.getSectionFromEl"></a>
### Slide.getSectionFromEl(el) ⇒ <code>Object</code> ### `Slide.getSectionFromEl(el)` ⇒ <code>Object</code>
Gets the section element from an inner element. Gets the section element from an inner element.
**Returns**: <code>Object</code> - A map with the section and the **Returns**: <code>Object</code> - A map with the section and the