motion-start 0.0.1

package/src/value/use-motion-template.ts

@@ -0,0 +1,57 @@
+/** 
+based on framer-motion@4.1.17,
+Copyright (c) 2018 Framer B.V.
+*/
+import { MotionValue } from ".";
+
+import { useCombineMotionValues } from "./use-combine-values"
+
+/**
+ * Combine multiple motion values into a new one using a string template literal.
+ *
+ * ```jsx
+ * import {
+ *   motion,
+ *   useSpring,
+ *   useMotionValue,
+ *   useMotionTemplate
+ * } from "framer-motion"
+ *
+ * function Component() {
+ *   const shadowX = useSpring(0)
+ *   const shadowY = useMotionValue(0)
+ *   const shadow = useMotionTemplate`drop-shadow(${shadowX}px ${shadowY}px 20px rgba(0,0,0,0.3))`
+ *
+ *   return <MotionDiv style={{ filter: shadow }} />
+ * }
+ * ```
+ *
+ * @public
+ */
+
+export const useMotionTemplate = (fragments: TemplateStringsArray, ...values: MotionValue[]) => {
+    /**
+    * Create a function that will build a string from the latest motion values.
+    */
+    let numFragments = fragments.length;
+    const buildValue = () => {
+        let output = ``
+
+        for (let i = 0; i < numFragments; i++) {
+            output += fragments[i]
+            const value = values[i]
+            if (value) output += values[i].get()
+        }
+
+        return output
+    }
+    const value = useCombineMotionValues(values, buildValue) as any;
+    value.resetInner = value.reset;
+
+    value.reset = (f: TemplateStringsArray, ...vs: MotionValue[]) => {
+        numFragments = f.length;
+        value.resetInner(vs,buildValue)
+    }
+
+    return value as MotionValue<string> & { reset: (fragments: TemplateStringsArray, ...values: MotionValue[]) => void };
+}

package/src/value/use-motion-value.ts

@@ -0,0 +1,27 @@
+/** 
+based on framer-motion@4.1.17,
+Copyright (c) 2018 Framer B.V.
+*/
+/**
+ * Creates a `MotionValue` to track the state and velocity of a value.
+ *
+ * Usually, these are created automatically. For advanced use-cases, like use with `useTransform`, you can create `MotionValue`s externally and pass them into the animated component via the `style` prop.
+ *
+ * @motion
+ *
+ * ```jsx
+ * <script>
+ *   const scale = useMotionValue(1)
+ * </script
+ * 
+ * <Motion let:motion>
+ *  <div style={{scale}} use:motion/>
+ * </Motion>
+ * ```
+ * 
+ * @param initial - The initial state.
+ *
+ * @public
+ */
+export { motionValue as useMotionValue } from './index.js';
+// export { default as UseMotionValue } from './UseMotionValue.svelte';

package/src/value/use-spring.ts

@@ -0,0 +1,84 @@
+/** 
+based on framer-motion@4.1.17,
+Copyright (c) 2018 Framer B.V.
+*/
+import type { SpringOptions } from "popmotion";
+import { MotionValue } from "../value";
+
+/** 
+based on framer-motion@4.1.16,
+Copyright (c) 2018 Framer B.V.
+*/
+
+import { fixed } from '../utils/fix-process-env';
+import { getContext } from "svelte"
+import { MotionConfigContext, type MotionConfigContextObject } from "../context/MotionConfigContext"
+import { get, type Writable } from 'svelte/store';
+import { useMotionValue } from "./use-motion-value";
+import { isMotionValue } from "./utils/is-motion-value";
+import { animate } from "popmotion"
+
+/**
+ * Creates a `MotionValue` that, when `set`, will use a spring animation to animate to its new state.
+ *
+ * It can either work as a stand-alone `MotionValue` by initialising it with a value, or as a subscriber
+ * to another `MotionValue`.
+ *
+ * @remarks
+ *
+ * ```jsx
+ * const x = useSpring(0, { stiffness: 300 })
+ * const y = useSpring(x, { damping: 10 })
+ * ```
+ *
+ * @param inputValue - `MotionValue` or number. If provided a `MotionValue`, when the input `MotionValue` changes, the created `MotionValue` will spring towards that value.
+ * @param springConfig - Configuration options for the spring.
+ * @returns `MotionValue`
+ *
+ * @public
+ */
+export const useSpring = (source: MotionValue | number, config: SpringOptions = {}, isCustom = false) => {
+
+    const mcc: Writable<MotionConfigContextObject> = getContext(MotionConfigContext) || MotionConfigContext(isCustom);
+
+    let activeSpringAnimation: { stop: () => void } | null = null;
+
+    let value = useMotionValue(isMotionValue(source) ? source.get() : source) as MotionValue<any> & { reset: (_: any, config: SpringOptions) => void };
+
+    let cleanup: () => void;
+    const update = (_source: typeof source, _config: typeof config) => {
+        value.attach((v, set) => {
+
+
+            const { isStatic } = get(mcc);
+
+            if (isStatic) {
+                return set(v);
+            }
+            if (activeSpringAnimation) {
+                activeSpringAnimation.stop();
+            }
+            activeSpringAnimation = animate({
+                from: value.get(),
+                to: v,
+                velocity: value.getVelocity(),
+                ..._config,
+                onUpdate: set,
+            })
+
+            return value.get();
+        })
+        cleanup?.()
+        return isMotionValue(_source) ?
+            _source.onChange(v => value.set(parseFloat(v))) :
+            undefined
+    }
+
+    update(source, config);
+
+    value.reset = update;
+    
+    return value;
+}
+
+//export { default as UseSpring } from './UseSpring.svelte';

