rsnext/examples/with-mobx-state-tree-typescript
Tim Neutkens ed81a14922
Enable @typescript-eslint/no-use-before-define for examples dir (#39469)
Found that this rule was added but all options are set to `false` so it doesn't do anything. Started with enabling it for examples to ensure minimal breaking of existing PRs.

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## 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
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm lint`
- [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
2022-08-10 16:30:36 +00:00
..
components Enable @typescript-eslint/no-use-before-define for examples dir (#39469) 2022-08-10 16:30:36 +00:00
pages fix: hydration warning in with-mobx-state-tree-typescript example (#27339) 2021-07-20 14:15:02 +00:00
.babelrc Update typescript examples (#7867) 2019-07-10 12:51:21 +02:00
.gitignore Update default gitignore templates (#39051) 2022-07-26 20:08:40 -05:00
next-env.d.ts Include submodules in exported type definition (#28316) 2021-11-26 14:46:56 +01:00
package.json Remove licence from all example/package.json that has them (#28007) 2021-08-14 10:48:39 -05:00
README.md docs(examples): improve DX while copying command to create new project (#38410) 2022-07-26 21:57:48 -05:00
store.ts Fix minor typos (#31161) 2021-11-08 11:24:53 -06:00
tsconfig.json Update typescript examples (#7867) 2019-07-10 12:51:21 +02:00

MobX State Tree with TypeScript example

Usually splitting your app state into pages feels natural but sometimes you'll want to have global state for your app. This is an example on how you can use mobx that also works with our universal rendering approach.

In this example we are going to display a digital clock that updates every second. The first render is happening in the server and the date will be 00:00:00, then the browser will take over and it will start updating the date.

To illustrate SSG and SSR, go to /ssg and /ssr, those pages are using Next.js data fetching methods to get the date in the server and return it as props to the page, and then the browser will hydrate the store and continue updating the date.

The trick here for supporting universal mobx is to separate the cases for the client and the server. When we are on the server we want to create a new store every time, otherwise different users data will be mixed up. If we are in the client we want to use always the same store. That's what we accomplish on store.js

The clock, under components/Clock.js, has access to the state using the inject and observer functions from mobx-react. In this case Clock is a direct child from the page but it could be deep down the render tree.

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-mobx-state-tree-typescript with-mobx-state-tree-typescript-app
yarn create next-app --example with-mobx-state-tree-typescript with-mobx-state-tree-typescript-app
pnpm create next-app --example with-mobx-state-tree-typescript with-mobx-state-tree-typescript-app

Deploy it to the cloud with Vercel (Documentation).