Skip to content

Commit a26ed80

Browse files
committed
docs: update documentation
1 parent b704337 commit a26ed80

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/animate.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Handles all the animation process
1111
- _export_
1212

1313
- [init(animationId, opts, eventType)](#init-animationid-opts-eventtype)
14+
- [end(triggerSelector, eventType)](#end-triggerselector-eventtype)
1415
- [animate(element, action, id, opts)](#animate-element-action-id-opts)
1516
- [preset(el, args)](#preset-el-args)
1617
- [isEnabled(element)](#isenabled-element) ⇒ <code>boolean</code>
@@ -60,6 +61,17 @@ Initiate the event listener with the animation
6061
| opts | <code>Object</code> | | All options passed by the user |
6162
| eventType | <code>string</code> | <code>&quot;click&quot;</code> | The event to attach the animation to |
6263

64+
## end(triggerSelector, eventType)
65+
66+
Removes the event listener of all elements represented by the triggerSelector
67+
68+
**Kind**: static function of [<code>animate</code>](#animate-js)
69+
70+
| Param | Type | Default | Description |
71+
| --------------- | ------------------- | ------------------------------ | --------------------------------------------------------------------------------------------------- |
72+
| triggerSelector | <code>string</code> | <code>null</code> | A valid CSS selector for the trigger Element. If ommited, CLASS_NAMES.trigger will be used instead. |
73+
| eventType | <code>string</code> | <code>&quot;click&quot;</code> | The event name. If ommited, 'click' is the default value. |
74+
6375
## animate(element, action, id, opts)
6476

6577
Handles all the animation process

0 commit comments

Comments
 (0)