Skip to content

Commit a499213

Browse files
benhatsorbenhatsor
committed
a
1 parent 398aae4 commit a499213

12 files changed

Lines changed: 328 additions & 310 deletions

‎docs/Reference.md‎

Lines changed: 9 additions & 308 deletions
Original file line numberDiff line numberDiff line change
@@ -1,316 +1,17 @@
11
## Classes
22

3-
### KeyframeEffectParameters
4-
5-
Defined in: [KeyframeKit.ts:232](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L232)
6-
7-
#### Constructors
8-
9-
##### Constructor
10-
11-
```ts
12-
new KeyframeEffectParameters(obj: {
13-
keyframes: KeyframeArgument;
14-
options?: number | KeyframeEffectOptions;
15-
}): KeyframeEffectParameters;
16-
```
17-
18-
Defined in: [KeyframeKit.ts:237](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L237)
19-
20-
###### Parameters
21-
22-
###### obj
23-
24-
###### keyframes
25-
26-
[`KeyframeArgument`](../wiki/#keyframeargument)
27-
28-
###### options?
29-
30-
`number` | `KeyframeEffectOptions` = `{}`
31-
32-
###### Returns
33-
34-
[`KeyframeEffectParameters`](../wiki/#keyframeeffectparameters)
35-
36-
#### Properties
37-
38-
##### keyframes
39-
40-
```ts
41-
keyframes: KeyframeArgument;
42-
```
43-
44-
Defined in: [KeyframeKit.ts:234](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L234)
45-
46-
##### options?
47-
48-
```ts
49-
optional options: number | KeyframeEffectOptions;
50-
```
51-
52-
Defined in: [KeyframeKit.ts:235](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L235)
53-
54-
#### Methods
55-
56-
##### toAnimation()
57-
58-
```ts
59-
toAnimation(obj: {
60-
target: Element | null;
61-
timeline?: AnimationTimeline;
62-
}): Animation;
63-
```
64-
65-
Defined in: [KeyframeKit.ts:247](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L247)
66-
67-
###### Parameters
68-
69-
###### obj
70-
71-
###### target
72-
73-
[`Element`](https://developer.mozilla.org/docs/Web/API/Element) | `null`
74-
75-
###### timeline?
76-
77-
[`AnimationTimeline`](https://developer.mozilla.org/docs/Web/API/AnimationTimeline) = `document.timeline`
78-
79-
###### Returns
80-
81-
[`Animation`](https://developer.mozilla.org/docs/Web/API/Animation)
82-
83-
***
84-
85-
### KeyframesFactory
86-
87-
Defined in: [KeyframeKit.ts:14](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L14)
88-
89-
#### Properties
90-
91-
##### KeyframesRuleNameTypeError
92-
93-
```ts
94-
readonly KeyframesRuleNameTypeError: typeof KeyframesFactoryKeyframesRuleNameTypeError;
95-
```
96-
97-
Defined in: [KeyframeKit.ts:16](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L16)
98-
99-
##### SourceTypeError
100-
101-
```ts
102-
readonly SourceTypeError: typeof KeyframesFactorySourceTypeError;
103-
```
104-
105-
Defined in: [KeyframeKit.ts:20](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L20)
106-
107-
#### Methods
108-
109-
##### getAllStyleSheetKeyframesRules()
110-
111-
```ts
112-
getAllStyleSheetKeyframesRules(obj?: {
113-
in?: KeyframesFactorySource;
114-
}): ParsedKeyframesRules;
115-
```
116-
117-
Defined in: [KeyframeKit.ts:102](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L102)
118-
119-
###### Parameters
120-
121-
###### obj?
122-
123-
###### in?
124-
125-
[`KeyframesFactorySource`](../wiki/#keyframesfactorysource) = `document`
126-
127-
###### Returns
128-
129-
[`ParsedKeyframesRules`](../wiki/#parsedkeyframesrules)
130-
131-
##### getStyleSheetKeyframes()
132-
133-
```ts
134-
getStyleSheetKeyframes(obj: {
135-
in?: KeyframesFactorySource;
136-
of: string;
137-
}): ParsedKeyframes | undefined;
138-
```
139-
140-
Defined in: [KeyframeKit.ts:25](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L25)
141-
142-
###### Parameters
143-
144-
###### obj
145-
146-
###### in?
147-
148-
[`KeyframesFactorySource`](../wiki/#keyframesfactorysource) = `document`
149-
150-
###### of
151-
152-
`string`
153-
154-
###### Returns
155-
156-
[`ParsedKeyframes`](../wiki/#parsedkeyframes) | `undefined`
157-
158-
##### parseKeyframesRule()
159-
160-
```ts
161-
parseKeyframesRule(obj: {
162-
rule: CSSKeyframesRule;
163-
}): ParsedKeyframes;
164-
```
165-
166-
Defined in: [KeyframeKit.ts:174](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L174)
167-
168-
###### Parameters
169-
170-
###### obj
171-
172-
###### rule
173-
174-
[`CSSKeyframesRule`](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule)
175-
176-
###### Returns
177-
178-
[`ParsedKeyframes`](../wiki/#parsedkeyframes)
179-
180-
***
181-
182-
### KeyframesFactoryKeyframesRuleNameTypeError
183-
184-
Defined in: [KeyframeKit.ts:16](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L16)
185-
186-
#### Properties
187-
188-
##### message
189-
190-
```ts
191-
message: string;
192-
```
193-
194-
Defined in: [KeyframeKit.ts:17](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L17)
195-
196-
***
197-
198-
### KeyframesFactorySourceTypeError
199-
200-
Defined in: [KeyframeKit.ts:20](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L20)
201-
202-
#### Properties
203-
204-
##### message
205-
206-
```ts
207-
message: string;
208-
```
209-
210-
Defined in: [KeyframeKit.ts:21](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L21)
211-
212-
***
213-
214-
### ParsedKeyframes
215-
216-
Defined in: [KeyframeKit.ts:270](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L270)
217-
218-
#### Constructors
219-
220-
##### Constructor
221-
222-
```ts
223-
new ParsedKeyframes(keyframes: Keyframe[]): ParsedKeyframes;
224-
```
225-
226-
Defined in: [KeyframeKit.ts:274](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L274)
227-
228-
###### Parameters
229-
230-
###### keyframes
231-
232-
`Keyframe`\[]
233-
234-
###### Returns
235-
236-
[`ParsedKeyframes`](../wiki/#parsedkeyframes)
237-
238-
#### Properties
239-
240-
##### keyframes
241-
242-
```ts
243-
keyframes: Keyframe[];
244-
```
245-
246-
Defined in: [KeyframeKit.ts:272](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L272)
247-
248-
#### Methods
249-
250-
##### toKeyframeEffect()
251-
252-
```ts
253-
toKeyframeEffect(options: number | KeyframeEffectOptions | null): KeyframeEffectParameters;
254-
```
255-
256-
Defined in: [KeyframeKit.ts:278](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L278)
257-
258-
###### Parameters
259-
260-
###### options
261-
262-
`number` | `KeyframeEffectOptions` | `null`
263-
264-
###### Returns
265-
266-
[`KeyframeEffectParameters`](../wiki/#keyframeeffectparameters)
3+
* [KeyframeEffectParameters](../wiki/classes/KeyframeEffectParameters)
4+
* [KeyframesFactory](../wiki/classes/KeyframesFactory)
5+
* [KeyframesFactoryKeyframesRuleNameTypeError](../wiki/classes/KeyframesFactoryKeyframesRuleNameTypeError)
6+
* [KeyframesFactorySourceTypeError](../wiki/classes/KeyframesFactorySourceTypeError)
7+
* [ParsedKeyframes](../wiki/classes/ParsedKeyframes)
2678

2689
## Type Aliases
26910

270-
### KeyframeArgument
271-
272-
```ts
273-
type KeyframeArgument = Keyframe[] | PropertyIndexedKeyframes;
274-
```
275-
276-
Defined in: [KeyframeKit.ts:228](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L228)
277-
278-
***
279-
280-
### KeyframesFactorySource
281-
282-
```ts
283-
type KeyframesFactorySource =
284-
| DocumentOrShadowRoot
285-
| CSSStyleSheet;
286-
```
287-
288-
Defined in: [KeyframeKit.ts:12](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L12)
289-
290-
***
291-
292-
### ParsedKeyframesRules
293-
294-
```ts
295-
type ParsedKeyframesRules = {
296-
[ruleName: string]: ParsedKeyframes;
297-
};
298-
```
299-
300-
Defined in: [KeyframeKit.ts:307](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L307)
301-
302-
#### Index Signature
303-
304-
```ts
305-
[ruleName: string]: ParsedKeyframes
306-
```
11+
* [KeyframeArgument](../wiki/type-aliases/KeyframeArgument)
12+
* [KeyframesFactorySource](../wiki/type-aliases/KeyframesFactorySource)
13+
* [ParsedKeyframesRules](../wiki/type-aliases/ParsedKeyframesRules)
30714

30815
## Variables
30916

310-
### default
311-
312-
```ts
313-
default: KeyframesFactory;
314-
```
315-
316-
Defined in: [KeyframeKit.ts:14](https://github.com/benhatsor/KeyframeKit.js/blob/be54f53f0971365aa2b2824a746dd1649a314a10/src/KeyframeKit.ts#L14)
17+
* [default](../wiki/variables/default)

‎docs/_Sidebar.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Reference
2+
3+
### Classes
4+
5+
- [KeyframeEffectParameters](../wiki/classes/KeyframeEffectParameters)
6+
- [KeyframesFactory](../wiki/classes/KeyframesFactory)
7+
- [KeyframesFactoryKeyframesRuleNameTypeError](../wiki/classes/KeyframesFactoryKeyframesRuleNameTypeError)
8+
- [KeyframesFactorySourceTypeError](../wiki/classes/KeyframesFactorySourceTypeError)
9+
- [ParsedKeyframes](../wiki/classes/ParsedKeyframes)
10+
11+
### Type Aliases
12+
13+
- [KeyframeArgument](../wiki/type-aliases/KeyframeArgument)
14+
- [KeyframesFactorySource](../wiki/type-aliases/KeyframesFactorySource)
15+
- [ParsedKeyframesRules](../wiki/type-aliases/ParsedKeyframesRules)
16+
17+
### Variables
18+
19+
- [default](../wiki/variables/default)

0 commit comments

Comments
 (0)