File tree Expand file tree Collapse file tree 1 file changed +18
-0
lines changed Expand file tree Collapse file tree 1 file changed +18
-0
lines changed Original file line number Diff line number Diff line change @@ -16,6 +16,24 @@ A component to integrate [P5.js](https://p5js.org/) sketches into
1616> in your sketches and much more besides, you can read more on the upcoming
1717> version of the [ P5 docs] ( https://beta.p5js.org/ ) .
1818
19+ ## ⚠️ Migration Notes
20+
21+ The main component for rendering p5 sketches in React depends on your version:
22+
23+ - Version 4 and earlier: use ` ReactP5Wrapper ` .
24+ - Version 5 and later: use ` P5Canvas ` .
25+
26+ Both components work in the same way.
27+
28+ Breaking changes in v5:
29+
30+ 1 . Component rename
31+ - ` ReactP5Wrapper ` → ` P5Canvas `
32+
33+ 2 . Types
34+ - ` P5WrapperProps ` → ` P5CanvasProps `
35+ - ` P5WrapperClassName ` → ` CanvasContainerClassName `
36+
1937## Installation
2038
2139To install, use the following command in the format appropriate to your chosen
You can’t perform that action at this time.
0 commit comments