@infinityfx/lively 2.1.6 → 3.0.0-beta.0

package/types/core/link.d.ts

@@ -1,12 +0,0 @@
-export type Link = {
-
-    set: (val: any, duration?: number) => void;
-
-}
-
-/**
- * A reactive `Function` which returns it currently stored value.
- * 
- * @param {Function} transformer - A function which transforms the `Link` value before returning it.
- */
-export function Link(transformer?: (val: any) => any): any;

package/types/globals.d.ts

@@ -1,90 +0,0 @@
-import React from 'react';
-
-type TranslateProperty = { x?: number; y?: number; } | string;
-
-type ScaleProperty = { x?: number; y?: number; } | string | number;
-
-type ClipProperty = {
-    left?: number | string;
-    top?: number | string;
-    right?: number | string;
-    bottom?: number | string;
-}
-
-export interface AnimationInitials extends React.CSSProperties {
-    /**
-     * Define the position of an `element` relative to initial rendered position.
-     * 
-     * @default { x: 0, y: 0 }
-     */
-    translate?: TranslateProperty;
-
-    /**
-     * @default { x: 1, y: 1 }
-     */
-    scale?: ScaleProperty;
-
-    /**
-     * @default 0
-     */
-    rotate?: number | string;
-
-    /**
-     * @default { left: 0, top: 0, right: 0, bottom: 0 }
-     */
-    clip?: ClipProperty;
-
-    /**
-     * Value between `0` and `1` which defines how much of an `SVGElement`'s stroke is shown.
-     * 
-     * @default 1
-     */
-    length?: number;
-}
-
-export interface AnimationProperties extends AnimationInitials {
-
-    /**
-     * Delay of the animation in seconds.
-     * 
-     * @default 0
-     */
-    delay?: number;
-
-    /**
-     * Duration of animation in seconds.
-     * 
-     * @default 1
-     */
-    duration?: number;
-
-    /**
-     * Number of times to repeat the animation.
-     * 
-     * Accepts `Infinity` as a value to loop the animation indefinitely.
-     * 
-     * @default 1
-     */
-    repeat?: number;
-
-    /**
-     * Whether to alternate the animation direction (reversed) on repeats.
-     * 
-     * @default false
-     */
-    alternate?: boolean;
-
-    /**
-     * Interpolation method used between keyframes.
-     * 
-     * @default "ease"
-     */
-    interpolate?: 'constant' | 'linear' | 'ease' | 'spring';
-
-    /**
-     * Alias for `transform-origin`.
-     * 
-     * @default { x: 0.5, y: 0.5 }
-     */
-    origin?: string | { x?: number, y?: number } | number;
-}

package/types/hooks/link.d.ts

@@ -1,8 +0,0 @@
-import { Link } from '../core/link';
-
-/**
- * Returns a `Link`, which can be used as an animation value.
- * 
- * @param {any} initial - The initial value for the `Link`.
- */
-export function useLink(initial: any): [Link, Link.set];

package/types/hooks/path.d.ts

@@ -1,9 +0,0 @@
-import React from 'react';
-
-/**
- * Returns a `Function`, which can be passed as an animation value for the `translate` property, that describes the motion along a referenced `SVGElement`'s path.
- * 
- * @param {number[]} [offset=[0, 0]] - Offset the path's position by some amount along the x and y axis in pixels.
- * @param {number} [scale=1] - Scale the size of the path some amount.
- */
-export function usePath(offset?: number[], scale?: number): [Function, React.Ref<SVGElement>];

package/types/hooks/reduced-motions.d.ts

@@ -1,4 +0,0 @@
-/**
- * Checks whether a user prefers reduced motion, when `preferes-reduced-motion: reduce`.
- */
-export function useReducedMotion(): boolean;

package/types/hooks/scroll.d.ts

@@ -1,6 +0,0 @@
-import { Link } from '../core/link';
-
-/**
- * Returns a `Link`, which can be used as an animation value, that describes the current scroll position on the page.
- */
-export function useScroll(): Link;

package/types/hooks/unmount.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-import { Animatable } from '../animatable';
-import { Animate } from '../animate';
-
-/**
- * Returns a boolean value which dictates whether the referenced component should be mounted or not and allows for animating the respective component when it unmounts.
- * 
- * @param {boolean} initial - whether the referenced component is initially mounted.
- */
-export function useUnmount(initial: boolean): [boolean, (mounted: boolean) => void, React.Ref<Animatable | Animate>];

package/types/hooks.d.ts

@@ -1,7 +0,0 @@
-export as namespace Hooks;
-
-export { useUnmount } from './hooks/unmount';
-export { useLink } from './hooks/link';
-export { useScroll } from './hooks/scroll';
-export { usePath } from './hooks/path';
-export { useReducedMotion } from './hooks/reduced-motion';

package/types/index.d.ts

@@ -1,4 +0,0 @@
-export as namespace Lively;
-
-export { Animatable } from './animatable';
-export { Animate } from './animate';