From 941f3ba154780127728b8551352db5ab3d25cbfc Mon Sep 17 00:00:00 2001 From: Stepan Riha Date: Tue, 12 Jan 2016 23:36:37 -0600 Subject: [PATCH] feat(collapse): clean up documentation Closes #5194 --- src/collapse/docs/readme.md | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/src/collapse/docs/readme.md b/src/collapse/docs/readme.md index d896f4ecef..30a4840811 100644 --- a/src/collapse/docs/readme.md +++ b/src/collapse/docs/readme.md @@ -8,26 +8,22 @@ _(Default: `false`)_ - Whether the element should be collapsed or not. -* `collapsing` - $ - _(Default: `none`)_ - - A callback function that gets fired before the element begins collapsing. - If the function returns a promise, animation won't start until the promise resolves. +* `collapsing()` + $ - + An optional expression called before the element begins collapsing. + If the expression returns a promise, animation won't start until the promise resolves. If the returned promise is rejected, collapsing will be cancelled. -* `collapsed` - $ - _(Default: `none`)_ - - A callback function that gets fired after the element finished collapsing. +* `collapsed()` + $ - + An optional expression called after the element finished collapsing. -* `expanding` - $ - _(Default: `none`)_ - - A callback function that gets fired before the element begins expanding. - If the function returns a promise, animation won't start until the promise resolves. +* `expanding()` + $ - + An optional expression called before the element begins expanding. + If the expression returns a promise, animation won't start until the promise resolves. If the returned promise is rejected, expanding will be cancelled. -* `expanded` - $ - _(Default: `none`)_ - - A callback function that gets fired after the element finished expanding. +* `expanded()` + $ - + An optional expression called after the element finished expanding.