Skip to content

Initial release #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,48 @@
# nextjs
# @P5-wrapper/next

![@P5-wrapper/next](https://socialify.git.ci/p5-wrapper/next/image?description=1&font=Rokkitt&forks=1&issues=1&language=1&logo=https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2F8%2F8e%2FNextjs-logo.svg&name=1&owner=1&pattern=Floating%20Cogs&pulls=1&stargazers=1&theme=Auto)

> **Note:**
>
> This library simply re-exports the [@P5-wrapper/react (react-p5-wrapper) component](https://github.com/P5-wrapper/react) as a NextJS dynamic component. Nothing more.
>
> For more in-depth information on the base component, check the documentation via [the @P5-wrapper/react (react-p5-wrapper) docs](https://github.com/P5-wrapper/react).

## Installation

To install the component, run the following:

```shell
[npm|yarn|pnpm] [install|add] @p5-wrapper/next
```

## Usage

Then to use the component in your NextJS project you can simply import like so:

```tsx
import React from "react";
import { type Sketch } from "react-p5-wrapper";
import { NextReactP5Wrapper } from "@p5-wrapper/next";

const sketch: Sketch = p5 => {
p5.setup = () => p5.createCanvas(600, 400, p5.WEBGL);

p5.draw = () => {
p5.background(250);
p5.normalMaterial();
p5.push();
p5.rotateZ(p5.frameCount * 0.01);
p5.rotateX(p5.frameCount * 0.01);
p5.rotateY(p5.frameCount * 0.01);
p5.plane(100);
p5.pop();
};
};

export default function Page() {
return (
<NextReactP5Wrapper sketch={sketch} />
)
}
```
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"name": "@p5-wrapper/next",
"description": "A NextJS specific library for the @P5-Wrapper/react project.",
"private": true,
"version": "1.0.0",
"version": "0.1.0",
"type": "module",
"homepage": "https://github.com/P5-wrapper/next",
"license": "MIT",
Expand Down Expand Up @@ -56,6 +55,7 @@
"@vitejs/plugin-react": "^3.1.0",
"rimraf": "^5.0.0",
"typescript": "^5.0.0",
"vite": "^4.2.0"
"vite": "^4.2.0",
"vite-plugin-dts": "^2.3.0"
}
}
Loading