Skip to content

Commit

Permalink
0.13.5
Browse files Browse the repository at this point in the history
  • Loading branch information
inokawa committed Jan 8, 2023
1 parent 3724fbf commit ad138e2
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 46 deletions.
30 changes: 15 additions & 15 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ A component to manage enter/update/exit of its children by key, that works simil

#### Defined in

[src/react/components/TransitionGroup.tsx:74](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/components/TransitionGroup.tsx#L74)
[src/react/components/TransitionGroup.tsx:74](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/components/TransitionGroup.tsx#L74)

___

Expand Down Expand Up @@ -80,7 +80,7 @@ A basic hook to use Web Animations API. See [AnimationHandle](interfaces/Animati

#### Defined in

[src/react/hooks/useAnimation.ts:91](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L91)
[src/react/hooks/useAnimation.ts:91](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L91)

___

Expand Down Expand Up @@ -109,7 +109,7 @@ Same as [useAnimation](API.md#useanimation), but it drives function not React el

#### Defined in

[src/react/hooks/useAnimationFunction.ts:66](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimationFunction.ts#L66)
[src/react/hooks/useAnimationFunction.ts:66](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimationFunction.ts#L66)

___

Expand All @@ -135,19 +135,19 @@ This hook must be used under [TransitionGroup](API.md#transitiongroup) component

#### Defined in

[src/react/hooks/useTransitionAnimation.ts:33](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useTransitionAnimation.ts#L33)
[src/react/hooks/useTransitionAnimation.ts:33](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useTransitionAnimation.ts#L33)

## Type Aliases

### TypedKeyframe

Ƭ **TypedKeyframe**: `Pick`<`Keyframe`, ``"composite"`` \| ``"easing"`` \| ``"offset"``\> & [`AnimatableCSSProperties`](API.md#animatablecssproperties)
Ƭ **TypedKeyframe**: `Pick`<`Keyframe`, ``"composite"`` \| ``"easing"`` \| ``"offset"``\> & { `[key: `--${string}`]`: `string` \| `number`; } & [`AnimatableCSSProperties`](API.md#animatablecssproperties)

Strictly typed [Keyframe](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats)

#### Defined in

[src/core/waapi.ts:17](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/core/waapi.ts#L17)
[src/core/waapi.ts:17](https://github.com/inokawa/react-animatable/blob/3724fbf/src/core/waapi.ts#L17)

___

Expand All @@ -157,7 +157,7 @@ ___

#### Defined in

[src/core/waapi.ts:20](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/core/waapi.ts#L20)
[src/core/waapi.ts:22](https://github.com/inokawa/react-animatable/blob/3724fbf/src/core/waapi.ts#L22)

___

Expand All @@ -177,7 +177,7 @@ A function to define keyframe dynamically

#### Defined in

[src/core/waapi.ts:29](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/core/waapi.ts#L29)
[src/core/waapi.ts:31](https://github.com/inokawa/react-animatable/blob/3724fbf/src/core/waapi.ts#L31)

___

Expand All @@ -187,7 +187,7 @@ ___

#### Defined in

[src/core/waapi.ts:4](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/core/waapi.ts#L4)
[src/core/waapi.ts:4](https://github.com/inokawa/react-animatable/blob/3724fbf/src/core/waapi.ts#L4)

___

Expand All @@ -203,7 +203,7 @@ ___

#### Defined in

[src/core/waapi.ts:83](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/core/waapi.ts#L83)
[src/core/waapi.ts:85](https://github.com/inokawa/react-animatable/blob/3724fbf/src/core/waapi.ts#L85)

___

Expand All @@ -213,7 +213,7 @@ ___

#### Defined in

[src/core/waapi.ts:154](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/core/waapi.ts#L154)
[src/core/waapi.ts:156](https://github.com/inokawa/react-animatable/blob/3724fbf/src/core/waapi.ts#L156)

___

Expand All @@ -229,7 +229,7 @@ ___

#### Defined in

[src/react/hooks/useAnimation.ts:23](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L23)
[src/react/hooks/useAnimation.ts:23](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L23)

___

Expand All @@ -241,7 +241,7 @@ Non nullable [ComputedEffectTiming](https://developer.mozilla.org/en-US/docs/Web

#### Defined in

[src/react/hooks/useAnimationFunction.ts:29](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimationFunction.ts#L29)
[src/react/hooks/useAnimationFunction.ts:29](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimationFunction.ts#L29)

___

Expand All @@ -262,7 +262,7 @@ In this callback you can update any state or ref in JS.

#### Defined in

[src/react/hooks/useAnimationFunction.ts:39](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimationFunction.ts#L39)
[src/react/hooks/useAnimationFunction.ts:39](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimationFunction.ts#L39)

___

Expand All @@ -272,4 +272,4 @@ ___

#### Defined in

[src/react/hooks/useTransitionAnimation.ts:23](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useTransitionAnimation.ts#L23)
[src/react/hooks/useTransitionAnimation.ts:23](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useTransitionAnimation.ts#L23)
16 changes: 8 additions & 8 deletions docs/interfaces/AnimationFunctionHandle.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ A wrapper of Web Animations API's [play](https://developer.mozilla.org/en-US/doc

#### Defined in

[src/react/hooks/useAnimation.ts:31](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L31)
[src/react/hooks/useAnimation.ts:31](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L31)

___

Expand All @@ -79,7 +79,7 @@ A wrapper of Web Animations API's [reverse](https://developer.mozilla.org/en-US/

#### Defined in

[src/react/hooks/useAnimation.ts:35](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L35)
[src/react/hooks/useAnimation.ts:35](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L35)

___

Expand All @@ -103,7 +103,7 @@ A wrapper of Web Animations API's [cancel](https://developer.mozilla.org/en-US/d

#### Defined in

[src/react/hooks/useAnimation.ts:39](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L39)
[src/react/hooks/useAnimation.ts:39](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L39)

___

Expand All @@ -127,7 +127,7 @@ A wrapper of Web Animations API's [finish](https://developer.mozilla.org/en-US/d

#### Defined in

[src/react/hooks/useAnimation.ts:43](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L43)
[src/react/hooks/useAnimation.ts:43](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L43)

___

Expand All @@ -151,7 +151,7 @@ A wrapper of Web Animations API's [pause](https://developer.mozilla.org/en-US/do

#### Defined in

[src/react/hooks/useAnimation.ts:47](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L47)
[src/react/hooks/useAnimation.ts:47](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L47)

___

Expand Down Expand Up @@ -183,7 +183,7 @@ If you pass function, you can get [endTime](https://developer.mozilla.org/en-US/

#### Defined in

[src/react/hooks/useAnimation.ts:53](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L53)
[src/react/hooks/useAnimation.ts:53](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L53)

___

Expand Down Expand Up @@ -215,7 +215,7 @@ If you pass function, you can get current [playbackRate](https://developer.mozil

#### Defined in

[src/react/hooks/useAnimation.ts:61](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L61)
[src/react/hooks/useAnimation.ts:61](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L61)

___

Expand Down Expand Up @@ -248,4 +248,4 @@ A getter of Promise that will be resolved in specified timing.

#### Defined in

[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L70)
[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L70)
18 changes: 9 additions & 9 deletions docs/interfaces/AnimationHandle.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You have to pass this callback to ref of element you want to control.

#### Defined in

[src/react/hooks/useAnimation.ts:84](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L84)
[src/react/hooks/useAnimation.ts:84](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L84)

## Table of contents

Expand Down Expand Up @@ -75,7 +75,7 @@ A wrapper of Web Animations API's [play](https://developer.mozilla.org/en-US/doc

#### Defined in

[src/react/hooks/useAnimation.ts:31](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L31)
[src/react/hooks/useAnimation.ts:31](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L31)

___

Expand All @@ -99,7 +99,7 @@ A wrapper of Web Animations API's [reverse](https://developer.mozilla.org/en-US/

#### Defined in

[src/react/hooks/useAnimation.ts:35](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L35)
[src/react/hooks/useAnimation.ts:35](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L35)

___

Expand All @@ -123,7 +123,7 @@ A wrapper of Web Animations API's [cancel](https://developer.mozilla.org/en-US/d

#### Defined in

[src/react/hooks/useAnimation.ts:39](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L39)
[src/react/hooks/useAnimation.ts:39](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L39)

___

Expand All @@ -147,7 +147,7 @@ A wrapper of Web Animations API's [finish](https://developer.mozilla.org/en-US/d

#### Defined in

[src/react/hooks/useAnimation.ts:43](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L43)
[src/react/hooks/useAnimation.ts:43](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L43)

___

Expand All @@ -171,7 +171,7 @@ A wrapper of Web Animations API's [pause](https://developer.mozilla.org/en-US/do

#### Defined in

[src/react/hooks/useAnimation.ts:47](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L47)
[src/react/hooks/useAnimation.ts:47](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L47)

___

Expand Down Expand Up @@ -203,7 +203,7 @@ If you pass function, you can get [endTime](https://developer.mozilla.org/en-US/

#### Defined in

[src/react/hooks/useAnimation.ts:53](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L53)
[src/react/hooks/useAnimation.ts:53](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L53)

___

Expand Down Expand Up @@ -235,7 +235,7 @@ If you pass function, you can get current [playbackRate](https://developer.mozil

#### Defined in

[src/react/hooks/useAnimation.ts:61](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L61)
[src/react/hooks/useAnimation.ts:61](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L61)

___

Expand Down Expand Up @@ -268,4 +268,4 @@ A getter of Promise that will be resolved in specified timing.

#### Defined in

[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L70)
[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L70)
2 changes: 1 addition & 1 deletion docs/interfaces/AnimationOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Extended [options of KeyframeEffect](https://developer.mozilla.org/en-US/docs/We

#### Defined in

[src/core/waapi.ts:38](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/core/waapi.ts#L38)
[src/core/waapi.ts:40](https://github.com/inokawa/react-animatable/blob/3724fbf/src/core/waapi.ts#L40)

___

Expand Down
16 changes: 8 additions & 8 deletions docs/interfaces/BaseAnimationHandle.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ A wrapper of Web Animations API's [play](https://developer.mozilla.org/en-US/doc

#### Defined in

[src/react/hooks/useAnimation.ts:31](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L31)
[src/react/hooks/useAnimation.ts:31](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L31)

___

Expand All @@ -71,7 +71,7 @@ A wrapper of Web Animations API's [reverse](https://developer.mozilla.org/en-US/

#### Defined in

[src/react/hooks/useAnimation.ts:35](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L35)
[src/react/hooks/useAnimation.ts:35](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L35)

___

Expand All @@ -91,7 +91,7 @@ A wrapper of Web Animations API's [cancel](https://developer.mozilla.org/en-US/d

#### Defined in

[src/react/hooks/useAnimation.ts:39](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L39)
[src/react/hooks/useAnimation.ts:39](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L39)

___

Expand All @@ -111,7 +111,7 @@ A wrapper of Web Animations API's [finish](https://developer.mozilla.org/en-US/d

#### Defined in

[src/react/hooks/useAnimation.ts:43](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L43)
[src/react/hooks/useAnimation.ts:43](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L43)

___

Expand All @@ -131,7 +131,7 @@ A wrapper of Web Animations API's [pause](https://developer.mozilla.org/en-US/do

#### Defined in

[src/react/hooks/useAnimation.ts:47](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L47)
[src/react/hooks/useAnimation.ts:47](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L47)

___

Expand Down Expand Up @@ -159,7 +159,7 @@ If you pass function, you can get [endTime](https://developer.mozilla.org/en-US/

#### Defined in

[src/react/hooks/useAnimation.ts:53](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L53)
[src/react/hooks/useAnimation.ts:53](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L53)

___

Expand Down Expand Up @@ -187,7 +187,7 @@ If you pass function, you can get current [playbackRate](https://developer.mozil

#### Defined in

[src/react/hooks/useAnimation.ts:61](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L61)
[src/react/hooks/useAnimation.ts:61](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L61)

___

Expand Down Expand Up @@ -216,4 +216,4 @@ A getter of Promise that will be resolved in specified timing.

#### Defined in

[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L70)
[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L70)
2 changes: 1 addition & 1 deletion docs/interfaces/TransitionAnimationHandle.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@

#### Defined in

[src/react/hooks/useTransitionAnimation.ts:20](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useTransitionAnimation.ts#L20)
[src/react/hooks/useTransitionAnimation.ts:20](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useTransitionAnimation.ts#L20)
2 changes: 1 addition & 1 deletion docs/interfaces/TransitionGroupProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@

#### Defined in

[src/react/components/TransitionGroup.tsx:68](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/components/TransitionGroup.tsx#L68)
[src/react/components/TransitionGroup.tsx:68](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/components/TransitionGroup.tsx#L68)
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-animatable",
"version": "0.13.4",
"version": "0.13.5",
"description": "A powerful composable animation library for React, built on Web Animations API and React hook.",
"main": "lib/index.js",
"module": "lib/index.mjs",
Expand Down

0 comments on commit ad138e2

Please sign in to comment.