keyframekit 1.1.9 → 1.2.1

package/docs/.vitepress/theme/index.ts

@@ -1,40 +0,0 @@
-import type { EnhanceAppContext } from 'vitepress'
-
-import DefaultTheme from 'vitepress/theme'
-
-import Playground from '../components/Playground/Playground.vue'
-
-import './base-styles.css'
-
-export default {
-  extends: DefaultTheme,
-  enhanceApp({ app }: EnhanceAppContext) {
-
-    /* if (typeof window !== 'undefined') {
-      window.MonacoEnvironment = {
-        getWorkerUrl(_moduleId: string, label: string): string {
-          const base = '/monacoeditorwork/'
-          
-          if (label === 'typescript' || label === 'javascript') {
-            return `${base}ts.worker.bundle.js`
-          }
-          if (label === 'json') {
-            return `${base}json.worker.bundle.js`
-          }
-          if (label === 'css' || label === 'scss' || label === 'less') {
-            return `${base}css.worker.bundle.js`
-          }
-          if (label === 'html' || label === 'handlebars' || label === 'razor') {
-            return `${base}html.worker.bundle.js`
-          }
-          
-          return `${base}editor.worker.bundle.js`
-        }
-      }
-    } */
-
-
-    app.component('Playground', Playground)
-
-  }
-}

package/docs/docs/get-started.md

