rsnext/examples/with-context-api
Henrik Wenz 16655c7924
[Docs] Migrate with-context-api example to typescript (#40297)
## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm lint`
- [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
2022-09-07 09:14:54 +00:00
..
components [Docs] Migrate with-context-api example to typescript (#40297) 2022-09-07 09:14:54 +00:00
pages [Docs] Migrate with-context-api example to typescript (#40297) 2022-09-07 09:14:54 +00:00
.gitignore Update default gitignore templates (#39051) 2022-07-26 20:08:40 -05:00
package.json [Docs] Migrate with-context-api example to typescript (#40297) 2022-09-07 09:14:54 +00:00
README.md docs(examples): improve DX while copying command to create new project (#38410) 2022-07-26 21:57:48 -05:00
tsconfig.json [Docs] Migrate with-context-api example to typescript (#40297) 2022-09-07 09:14:54 +00:00

Hello World example

This example shows how to use react context api in our app.

It provides an example of using pages/_app.js to include the context api provider and then shows how both the pages/index.js and pages/about.js can both share the same data using the context api consumer.

We start off by creating two contexts. One that actually never changes (CounterDispatchContext) and one that changes more often (CounterStateContext).

The pages/index.js shows how to, from the home page, increment and decrement the context data by 1 (a hard code value in the context provider itself).

The pages/about.js shows how to pass an increment value from the about page into the context provider itself.

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

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

npx create-next-app --example with-context-api with-context-api-app
yarn create next-app --example with-context-api with-context-api-app
pnpm create next-app --example with-context-api with-context-api-app

Deploy it to the cloud with Vercel (Documentation).