Skip to content

Commit

Permalink
0.14.0
Browse files Browse the repository at this point in the history
  • Loading branch information
inokawa committed Aug 8, 2023
1 parent 90fdc5a commit 4955e87
Show file tree
Hide file tree
Showing 12 changed files with 51 additions and 49 deletions.
28 changes: 14 additions & 14 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,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/dd9ec77/src/react/components/TransitionGroup.tsx#L74)
[src/react/components/TransitionGroup.tsx:74](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/components/TransitionGroup.tsx#L74)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:162](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L162)
[src/react/hooks/useAnimation.ts:162](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L162)

___

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

#### Defined in

[src/react/hooks/useAnimationFunction.ts:69](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimationFunction.ts#L69)
[src/react/hooks/useAnimationFunction.ts:69](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimationFunction.ts#L69)

___

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

#### Defined in

[src/react/hooks/useTransitionAnimation.ts:37](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useTransitionAnimation.ts#L37)
[src/react/hooks/useTransitionAnimation.ts:37](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useTransitionAnimation.ts#L37)

## Type Aliases

Expand All @@ -150,7 +150,7 @@ Strictly typed [Keyframe](https://developer.mozilla.org/en-US/docs/Web/API/Web_A

#### Defined in

[src/core/waapi.ts:17](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/core/waapi.ts#L17)
[src/core/waapi.ts:17](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/core/waapi.ts#L17)

___

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

#### Defined in

[src/core/waapi.ts:22](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/core/waapi.ts#L22)
[src/core/waapi.ts:22](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/core/waapi.ts#L22)

___

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

#### Defined in

[src/core/waapi.ts:31](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/core/waapi.ts#L31)
[src/core/waapi.ts:31](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/core/waapi.ts#L31)

___

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

#### Defined in

[src/core/waapi.ts:4](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/core/waapi.ts#L4)
[src/core/waapi.ts:4](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/core/waapi.ts#L4)

___

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

#### Defined in

[src/core/waapi.ts:74](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/core/waapi.ts#L74)
[src/core/waapi.ts:74](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/core/waapi.ts#L74)

___

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

#### Defined in

[src/core/waapi.ts:145](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/core/waapi.ts#L145)
[src/core/waapi.ts:145](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/core/waapi.ts#L145)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:28](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L28)
[src/react/hooks/useAnimation.ts:28](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L28)

___

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

#### Defined in

[src/react/hooks/useAnimationFunction.ts:32](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimationFunction.ts#L32)
[src/react/hooks/useAnimationFunction.ts:32](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimationFunction.ts#L32)

___

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

#### Defined in

[src/react/hooks/useAnimationFunction.ts:42](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimationFunction.ts#L42)
[src/react/hooks/useAnimationFunction.ts:42](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimationFunction.ts#L42)

___

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

#### Defined in

[src/react/hooks/useTransitionAnimation.ts:27](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useTransitionAnimation.ts#L27)
[src/react/hooks/useTransitionAnimation.ts:27](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useTransitionAnimation.ts#L27)
16 changes: 8 additions & 8 deletions docs/interfaces/AnimationFunctionHandle.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:34](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L34)
[src/react/hooks/useAnimation.ts:34](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L34)

___

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:40](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L40)
[src/react/hooks/useAnimation.ts:40](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L40)

___

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:44](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L44)
[src/react/hooks/useAnimation.ts:44](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L44)

___

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:48](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L48)
[src/react/hooks/useAnimation.ts:48](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L48)

___

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:52](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L52)
[src/react/hooks/useAnimation.ts:52](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L52)

___

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:58](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L58)
[src/react/hooks/useAnimation.ts:58](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L58)

___

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:66](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L66)
[src/react/hooks/useAnimation.ts:66](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L66)

___

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:75](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L75)
[src/react/hooks/useAnimation.ts:75](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L75)
2 changes: 1 addition & 1 deletion docs/interfaces/AnimationFunctionOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Extended [options of KeyframeEffect](https://developer.mozilla.org/en-US/docs/We

#### Defined in

[src/core/waapi.ts:40](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/core/waapi.ts#L40)
[src/core/waapi.ts:40](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/core/waapi.ts#L40)

___

Expand Down
20 changes: 11 additions & 9 deletions docs/interfaces/AnimationHandle.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Interface: AnimationHandle<Args\>

Handle of [useAnimation](../API.md#useanimation).

## Type parameters

| Name | Type | Description |
Expand Down Expand Up @@ -32,7 +34,7 @@ You have to pass this callback to ref of element you want to control.

#### Defined in

[src/react/hooks/useAnimation.ts:87](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L87)
[src/react/hooks/useAnimation.ts:87](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L87)

## Table of contents

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

#### Defined in

[src/react/hooks/useAnimation.ts:34](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L34)
[src/react/hooks/useAnimation.ts:34](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L34)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:40](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L40)
[src/react/hooks/useAnimation.ts:40](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L40)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:44](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L44)
[src/react/hooks/useAnimation.ts:44](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L44)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:48](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L48)
[src/react/hooks/useAnimation.ts:48](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L48)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:52](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L52)
[src/react/hooks/useAnimation.ts:52](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L52)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:58](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L58)
[src/react/hooks/useAnimation.ts:58](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L58)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:66](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L66)
[src/react/hooks/useAnimation.ts:66](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L66)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:75](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L75)
[src/react/hooks/useAnimation.ts:75](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L75)
4 changes: 2 additions & 2 deletions docs/interfaces/AnimationOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If true, run animation automatically when keyframe or options changes.

#### Defined in

[src/react/hooks/useAnimation.ts:94](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L94)
[src/react/hooks/useAnimation.ts:94](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L94)

___

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

#### Defined in

[src/core/waapi.ts:40](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/core/waapi.ts#L40)
[src/core/waapi.ts:40](https://github.com/inokawa/react-animatable/blob/90fdc5a/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 @@ -47,7 +47,7 @@ A wrapper of Web Animations API's [play](https://developer.mozilla.org/en-US/doc

#### Defined in

[src/react/hooks/useAnimation.ts:34](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L34)
[src/react/hooks/useAnimation.ts:34](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L34)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:40](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L40)
[src/react/hooks/useAnimation.ts:40](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L40)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:44](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L44)
[src/react/hooks/useAnimation.ts:44](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L44)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:48](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L48)
[src/react/hooks/useAnimation.ts:48](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L48)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:52](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L52)
[src/react/hooks/useAnimation.ts:52](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L52)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:58](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L58)
[src/react/hooks/useAnimation.ts:58](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L58)

___

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

#### Defined in

[src/react/hooks/useAnimation.ts:66](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L66)
[src/react/hooks/useAnimation.ts:66](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L66)

___

Expand All @@ -184,4 +184,4 @@ A getter of Promise that will be resolved in specified timing.

#### Defined in

[src/react/hooks/useAnimation.ts:75](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useAnimation.ts#L75)
[src/react/hooks/useAnimation.ts:75](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useAnimation.ts#L75)
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:21](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/react/hooks/useTransitionAnimation.ts#L21)
[src/react/hooks/useTransitionAnimation.ts:21](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/hooks/useTransitionAnimation.ts#L21)
2 changes: 1 addition & 1 deletion docs/interfaces/TransitionAnimationOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Extended [options of KeyframeEffect](https://developer.mozilla.org/en-US/docs/We

#### Defined in

[src/core/waapi.ts:40](https://github.com/inokawa/react-animatable/blob/dd9ec77/src/core/waapi.ts#L40)
[src/core/waapi.ts:40](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/core/waapi.ts#L40)

___

Expand Down
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/dd9ec77/src/react/components/TransitionGroup.tsx#L68)
[src/react/components/TransitionGroup.tsx:68](https://github.com/inokawa/react-animatable/blob/90fdc5a/src/react/components/TransitionGroup.tsx#L68)
Loading

0 comments on commit 4955e87

Please sign in to comment.