mirror of
https://github.com/webslides/WebSlides.git
synced 2025-09-01 09:03:04 +02:00
Updated Core API (markdown)
16
Core-API.md
16
Core-API.md
@@ -168,47 +168,47 @@ Hides the node and removes the class that makes it "active".
|
||||
|
||||
<a name="show"></a>
|
||||
|
||||
### slide.show()
|
||||
### `slide.show()`
|
||||
Shows the node and adds the class that makes it "active".
|
||||
|
||||
<a name="moveAfterLast"></a>
|
||||
|
||||
### slide.moveAfterLast()
|
||||
### `slide.moveAfterLast()`
|
||||
Moves the section to the bottom of the section's list.
|
||||
|
||||
**Emits**: <code>dom:leave</code>, <code>dom:enter</code>
|
||||
<a name="moveBeforeFirst"></a>
|
||||
|
||||
### slide.moveBeforeFirst()
|
||||
### `slide.moveBeforeFirst()`
|
||||
Moves the section to the top of the section's list.
|
||||
|
||||
**Emits**: <code>dom:leave</code>, <code>dom:enter</code>
|
||||
<a name="enable"></a>
|
||||
|
||||
### slide.enable()
|
||||
### `slide.enable()`
|
||||
Fires an enable event.
|
||||
|
||||
**Emits**: <code>slide:enable</code>
|
||||
<a name="disable"></a>
|
||||
|
||||
### slide.disable()
|
||||
### `slide.disable()`
|
||||
Fires a disable event.
|
||||
|
||||
**Emits**: <code>slide:disable</code>
|
||||
<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.
|
||||
|
||||
**Returns**: <code>boolean</code> - Whether is candidate or not.
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| el | <code>Element</code> | Element to be checked. |
|
||||
| `el` | <code>Element</code> | Element to be checked. |
|
||||
|
||||
<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.
|
||||
|
||||
**Returns**: <code>Object</code> - A map with the section and the
|
||||
|
Reference in New Issue
Block a user