honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
sp-dev-fx-webparts/samples/react-mobx/README.md

78 lines
2.4 KiB
Markdown
Raw Normal View History

URL dev.office.com to docs.microsoft.com
2020-06-09 03:09:22 -04:00
---
page_type: sample
products:
- office-sp
languages:
- javascript
- typescript
extensions:
contentType: samples
technologies:
- SharePoint Framework
platforms:
- React
createdDate: 1/1/2016 12:00:00 AM
---
Update README.md
2020-11-08 23:38:06 -05:00
# Using Mobx
Sample react-mobx (#56) * [react-mobx] scaffold project + migrate to drop5 * [react-mobx] install mobx dependencies * [react-mobx] configure reactive and nonreactive webpart version * [react-mobx] add presentational and container components * [react-mobx] Replace description field with name * [react-mobx] Add mobx store and hook up webpart & components * [react-mobx] update readme * [react-mobx] remove custom tslint.config * [react-mobx] only render the webpart once
2016-11-10 10:48:31 -05:00
## Summary
Added links to issue templates
2021-04-26 02:08:59 -04:00
Sample web part implementation that uses [Mobx](https://github.com/mobxjs/mobx) to keep track of its state.
Sample react-mobx (#56) * [react-mobx] scaffold project + migrate to drop5 * [react-mobx] install mobx dependencies * [react-mobx] configure reactive and nonreactive webpart version * [react-mobx] add presentational and container components * [react-mobx] Replace description field with name * [react-mobx] Add mobx store and hook up webpart & components * [react-mobx] update readme * [react-mobx] remove custom tslint.config * [react-mobx] only render the webpart once
2016-11-10 10:48:31 -05:00
### Reactive
![](https://i.gyazo.com/e6f1903b9a9c8201985cd25cc1fe28bc.gif)
### Non-Reactive
![](https://i.gyazo.com/876858e31cf14de1b6d1a281a0636029.gif)
Updated legacy compatiblity matrix
2021-11-07 01:33:53 -05:00
## Compatibility
![SPFx 0.5.1](https://img.shields.io/badge/SPFx-0.5.0-orange.svg)
![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg)
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Compatible SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Compatible-green.svg)
![Compatible with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Compatible-green.svg)
![Local Workbench Compatible](https://img.shields.io/badge/Local%20Workbench-Compatible-green.svg)
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
Added SPFx version indicator to readme files for all samples.
2016-12-13 04:26:45 -05:00
Sample react-mobx (#56) * [react-mobx] scaffold project + migrate to drop5 * [react-mobx] install mobx dependencies * [react-mobx] configure reactive and nonreactive webpart version * [react-mobx] add presentational and container components * [react-mobx] Replace description field with name * [react-mobx] Add mobx store and hook up webpart & components * [react-mobx] update readme * [react-mobx] remove custom tslint.config * [react-mobx] only render the webpart once
2016-11-10 10:48:31 -05:00
## Applies to
URL dev.office.com to docs.microsoft.com
2020-06-09 03:09:22 -04:00
* [SharePoint Framework Developer Preview](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 developer tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
Sample react-mobx (#56) * [react-mobx] scaffold project + migrate to drop5 * [react-mobx] install mobx dependencies * [react-mobx] configure reactive and nonreactive webpart version * [react-mobx] add presentational and container components * [react-mobx] Replace description field with name * [react-mobx] Add mobx store and hook up webpart & components * [react-mobx] update readme * [react-mobx] remove custom tslint.config * [react-mobx] only render the webpart once
2016-11-10 10:48:31 -05:00
## Solution
Solution|Author(s)
--------|---------
react-mobx | Kevin Mees <kev.mees@gmail.com> (Experts Inside GmbH, @kmees)
## Version history
Version|Date|Comments
-------|----|--------
1.0|November 4, 2016|Initial release
## Minimal Path to Awesome
```sh
Changed master to main
2021-05-02 15:04:59 -04:00
$ git clone https://github.com/pnp/sp-dev-fx-webparts
Sample react-mobx (#56) * [react-mobx] scaffold project + migrate to drop5 * [react-mobx] install mobx dependencies * [react-mobx] configure reactive and nonreactive webpart version * [react-mobx] add presentational and container components * [react-mobx] Replace description field with name * [react-mobx] Add mobx store and hook up webpart & components * [react-mobx] update readme * [react-mobx] remove custom tslint.config * [react-mobx] only render the webpart once
2016-11-10 10:48:31 -05:00
$ cd sp-dev-fx-webparts/samples/react-mobx
$ npm install
$ gulp serve
```
## Features
* Presentational (dumb) components live in `./components`
* Container (smart) components live in `./container`
Added links to issue templates
2021-04-26 02:08:59 -04:00
* Mobx stores are defined in `./store` with a sample web part store that keeps track of the web part properties.
Sample react-mobx (#56) * [react-mobx] scaffold project + migrate to drop5 * [react-mobx] install mobx dependencies * [react-mobx] configure reactive and nonreactive webpart version * [react-mobx] add presentational and container components * [react-mobx] Replace description field with name * [react-mobx] Add mobx store and hook up webpart & components * [react-mobx] update readme * [react-mobx] remove custom tslint.config * [react-mobx] only render the webpart once
2016-11-10 10:48:31 -05:00
Moved disclaimers to bottom
2021-11-07 01:54:14 -05:00
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
Sample react-mobx (#56) * [react-mobx] scaffold project + migrate to drop5 * [react-mobx] install mobx dependencies * [react-mobx] configure reactive and nonreactive webpart version * [react-mobx] add presentational and container components * [react-mobx] Replace description field with name * [react-mobx] Add mobx store and hook up webpart & components * [react-mobx] update readme * [react-mobx] remove custom tslint.config * [react-mobx] only render the webpart once
2016-11-10 10:48:31 -05:00
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-mobx" />