react-pts-canvas
react-pts-canvas
includes React components for canvas drawing using Pts. In this repo, you'll find implementations for both functional component and legacy class component. Read more below.
Pts is a javascript library for visualization and creative-coding. You may use Pts by itself, or with React and other frameworks.
If you are getting started with Pts, take a look at the demos and read the guides.
Install
npm install --save react-pts-canvas
Examples
- See examples in react-pts-canvas-examples repo
- The example folder in this repo also provides a quick example of using PtsCanvas in a React app
PtsCanvas function component
PtsCanvas
is a functional component that helps you get started on Pts in React. A quick example as follows (please refer to this guide to learn more about these functions).
PtsCanvas
/* App.js */
<PtsCanvas
name='myClassName'
onStart={ (bound, space, form) => {...} }
onAnimate={ (space, form, time, ftime) => {...} }
onResize={ (space, form, size, evt) => {...} }
onAction={ (space, form, type, px, py, evt) => {...} }
/>
/* App.css */
.myClassName {
position: absolute;
top: 0; left: 0; right: 0; bottom: 0;
}
PtsCanvas
component makes use of the useEffect
hook to handle lifecycle events, and the useRef
hook to maintain reference to the space, form, and canvas elements. It provides the following props:
name
- The css class name of the container
<div>
. Default value is "pts-react". Use this class name to set custom styles in your .css file.
- The css class name of the container
background
- background fill color of the canvas. Default value is "#9ab".
onStart
- onStart handler function
onAnimate
- onAnimate handler function
onResize
- onResize handler function
onAction
- onAction handler function
play
- A boolean value to set whether the canvas should animate. Default is
true
.
- A boolean value to set whether the canvas should animate. Default is
resize
- A boolean value to indicate whether the canvas should auto resize. Default is
true
.
- A boolean value to indicate whether the canvas should auto resize. Default is
retina
- A boolean value to indicate whether the canvas should support retina resolution. Default is
true
.
- A boolean value to indicate whether the canvas should support retina resolution. Default is
touch
- A boolean value to set whether the canvas should track mouse and touch events. Default is
true
.
- A boolean value to set whether the canvas should track mouse and touch events. Default is
style
- Optionally override css styles of the container
<div>
.
- Optionally override css styles of the container
canvasStyle
- Optionally override css styles of the
<canvas>
itself. Avoid using this except for special use cases.
- Optionally override css styles of the
tempo
- a
Tempo
object. In a parent component, you can create a ref to a tempo object, add functions to it viaTempo.every
in your onStart handler, then pass thatTempo
's ref.current as this prop. Thetempo
will be added to the space with the other handlers.
- a
spaceRef
- a ref returned from
useRef(null)
if you need reference to the space in your parent component
- a ref returned from
formRef
- a ref returned from
useRef(null)
if you need reference to the form in your parent component
- a ref returned from
Canvas ref access
PtsCanvas
is wrapped with forwardRef
, so you can pass a ref to the component itself if you need
access to the canvas ref within your parent component:
import React, {createRef} from 'react'
const ParentComponent = () => {
const ref = createRef<HTMLCanvasElement>()
return (
<PtsCanvas
ref={ref}
onAnimate={() => {...}}
>
)
}
See example/src/App-ParentRef.tsx
Common issues
- If you are getting sourcemap warnings, create a file called '.env' in your project folder and add
GENERATE_SOURCEMAP=false
into it.
Legacy Components
QuickStartCanvasLegacy class component
<QuickStartCanvasLegacy>
helps you get started quickly. Here is a minimal example that draws a point the follows the cursor, by passing a callback function to onAnimate
property:
import React from 'react'
import { QuickStartCanvasLegacy } from 'react-pts-canvas'
// ...
;<QuickStartCanvasLegacy
onAnimate={(space, form, time) => form.point(space.pointer, 10)}
/>
// ...
In addition to the props in PtsCanvas
(see below), QuickStartCanvas
provides 4 callback props that correspond to the player functions in Pts. The space
and form
instances are also passed as parameters.
<QuickStartCanvasLegacy
onStart={ (bound, space) => {...} }
onAnimate={ (space, form, time, ftime) => {...} }
onResize={ (space, form, size, evt) => {...} }
onAction={ (space, form, type, px, py, evt) => {...} }
/>
PtsCanvasLegacy class component
PtsCanvasLegacy
is a class component that you may extend to implement your own drawings and animations on canvas using Pts. Like this:
class MyCanvas extends PtsCanvasLegacy {
animate (time, ftime, space) {
// your code for drawing and animation
}
start (bound, space) {
// Optional code for canvas init
}
action: (type, x, y, event) {
// Optional code for interaction
}
resize (size, event) {
// Optional code for resize
}
}
There are 4 functions in Pts that you can (optionally) overrides: animate
, start
, resize
, and action
. See this guide to learn more about how these functions work.
Once you have implemented your own canvas, you can use it as a component like this:
import React from 'react'
import { PtsCanvas } from 'react-pts-canvas'
class Example extends React.Component {
render() {
return <MyCanvas background="#abc" play={true} />
}
}
PtsCanvasLegacy
component provides the following props:
name
- The css class name of the container
<div>
. Default value is "pts-react". Use this class name to set custom styles in your .css file.
- The css class name of the container
background
- background fill color of the canvas. Default value is "#9ab".
resize
- A boolean value to indicate whether the canvas should auto resize. Default is
true
.
- A boolean value to indicate whether the canvas should auto resize. Default is
retina
- A boolean value to indicate whether the canvas should support retina resolution. Default is
true
.
- A boolean value to indicate whether the canvas should support retina resolution. Default is
play
- A boolean value to set whether the canvas should animate. Default is
true
.
- A boolean value to set whether the canvas should animate. Default is
touch
- A boolean value to set whether the canvas should track mouse and touch events. Default is
true
.
- A boolean value to set whether the canvas should track mouse and touch events. Default is
style
- Optionally override css styles of the container
<div>
.
- Optionally override css styles of the container
canvasStyle
- Optionally override css styles of the
<canvas>
itself. Avoid using this except for special use cases.
- Optionally override css styles of the
License
Apache License 2.0. See LICENSE file for details. Copyright © 2017-2021 by William Ngan and contributors.