package/src/value/use-transform.ts

@@ -0,0 +1,216 @@
+/** 
+based on framer-motion@4.1.17,
+Copyright (c) 2018 Framer B.V.
+*/
+import { MotionValue } from "../value";
+import type { TransformOptions } from "../utils/transform";
+
+import { transform } from "../utils/transform"
+import { useCombineMotionValues } from "./use-combine-values"
+
+export type InputRange = number[];
+type SingleTransformer<I, O> = (input: I) => O;
+type MultiTransformer<I, O> = (input: I[]) => O;
+type Transformer<I, O> =
+    | SingleTransformer<I, O>
+    /**
+     * Ideally, this would be typed <I, O> in all instances, but to type this
+     * more accurately requires the tuple support in TypeScript 4:
+     * https://gist.github.com/InventingWithMonster/c4d23752a0fae7888596c4ff6d92733a
+     */
+    | MultiTransformer<string | number, O>
+/**
+ * Create a `MotionValue` that transforms the output of another `MotionValue` by mapping it from one range of values into another.
+ *
+ * @remarks
+ *
+ * Given an input range of `[-200, -100, 100, 200]` and an output range of
+ * `[0, 1, 1, 0]`, the returned `MotionValue` will:
+ *
+ * - When provided a value between `-200` and `-100`, will return a value between `0` and  `1`.
+ * - When provided a value between `-100` and `100`, will return `1`.
+ * - When provided a value between `100` and `200`, will return a value between `1` and  `0`
+ *
+ *
+ * The input range must be a linear series of numbers. The output range
+ * can be any value type supported by Framer Motion: numbers, colors, shadows, etc.
+ *
+ * Every value in the output range must be of the same type and in the same format.
+ *
+  * @motion
+ *
+ * ```jsx
+ * <script>
+ *   const x = useMotionValue(0)
+ *   const xRange = [-200, -100, 100, 200]
+ *   const opacityRange = [0, 1, 1, 0]
+ *   const opacity = useTransform(x, xRange, opacityRange)
+ * </script>
+ * 
+ * <Motion let:motion 
+ *      animate={{ x: 200 }}
+ *      style={{ opacity, x }}
+ *  >
+ *     <div use:motion/>
+ *  </Motion>
+ * ```
+ *
+ * @param inputValue - `MotionValue`
+ * @param inputRange - A linear series of numbers (either all increasing or decreasing)
+ * @param outputRange - A series of numbers, colors or strings. Must be the same length as `inputRange`.
+ * @param options -
+ *
+ *  - clamp: boolean. Clamp values to within the given range. Defaults to `true`
+ *  - ease: EasingFunction[]. Easing functions to use on the interpolations between each value in the input and output ranges. If provided as an array, the array must be one item shorter than the input and output ranges, as the easings apply to the transition between each.
+ *
+ * @returns `MotionValue & { reset: (value: MotionValue<number>, inputRange: InputRange, outputRange: O[], options?: TransformOptions<O>) => void }`
+ *
+ * @public
+ */
+export function useTransform<I, O>(value: MotionValue<number>, inputRange: InputRange, outputRange: O[], options?: TransformOptions<O>): 
+    MotionValue<O> & { reset: (value: MotionValue<number>, inputRange: InputRange, outputRange: O[], options?: TransformOptions<O>) => void };
+/**
+ * Create a `MotionValue` that transforms the output of another `MotionValue` through a function.
+ * In this example, `y` will always be double `x`.
+ *
+ * @motion
+ *
+ * ```jsx
+ * <script>
+ *   const x = useMotionValue(10)
+ *   const y = useTransform(x, value => value * 2)
+ * </script>
+ * 
+ * <Motion let:motion style={{ x, y }}>
+ *   <div use:motion/>
+ * </Motion>
+ * ```
+ *
+ * @param input - A `MotionValue` that will pass its latest value through `transform` to update the returned `MotionValue`.
+ * @param transform - A function that accepts the latest value from `input` and returns a new value.
+ * @returns `MotionValue`
+ *
+ * @public
+ */
+export function useTransform<I, O>(input: MotionValue<I>, transformer: SingleTransformer<I, O>): 
+    MotionValue<O> & { reset: (input: MotionValue<I>, transformer: SingleTransformer<I, O>) => void};
+/**
+ * Pass an array of `MotionValue`s and a function to combine them. In this example, `z` will be the `x` multiplied by `y`.
+ *
+ * @motion
+ *
+ * ```jsx
+ * <script>
+ *   const x = useMotionValue(0)
+ *   const y = useMotionValue(0)
+ *   const z = useTransform([x, y], [latestX, latestY] => latestX * latestY)
+ * </script>
+ * 
+ * <Motion let:motion style={{ x, y, z }}>
+ *   return <div use:motion/>
+ * </Motion>
+ * ```
+ *
+ * @param input - An array of `MotionValue`s that will pass their latest values through `transform` to update the returned `MotionValue`.
+ * @param transform - A function that accepts the latest values from `input` and returns a new value.
+ * @returns `MotionValue`
+ *
+ * @public
+ */
+// export function useTransform<I, O>(input: MotionValue<string | number>[], transformer: MultiTransformer<I, O>):
+//     MotionValue<O> & { reset: (input: MotionValue<string | number>[], transformer: MultiTransformer<I, O>) => void };
+// export function useTransform<I, O>(
+// 	input: MotionValue<string>[] | MotionValue<number>[] | MotionValue<string | number>[],
+// 	transformer: MultiTransformer<I, O>
+// ): MotionValue<O> & { reset: (input: MotionValue<string>[] | MotionValue<number>[] | MotionValue<string | number>[], transformer: MultiTransformer<I, O>) => void };
+// export function useTransform<I, O>(transformer: () => O): MotionValue<O>;
+/**
+ * Pass an array of `MotionValue`s and a function to combine them. In this example, `z` will be the `x` multiplied by `y`.
+ *
+ * ```jsx
+ * export const MyComponent = () => {
+ *   const x = useMotionValue(0)
+ *   const y = useMotionValue(0)
+ *   const z = useTransform([x, y], ([latestX, latestY]) => latestX * latestY)
+ *
+ *   return <motion.div style={{ x, y, z }} />
+ * }
+ * ```
+ *
+ * @param input - An array of `MotionValue`s that will pass their latest values through `transform` to update the returned `MotionValue`.
+ * @param transform - A function that accepts the latest values from `input` and returns a new value.
+ * @returns `MotionValue`
+ *
+ * @public
+ */
+export function useTransform<I, O>(
+    input:
+        | MotionValue<I>
+        | MotionValue<string>[]
+        | MotionValue<number>[]
+        | MotionValue<string | number>[]
+        | (() => O),
+    inputRangeOrTransformer?: InputRange | Transformer<I, O>,
+    outputRange?: O[],
+    options?: TransformOptions<O>
+): any {
+
+    const latest = <I[]>[];
+
+    const update = (
+        input:
+        | MotionValue<I>
+        | MotionValue<string>[]
+        | MotionValue<number>[]
+        | MotionValue<string | number>[]
+        | (() => O),
+        inputRangeOrTransformer?: InputRange | Transformer<I,O>,
+        outputRange?: O[],
+        options?: TransformOptions<O>
+    ) => {
+        const transformer = typeof inputRangeOrTransformer === "function"
+            ? inputRangeOrTransformer
+            : transform(inputRangeOrTransformer!, outputRange!, options);
+        const values = Array.isArray(input) ? input : [input];
+        const _transformer = Array.isArray(input) ? transformer :
+            ([latest]) =>
+                transformer(latest);
+        return [values, () => {
+            latest.length = 0
+            const numValues = values.length
+            for (let i = 0; i < numValues; i++) {
+                latest[i] = values[i].get()
+            }
+
+            return _transformer(latest)
+        }]
+
+    }
+    const comb = useCombineMotionValues(...update(input,
+        inputRangeOrTransformer,
+        outputRange,
+        options)) as any;
+
+    comb.updateInner = comb.reset;
+
+    comb.reset = (
+        input:
+        | MotionValue<I>
+        | MotionValue<string>[]
+        | MotionValue<number>[]
+        | MotionValue<string | number>[]
+        | (() => O),
+        inputRangeOrTransformer?: InputRange | Transformer<I,O>,
+        outputRange?: O[],
+        options?: TransformOptions<O>
+    ) => comb.updateInner(
+        ...update(
+            input,
+            inputRangeOrTransformer,
+            outputRange,
+            options
+        )
+    )
+    return comb;
+}
+// export { default as UseTransform } from './UseTransform.svelte';

