Skip to content
This repository was archived by the owner on May 29, 2019. It is now read-only.

Commit 941f3ba

Browse files
committed
feat(collapse): clean up documentation
Closes #5194
1 parent bca2e25 commit 941f3ba

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

src/collapse/docs/readme.md

+14-18
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,22 @@
88
_(Default: `false`)_ -
99
Whether the element should be collapsed or not.
1010

11-
* `collapsing`
12-
<small class="badge">$</small>
13-
_(Default: `none`)_ -
14-
A callback function that gets fired before the element begins collapsing.
15-
If the function returns a promise, animation won't start until the promise resolves.
11+
* `collapsing()`
12+
<small class="badge">$</small> -
13+
An optional expression called before the element begins collapsing.
14+
If the expression returns a promise, animation won't start until the promise resolves.
1615
If the returned promise is rejected, collapsing will be cancelled.
1716

18-
* `collapsed`
19-
<small class="badge">$</small>
20-
_(Default: `none`)_ -
21-
A callback function that gets fired after the element finished collapsing.
17+
* `collapsed()`
18+
<small class="badge">$</small> -
19+
An optional expression called after the element finished collapsing.
2220

23-
* `expanding`
24-
<small class="badge">$</small>
25-
_(Default: `none`)_ -
26-
A callback function that gets fired before the element begins expanding.
27-
If the function returns a promise, animation won't start until the promise resolves.
21+
* `expanding()`
22+
<small class="badge">$</small> -
23+
An optional expression called before the element begins expanding.
24+
If the expression returns a promise, animation won't start until the promise resolves.
2825
If the returned promise is rejected, expanding will be cancelled.
2926

30-
* `expanded`
31-
<small class="badge">$</small>
32-
_(Default: `none`)_ -
33-
A callback function that gets fired after the element finished expanding.
27+
* `expanded()`
28+
<small class="badge">$</small> -
29+
An optional expression called after the element finished expanding.

0 commit comments

Comments
 (0)