rsnext/examples/using-preact/README.md
Dominic Elm d2caaeab64
docs: add 'Open in StackBlitz' buttons to various examples (#25853)
This PR adds a `Preview` section and a `Open in StackBlitz` button to various examples. I have tested all examples and omitted the ones that require third party API keys, or didn't work. Some examples don't work locally either.

Here's an example:
![image](https://user-images.githubusercontent.com/12571019/121027783-88971280-c7a7-11eb-851a-0ad30cf74b42.png)

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [x] Examples updated
- [ ] Telemetry added. In case of a feature if it's used or not.

## Documentation / Examples

- [x] Make sure the linting passes
2021-06-08 20:45:02 +00:00

1.6 KiB

Preact example

This example uses Preact instead of React. It's a React like UI framework which is fast and small.

Preview

Preview the example live on StackBlitz:

Open in StackBlitz

How to use

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example using-preact using-preact-app
# or
yarn create next-app --example using-preact using-preact-app

Deploy it to the cloud with Vercel (Documentation).

Aliasing react -> preact

Using preact with next.js depends on aliasing react packages to preact ones (like @preact/compat). This is done directly in the package.json dependencies.

next-plugin-preact

This example was updated to use next-plugin-preact and now requires minimal configuration, if you want to add preact without a plugin, or see how it works, head to the previous next.config.js.