Skip to content

Commit 01ab56d

Browse files
benhatsorbenhatsor
committed
a
1 parent 6635dd1 commit 01ab56d

9 files changed

Lines changed: 173 additions & 146 deletions

‎docs/Class.KeyframeEffectParameters.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
[KeyframeKit.js](../wiki/globals) / KeyframeEffectParameters
2+
3+
# Class: KeyframeEffectParameters
4+
5+
Defined in: [KeyframeKit.ts:232](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L232)
6+
7+
## Constructors
8+
9+
### Constructor
10+
11+
> **new KeyframeEffectParameters**(`__namedParameters`): `KeyframeEffectParameters`
12+
13+
Defined in: [KeyframeKit.ts:237](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L237)
14+
15+
#### Parameters
16+
17+
##### \_\_namedParameters
18+
19+
###### keyframes
20+
21+
[`KeyframeArgument`](../wiki/TypeAlias.KeyframeArgument)
22+
23+
###### options?
24+
25+
`number` \| `KeyframeEffectOptions` = `{}`
26+
27+
#### Returns
28+
29+
`KeyframeEffectParameters`
30+
31+
## Properties
32+
33+
### keyframes
34+
35+
> **keyframes**: [`KeyframeArgument`](../wiki/TypeAlias.KeyframeArgument)
36+
37+
Defined in: [KeyframeKit.ts:234](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L234)
38+
39+
***
40+
41+
### options?
42+
43+
> `optional` **options**: `number` \| `KeyframeEffectOptions`
44+
45+
Defined in: [KeyframeKit.ts:235](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L235)
46+
47+
## Methods
48+
49+
### toAnimation()
50+
51+
> **toAnimation**(`__namedParameters`): `Animation`
52+
53+
Defined in: [KeyframeKit.ts:247](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L247)
54+
55+
#### Parameters
56+
57+
##### \_\_namedParameters
58+
59+
###### target
60+
61+
`Element` \| `null`
62+
63+
###### timeline?
64+
65+
`AnimationTimeline` = `document.timeline`
66+
67+
#### Returns
68+
69+
`Animation`

‎docs/Class.ParsedKeyframes.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
[KeyframeKit.js](../wiki/globals) / ParsedKeyframes
2+
3+
# Class: ParsedKeyframes
4+
5+
Defined in: [KeyframeKit.ts:270](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L270)
6+
7+
## Constructors
8+
9+
### Constructor
10+
11+
> **new ParsedKeyframes**(`keyframes`): `ParsedKeyframes`
12+
13+
Defined in: [KeyframeKit.ts:274](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L274)
14+
15+
#### Parameters
16+
17+
##### keyframes
18+
19+
`Keyframe`[]
20+
21+
#### Returns
22+
23+
`ParsedKeyframes`
24+
25+
## Properties
26+
27+
### keyframes
28+
29+
> **keyframes**: `Keyframe`[]
30+
31+
Defined in: [KeyframeKit.ts:272](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L272)
32+
33+
## Methods
34+
35+
### toKeyframeEffect()
36+
37+
> **toKeyframeEffect**(`options`): [`KeyframeEffectParameters`](../wiki/Class.KeyframeEffectParameters)
38+
39+
Defined in: [KeyframeKit.ts:278](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L278)
40+
41+
#### Parameters
42+
43+
##### options
44+
45+
`number` | `KeyframeEffectOptions` | `null`
46+
47+
#### Returns
48+
49+
[`KeyframeEffectParameters`](../wiki/Class.KeyframeEffectParameters)

‎docs/TypeAlias.KeyframeArgument.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[KeyframeKit.js](../wiki/globals) / KeyframeArgument
2+
3+
# Type Alias: KeyframeArgument
4+
5+
> **KeyframeArgument** = `Keyframe`[] \| `PropertyIndexedKeyframes`
6+
7+
Defined in: [KeyframeKit.ts:228](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L228)

‎docs/TypeAlias.KeyframesFactorySource.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[KeyframeKit.js](../wiki/globals) / KeyframesFactorySource
2+
3+
# Type Alias: KeyframesFactorySource
4+
5+
> **KeyframesFactorySource** = `DocumentOrShadowRoot` \| `CSSStyleSheet`
6+
7+
Defined in: [KeyframeKit.ts:12](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L12)

‎docs/TypeAlias.ParsedKeyframesRules.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[KeyframeKit.js](../wiki/globals) / ParsedKeyframesRules
2+
3+
# Type Alias: ParsedKeyframesRules
4+
5+
> **ParsedKeyframesRules** = `object`
6+
7+
Defined in: [KeyframeKit.ts:307](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L307)
8+
9+
## Index Signature
10+
11+
\[`ruleName`: `string`\]: [`ParsedKeyframes`](../wiki/Class.ParsedKeyframes)