@@ -1,133 +0,0 @@
-
-# Get Started
-
-## About
-
-The [Web Animations API][1] opens the browser's animation engine to developers and provides unprecedented control and performance when animating on the web. But confusingly, it provides no easy way to use your existing CSS animations with the API. So I wrote a lightweight, typed, spec-compliant library to convert stylesheet keyframes to Web Animations API-compatible animations, letting you play your CSS-defined animations right in JS. [Read more.][2]
-
-## Installation
-
-::: code-group
-```sh [npm]
-npm install keyframekit
-```
-```sh [yarn]
-yarn add keyframekit
-```
-```sh [pnpm]
-pnpm add keyframekit
-```
-:::
-
-## Usage
-
-### Playing CSS-defined animations with JS
-
-In your CSS:
-```css
-@keyframes rotate-small { ... }
-```
-
-Then, in JS:
-```js
-import KeyframeKit from 'keyframekit';
-
-const documentStyleSheets = await KeyframeKit.getDocumentStyleSheetsOnLoad();
-
-// get animation keyframes from the document's stylesheets
-const rotateSmallAnimKeyframes = KeyframeKit.getStyleSheetKeyframes({
-  of: 'rotate-small',
-  in: documentStyleSheets
-});
-
-// then, define your animation
-const rotateSmallAnim = rotateSmallAnimKeyframes.toKeyframeEffect({
-  duration: 700,
-  easing: 'ease'
-});
-
-// finally, attach it to an element:
-const attachedAnim = rotateSmallAnim.toAnimation({
-  target: document.querySelector('.el')
-});
-
-attachedAnim.play();
-```
-
-The primary reason to play your animation with JS is because you get way more control over its playback:
-```js
-attachedAnim.pause();
-attachedAnim.playbackRate = -1;
-const progress = attachedAnim.overallProgress; // 0 to 1 (Baseline newly available)
-await attachedAnim.finished;
-```
-[...and more.][3]
-
-### Importing animations directly from a CSS file
-
-Instead of getting an animation from the document's stylesheets, you can also import it directly from a CSS file.
-
-```js
-import KeyframeKit from 'keyframekit';
-
-const styleSheet = await KeyframeKit.importStyleSheet('./styles.css');
-
-// get animation keyframes from stylesheet
-const rotateSmallAnimKeyframes = KeyframeKit.getStyleSheetKeyframes({
-  of: 'rotate-small',
-  in: styleSheet
-});
-```
-
-> Note: This won't resolve any `@import` rules in the stylesheet. [See more.][4]
-
-### Defining animations in JS
-
-The [`KeyframeEffectParameters`](reference/classes/KeyframeEffectParameters.md) class provides a more convenient way to define your animations in JS than is offered natively.  
-It's useful for when you want to have all your animation code in one place.
-
-```js
-import { KeyframeEffectParameters } from 'keyframekit';
-
-// define your animation
-const linkTextHoverAnim = new KeyframeEffectParameters({
-
-  keyframes: {
-    // 0 to 1. equivalent to CSS keyframe percentage values:
-    offset: [0, 0.499, 0.5, 1],
-    // respective CSS property keyframes:
-    clipPath: ['inset(0 0 0 0)', 'inset(100% 0 0 0)', 'inset(0 0 100% 0)', 'inset(0 0 0 0)'],
-    top: ['0', '-20px', '20px', '0']
-  },
-
-  options: {
-    duration: 700,
-    easing: 'ease'
-  }
-  
-});
-
-// then, attach it to an element:
-const attachedAnim = linkTextHoverAnim.toAnimation({
-  target: document.querySelector('.link')
-});
-
-attachedAnim.play();
-```
-
-### Full reference
-[See here.](/reference/index.md)
-
-## Typing
-
-This library is fully compatable with native JS, but it also has full spec-compliant type support, including declaration files and source maps.
-
-## License
-
-[MIT](https://github.com/benhatsor/KeyframeKit/blob/main/LICENSE)
-
-
-[1]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API
-[2]: https://benhatsor.medium.com/99573ef4738b
-[3]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Using_the_Web_Animations_API
-[4]: https://github.com/WICG/construct-stylesheets/issues/119#issuecomment-588352418

package/docs/docs/index.md

@@ -1,17 +0,0 @@
----
-# https://vitepress.dev/reference/default-theme-home-page
-layout: home
-
-hero:
-  name: KeyframeKit
-  tagline: Unlock fine-grained control over your CSS animations with JavaScript.
-  actions:
-    - theme: brand
-      text: Get Started
-      link: /get-started
-    - theme: alt
-      text: Reference
-      link: /reference
----
-
-<Playground/>

package/docs/docs/public/playground/KeyframeKit/dist/KeyframeKit.d.ts

@@ -1,172 +0,0 @@
-export type CSSStyleSheetSource = CSSStyleSheet | StyleSheetList;
-declare class KeyframesFactory {
-    #private;
-    readonly Error: {
-        /** Keyframes rule name must be a string. */
-        readonly KeyframesRuleNameTypeError: {
-            new (message?: string): {
-                message: string;
-                name: string;
-                stack?: string;
-                cause?: unknown;
-            };
-            new (message?: string, options?: ErrorOptions): {
-                message: string;
-                name: string;
-                stack?: string;
-                cause?: unknown;
-            };
-            new (message?: string): {
-                message: string;
-                name: string;
-                stack?: string;
-                cause?: unknown;
-            };
-            new (message?: string, options?: ErrorOptions): {
-                message: string;
-                name: string;
-                stack?: string;
-                cause?: unknown;
-            };
-            isError(error: unknown): error is Error;
-        };
-        /** Source must be either a `CSSStyleSheet` or a `StyleSheetList`. */
-        readonly SourceTypeError: {
-            new (message?: string): {
-                message: string;
-                name: string;
-                stack?: string;
-                cause?: unknown;
-            };
-            new (message?: string, options?: ErrorOptions): {
-                message: string;
-                name: string;
-                stack?: string;
-                cause?: unknown;
-            };
-            new (message?: string): {
-                message: string;
-                name: string;
-                stack?: string;
-                cause?: unknown;
-            };
-            new (message?: string, options?: ErrorOptions): {
-                message: string;
-                name: string;
-                stack?: string;
-                cause?: unknown;
-            };
-            isError(error: unknown): error is Error;
-        };
-        /** The stylesheet could not be imported. */
-        readonly StyleSheetImportError: {
-            new (message?: string): {
-                message: string;
-                name: string;
-                stack?: string;
-                cause?: unknown;
-            };
-            new (message?: string, options?: ErrorOptions): {
-                message: string;
-                name: string;
-                stack?: string;
-                cause?: unknown;
-            };
-            isError(error: unknown): error is Error;
-        };
-    };
-    /**
-     * Gets a document's stylesheets when it loads,
-     * or immediately returns them if it's already loaded.
-     * @param obj
-     * @param obj.document The document to get stylesheets from.
-     */
-    getDocumentStyleSheetsOnLoad({ document }?: {
-        document?: Document;
-    }): Promise<StyleSheetList>;
-    /**
-     * Imports a stylesheet from a URL.
-     * @param url The URL of the stylesheet to import.
-     * @remarks
-     *  Note: `@import` rules won't be resolved in imported stylesheets.
-     *  See https://github.com/WICG/construct-stylesheets/issues/119#issuecomment-588352418.
-     */
-    importStyleSheet(url: string): Promise<CSSStyleSheet>;
-    /**
-     * Gets a CSS keyframes rule from a stylesheet or stylesheet list,
-     * then converts it to Web Animations API keyframes.
-     * @param obj
-     * @param obj.of The name of the `@keyframes` rule to get keyframes from.
-     * @param obj.in The stylesheet or stylesheet list where the rule resides.
-     */
-    getStyleSheetKeyframes({ of: ruleName, in: source }: {
-        of: string;
-        in: CSSStyleSheetSource;
-    }): ParsedKeyframes | undefined;
-    /**
-     * Gets all the CSS keyframes rules in a stylesheet or stylesheet list,
-     * then converts them to Web Animations API keyframes.
-     * @param obj
-     * @param obj.in The style sheet or style sheet list to get keyframes from.
-     */
-    getAllStyleSheetKeyframesRules({ in: source }: {
-        in: CSSStyleSheetSource;
-    }): ParsedKeyframesRules;
-    /**
-     * Converts a CSS keyframes rule to Web Animations API keyframes.
-     * @param obj
-     * @param obj.rule The rule to convert.
-     */
-    parseKeyframesRule({ rule: keyframes }: {
-        rule: CSSKeyframesRule;
-    }): ParsedKeyframes;
-}
-declare const _default: KeyframesFactory;
-export default _default;
-export type { KeyframesFactory };
-/** https://drafts.csswg.org/web-animations-1/#processing-a-keyframes-argument */
-export type KeyframeArgument = Keyframe[] | PropertyIndexedKeyframes;
-/** https://drafts.csswg.org/web-animations-1/#the-keyframeeffect-interface */
-export declare class KeyframeEffectParameters {
-    #private;
-    keyframes: KeyframeArgument;
-    options: KeyframeEffectOptions;
-    /**
-     * @param obj
-     * @param obj.keyframes [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats)
-     * @param obj.options [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
-     */
-    constructor({ keyframes, options }: {
-        keyframes: KeyframeArgument;
-        options?: number | KeyframeEffectOptions;
-    });
-    /**
-     * @param obj
-     * @param obj.target An element to attach the animation to.
-     * @param obj.options Additional keyframe effect options. Can override existing keys.
-     *  [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
-     * @param obj.timeline [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Animation/Animation#timeline)
-     *
-     * @see Specifications:
-     * - https://drafts.csswg.org/web-animations-1/#the-keyframeeffect-interface
-     * - https://drafts.csswg.org/web-animations-1/#the-animation-interface
-     */
-    toAnimation({ target, options: additionalOptions, timeline }: {
-        target: Element | null;
-        options?: number | KeyframeEffectOptions;
-        timeline?: AnimationTimeline | null;
-    }): Animation;
-}
-export declare class ParsedKeyframes {
-    keyframes: Keyframe[];
-    constructor(keyframes: Keyframe[]);
-    /**
-     * @param options
-     * [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
-     */
-    toKeyframeEffect(options: number | KeyframeEffectOptions | null): KeyframeEffectParameters;
-}
-export type ParsedKeyframesRules = {
-    [ruleName: string]: ParsedKeyframes;
-};
-//# sourceMappingURL=KeyframeKit.d.ts.map

package/docs/docs/public/playground/KeyframeKit/dist/KeyframeKit.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"KeyframeKit.d.ts","sourceRoot":"","sources":["../src/KeyframeKit.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG,cAAc,CAAC;AAEjE,cAAM,gBAAgB;;IAEpB,QAAQ,CAAC,KAAK;QACZ,4CAA4C;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAI5C,qEAAqE;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAIrE,4CAA4C;;;;;;;;;;;;;;;;MAInC;IAGX;;;;;OAKG;IACG,4BAA4B,CAAC,EAAE,QAA0B,EAAE,GAAE;QACjE,QAAQ,CAAC,EAAE,QAAQ,CAAA;KACf;IAWN;;;;;;OAMG;IACG,gBAAgB,CAAC,GAAG,EAAE,MAAM;IAwBlC;;;;;;OAMG;IACH,sBAAsB,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE;QACnD,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,mBAAmB,CAAA;KACxB,GAAG,eAAe,GAAG,SAAS;IA0E/B;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE;QAC7C,EAAE,EAAE,mBAAmB,CAAA;KACxB,GAAG,oBAAoB;IAsExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;QACtC,IAAI,EAAE,gBAAgB,CAAA;KACvB,GAAG,eAAe;CAiHpB;;AAED,wBAAsC;AACtC,YAAY,EAAE,gBAAgB,EAAE,CAAC;AAMjC,iFAAiF;AACjF,MAAM,MAAM,gBAAgB,GAAG,QAAQ,EAAE,GAAG,wBAAwB,CAAC;AAErE,8EAA8E;AAC9E,qBAAa,wBAAwB;;IAEnC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,OAAO,EAAE,qBAAqB,CAAC;IAE/B;;;;OAIG;gBACS,EAAE,SAAS,EAAE,OAAY,EAAE,EAAE;QACvC,SAAS,EAAE,gBAAgB,CAAC;QAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,qBAAqB,CAAA;KACzC;IAKD;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAsB,EAAE,QAA4B,EAAE,EAAE;QACrF,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,GAAG,qBAAqB,CAAC;QACzC,QAAQ,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;KACpC,GAAG,SAAS;CAqCd;AAGD,qBAAa,eAAe;IAE1B,SAAS,EAAE,QAAQ,EAAE,CAAC;gBAEV,SAAS,EAAE,QAAQ,EAAE;IAIjC;;;OAGG;IACH,gBAAgB,CACd,OAAO,EAAE,MAAM,GAAG,qBAAqB,GAAG,IAAI,GAC7C,wBAAwB;CAwB5B;AAGD,MAAM,MAAM,oBAAoB,GAAG;IACjC,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe,CAAA;CACpC,CAAC"}