keyframekit 1.0.7 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +129 -126
  3. package/dist/KeyframeKit.d.ts +138 -138
  4. package/dist/KeyframeKit.js +293 -293
  5. package/docs/.vitepress/components/Playground/Playground.js +242 -242
  6. package/docs/.vitepress/components/Playground/Playground.vue +206 -206
  7. package/docs/.vitepress/components/Playground/defaultExample.js +175 -175
  8. package/docs/.vitepress/components/Playground/interFont.js +14 -14
  9. package/docs/.vitepress/components/Playground/themes/githubDark.js +401 -401
  10. package/docs/.vitepress/components/Playground/themes/githubLight.js +398 -398
  11. package/docs/.vitepress/components/Playground/themes.js +24 -24
  12. package/docs/.vitepress/config.ts +84 -69
  13. package/docs/.vitepress/referenceNavigation.ts +37 -37
  14. package/docs/.vitepress/theme/base-styles.css +100 -91
  15. package/docs/.vitepress/theme/env.d.ts +5 -5
  16. package/docs/.vitepress/theme/index.ts +39 -39
  17. package/docs/docs/index.md +142 -141
  18. package/docs/docs/public/playground/KeyframeKit/dist/KeyframeKit.d.ts +138 -138
  19. package/docs/docs/public/playground/KeyframeKit/dist/KeyframeKit.js +293 -293
  20. package/docs/docs/reference/_media/LICENSE +21 -21
  21. package/docs/docs/reference/classes/KeyframeEffectParameters.md +95 -95
  22. package/docs/docs/reference/classes/ParsedKeyframes.md +49 -49
  23. package/docs/docs/reference/index.md +20 -20
  24. package/docs/docs/reference/interfaces/KeyframesFactory.md +151 -151
  25. package/docs/docs/reference/navigation.json +63 -63
  26. package/docs/docs/reference/type-aliases/KeyframeArgument.md +9 -9
  27. package/docs/docs/reference/type-aliases/KeyframesFactorySource.md +9 -9
  28. package/docs/docs/reference/type-aliases/ParsedKeyframesRules.md +15 -15
  29. package/docs/docs/reference/variables/default.md +7 -7
  30. package/docs/package.json +25 -25
  31. package/docs/typedoc/plugin-param-names.js +51 -51
  32. package/docs/typedoc.json +62 -62
  33. package/package.json +37 -37
  34. package/src/KeyframeKit.ts +508 -508
  35. package/tsconfig.json +47 -47
  36. package/vercel.json +12 -12
