Skip to content

Commit 72e5961

Browse files
igorMSoaresigorMSoares
committed
docs: fix transitions.md anchors
1 parent 8f9972b commit 72e5961

File tree

1 file changed

+83
-88
lines changed

1 file changed

+83
-88
lines changed

‎docs/transitions.md

Lines changed: 83 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -4,137 +4,132 @@ title: transitions
44

55
# transitions
66

7-
<a name="module_transitions"></a>
7+
## transitions.js
88

9-
## transitions
109
Handle user defined transitions to not conflict with js-css-animations transitions
1110

11+
- [transitions](#transitions)
12+
- _static_
13+
- [.getCurrentTransition](#getcurrenttransition) ⇒ <code>string</code> \| <code>null</code>
14+
- [.getClassTransition](#getclasstransition) ⇒ <code>string</code>
15+
- [.appendTransition](#appendtransition)
16+
- [.setDimensionsTransitions](#setdimensionstransitions)
17+
- [.removeInlineTransition](#removeinlinetransition)
18+
- [.removeDimensionsTransitions](#removedimensionstransitions)
19+
- _inner_
20+
- [~getAllTransitions(cssProperties)](#getalltransitions-cssproperties) ⇒ <code>string</code>
21+
- [~transitions](#getalltransitions-transitions) : <code>Object</code>
22+
- [~properties](#getalltransitions-properties) : <code>Array.&lt;string&gt;</code>
23+
- [~getTransitionClassName(wTransit, hTransit)](#gettransitionclassname-wtransit-htransit) ⇒ <code>string</code> \| <code>undefined</code>
24+
25+
### getCurrentTransition ⇒ <code>string</code> \| <code>null</code>
1226

13-
* [transitions](#module_transitions)
14-
* _static_
15-
* [.getCurrentTransition](#module_transitions.getCurrentTransition) ⇒ <code>string</code> \| <code>null</code>
16-
* [.getClassTransition](#module_transitions.getClassTransition) ⇒ <code>string</code>
17-
* [.appendTransition](#module_transitions.appendTransition)
18-
* [.setDimensionsTransitions](#module_transitions.setDimensionsTransitions)
19-
* [.removeInlineTransition](#module_transitions.removeInlineTransition)
20-
* [.removeDimensionsTransitions](#module_transitions.removeDimensionsTransitions)
21-
* _inner_
22-
* [~getAllTransitions(cssProperties)](#module_transitions..getAllTransitions) ⇒ <code>string</code>
23-
* [~transitions](#module_transitions..getAllTransitions..transitions) : <code>Object</code>
24-
* [~properties](#module_transitions..getAllTransitions..properties) : <code>Array.&lt;string&gt;</code>
25-
* [~getTransitionClassName(wTransit, hTransit)](#module_transitions..getTransitionClassName) ⇒ <code>string</code> \| <code>undefined</code>
26-
27-
<a name="module_transitions.getCurrentTransition"></a>
28-
29-
### transitions.getCurrentTransition ⇒ <code>string</code> \| <code>null</code>
3027
Gets user defined transitions of an element, if any
3128

32-
**Kind**: static constant of [<code>transitions</code>](#module_transitions)
33-
**Returns**: <code>string</code> \| <code>null</code> - All user defined transitions combined into single shorthandproperty or null if there's no transition defined by the user
29+
**Kind**: static constant of [<code>transitions</code>](#transitions)
30+
**Returns**: <code>string</code> \| <code>null</code> - All user defined transitions combined into single shorthand
31+
property or null if there's no transition defined by the user
3432

35-
| Param | Type |
36-
| --- | --- |
37-
| element | <code>HTMLElement</code> |
33+
| Param | Type |
34+
| ------- | ------------------------ |
35+
| element | <code>HTMLElement</code> |
3836

39-
<a name="module_transitions.getClassTransition"></a>
37+
### getClassTransition ⇒ <code>string</code>
4038

41-
### transitions.getClassTransition ⇒ <code>string</code>
4239
Gets the transition in a given CSS class
4340

44-
**Kind**: static constant of [<code>transitions</code>](#module_transitions)
45-
**Returns**: <code>string</code> - A shorthand value for CSS transition property
41+
**Kind**: static constant of [<code>transitions</code>](#transitions)
42+
**Returns**: <code>string</code> - A shorthand value for CSS transition property
4643

47-
| Param | Type | Description |
48-
| --- | --- | --- |
44+
| Param | Type | Description |
45+
| --------- | ------------------- | --------------------------------- |
4946
| className | <code>string</code> | Name of the animation's CSS class |
5047

51-
<a name="module_transitions.appendTransition"></a>
48+
### appendTransition
5249

53-
### transitions.appendTransition
54-
If an element already has any transition defined, other than that in className,the current transition(s) will be appended to the className transition so thatno transition will be overwritten
50+
If an element already has any transition defined, other than that in className,
51+
the current transition(s) will be appended to the className transition so that
52+
no transition will be overwritten
5553

56-
**Kind**: static constant of [<code>transitions</code>](#module_transitions)
54+
**Kind**: static constant of [<code>transitions</code>](#transitions)
5755

58-
| Param | Type | Description |
59-
| --- | --- | --- |
60-
| element | <code>HTMLElement</code> | The DOM element to append the transition |
61-
| className | <code>string</code> | CSS class with a transition to append to other transitions |
62-
| currTransition | <code>string</code> | Transition(s) already defined to element, before it receives the new class (className) |
56+
| Param | Type | Description |
57+
| -------------- | ------------------------ | -------------------------------------------------------------------------------------- |
58+
| element | <code>HTMLElement</code> | The DOM element to append the transition |
59+
| className | <code>string</code> | CSS class with a transition to append to other transitions |
60+
| currTransition | <code>string</code> | Transition(s) already defined to element, before it receives the new class (className) |
6361

64-
<a name="module_transitions.setDimensionsTransitions"></a>
62+
### setDimensionsTransitions
6563

66-
### transitions.setDimensionsTransitions
67-
Appends the appropriate CSS class to handle dimension transitions.If wTransit and hTransit are both set to false, no class will be appended.
64+
Appends the appropriate CSS class to handle dimension transitions.
65+
If wTransit and hTransit are both set to false, no class will be appended.
6866

69-
**Kind**: static constant of [<code>transitions</code>](#module_transitions)
67+
**Kind**: static constant of [<code>transitions</code>](#transitions)
7068

71-
| Param | Type | Description |
72-
| --- | --- | --- |
73-
| element | <code>HTMLElement</code> | The DOM element to set the transition |
74-
| wTransit | <code>boolean</code> | Indicates if should have width transition |
75-
| hTransit | <code>boolean</code> | Indicates if should have height transition |
69+
| Param | Type | Description |
70+
| -------- | ------------------------ | ------------------------------------------ |
71+
| element | <code>HTMLElement</code> | The DOM element to set the transition |
72+
| wTransit | <code>boolean</code> | Indicates if should have width transition |
73+
| hTransit | <code>boolean</code> | Indicates if should have height transition |
7674

77-
<a name="module_transitions.removeInlineTransition"></a>
75+
### removeInlineTransition
7876

79-
### transitions.removeInlineTransition
80-
If element has an inline css transition appended by appendTransition()the inline transition property will be removed to reset the element backto its previous state
77+
If element has an inline css transition appended by appendTransition()
78+
the inline transition property will be removed to reset the element back
79+
to its previous state
8180

82-
**Kind**: static constant of [<code>transitions</code>](#module_transitions)
83-
**See**: module:transitions.appendTransition
81+
**Kind**: static constant of [<code>transitions</code>](#transitions)
82+
**See**: module:transitions.appendTransition
8483

85-
| Param | Type | Description |
86-
| --- | --- | --- |
84+
| Param | Type | Description |
85+
| ------- | ------------------------ | ---------------------------------------- |
8786
| element | <code>HTMLElement</code> | The DOM element to remove the transition |
8887

89-
<a name="module_transitions.removeDimensionsTransitions"></a>
88+
### removeDimensionsTransitions
9089

91-
### transitions.removeDimensionsTransitions
9290
Removes the CSS class added by setDimensionsTransitions(), if any
9391

94-
**Kind**: static constant of [<code>transitions</code>](#module_transitions)
95-
**See**: module:transitions.setDimensionsTransitions
92+
**Kind**: static constant of [<code>transitions</code>](#transitions)
93+
**See**: module:transitions.setDimensionsTransitions
9694

97-
| Param | Type | Description |
98-
| --- | --- | --- |
99-
| element | <code>HTMLElement</code> | The DOM element to remove the transitions |
100-
| wTransit | <code>boolean</code> | Indicates wheter there was a width transition |
101-
| hTransit | <code>boolean</code> | Indicates wheter there was a height transition |
95+
| Param | Type | Description |
96+
| -------- | ------------------------ | ---------------------------------------------- |
97+
| element | <code>HTMLElement</code> | The DOM element to remove the transitions |
98+
| wTransit | <code>boolean</code> | Indicates wheter there was a width transition |
99+
| hTransit | <code>boolean</code> | Indicates wheter there was a height transition |
102100

103-
<a name="module_transitions..getAllTransitions"></a>
101+
### getAllTransitions(cssProperties) ⇒ <code>string</code>
104102

105-
### transitions~getAllTransitions(cssProperties) ⇒ <code>string</code>
106-
Parses all CSS properties and combine all transitions into one valid shorthand valuefor 'transition' CSS property
103+
Parses all CSS properties and combine all transitions into one valid shorthand value
104+
for 'transition' CSS property
107105

108-
**Kind**: inner method of [<code>transitions</code>](#module_transitions)
109-
**Returns**: <code>string</code> - All transitions combined into a single shorthand property
106+
**Kind**: inner method of [<code>transitions</code>](#transitions)
107+
**Returns**: <code>string</code> - All transitions combined into a single shorthand property
110108

111-
| Param | Type | Description |
112-
| --- | --- | --- |
109+
| Param | Type | Description |
110+
| ------------- | -------------------------------- | ------------------------- |
113111
| cssProperties | <code>CSSStyleDeclaration</code> | A collection of CSS rules |
114112

115-
116-
* [~getAllTransitions(cssProperties)](#module_transitions..getAllTransitions) ⇒ <code>string</code>
117-
* [~transitions](#module_transitions..getAllTransitions..transitions) : <code>Object</code>
118-
* [~properties](#module_transitions..getAllTransitions..properties) : <code>Array.&lt;string&gt;</code>
119-
120-
<a name="module_transitions..getAllTransitions..transitions"></a>
113+
- [~getAllTransitions(cssProperties)](#getalltransitions) ⇒ <code>string</code>
114+
- [~transitions](#getalltransitions-transitions) : <code>Object</code>
115+
- [~properties](#getalltransitions-properties) : <code>Array.&lt;string&gt;</code>
121116

122117
#### getAllTransitions~transitions : <code>Object</code>
123-
**Kind**: inner constant of [<code>getAllTransitions</code>](#module_transitions..getAllTransitions)
124-
<a name="module_transitions..getAllTransitions..properties"></a>
118+
119+
**Kind**: inner constant of [<code>getAllTransitions</code>](#getalltransitions)
125120

126121
#### getAllTransitions~properties : <code>Array.&lt;string&gt;</code>
127-
**Kind**: inner constant of [<code>getAllTransitions</code>](#module_transitions..getAllTransitions)
128-
<a name="module_transitions..getTransitionClassName"></a>
129122

130-
### transitions~getTransitionClassName(wTransit, hTransit) ⇒ <code>string</code> \| <code>undefined</code>
123+
**Kind**: inner constant of [<code>getAllTransitions</code>](#getalltransitions)
124+
125+
### getTransitionClassName(wTransit, hTransit) ⇒ <code>string</code> \| <code>undefined</code>
126+
131127
Verifies wether there should be widht or height transition, or both, or none
132128

133-
**Kind**: inner method of [<code>transitions</code>](#module_transitions)
134-
**Returns**: <code>string</code> \| <code>undefined</code> - The name of the class with the respective transition, or undefined if there should be no transitions
129+
**Kind**: inner method of [<code>transitions</code>](#transitions)
130+
**Returns**: <code>string</code> \| <code>undefined</code> - The name of the class with the respective transition, or undefined if there should be no transitions
135131

136-
| Param | Type | Description |
137-
| --- | --- | --- |
138-
| wTransit | <code>boolean</code> | Indicates if it should have width transition |
132+
| Param | Type | Description |
133+
| -------- | -------------------- | --------------------------------------------- |
134+
| wTransit | <code>boolean</code> | Indicates if it should have width transition |
139135
| hTransit | <code>boolean</code> | Indicates if it should have height transition |
140-

0 commit comments

Comments
 (0)