Skip to content
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

Adds mobx example #676

Merged
merged 12 commits into from
Jan 6, 2017
Merged
Show file tree
Hide file tree
Changes from 5 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
8 changes: 8 additions & 0 deletions examples/with-mobx/.babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"presets": [
"next/babel"
],
"plugins": [
"transform-decorators-legacy"
]
}
53 changes: 53 additions & 0 deletions examples/with-mobx/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@

# MobX example

## How to use

Download the example (or clone the repo)[https://github.com/zeit/next.js.git]:

```bash
curl https://codeload.github.com/zeit/next.js/tar.gz/master | tar -xz --strip=2 next.js-master/examples/with-mobx
cd with-mobx
```

Install it and run:

```bash
npm install
npm run dev
```

Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))

```bash
now
```
## Notes
This example is a mobx port of the [with-redux](https://github.com/zeit/next.js/tree/master/examples/with-redux) example. Decorator support is activated by adding a `.babelrc` file at the root of the project:

```json
{
"presets": [
"next/babel"
],
"plugins": [
"transform-decorators-legacy"
]
}
```

## The idea behind the 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. This is just a way you can do it but it's not the only one.

In this example we are going to display a digital clock that updates every second. The first render is happening in the server and then the browser will take over. To illustrate this, the server rendered clock will have a different background color than the client one.

![](http://i.imgur.com/JCxtWSj.gif)

Our page is located at `pages/index.js` so it will map the route `/`. To get the initial data for rendering we are implementing the static method `getInitialProps`, initializing the mobx store and returning the initial timestamp to be rendered. The root component for the render method is the `mobx-react Provider` that allows us to send the store down to children components so they can access to the state when required.

To pass the initial timestamp from the server to the client we pass it as a prop called `lastUpdate` so then it's available when the client takes over.

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.
29 changes: 29 additions & 0 deletions examples/with-mobx/components/Clock.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import React from 'react'
import { inject, observer } from 'mobx-react'

const Clock = inject('store')(observer(({store}) => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we do this injecting part in the place where we use it?
If not, try to expose the actual clock component.
The idea is, we need to have a state logic independent UI component.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can, since The Clock element is used in a page component. However in a real app case, the component could be nested in multiple layers.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fdidron Yep. I get that. But I like to have UI components separated.
Anyway, here this is not a big deal.
We just wanna show how to use Mobx with Next.js.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my latest commit fa87184 I fixed it by having a page component that does the injection, and calls the Clock component

return (
<div className={store.light ? 'light' : ''}>
{format(new Date(store.lastUpdate))}
<style jsx>{`
div {
padding: 15px;
display: inline-block;
color: #82FA58;
font: 50px menlo, monaco, monospace;
background-color: #000;
}

.light {
background-color: #999;
}
`}</style>
</div>
)
}))

const format = t => `${pad(t.getHours())}:${pad(t.getMinutes())}:${pad(t.getSeconds())}`

const pad = n => n < 10 ? `0${n}` : n

export default Clock
19 changes: 19 additions & 0 deletions examples/with-mobx/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "with-mobx",
"version": "1.0.0",
"scripts": {
"dev": "next",
"build": "next build",
"start": "next start"
},
"dependencies": {
"mobx": "^2.7.0",
"mobx-react": "^4.0.4",
"next": "beta"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change this to ^2.0.0-beta

},
"author": "",
"license": "ISC",
"devDependencies": {
"babel-plugin-transform-decorators-legacy": "^1.3.4"
}
}
33 changes: 33 additions & 0 deletions examples/with-mobx/pages/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import React from 'react'
import { Provider } from 'mobx-react'
import { initStore } from '../store'
import Clock from '../components/Clock'

export default class Counter extends React.Component {
static getInitialProps ({ req }) {
const isServer = !!req
const store = initStore(isServer)
return { lastUpdate: store.lastUpdate, isServer }
}

constructor (props) {
super(props)
this.store = initStore(props.isServer, props.lastUpdate)
}

componentDidMount () {
this.store.start()
}

componentWillUnmount () {
this.store.stop()
}

render () {
return (
<Provider store={this.store}>
<Clock />
</Provider>
)
}
}
30 changes: 30 additions & 0 deletions examples/with-mobx/store.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { action, observable } from 'mobx'

class Store {
@observable lastUpdate = 0
@observable light = false

constructor (isServer, lastUpdate) {
this.lastUpdate = lastUpdate
}

@action start = () => {
this.timer = setInterval(() => {
this.lastUpdate = Date.now()
this.light = true
})
}

stop = () => clearInterval(this.timer)
}

export const initStore = (isServer, lastUpdate = Date.now()) => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

export function intStore () {} looks much better.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

if (isServer && typeof window === 'undefined') {
return new Store(isServer, lastUpdate)
} else {
if (!window.store) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not assign the store into window.? You can save it as a local variable inside this module.
(If this because to support Mobx devtools, then that fine.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I shamelessly copied what's done on the react redux example :D I will move it to a local variable

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

window.store = new Store(isServer, lastUpdate)
}
return window.store
}
}
Loading