@@ -1,64 +1,64 @@
1
- [
2
- {
3
- "title": "Classes",
4
- "children": [
5
- {
6
- "title": "KeyframeEffectParameters",
7
- "kind": 128,
8
- "path": "classes/KeyframeEffectParameters.md",
9
- "isDeprecated": false
10
- },
11
- {
12
- "title": "ParsedKeyframes",
13
- "kind": 128,
14
- "path": "classes/ParsedKeyframes.md",
15
- "isDeprecated": false
16
- }
17
- ]
18
- },
19
- {
20
- "title": "Interfaces",
21
- "children": [
22
- {
23
- "title": "KeyframesFactory",
24
- "kind": 256,
25
- "path": "interfaces/KeyframesFactory.md",
26
- "isDeprecated": false
27
- }
28
- ]
29
- },
30
- {
31
- "title": "Type Aliases",
32
- "children": [
33
- {
34
- "title": "KeyframeArgument",
35
- "kind": 2097152,
36
- "path": "type-aliases/KeyframeArgument.md",
37
- "isDeprecated": false
38
- },
39
- {
40
- "title": "KeyframesFactorySource",
41
- "kind": 2097152,
42
- "path": "type-aliases/KeyframesFactorySource.md",
43
- "isDeprecated": false
44
- },
45
- {
46
- "title": "ParsedKeyframesRules",
47
- "kind": 2097152,
48
- "path": "type-aliases/ParsedKeyframesRules.md",
49
- "isDeprecated": false
50
- }
51
- ]
52
- },
53
- {
54
- "title": "Variables",
55
- "children": [
56
- {
57
- "title": "default",
58
- "kind": 32,
59
- "path": "variables/default.md",
60
- "isDeprecated": false
61
- }
62
- ]
63
- }
1
+ [
2
+ {
3
+ "title": "Classes",
4
+ "children": [
5
+ {
6
+ "title": "KeyframeEffectParameters",
7
+ "kind": 128,
8
+ "path": "classes/KeyframeEffectParameters.md",
9
+ "isDeprecated": false
10
+ },
11
+ {
12
+ "title": "ParsedKeyframes",
13
+ "kind": 128,
14
+ "path": "classes/ParsedKeyframes.md",
15
+ "isDeprecated": false
16
+ }
17
+ ]
18
+ },
19
+ {
20
+ "title": "Interfaces",
21
+ "children": [
22
+ {
23
+ "title": "KeyframesFactory",
24
+ "kind": 256,
25
+ "path": "interfaces/KeyframesFactory.md",
26
+ "isDeprecated": false
27
+ }
28
+ ]
29
+ },
30
+ {
31
+ "title": "Type Aliases",
32
+ "children": [
33
+ {
34
+ "title": "KeyframeArgument",
35
+ "kind": 2097152,
36
+ "path": "type-aliases/KeyframeArgument.md",
37
+ "isDeprecated": false
38
+ },
39
+ {
40
+ "title": "KeyframesFactorySource",
41
+ "kind": 2097152,
42
+ "path": "type-aliases/KeyframesFactorySource.md",
43
+ "isDeprecated": false
44
+ },
45
+ {
46
+ "title": "ParsedKeyframesRules",
47
+ "kind": 2097152,
48
+ "path": "type-aliases/ParsedKeyframesRules.md",
49
+ "isDeprecated": false
50
+ }
51
+ ]
52
+ },
53
+ {
54
+ "title": "Variables",
55
+ "children": [
56
+ {
57
+ "title": "default",
58
+ "kind": 32,
59
+ "path": "variables/default.md",
60
+ "isDeprecated": false
61
+ }
62
+ ]
63
+ }
64
64
  ]
@@ -1,9 +1,9 @@
1
- [KeyframeKit](../index.md) / KeyframeArgument
2
-
3
- # Type Alias: KeyframeArgument
4
-
5
- ```ts
6
- type KeyframeArgument = Keyframe[] | PropertyIndexedKeyframes;
7
- ```
8
-
9
- https://drafts.csswg.org/web-animations-1/#processing-a-keyframes-argument
1
+ [KeyframeKit](../index.md) / KeyframeArgument
2
+
3
+ # Type Alias: KeyframeArgument
4
+
5
+ ```ts
6
+ type KeyframeArgument = Keyframe[] | PropertyIndexedKeyframes;
7
+ ```
8
+
9
+ https://drafts.csswg.org/web-animations-1/#processing-a-keyframes-argument
@@ -1,9 +1,9 @@
1
- [KeyframeKit](../index.md) / KeyframesFactorySource
2
-
3
- # Type Alias: KeyframesFactorySource
4
-
5
- ```ts
6
- type KeyframesFactorySource =
7
- | StyleSheetList
8
- | CSSStyleSheet;
9
- ```
1
+ [KeyframeKit](../index.md) / KeyframesFactorySource
2
+
3
+ # Type Alias: KeyframesFactorySource
4
+
5
+ ```ts
6
+ type KeyframesFactorySource =
7
+ | StyleSheetList
8
+ | CSSStyleSheet;
9
+ ```
@@ -1,15 +1,15 @@
1
- [KeyframeKit](../index.md) / ParsedKeyframesRules
2
-
3
- # Type Alias: ParsedKeyframesRules
4
-
5
- ```ts
6
- type ParsedKeyframesRules = {
7
- [ruleName: string]: ParsedKeyframes;
8
- };
9
- ```
10
-
11
- ## Index Signature
12
-
13
- ```ts
14
- [ruleName: string]: ParsedKeyframes
15
- ```
1
+ [KeyframeKit](../index.md) / ParsedKeyframesRules
2
+
3
+ # Type Alias: ParsedKeyframesRules
4
+
5
+ ```ts
6
+ type ParsedKeyframesRules = {
7
+ [ruleName: string]: ParsedKeyframes;
8
+ };
9
+ ```
10
+
11
+ ## Index Signature
12
+
13
+ ```ts
14
+ [ruleName: string]: ParsedKeyframes
15
+ ```
@@ -1,7 +1,7 @@
1
- [KeyframeKit](../index.md) / default
2
-
3
- # Variable: default
4
-
5
- ```ts
6
- default: KeyframesFactory;
7
- ```
1
+ [KeyframeKit](../index.md) / default
2
+
3
+ # Variable: default
4
+
5
+ ```ts
6
+ default: KeyframesFactory;
7
+ ```
package/docs/package.json CHANGED
@@ -1,25 +1,25 @@
1
- {
2
- "scripts": {
3
- "dev": "vitepress dev",
4
- "build": "vitepress build",
5
- "preview": "vitepress preview",
6
- "bump": "npm run reference && npm run playground:bumplib",
7
- "reference": "typedoc && rm ./docs/reference/README.md",
8
- "playground:bumplib": "mkdir -p ./docs/public/playground/KeyframeKit && cp -r ../dist ./docs/public/playground/KeyframeKit/"
9
- },
10
- "devDependencies": {
11
- "remark-collapse": "^0.1.2",
12
- "remark-insert-headings": "^0.0.0",
13
- "remark-toc": "^9.0.0",
14
- "typedoc": "^0.28.17",
15
- "typedoc-plugin-inline-sources": "^1.3.0",
16
- "typedoc-plugin-markdown": "^4.10.0",
17
- "typedoc-plugin-mdn-links": "^5.1.1",
18
- "typedoc-plugin-remark": "^0.0.0",
19
- "vitepress": "^2.0.0-alpha.16",
20
- "vue": "^3.5.28"
21
- },
22
- "dependencies": {
23
- "@monaco-editor/loader": "^1.7.0"
24
- }
25
- }
1
+ {
2
+ "scripts": {
3
+ "dev": "vitepress dev",
4
+ "build": "vitepress build",
5
+ "preview": "vitepress preview",
6
+ "bump": "npm run reference && npm run playground:bumplib",
7
+ "reference": "typedoc && rm ./docs/reference/README.md",
8
+ "playground:bumplib": "mkdir -p ./docs/public/playground/KeyframeKit && cp -r ../dist ./docs/public/playground/KeyframeKit/"
9
+ },
10
+ "devDependencies": {
11
+ "remark-collapse": "^0.1.2",
12
+ "remark-insert-headings": "^0.0.0",
13
+ "remark-toc": "^9.0.0",
14
+ "typedoc": "^0.28.17",
15
+ "typedoc-plugin-inline-sources": "^1.3.0",
16
+ "typedoc-plugin-markdown": "^4.10.0",
17
+ "typedoc-plugin-mdn-links": "^5.1.1",
18
+ "typedoc-plugin-remark": "^0.0.0",
19
+ "vitepress": "^2.0.0-alpha.16",
20
+ "vue": "^3.5.28"
21
+ },
22
+ "dependencies": {
23
+ "@monaco-editor/loader": "^1.7.0"
24
+ }
25
+ }
@@ -1,52 +1,52 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.load = void 0;
4
- const typedoc_1 = require("typedoc");
5
- const paramNameOption = 'namedParamName';
6
- const detectFromCommentsOption = 'detectNamedParamFromComments';
7
- const changeParamTagOption = 'changeNamedParamTag';
8
- const load = (app) => {
9
- app.options.addDeclaration({
10
- name: paramNameOption,
11
- help: 'Specifies the name to replace __namedParameters with, if a @param tag isn’t found.',
12
- type: typedoc_1.ParameterType.String,
13
- defaultValue: 'options'
14
- });
15
- app.options.addDeclaration({
16
- name: detectFromCommentsOption,
17
- help: 'Whether to detect the name of parameters from the documentation comments.',
18
- type: typedoc_1.ParameterType.Boolean,
19
- defaultValue: true
20
- });
21
- app.options.addDeclaration({
22
- name: changeParamTagOption,
23
- help: `Whether to change the name of the @param tag to ${paramNameOption} so documentation is shown for a corresponding __namedParameters parameter. Ignored if ${detectFromCommentsOption} is true.`,
24
- type: typedoc_1.ParameterType.Boolean,
25
- defaultValue: true
26
- });
27
- let paramName;
28
- let detectFromComments;
29
- let changeParamTag;
30
- app.converter.on(typedoc_1.Converter.EVENT_BEGIN, () => {
31
- paramName = app.options.getValue(paramNameOption);
32
- detectFromComments = app.options.getValue(detectFromCommentsOption);
33
- changeParamTag = app.options.getValue(changeParamTagOption);
34
- if (!changeParamTag && detectFromComments) {
35
- app.logger.warn(`${changeParamTagOption} is ignored when ${detectFromCommentsOption} is true`);
36
- }
37
- });
38
- app.converter.on(typedoc_1.Converter.EVENT_CREATE_SIGNATURE, (context, sig) => {
39
- var _a, _b;
40
-
41
- if (!sig.parameters)
42
- return;
43
- for (const [i, param] of sig.parameters.entries()) {
44
- if (param.name !== '__namedParameters')
45
- continue;
46
- else {
47
- param.name = 'obj';
48
- }
49
- }
50
- });
51
- };
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.load = void 0;
4
+ const typedoc_1 = require("typedoc");
5
+ const paramNameOption = 'namedParamName';
6
+ const detectFromCommentsOption = 'detectNamedParamFromComments';
7
+ const changeParamTagOption = 'changeNamedParamTag';
8
+ const load = (app) => {
9
+ app.options.addDeclaration({
10
+ name: paramNameOption,
11
+ help: 'Specifies the name to replace __namedParameters with, if a @param tag isn’t found.',
12
+ type: typedoc_1.ParameterType.String,
13
+ defaultValue: 'options'
14
+ });
15
+ app.options.addDeclaration({
16
+ name: detectFromCommentsOption,
17
+ help: 'Whether to detect the name of parameters from the documentation comments.',
18
+ type: typedoc_1.ParameterType.Boolean,
19
+ defaultValue: true
20
+ });
21
+ app.options.addDeclaration({
22
+ name: changeParamTagOption,
23
+ help: `Whether to change the name of the @param tag to ${paramNameOption} so documentation is shown for a corresponding __namedParameters parameter. Ignored if ${detectFromCommentsOption} is true.`,
24
+ type: typedoc_1.ParameterType.Boolean,
25
+ defaultValue: true
26
+ });
27
+ let paramName;
28
+ let detectFromComments;
29
+ let changeParamTag;
30
+ app.converter.on(typedoc_1.Converter.EVENT_BEGIN, () => {
31
+ paramName = app.options.getValue(paramNameOption);
32
+ detectFromComments = app.options.getValue(detectFromCommentsOption);
33
+ changeParamTag = app.options.getValue(changeParamTagOption);
34
+ if (!changeParamTag && detectFromComments) {
35
+ app.logger.warn(`${changeParamTagOption} is ignored when ${detectFromCommentsOption} is true`);
36
+ }
37
+ });
38
+ app.converter.on(typedoc_1.Converter.EVENT_CREATE_SIGNATURE, (context, sig) => {
39
+ var _a, _b;
40
+
41
+ if (!sig.parameters)
42
+ return;
43
+ for (const [i, param] of sig.parameters.entries()) {
44
+ if (param.name !== '__namedParameters')
45
+ continue;
46
+ else {
47
+ param.name = 'obj';
48
+ }
49
+ }
50
+ });
51
+ };
52
52
  exports.load = load;
package/docs/typedoc.json CHANGED
@@ -1,63 +1,63 @@
1
- {
2
- "name": "KeyframeKit",
3
-
4
- "plugin": [
5
- "./typedoc/plugin-param-names.js",
6
- "typedoc-plugin-mdn-links",
7
- "typedoc-plugin-inline-sources",
8
- "typedoc-plugin-markdown",
9
- "typedoc-plugin-remark",
10
- //"typedoc-github-wiki-theme",
11
- //"typedoc-plugin-missing-exports"
12
- ],
13
-
14
- "entryPoints": ["../src/KeyframeKit.ts"],
15
- "out": "docs/reference",
16
-
17
- "validation": {
18
- "notExported": false
19
- },
20
-
21
- //"excludeExternals": true,
22
- //"placeInternalsInOwningModule": true,
23
-
24
- "disableSources": true,
25
-
26
- //"flattenOutputFiles": false,
27
-
28
- "router": "member", // "module"
29
-
30
- //"readme": "none",
31
-
32
- //"sidebar": {
33
- //"autoConfiguration": false,
34
- //"heading": "[KeyframeKit](../wiki)"
35
- //},
36
-
37
- "remarkPlugins": [
38
- ["remark-insert-headings", { "text": "Contents", "minHeadingCount": 1 }],
39
- ["remark-toc", { "maxDepth": 3, "tight": true }],
40
- //["remark-collapse", {"test": "Contents"}]
41
- ],
42
-
43
- "modulesFileName": "index", // KeyframeKit
44
-
45
- "expandParameters": true,
46
- "expandObjects": true,
47
-
48
- //"parametersFormat": "htmlTable",
49
-
50
- "useCodeBlocks": true,
51
-
52
- //"hidePageTitle": true,
53
- "hidePageHeader": true,
54
-
55
- //"namedParamName": "obj"
56
-
57
- "navigationJson": "docs/reference/navigation.json",
58
- "navigation": {
59
- "includeCategories": true,
60
- "includeGroups": true,
61
- "includeFolders": true,
62
- }
1
+ {
2
+ "name": "KeyframeKit",
3
+
4
+ "plugin": [
5
+ "./typedoc/plugin-param-names.js",
6
+ "typedoc-plugin-mdn-links",
7
+ "typedoc-plugin-inline-sources",
8
+ "typedoc-plugin-markdown",
9
+ "typedoc-plugin-remark",
10
+ //"typedoc-github-wiki-theme",
11
+ //"typedoc-plugin-missing-exports"
12
+ ],
13
+
14
+ "entryPoints": ["../src/KeyframeKit.ts"],
15
+ "out": "docs/reference",
16
+
17
+ "validation": {
18
+ "notExported": false
19
+ },
20
+
21
+ //"excludeExternals": true,
22
+ //"placeInternalsInOwningModule": true,
23
+
24
+ "disableSources": true,
25
+
26
+ //"flattenOutputFiles": false,
27
+
28
+ "router": "member", // "module"
29
+
30
+ //"readme": "none",
31
+
32
+ //"sidebar": {
33
+ //"autoConfiguration": false,
34
+ //"heading": "[KeyframeKit](../wiki)"
35
+ //},
36
+
37
+ "remarkPlugins": [
38
+ ["remark-insert-headings", { "text": "Contents", "minHeadingCount": 1 }],
39
+ ["remark-toc", { "maxDepth": 3, "tight": true }],
40
+ //["remark-collapse", {"test": "Contents"}]
41
+ ],
42
+
43
+ "modulesFileName": "index", // KeyframeKit
44
+
45
+ "expandParameters": true,
46
+ "expandObjects": true,
47
+
48
+ //"parametersFormat": "htmlTable",
49
+
50
+ "useCodeBlocks": true,
51
+
52
+ //"hidePageTitle": true,
53
+ "hidePageHeader": true,
54
+
55
+ //"namedParamName": "obj"
56
+
57
+ "navigationJson": "docs/reference/navigation.json",
58
+ "navigation": {
59
+ "includeCategories": true,
60
+ "includeGroups": true,
61
+ "includeFolders": true,
62
+ }
63
63
  }
package/package.json CHANGED
@@ -1,37 +1,37 @@
1
- {
2
- "name": "keyframekit",
3
- "version": "1.0.7",
4
- "description": "Intuitive, powerful and performant tools for working with CSS animations in JavaScript.",
5
- "main": "./dist/KeyframeKit.js",
6
- "scripts": {
7
- "build": "npx tsc",
8
- "docs:bump": "(cd docs && npm run bump)",
9
- "docs:build": "(cd docs && npm run build)"
10
- },
11
- "repository": {
12
- "type": "git",
13
- "url": "git+https://github.com/benhatsor/KeyframeKit.git"
14
- },
15
- "keywords": [
16
- "css",
17
- "js",
18
- "javascript",
19
- "animation",
20
- "keyframe",
21
- "stylesheet",
22
- "framework",
23
- "tools",
24
- "performance",
25
- "typescript"
26
- ],
27
- "author": "Ben Hatsor",
28
- "license": "MIT",
29
- "types": "./dist/KeyframeKit.d.ts",
30
- "bugs": {
31
- "url": "https://github.com/benhatsor/KeyframeKit/issues"
32
- },
33
- "homepage": "https://keyframekit.berryscript.com",
34
- "devDependencies": {
35
- "typescript": "^5.9.3"
36
- }
37
- }
1
+ {
2
+ "name": "keyframekit",
3
+ "version": "1.0.9",
4
+ "description": "Intuitive, powerful and lightweight tools for working with CSS animations in JavaScript.",
5
+ "main": "./dist/KeyframeKit.js",
6
+ "scripts": {
7
+ "build": "npx tsc",
8
+ "docs:bump": "(cd docs && npm run bump)",
9
+ "docs:build": "(cd docs && npm run build)"
10
+ },
11
+ "repository": {
12
+ "type": "git",
13
+ "url": "git+https://github.com/benhatsor/KeyframeKit.git"
14
+ },
15
+ "keywords": [
16
+ "css",
17
+ "js",
18
+ "javascript",
19
+ "animation",
20
+ "keyframe",
21
+ "stylesheet",
22
+ "framework",
23
+ "tools",
24
+ "performance",
25
+ "typescript"
26
+ ],
27
+ "author": "Ben Hatsor",
28
+ "license": "MIT",
29
+ "types": "./dist/KeyframeKit.d.ts",
30
+ "bugs": {
31
+ "url": "https://github.com/benhatsor/KeyframeKit/issues"
32
+ },
33
+ "homepage": "https://keyframekit.berryscript.com",
34
+ "devDependencies": {
35
+ "typescript": "^5.9.3"
36
+ }
37
+ }