package/src/value/use-velocity.ts

@@ -0,0 +1,44 @@
+
+/** 
+based on framer-motion@4.1.17,
+Copyright (c) 2018 Framer B.V.
+*/
+import { MotionValue } from "./index.js";
+import { useMotionValue } from "./use-motion-value.js"
+/**
+ * Creates a `MotionValue` that updates when the velocity of the provided `MotionValue` changes.
+ *
+ * ```javascript
+ * const x = useMotionValue(0)
+ * const xVelocity = useVelocity(x)
+ * const xAcceleration = useVelocity(xVelocity)
+ * ```
+ *
+ * @public
+ */
+export const useVelocity = (value : MotionValue<number>) => {
+    let val = value;
+    let cleanup: () => void;
+
+    const reset = (value: MotionValue<number>) => {
+        cleanup?.();
+        val = value
+        cleanup = val.velocityUpdateSubscribers.add((newVelocity) => {
+            velocity.set(newVelocity);
+        })
+    }
+    
+    const velocity = useMotionValue(value.getVelocity(), () => {
+        cleanup?.();
+        cleanup = val.velocityUpdateSubscribers.add((newVelocity) => {
+            velocity.set(newVelocity);
+        })
+        return () => {
+            cleanup?.()     
+        }
+    }) as MotionValue<number> & { reset: typeof reset };
+
+    velocity.reset = reset;
+
+    return velocity;
+}

