Skip to content

Commit

Permalink
Regenerate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gakimball committed Oct 13, 2015
1 parent 82286b3 commit 6bf1816
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 22 deletions.
12 changes: 6 additions & 6 deletions docs/animations.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,16 +140,16 @@ Creates a new animation queue.

**Parameters:**

- `delay` (Number) - Delay in seconds or milliseconds to place at the front of the animation queue. (**Default:** 0s)
- `delay` (Duration) - Delay in seconds or milliseconds to place at the front of the animation queue. (**Default:** 0s)

### mui-queue()

Adds an animation to an animation queue. Only use this mixin inside of `mui-series()`.

**Parameters:**

- `duration` (Number) - Length of the animation. (**Default:** 1s)
- `gap` (Number) - Amount of time to pause before playing the animation after this one. Use a negative value to make the next effect overlap with the current one. (**Default:** 0s)
- `duration` (Duration) - Length of the animation. (**Default:** 1s)
- `gap` (Duration) - Amount of time to pause before playing the animation after this one. Use a negative value to make the next effect overlap with the current one. (**Default:** 0s)
- `keyframes...` (Function) - One or more effect functions to build the keyframe with.

## Functions
Expand All @@ -161,7 +161,7 @@ Creates a fading animation.
**Parameters:**

- `from` (Number) - Opacity to start at. (**Default:** 0)
- `to:` (Number) - Opacity to end at. (**Default:** 1)
- `to` (Number) - Opacity to end at. (**Default:** 1)

### hinge()

Expand All @@ -181,7 +181,7 @@ Creates a string for a CSS keyframe, by converting a list of numbers to a comma-

**Parameters:**

- `input` (List) - List of numbers to use.
- `input` (Number|List) - List of numbers to use.

### -mui-keyframe-split()

Expand Down Expand Up @@ -214,7 +214,7 @@ Creates a shaking animation.

**Parameters:**

- `intensity` (Number) - Intensity of the shake, as a percentage value. (**Default:** 7%)
- `intensity` (Percentage) - Intensity of the shake, as a percentage value. (**Default:** 7%)

### slide()

Expand Down
33 changes: 17 additions & 16 deletions docs/transitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ Creates a fade transition by adjusting the opacity of the element.
- `state` (Keyword) - State to transition to. (**Default:** in)
- `from` (Number) - Opacity to start at. Must be a number between 0 and 1. (**Default:** 0)
- `to` (Number) - Opacity to end on. (**Default:** 1)
- `duration` (Keyword) - Length (speed) of the transition. (**Default:** 500ms)
- `timing` (Keyword|Function) - Easing of the transition. (**Default:** linear)
- `delay` (Number) - Delay in seconds or milliseconds before the transition starts. (**Default:** 0s)
- `duration` (Keyword) - Length (speed) of the transition. (**Default:** null)
- `timing` (Keyword|Function) - Easing of the transition. (**Default:** null)
- `delay` (Duration) - Delay in seconds or milliseconds before the transition starts. (**Default:** null)

### mui-hinge()

Expand All @@ -55,12 +55,12 @@ Creates a hinge transition by rotating the element.
- `state` (Keyword) - State to transition to. (**Default:** in)
- `from` (Keyword) - Edge of the element to rotate from. Can be `top`, `right`, `bottom`, or `left`. (**Default:** left)
- `axis` (Keyword) - Axis of the element to rotate on. Can be `edge` or `center`. (**Default:** edge)
- `perspective` (Number) - Perceived distance between the viewer and the element. A higher number will make the rotation effect more pronounced. (**Default:** 2000px)
- `perspective` (Length) - Perceived distance between the viewer and the element. A higher number will make the rotation effect more pronounced. (**Default:** 2000px)
- `turn-origin` (Keyword) - Side of the element to start the rotation from. Can be `from-back` or `from-front`. (**Default:** from-back)
- `fade` (Boolean) - Set to `true` to fade the element in or out simultaneously. (**Default:** true)
- `duration` (Keyword) - Length (speed) of the transition. (**Default:** 500ms)
- `timing` (Keyword|Function) - Easing of the transition. (**Default:** linear)
- `delay` (Number) - Delay in seconds or milliseconds before the transition starts. (**Default:** 0s)
- `duration` (Duration) - Length (speed) of the transition. (**Default:** null)
- `timing` (Keyword|Function) - Easing of the transition. (**Default:** null)
- `delay` (Duration) - Delay in seconds or milliseconds before the transition starts. (**Default:** null)

### mui-slide()

Expand All @@ -70,10 +70,11 @@ Creates a sliding transition by translating the element horizontally or vertical

- `state` (Keyword) - State to transition to. (**Default:** in)
- `direction` (Keyword) - Side of the element to slide from. Can be `top`, `right`, `bottom`, or `left`. (**Default:** left)
- `amount` (Length) - Length of the slide as a percentage value. (**Default:** 100%)
- `fade` (Boolean) - Set to `true` to fade the element in or out simultaneously. (**Default:** false)
- `duration` (Keyword) - Length (speed) of the transition. (**Default:** 500ms)
- `timing` (Keyword|Function) - Easing of the transition. (**Default:** linear)
- `delay` (Number) - Delay in seconds or milliseconds before the transition starts. (**Default:** 0s)
- `duration` (Duration) - Length (speed) of the transition. (**Default:** null)
- `timing` (Keyword|Function) - Easing of the transition. (**Default:** null)
- `delay` (Duration) - Delay in seconds or milliseconds before the transition starts. (**Default:** null)

### mui-spin()

Expand All @@ -85,9 +86,9 @@ Creates a spinning transition by rotating the element. The `turn` unit is used t
- `direction` (Boolean) - Direction to spin. Should be `cw` (clockwise) or `ccw` (counterclockwise). (**Default:** cw)
- `amount` (Number) - Amount to element the element. (**Default:** 0.75turn)
- `fade` (Boolean) - Set to `true` to fade the element in or out simultaneously. (**Default:** false)
- `duration` (Keyword) - Length (speed) of the transition. (**Default:** 500ms)
- `timing` (Keyword|Function) - Easing of the transition. (**Default:** linear)
- `delay` (Number) - Delay in seconds or milliseconds before the transition starts. (**Default:** 0s)
- `duration` (Duration) - Length (speed) of the transition. (**Default:** null)
- `timing` (Keyword|Function) - Easing of the transition. (**Default:** null)
- `delay` (Duration) - Delay in seconds or milliseconds before the transition starts. (**Default:** null)

### mui-zoom()

Expand All @@ -99,7 +100,7 @@ Creates a scaling transition. A scale of `1` means the element is the same size.
- `from` (Number) - Size to start at. (**Default:** 1.5)
- `from` (Number) - Size to end at. (**Default:** 1)
- `fade` (Boolean) - Set to `true` to fade the element in or out simultaneously. (**Default:** true)
- `duration` (Keyword) - Length (speed) of the transition. (**Default:** 500ms)
- `timing` (Keyword|Function) - Easing of the transition. (**Default:** linear)
- `delay` (Number) - Delay in seconds or milliseconds before the transition starts. (**Default:** 0s)
- `duration` (Duration) - Length (speed) of the transition. (**Default:** null)
- `timing` (Keyword|Function) - Easing of the transition. (**Default:** null)
- `delay` (Duration) - Delay in seconds or milliseconds before the transition starts. (**Default:** null)

0 comments on commit 6bf1816

Please sign in to comment.