Skip to content

Commit cb98603

Browse files
igorMSoaresigorMSoares
committed
docs: fix anchors references
1 parent 823030d commit cb98603

File tree

2 files changed

+72
-68
lines changed

2 files changed

+72
-68
lines changed

‎docs/animate.md

Lines changed: 69 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,18 @@ title: animate
88

99
Handles all the animation process
1010

11-
- _Constants_
11+
- _export_
12+
13+
- [init(animationId, opts, eventType)](#init-animationid-opts-eventtype)
14+
- [animate(element, action, id, opts)](#animate-element-action-id-opts)
15+
- [preset(el, args)](#preset-el-args)
16+
- [isEnabled(element)](#isenabled-element) ⇒ <code>boolean</code>
17+
18+
- _inner_
19+
1220
- [DURATION_REGEX](#duration-regex) : <code>RegExp</code>
1321
- [CALLBACK_TRACKER](#callback-tracker) : <code>Object</code>
1422
- [TARGETS_STACK](#targets-stack) : <code>Object</code>
15-
- _Functions_
1623
- [removeCustomCssProperties(element)](#removecustomcssproperties-element)
1724
- [setCssProperty(element, property, value)](#setcssproperty-element-property-value)
1825
- [updateCssProperties(element, opts)](#updatecssproperties-element-opts)
@@ -24,16 +31,69 @@ Handles all the animation process
2431
- [removeMotionCssClass(element)](#removemotioncssclass-element)
2532
- [disable(element)](#disable-element)
2633
- [enable(element)](#enable-element)
27-
- [isEnabled(element)](#isenabled-element) ⇒ <code>boolean</code>
2834
- [hasIterationProp(element)](#hasiterationprop-element) ⇒ <code>boolean</code>
2935
- [handleVisibilityToggle(element, args)](#handlevisibilitytoggle-element-args)
3036
- [endVisibilityToggle(element, opts)](#endvisibilitytoggle-element-opts)
3137
- [initcallback(trigger, fn, type)](#initcallback-trigger-fn-type)
32-
- [animate(element, action, id, opts)](#animate-element-action-id-opts)
3338
- [getAction(element, animType)](#getaction-element-animtype) ⇒ <code>string</code> \| <code>null</code>
34-
- [preset(el, args)](#preset-el-args)
3539
- [eventHandler(el, animationId, opts)](#eventhandler-el-animationid-opts) ⇒ <code>function</code>
36-
- [init(animationId, opts, eventType)](#init-animationid-opts-eventtype)
40+
41+
## init(animationId, opts, eventType)
42+
43+
Initiate the event listener with the animation
44+
45+
**Kind**: static function of [<code>animate</code>](#animate)
46+
47+
**See**:
48+
49+
- [globals.VISIBILITY_ANIMS_ID](globals.html#visibility-anims-id)
50+
- [globals.MOTION_ANIMS_ID](globals.html#motion-anims-id)
51+
52+
| Param | Type | Default | Description |
53+
| ----------- | ------------------- | ------------------------------ | ---------------------------------------------- |
54+
| animationId | <code>number</code> | | The ID of the animation in \*\_ANIMS_ID object |
55+
| opts | <code>Object</code> | | All options passed by the user |
56+
| eventType | <code>string</code> | <code>&quot;click&quot;</code> | The event to attach the animation to |
57+
58+
## animate(element, action, id, opts)
59+
60+
Handles all the animation process
61+
62+
**Kind**: static function of [<code>animate</code>](#animate)
63+
**See**:
64+
65+
- [globals.VISIBILITY_ANIMS_ID](globals.html#visibility-anims-id)
66+
- [globals.MOTION_ANIMS_ID](globals.html#motion-anims-id)
67+
68+
| Param | Type | Description |
69+
| ------- | --------------------------------------- | ---------------------------------------------- |
70+
| element | <code>HTMLElement</code> | The DOM element to animate |
71+
| action | <code>string</code> | 'show', 'hide', or 'move' |
72+
| id | <code>number</code> | ID of an animation in the \*\_ANIMS_ID objects |
73+
| opts | <code>Object.&lt;string, any&gt;</code> | All the options passed by the user |
74+
75+
## preset(el, args)
76+
77+
Sets the CSS properties customized by the user,
78+
prior to the begining of the animation
79+
80+
**Kind**: static function of [<code>animate</code>](#animate)
81+
82+
| Param | Type | Description |
83+
| ----- | ------------------------ | ------------------------------------------------------------------ |
84+
| el | <code>HTMLElement</code> | The DOM element being animated |
85+
| args | <code>Object</code> | The animation's ID and type and all the options passed by the user |
86+
87+
## isEnabled(element) ⇒ <code>boolean</code>
88+
89+
Verifies if an element is already being animated or not
90+
91+
**Kind**: static function of [<code>animate</code>](#animate)
92+
**Returns**: True if the element is not currently being animated
93+
94+
| Param | Type | Description |
95+
| ------- | ------------------------ | ------------------------ |
96+
| element | <code>HTMLElement</code> | The DOM element to check |
3797

3898
## DURATION_REGEX : <code>RegExp</code>
3999

@@ -137,7 +197,7 @@ Sets an inline CSS property
137197

138198
**Kind**: static function of [<code>animate</code>](#animate)
139199

140-
**See**: [globals.PROPERTY_NAMES](globals.html#globals-property-names)
200+
**See**: [globals.PROPERTY_NAMES](globals.html#property-names)
141201

142202
| Param | Type | Description |
143203
| -------- | ------------------------ | ----------------------------------------------- |
@@ -247,17 +307,6 @@ Removes the attribute that indicates that an element is currently being animated
247307
| ------- | ------------------------ |
248308
| element | <code>HTMLElement</code> |
249309

250-
## isEnabled(element) ⇒ <code>boolean</code>
251-
252-
Verifies if an element is already being animated or not
253-
254-
**Kind**: static function of [<code>animate</code>](#animate)
255-
**Returns**: True if the element is not currently being animated
256-
257-
| Param | Type | Description |
258-
| ------- | ------------------------ | ------------------------ |
259-
| element | <code>HTMLElement</code> | The DOM element to check |
260-
261310
## hasIterationProp(element) ⇒ <code>boolean</code>
262311

263312
Verifies if an element has defined an iteration CSS property
@@ -307,23 +356,6 @@ executed by another element being animated by the same trigger button
307356
| fn | <code>function</code> | The callback to execute |
308357
| type | <code>string</code> | Either 'start' or 'complete' |
309358

310-
## animate(element, action, id, opts)
311-
312-
Handles all the animation process
313-
314-
**Kind**: static function of [<code>animate</code>](#animate)
315-
**See**:
316-
317-
- [globals.VISIBILITY_ANIMS_ID](globals.html#globals-visibility-anims-id)
318-
- [globals.MOTION_ANIMS_ID](globals.html#globals-motion-anims-id)
319-
320-
| Param | Type | Description |
321-
| ------- | --------------------------------------- | ---------------------------------------------- |
322-
| element | <code>HTMLElement</code> | The DOM element to animate |
323-
| action | <code>string</code> | 'show', 'hide', or 'move' |
324-
| id | <code>number</code> | ID of an animation in the \*\_ANIMS_ID objects |
325-
| opts | <code>Object.&lt;string, any&gt;</code> | All the options passed by the user |
326-
327359
## getAction(element, animType) ⇒ <code>string</code> \| <code>null</code>
328360

329361
Checks which animation CSS class is set to determine wich action to perform next
@@ -336,18 +368,6 @@ Checks which animation CSS class is set to determine wich action to perform next
336368
| element | <code>HTMLElement</code> | The DOM element being animated |
337369
| animType | <code>\*</code> | Either 'motion' or 'visibility' |
338370

339-
## preset(el, args)
340-
341-
Sets the CSS properties customized by the user,
342-
prior to the begining of the animation
343-
344-
**Kind**: static function of [<code>animate</code>](#animate)
345-
346-
| Param | Type | Description |
347-
| ----- | ------------------------ | ------------------------------------------------------------------ |
348-
| el | <code>HTMLElement</code> | The DOM element being animated |
349-
| args | <code>Object</code> | The animation's ID and type and all the options passed by the user |
350-
351371
## eventHandler(el, animationId, opts) ⇒ <code>function</code>
352372

353373
Generates the handler function to be passed to the event listener
@@ -356,27 +376,11 @@ Generates the handler function to be passed to the event listener
356376
**Returns**: A function to be passed to the addEventListener() as a handler
357377
**See**:
358378

359-
- [globals.VISIBILITY_ANIMS_ID](globals.html#globals-visibility-anims-id)
360-
- [globals.MOTION_ANIMS_ID](globals.html#globals-motion-anims-id)
379+
- [globals.VISIBILITY_ANIMS_ID](globals.html#visibility-anims-id)
380+
- [globals.MOTION_ANIMS_ID](globals.html#motion-anims-id)
361381

362382
| Param | Type | Description |
363383
| ----------- | ------------------------ | ------------------------------------------- |
364384
| el | <code>HTMLElement</code> | The DOM element being animated |
365385
| animationId | <code>number</code> | The ID of the animation in the \*\_ANIMS_ID |
366386
| opts | <code>Object</code> | The options passed by the user |
367-
368-
## init(animationId, opts, eventType)
369-
370-
Initiate the event listener with the animation
371-
372-
**Kind**: static function of [<code>animate</code>](#animate)
373-
**See**:
374-
375-
- [module:globals.VISIBILITY_ANIMS_ID](module:globals.VISIBILITY_ANIMS_ID)
376-
- [module:globals.MOTION_ANIMS_ID](module:globals.MOTION_ANIMS_ID)
377-
378-
| Param | Type | Default | Description |
379-
| ----------- | ------------------- | ------------------------------ | ---------------------------------------------- |
380-
| animationId | <code>number</code> | | The ID of the animation in \*\_ANIMS_ID object |
381-
| opts | <code>Object</code> | | All options passed by the user |
382-
| eventType | <code>string</code> | <code>&quot;click&quot;</code> | The event to attach the animation to |

‎docs/js-css-animations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ All other keys of animationFunctions are Motion animations functions
4949

5050
**See**:
5151

52-
- [globals.VISIBILITY_ANIMS_ID](globals.html#globals-visibility-anims-id)
53-
- [globals.MOTION_ANIMS_ID](globals.html#globals-motion-anims-id)
52+
- [globals.VISIBILITY_ANIMS_ID](globals.html#visibility-anims-id)
53+
- [globals.MOTION_ANIMS_ID](globals.html#motion-anims-id)
5454

5555
## eventBoundAnimations : <code>Object.&lt;string, function()&gt;</code>
5656

@@ -117,7 +117,7 @@ it will toggle between the 'hide' state and the 'show' state,
117117
although this is only applicable to visibility animations.
118118

119119
**Kind**: inner method of [<code>js-css-animations</code>](#js-css-animations)
120-
**See**: [globals.VISIBILITY_ANIMS_ID](globals.html#globals-visibility-anims-id)
120+
**See**: [globals.VISIBILITY_ANIMS_ID](globals.html#visibility-anims-id)
121121

122122
| Param | Type | Description |
123123
| -------- | ----------------------------------------------- | -------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)