Merge pull request #84 from Shopify/fix/use-timestamp

Rename useProgress to useTimestamp

Author: chrfalch

docs/docs/animations/overview.md

@@ -58,9 +58,9 @@ The `useTiming` hook will create a timing based animation that changes the retur
 
 The `useSpring` hook will create a spring based animation that changes the returned animation value with the results from doing a physics simulation.
 
-### useProgress
+### useTimestamp
 
-The `useSprogress` hook will return an animation value that contains the number of milliseconds that passed since the cavans started to draw.
+The `useTimestamp` hook will return an animation value that contains the number of milliseconds that passed since the cavans started to draw.
 
 ### useTouchHandler
 

example/src/Examples/Animation/SimpleValueOverTime.tsx

@@ -1,13 +1,13 @@
 import React from "react";
 import { Dimensions, StyleSheet } from "react-native";
-import { Canvas, mix, useProgress } from "@shopify/react-native-skia";
+import { Canvas, mix, useTimestamp } from "@shopify/react-native-skia";
 
 import { AnimationElement, AnimationDemo, Padding } from "./Components";
 
 const { width } = Dimensions.get("window");
 
 export const SimpleValueOverTime = () => {
-  const progress = useProgress();
+  const progress = useTimestamp();
   return (
     <AnimationDemo title={"Simple animation of value over time"}>
       <Canvas style={styles.canvas}>

package/src/animation/Animation/hooks.ts

@@ -41,11 +41,11 @@ export const useTimeline = (initializer: (tla: TimelineAnimation) => void) => {
 };
 
 /**
- * Creates a progress animation where the provided value will be updated with
+ * Creates an animation value where the provided value will be updated with
  * the progress in seconds since the animation started.
  * @returns An animation value that will be updated by the animation
  */
-export const useProgress = (): AnimationValue => {
+export const useTimestamp = (): AnimationValue => {
   const animation = useMemo(() => {
     return AnimationFactory();
   }, []);

package/src/animation/Animation/index.ts

@@ -1 +1 @@
-export { useLoop, useProgress, useSpring, useTiming } from "./hooks";
+export { useLoop, useTimestamp, useSpring, useTiming } from "./hooks";