chore: release 4.5.0

CHANGELOG.md

@@ -4,11 +4,130 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v4.5.0](https://github.com/rive-app/rive-react/compare/v4.4.0...v4.5.0)
+
+- chore: bump react to 4.5.0 [`1c6837b`](https://github.com/rive-app/rive-react/commit/1c6837bf92a88eae3f80c71db67de1c19d8840e9)
+
+#### [v4.4.0](https://github.com/rive-app/rive-react/compare/v4.3.4...v4.4.0)
+
+> 6 October 2023
+
+- chore: release 4.4.0 [`15330ab`](https://github.com/rive-app/rive-react/commit/15330ababeaf49897e79fff2c731ee05612cb40e)
+- bump rive-app versions to 2.5.0 [`af70b81`](https://github.com/rive-app/rive-react/commit/af70b8150dc84cbcfeece2a018084a3d30c0288e)
+
+#### [v4.3.4](https://github.com/rive-app/rive-react/compare/v4.3.3...v4.3.4)
+
+> 3 October 2023
+
+- chore: release 4.3.4 [`a984e00`](https://github.com/rive-app/rive-react/commit/a984e007f480c1b236888a20f7d6d467eecd1dcf)
+- patch: bump rive-wasm to 2.4.4 [`04d8e01`](https://github.com/rive-app/rive-react/commit/04d8e01f87f20dc084b3de88c1e66d32cdbadeed)
+
+#### [v4.3.3](https://github.com/rive-app/rive-react/compare/v4.3.2...v4.3.3)
+
+> 20 September 2023
+
+- chore: release 4.3.3 [`44e46c5`](https://github.com/rive-app/rive-react/commit/44e46c5dee31df2f0035f00a58955d3b3a83e223)
+- chore: bump wasm to 2.4.3 for url sanitization [`323e92e`](https://github.com/rive-app/rive-react/commit/323e92e6361aa68b9a749e8466679760cc4a41a1)
+
+#### [v4.3.2](https://github.com/rive-app/rive-react/compare/v4.3.1...v4.3.2)
+
+> 19 September 2023
+
+- chore: release 4.3.2 [`a07fa02`](https://github.com/rive-app/rive-react/commit/a07fa02ed6cebe2661ccee8bd37fdcef18acc981)
+- chore: bump rive-wasm to 2.4.2 [`d710e1e`](https://github.com/rive-app/rive-react/commit/d710e1e4b24ad2eda66277eb748bdac7e9e48302)
+
+#### [v4.3.1](https://github.com/rive-app/rive-react/compare/v4.3.0...v4.3.1)
+
+> 18 September 2023
+
+- chore: release 4.3.1 [`d35e9b2`](https://github.com/rive-app/rive-react/commit/d35e9b28051ad28528142dbde1f4c5bd7a9814ab)
+- chore: bump rive-wasm to 2.4.1 for event updates [`cf44463`](https://github.com/rive-app/rive-react/commit/cf44463805e8117ee6f1ac5025b973f35f307b1c)
+
+#### [v4.3.0](https://github.com/rive-app/rive-react/compare/v4.2.1...v4.3.0)
+
+> 13 September 2023
+
+- feature: Bump WASM dependency to support Rive Events [`6ba68fa`](https://github.com/rive-app/rive-react/commit/6ba68fab9e5482a3ab2a92410ebb1b422db9ff9e)
+- chore: release 4.3.0 [`f59f446`](https://github.com/rive-app/rive-react/commit/f59f44692a9ca62c9c3f98447087647b125ada5d)
+
+#### [v4.2.1](https://github.com/rive-app/rive-react/compare/v4.2.0...v4.2.1)
+
+> 7 September 2023
+
+- chore: release 4.2.1 [`982addf`](https://github.com/rive-app/rive-react/commit/982addf163ad73a8b077c7a1a27d50bdae402260)
+- chore: bump rive-wasm to 2.3.1 for mesh fix [`dfd89c7`](https://github.com/rive-app/rive-react/commit/dfd89c769193541192718a68a8035e05caa57f07)
+
+#### [v4.2.0](https://github.com/rive-app/rive-react/compare/v4.1.6...v4.2.0)
+
+> 1 September 2023
+
+- chore: release 4.2.0 [`0247a46`](https://github.com/rive-app/rive-react/commit/0247a46c478f53499826fa40b6e03e25e833d969)
+- Updating rive wasm [`44626c7`](https://github.com/rive-app/rive-react/commit/44626c7450999abe095609b06aeafe240da8ddd5)
+
+#### [v4.1.6](https://github.com/rive-app/rive-react/compare/v4.1.5...v4.1.6)
+
+> 26 August 2023
+
+- chore: release 4.1.6 [`c0eb7d6`](https://github.com/rive-app/rive-react/commit/c0eb7d689dd96e41c19e3f647f30f8f324cf54a8)
+- chore: bump rive-wasm for follow up solo fix [`ff7a6aa`](https://github.com/rive-app/rive-react/commit/ff7a6aa6761d95ca5ea41f2d34e82a63b5e0ffee)
+
+#### [v4.1.5](https://github.com/rive-app/rive-react/compare/v4.1.4...v4.1.5)
+
+> 25 August 2023
+
+- chore: release 4.1.5 [`dc89439`](https://github.com/rive-app/rive-react/commit/dc89439d84624e44c5e1218a78bf823ed6928695)
+- chore: bump rive-wasm for follow path constraints on solos [`7ebc10a`](https://github.com/rive-app/rive-react/commit/7ebc10a4da5515ae1350edfe02ce21430de128e6)
+
+#### [v4.1.4](https://github.com/rive-app/rive-react/compare/v4.1.3...v4.1.4)
+
+> 14 August 2023
+
+- chore: release 4.1.4 [`e8e1a5b`](https://github.com/rive-app/rive-react/commit/e8e1a5bc089bbf14307d83b5ef672d74d0f23eb4)
+- chore: bump rive-wasm to 2.1.5 for follow path fix [`1bb8885`](https://github.com/rive-app/rive-react/commit/1bb8885f22583cccaa4b3b54fcbdf42c366548d3)
+
+#### [v4.1.3](https://github.com/rive-app/rive-react/compare/v4.1.2...v4.1.3)
+
+> 10 August 2023
+
+- chore: release 4.1.3 [`00d13ba`](https://github.com/rive-app/rive-react/commit/00d13badcf230a3879713301ddafffe90cd84557)
+- chore: bump wasm to 2.1.3 [`b9ab7b8`](https://github.com/rive-app/rive-react/commit/b9ab7b83d288f578385267b22b89a4b8e80508dc)
+
+#### [v4.1.2](https://github.com/rive-app/rive-react/compare/v4.1.1...v4.1.2)
+
+> 5 August 2023
+
+- chore: release 4.1.2 [`e0f0017`](https://github.com/rive-app/rive-react/commit/e0f00174c8a91f26131d3913e076a4e0c1bce343)
+- chore: bump rive-wasm to 2.1.2 [`200a86a`](https://github.com/rive-app/rive-react/commit/200a86a6bab5cd0e8a31c211df90b9dbf8e7d1be)
+
+#### [v4.1.1](https://github.com/rive-app/rive-react/compare/v4.1.0...v4.1.1)
+
+> 3 August 2023
+
+- chore: release 4.1.1 [`2662259`](https://github.com/rive-app/rive-react/commit/26622596c8a41b2c5cc5b83bb8db42de3e9dcac7)
+- patch: bump rive-wasm to 2.1.1 [`ac789f0`](https://github.com/rive-app/rive-react/commit/ac789f0855eaada115d84fd35da0030aad6b80e1)
+
+#### [v4.1.0](https://github.com/rive-app/rive-react/compare/v4.0.0...v4.1.0)
+
+> 31 July 2023
+
+- chore: release 4.1.0 [`6ecdc05`](https://github.com/rive-app/rive-react/commit/6ecdc05aea05277557c352601b535b3d16361435)
+- feature: expose RiveProps type from package [`f8aa50f`](https://github.com/rive-app/rive-react/commit/f8aa50fa498493428a81a169f36daa0e331b4da5)
+- feature: Add ability to get and set text via wasm runtime bump [`b59bfde`](https://github.com/rive-app/rive-react/commit/b59bfdef8425df26cf14e4e384b60bba812eaeef)
+
+### [v4.0.0](https://github.com/rive-app/rive-react/compare/v3.0.57...v4.0.0)
+
+> 26 July 2023
+
+- chore: release 4.0.0 [`948ded2`](https://github.com/rive-app/rive-react/commit/948ded25f7e0bbfb3a2c4553cc1e73555e3e092f)
+- Bump to rive wasm 2.0.0 [`27f7f2b`](https://github.com/rive-app/rive-react/commit/27f7f2b250c23f4de3c49c491ea2348534e6e2d9)
+
 #### [v3.0.57](https://github.com/rive-app/rive-react/compare/v3.0.56...v3.0.57)
 
+> 25 July 2023
+
 - chore: move to manual npm publish workflow [`4cce306`](https://github.com/rive-app/rive-react/commit/4cce3067a7bce0d66a17b0347c4d87a9d090da0b)
+- chore: release 3.0.57 [`184ba2e`](https://github.com/rive-app/rive-react/commit/184ba2e110e055a2923b885f5c627ab30cf1d3d2)
 - chore: remove dryrun from release it script [`f6d8db3`](https://github.com/rive-app/rive-react/commit/f6d8db323bc57235d1cdce505bb86cb8d05e38fa)
-- docs: add awesome-rive [`301e58f`](https://github.com/rive-app/rive-react/commit/301e58f3905b5596129f1fdae04519198957e97b)
 
 #### [v3.0.56](https://github.com/rive-app/rive-react/compare/v3.0.55...v3.0.56)
 

examples/stories/StateMachineDocs.stories.mdx

@@ -1,10 +1,14 @@
 <!-- RiveTestHook.stories.mdx -->
 
-import { useState } from 'react';
+import { useState, useEffect } from 'react';
 
 import { Canvas, Meta, Story, ArgsTable } from '@storybook/addon-docs';
 
-import RiveComponent, { useRive, useStateMachineInput } from '../../src';
+import RiveComponent, {
+  EventType,
+  useRive,
+  useStateMachineInput,
+} from '../../src';
 import { Button } from './components/Button';
 import './rive-overview.css';
 
@@ -160,3 +164,35 @@ Unlike the boolean and number inputs, you invoke the `.fire()` method on a trigg
     }}
   </Story>
 </Canvas>
+
+## Rive Events
+
+To listen for Rive Events reported during state machine play, use the `on` API to add an event listener.
+
+<Canvas withSource="open">
+  <Story name="Rive Events">
+    {() => {
+      const STATE_MACHINE_NAME = 'State Machine 1';
+      const { rive, RiveComponent } = useRive({
+        src: 'rating_animation.riv',
+        stateMachines: STATE_MACHINE_NAME,
+        autoplay: true,
+        automaticallyHandleEvents: true,
+      });
+      useEffect(() => {
+        if (rive) {
+          rive.on(EventType.RiveEvent, onRiveEventReceived);
+        }
+      }, [rive]);
+      const onRiveEventReceived = (riveEvent) => {
+        console.log('Rive Event Fired', riveEvent);
+      };
+      return (
+        <div className="center">
+          <RiveComponent className="base-canvas-size" />
+          <p>Click on the 5 star!</p>
+        </div>
+      );
+    }}
+  </Story>
+</Canvas>

npm/react-canvas/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/react-canvas",
-  "version": "3.0.57",
+  "version": "4.5.0",
   "description": "React wrapper around the @rive-app/canvas library",
   "main": "dist/index.js",
   "typings": "dist/types/index.d.ts",
@@ -18,7 +18,7 @@
   },
   "homepage": "https://github.com/rive-app/rive-react#readme",
   "dependencies": {
-    "@rive-app/canvas": "1.2.4"
+    "@rive-app/canvas": "2.7.0"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0"

npm/react-webgl/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/react-webgl",
-  "version": "3.0.57",
+  "version": "4.5.0",
   "description": "React wrapper around the @rive-app/webgl library",
   "main": "dist/index.js",
   "typings": "dist/types/index.d.ts",
@@ -18,7 +18,7 @@
   },
   "homepage": "https://github.com/rive-app/rive-react#readme",
   "dependencies": {
-    "@rive-app/webgl": "1.2.4"
+    "@rive-app/webgl": "2.7.0"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "rive-react",
-  "version": "3.0.57",
+  "version": "4.5.0",
   "description": "React wrapper around the rive-js library",
   "main": "dist/index.js",
   "typings": "dist/types/index.d.ts",
@@ -36,8 +36,8 @@
   },
   "homepage": "https://github.com/rive-app/rive-react#readme",
   "dependencies": {
-    "@rive-app/canvas": "1.2.4",
-    "@rive-app/webgl": "1.2.4"
+    "@rive-app/canvas": "2.7.0",
+    "@rive-app/webgl": "2.7.0"
   },
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0"

src/components/Rive.tsx

@@ -36,6 +36,18 @@ export interface RiveProps {
    * Specify whether to resize the canvas to its container automatically
    */
   shouldResizeCanvasToContainer?: boolean;
+  /**
+   * Enable Rive Events to be handled by the runtime. This means any special Rive Event may have
+   * functionality that can be invoked implicitly when detected.
+   *
+   * For example, if during the render loop an OpenUrlEvent is detected, the
+   * browser may try to open the specified URL in the payload.
+   *
+   * This flag is false by default to prevent any unwanted behaviors from taking place.
+   * This means any special Rive Event will have to be handled manually by subscribing to
+   * EventType.RiveEvent
+   */
+  automaticallyHandleEvents?: boolean;
 }
 
 const Rive = ({
@@ -47,6 +59,7 @@ const Rive = ({
   useOffscreenRenderer = true,
   shouldDisableRiveListeners = false,
   shouldResizeCanvasToContainer = true,
+  automaticallyHandleEvents = false,
   children,
   ...rest
 }: RiveProps & ComponentProps<'canvas'>) => {
@@ -58,6 +71,7 @@ const Rive = ({
     stateMachines,
     autoplay: true,
     shouldDisableRiveListeners,
+    automaticallyHandleEvents,
   };
 
   const options = {

src/index.ts

@@ -1,9 +1,9 @@
-import Rive from './components/Rive';
+import Rive, { RiveProps } from './components/Rive';
 import useRive from './hooks/useRive';
 import useStateMachineInput from './hooks/useStateMachineInput';
 import useResizeCanvas from './hooks/useResizeCanvas';
 
 export default Rive;
-export { useRive, useStateMachineInput, useResizeCanvas };
+export { useRive, useStateMachineInput, useResizeCanvas, RiveProps };
 export { RiveState, UseRiveParameters, UseRiveOptions } from './types';
 export * from '@rive-app/canvas';