Skip to content

Commit ad138e2

Browse files
inokawainokawa
committed
0.13.5
1 parent 3724fbf commit ad138e2

9 files changed

+46
-46
lines changed

‎docs/API.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ A component to manage enter/update/exit of its children by key, that works simil
5151

5252
#### Defined in
5353

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

5656
___
5757

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

8181
#### Defined in
8282

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

8585
___
8686

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

110110
#### Defined in
111111

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

114114
___
115115

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

136136
#### Defined in
137137

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

140140
## Type Aliases
141141

142142
### TypedKeyframe
143143

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

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

148148
#### Defined in
149149

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

152152
___
153153

@@ -157,7 +157,7 @@ ___
157157

158158
#### Defined in
159159

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

162162
___
163163

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

178178
#### Defined in
179179

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

182182
___
183183

@@ -187,7 +187,7 @@ ___
187187

188188
#### Defined in
189189

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

192192
___
193193

@@ -203,7 +203,7 @@ ___
203203

204204
#### Defined in
205205

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

208208
___
209209

@@ -213,7 +213,7 @@ ___
213213

214214
#### Defined in
215215

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

218218
___
219219

@@ -229,7 +229,7 @@ ___
229229

230230
#### Defined in
231231

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

234234
___
235235

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

242242
#### Defined in
243243

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

246246
___
247247

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

263263
#### Defined in
264264

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

267267
___
268268

@@ -272,4 +272,4 @@ ___
272272

273273
#### Defined in
274274

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

‎docs/interfaces/AnimationFunctionHandle.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ A wrapper of Web Animations API's [play](https://developer.mozilla.org/en-US/doc
5555

5656
#### Defined in
5757

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

6060
___
6161

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

8080
#### Defined in
8181

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

8484
___
8585

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

104104
#### Defined in
105105

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

108108
___
109109

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

128128
#### Defined in
129129

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

132132
___
133133

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

152152
#### Defined in
153153

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

156156
___
157157

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

184184
#### Defined in
185185

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

188188
___
189189

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

216216
#### Defined in
217217

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

220220
___
221221

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

249249
#### Defined in
250250

251-
[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L70)
251+
[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L70)

‎docs/interfaces/AnimationHandle.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ You have to pass this callback to ref of element you want to control.
3232

3333
#### Defined in
3434

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

3737
## Table of contents
3838

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

7676
#### Defined in
7777

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

8080
___
8181

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

100100
#### Defined in
101101

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

104104
___
105105

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

124124
#### Defined in
125125

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

128128
___
129129

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

148148
#### Defined in
149149

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

152152
___
153153

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

172172
#### Defined in
173173

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

176176
___
177177

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

204204
#### Defined in
205205

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

208208
___
209209

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

236236
#### Defined in
237237

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

240240
___
241241

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

269269
#### Defined in
270270

271-
[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L70)
271+
[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L70)

‎docs/interfaces/AnimationOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Extended [options of KeyframeEffect](https://developer.mozilla.org/en-US/docs/We
3333

3434
#### Defined in
3535

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

3838
___
3939

‎docs/interfaces/BaseAnimationHandle.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ A wrapper of Web Animations API's [play](https://developer.mozilla.org/en-US/doc
5151

5252
#### Defined in
5353

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

5656
___
5757

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

7272
#### Defined in
7373

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

7676
___
7777

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

9292
#### Defined in
9393

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

9696
___
9797

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

112112
#### Defined in
113113

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

116116
___
117117

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

132132
#### Defined in
133133

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

136136
___
137137

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

160160
#### Defined in
161161

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

164164
___
165165

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

188188
#### Defined in
189189

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

192192
___
193193

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

217217
#### Defined in
218218

219-
[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useAnimation.ts#L70)
219+
[src/react/hooks/useAnimation.ts:70](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useAnimation.ts#L70)

‎docs/interfaces/TransitionAnimationHandle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@
1818

1919
#### Defined in
2020

21-
[src/react/hooks/useTransitionAnimation.ts:20](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/hooks/useTransitionAnimation.ts#L20)
21+
[src/react/hooks/useTransitionAnimation.ts:20](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/hooks/useTransitionAnimation.ts#L20)

‎docs/interfaces/TransitionGroupProps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@
1414

1515
#### Defined in
1616

17-
[src/react/components/TransitionGroup.tsx:68](https://github.com/inokawa/react-animatable/blob/f3ebf49/src/react/components/TransitionGroup.tsx#L68)
17+
[src/react/components/TransitionGroup.tsx:68](https://github.com/inokawa/react-animatable/blob/3724fbf/src/react/components/TransitionGroup.tsx#L68)

‎package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-animatable",
3-
"version": "0.13.4",
3+
"version": "0.13.5",
44
"description": "A powerful composable animation library for React, built on Web Animations API and React hook.",
55
"main": "lib/index.js",
66
"module": "lib/index.mjs",

0 commit comments

Comments
 (0)