rsnext/examples/with-portals/README.md

43 lines
1.2 KiB
Markdown
Raw Normal View History

2017-12-02 18:02:22 +01:00
# Example with portals
This example show how to use the React [Portals](https://reactjs.org/docs/portals.html) feature with Next.js.
## Deploy your own
Deploy the example using [Vercel](https://vercel.com):
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/vercel/next.js/tree/canary/examples/with-portals)
2017-12-02 18:02:22 +01:00
## How to use
### Using `create-next-app`
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
```bash
npx create-next-app --example with-portals with-portals-app
# or
yarn create next-app --example with-portals with-portals-app
```
### Download manually
Download the example:
2017-12-02 18:02:22 +01:00
```bash
curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-portals
2017-12-02 18:02:22 +01:00
cd with-portals
```
Install it and run:
```bash
npm install
npm run dev
# or
yarn
yarn dev
2017-12-02 18:02:22 +01:00
```
Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).