‎docs/Variable.default.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[KeyframeKit.js](../wiki/globals) / default
2+
3+
# Variable: default
4+
5+
> **default**: `KeyframesFactory`
6+
7+
Defined in: [KeyframeKit.ts:14](https://github.com/benhatsor/KeyframeKit.js/blob/6635dd1b52578ec236ac4190b014199574c9b704/src/KeyframeKit.ts#L14)

‎docs/_Sidebar.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## API
2+
3+
### Classes
4+
5+
- [KeyframeEffectParameters](../wiki/Class.KeyframeEffectParameters)
6+
- [ParsedKeyframes](../wiki/Class.ParsedKeyframes)
7+
8+
### Type Aliases
9+
10+
- [KeyframeArgument](../wiki/TypeAlias.KeyframeArgument)
11+
- [KeyframesFactorySource](../wiki/TypeAlias.KeyframesFactorySource)
12+
- [ParsedKeyframesRules](../wiki/TypeAlias.ParsedKeyframesRules)
13+
14+
### Variables
15+
16+
- [default](../wiki/Variable.default)

‎docs/globals.md‎

Lines changed: 6 additions & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -2,154 +2,15 @@
22

33
## Classes
44

5-
### KeyframeEffectParameters
6-
7-
Defined in: [KeyframeKit.ts:232](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L232)
8-
9-
#### Constructors
10-
11-
##### Constructor
12-
13-
> **new KeyframeEffectParameters**(`__namedParameters`): [`KeyframeEffectParameters`](../wiki/#keyframeeffectparameters)
14-
15-
Defined in: [KeyframeKit.ts:237](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L237)
16-
17-
###### Parameters
18-
19-
###### \_\_namedParameters
20-
21-
###### keyframes
22-
23-
[`KeyframeArgument`](../wiki/#keyframeargument)
24-
25-
###### options?
26-
27-
`number` \| `KeyframeEffectOptions` = `{}`
28-
29-
###### Returns
30-
31-
[`KeyframeEffectParameters`](../wiki/#keyframeeffectparameters)
32-
33-
#### Properties
34-
35-
##### keyframes
36-
37-
> **keyframes**: [`KeyframeArgument`](../wiki/#keyframeargument)
38-
39-
Defined in: [KeyframeKit.ts:234](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L234)
40-
41-
##### options?
42-
43-
> `optional` **options**: `number` \| `KeyframeEffectOptions`
44-
45-
Defined in: [KeyframeKit.ts:235](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L235)
46-
47-
#### Methods
48-
49-
##### toAnimation()
50-
51-
> **toAnimation**(`__namedParameters`): `Animation`
52-
53-
Defined in: [KeyframeKit.ts:247](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L247)
54-
55-
###### Parameters
56-
57-
###### \_\_namedParameters
58-
59-
###### target
60-
61-
`Element` \| `null`
62-
63-
###### timeline?
64-
65-
`AnimationTimeline` = `document.timeline`
66-
67-
###### Returns
68-
69-
`Animation`
70-
71-
***
72-
73-
### ParsedKeyframes
74-
75-
Defined in: [KeyframeKit.ts:270](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L270)
76-
77-
#### Constructors
78-
79-
##### Constructor
80-
81-
> **new ParsedKeyframes**(`keyframes`): [`ParsedKeyframes`](../wiki/#parsedkeyframes)
82-
83-
Defined in: [KeyframeKit.ts:274](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L274)
84-
85-
###### Parameters
86-
87-
###### keyframes
88-
89-
`Keyframe`[]
90-
91-
###### Returns
92-
93-
[`ParsedKeyframes`](../wiki/#parsedkeyframes)
94-
95-
#### Properties
96-
97-
##### keyframes
98-
99-
> **keyframes**: `Keyframe`[]
100-
101-
Defined in: [KeyframeKit.ts:272](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L272)
102-
103-
#### Methods
104-
105-
##### toKeyframeEffect()
106-
107-
> **toKeyframeEffect**(`options`): [`KeyframeEffectParameters`](../wiki/#keyframeeffectparameters)
108-
109-
Defined in: [KeyframeKit.ts:278](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L278)
110-
111-
###### Parameters
112-
113-
###### options
114-
115-
`number` | `KeyframeEffectOptions` | `null`
116-
117-
###### Returns
118-
119-
[`KeyframeEffectParameters`](../wiki/#keyframeeffectparameters)
5+
- [KeyframeEffectParameters](../wiki/Class.KeyframeEffectParameters)
6+
- [ParsedKeyframes](../wiki/Class.ParsedKeyframes)
1207

1218
## Type Aliases
1229

123-
### KeyframeArgument
124-
125-
> **KeyframeArgument** = `Keyframe`[] \| `PropertyIndexedKeyframes`
126-
127-
Defined in: [KeyframeKit.ts:228](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L228)
128-
129-
***
130-
131-
### KeyframesFactorySource
132-
133-
> **KeyframesFactorySource** = `DocumentOrShadowRoot` \| `CSSStyleSheet`
134-
135-
Defined in: [KeyframeKit.ts:12](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L12)
136-
137-
***
138-
139-
### ParsedKeyframesRules
140-
141-
> **ParsedKeyframesRules** = `object`
142-
143-
Defined in: [KeyframeKit.ts:307](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L307)
144-
145-
#### Index Signature
146-
147-
\[`ruleName`: `string`\]: [`ParsedKeyframes`](../wiki/#parsedkeyframes)
10+
- [KeyframeArgument](../wiki/TypeAlias.KeyframeArgument)
11+
- [KeyframesFactorySource](../wiki/TypeAlias.KeyframesFactorySource)
12+
- [ParsedKeyframesRules](../wiki/TypeAlias.ParsedKeyframesRules)
14813

14914
## Variables
15015

151-
### default
152-
153-
> **default**: `KeyframesFactory`
154-
155-
Defined in: [KeyframeKit.ts:14](https://github.com/benhatsor/KeyframeKit.js/blob/0db1a18843ed681284a92c6b22be85343adb765e/src/KeyframeKit.ts#L14)
16+
- [default](../wiki/Variable.default)

‎typedoc.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
//"excludeExternals": true,
66
//"placeInternalsInOwningModule": true,
77

8-
"router": "module"
8+
"router": "member"
99
}

0 commit comments

Comments
 (0)