Add examples for using rive-react

2026-03-13 08:22:30 +08:00 · 2021-06-04 19:42:06 +01:00
parent 3b1d7593fe
commit 6b27b95541
31 changed files with 553 additions and 0 deletions
--- a/examples/basic/README.md
+++ b/examples/basic/README.md
@@ -0,0 +1,14 @@
+# Basic
+
+This is a very basic example of using the Rive component to autoplay a simple looping animation.
+
+## To Run
+
+This example is created using [Create React App](https://reactjs.org/docs/create-a-new-react-app.html).
+
+To install and run:
+
+```
+npm install
+npm start
+```
--- a/examples/basic/package.json
+++ b/examples/basic/package.json
@@ -0,0 +1,36 @@
+{
+  "name": "basic",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@testing-library/jest-dom": "^5.13.0",
+    "@testing-library/react": "^11.2.7",
+    "@testing-library/user-event": "^12.8.3",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "react-scripts": "4.0.3",
+    "rive-react": "0.0.1",
+    "web-vitals": "^1.1.2"
+  },
+  "scripts": {
+    "start": "SKIP_PREFLIGHT_CHECK=true react-scripts start"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
+}
--- a/examples/basic/public/index.html
+++ b/examples/basic/public/index.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Web site created using create-react-app"
+    />
+    <title>Rive React - Basic</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+  </body>
+</html>
--- a/examples/basic/public/poison-loader.riv
+++ b/examples/basic/public/poison-loader.riv
--- a/examples/basic/src/App.js
+++ b/examples/basic/src/App.js
@@ -0,0 +1,12 @@
+import Rive from "rive-react";
+
+function App() {
+  return (
+    // The animation will fit to the parent element.
+    <div style={{ height: "500px", width: "500px" }}>
+      <Rive src="poison-loader.riv" autoplay />
+    </div>
+  );
+}
+
+export default App;
--- a/examples/basic/src/index.js
+++ b/examples/basic/src/index.js
@@ -0,0 +1,10 @@
+import React from "react";
+import ReactDOM from "react-dom";
+import App from "./App";
+
+ReactDOM.render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>,
+  document.getElementById("root")
+);