package/src/value/utils/is-motion-value.ts

@@ -0,0 +1,15 @@
+/** 
+based on framer-motion@4.1.17,
+Copyright (c) 2018 Framer B.V.
+*/
+import type { MotionValue } from "../";
+
+/** 
+based on framer-motion@4.0.3,
+Copyright (c) 2018 Framer B.V.
+*/
+var isMotionValue = function (value: any): value is MotionValue {
+    return value !== null && typeof value === "object" && value.getVelocity;
+};
+
+export { isMotionValue };

package/src/value/utils/resolve-motion-value.ts

@@ -0,0 +1,29 @@
+/** 
+based on framer-motion@4.1.17,
+Copyright (c) 2018 Framer B.V.
+*/
+import { MotionValue } from "..";
+import type { CustomValueType } from "../../types";
+
+/** 
+based on framer-motion@4.0.3,
+Copyright (c) 2018 Framer B.V.
+*/
+import { isCustomValue } from '../../utils/resolve-value.js';
+import { isMotionValue } from './is-motion-value.js';
+
+/**
+ * If the provided value is a MotionValue, this returns the actual value, otherwise just the value itself
+ *
+ * TODO: Remove and move to library
+ *
+ * @internal
+ */
+function resolveMotionValue(value?: string | number | CustomValueType | MotionValue): string | number {
+    var unwrappedValue = isMotionValue(value) ? value.get() : value;
+    return isCustomValue(unwrappedValue)
+        ? unwrappedValue.toValue()
+        : unwrappedValue;
+}
+
+export { resolveMotionValue };