@shopify/react-native-skia 0.1.225 → 0.1.228

package/src/values/hooks/useComputedValue.ts

@@ -4,6 +4,9 @@ import { ValueApi } from "../api";
 import { isValue } from "../../renderer/processors/Animations";
 
 /**
+ * @deprecated Use Reanimated 3
+ * for animating Skia: https://shopify.github.io/react-native-skia/docs/animations/animations
+ *
  * Creates a new computed value - a value that will calculate its value depending
  * on other values.
  * @param cb Callback to calculate new value

package/src/values/hooks/useValue.ts

@@ -4,6 +4,9 @@ import { ValueApi } from "../api";
 import type { SkiaMutableValue } from "../types";
 
 /**
+ * @deprecated Use Reanimated 3
+ * for animating Skia: https://shopify.github.io/react-native-skia/docs/animations/animations
+ *
  * Creates a new value that holds some data.
  * @param v Value to hold
  * @returns A Value of type of v

package/src/values/hooks/useValueEffect.ts

@@ -3,6 +3,9 @@ import { useEffect } from "react";
 import type { SkiaValue } from "../types";
 
 /**
+ * @deprecated Use Reanimated 3
+ * for animating Skia: https://shopify.github.io/react-native-skia/docs/animations/animations
+ *
  * Sets up an effect that will be run whenever the value changes
  * @param value Value to subscribe to changes on
  * @param cb Callback to run when value changes

package/src/values/types.ts

@@ -48,26 +48,26 @@ export interface ISkiaValueApi {
    * Creates a new value that holds the initial value and that
    * can be changed.
    */
-  createValue: <T>(initialValue: T) => SkiaMutableValue<T>;
+  createValue<T>(initialValue: T): SkiaMutableValue<T>;
   /**
    * Creates a computed value. This is a calculated value that returns the result of
    * a function that is called with the values of the dependencies.
    */
-  createComputedValue: <R>(
+  createComputedValue<R>(
     cb: () => R,
     values: Array<SkiaValue<unknown>>
-  ) => SkiaValue<R>;
+  ): SkiaValue<R>;
   /**
    * Creates a clock value where the value is the number of milliseconds elapsed
    * since the clock was created
    */
-  createClockValue: () => SkiaClockValue;
+  createClockValue(): SkiaClockValue;
   /**
    * Creates an animation that is driven from a clock and updated every frame.
    * @param cb Callback to calculate next value from time.
    * @returns An animation object that can control a value.
    */
-  createAnimation: <S extends AnimationState = AnimationState>(
+  createAnimation<S extends AnimationState = AnimationState>(
     cb: (t: number, state: S | undefined) => S
-  ) => SkiaAnimation;
+  ): SkiaAnimation;
 }

package/src/views/SkiaView.tsx

@@ -11,9 +11,20 @@ export const SkiaViewNativeId = { current: 1000 };
 
 const NativeSkiaView = SkiaDrawViewNativeComponent;
 
+/**
+ * @deprecated If you are looking to use the Skia imperative API, you can use:
+ * The picture API: https://shopify.github.io/react-native-skia/docs/shapes/pictures/
+ * The offscreen API: https://shopify.github.io/react-native-skia/docs/animations/textures
+ */
 export class SkiaView extends React.Component<SkiaDrawViewProps> {
   constructor(props: SkiaDrawViewProps) {
     super(props);
+    console.warn(
+      `The SkiaView component is deprecated and will be removed in the next release.
+If you are looking to use the Skia imperative API, you can use:
+* The picture API: https://shopify.github.io/react-native-skia/docs/shapes/pictures/
+* The offscreen API: https://shopify.github.io/react-native-skia/docs/animations/textures`
+    );
     this._nativeId = SkiaViewNativeId.current++;
     const { onDraw, onSize } = props;
     if (onDraw) {