sp-dev-fx-webparts/samples/react-redux/README.md

95 lines
3.6 KiB
Markdown
Raw Normal View History

---
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
---
2021-04-26 02:08:59 -04:00
# Web part with React and Redux
## Summary
2021-04-26 02:08:59 -04:00
Sample web part implementation that uses [Redux](https://github.com/reactjs/redux) to keep track of its state.
### Reactive
2021-04-26 02:08:59 -04:00
![](https://i.gyazo.com/729c4addf6c992513f8eb91a3fa0e302.gif)
### Non-Reactive
2021-04-26 02:08:59 -04:00
![](https://i.gyazo.com/1981f22fa6a162931a29ce8dad9c2657.gif)
2021-11-07 01:33:53 -05:00
## Compatibility
| :warning: Important |
|:---------------------------|
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
This sample is designed to be used in the following environments:
2022-10-17 10:21:52 -04:00
2021-11-07 01:33:53 -05:00
![SPFx 0.4.0](https://img.shields.io/badge/SPFx-0.4.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)
2022-03-11 16:05:47 -05:00
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
2021-11-07 01:33:53 -05:00
2022-10-17 10:21:52 -04:00
For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix
2021-11-07 01:33:53 -05:00
## Applies to
2022-10-24 09:42:45 -04:00
* [SharePoint Framework Developer Preview](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 developer tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
2023-02-18 22:58:44 -05:00
## Contributors
2023-02-18 22:58:44 -05:00
* Kevin Mees <kev.mees@gmail.com> (Experts Inside GmbH, @kmees)
## Version history
Version|Date|Comments
-------|----|--------
1.0|October 28, 2016|Initial release
## Minimal Path to Awesome
2022-03-11 16:05:47 -05:00
```
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.sh
2021-05-02 15:04:59 -04:00
$ git clone https://github.com/pnp/sp-dev-fx-webparts
$ cd sp-dev-fx-webparts/samples/react-redux
$ npm install
$ gulp serve
```
2022-03-11 16:05:47 -05:00
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.
## Features
* Presentational (dumb) components live in `./components`
* Container (smart) components live in `./container`
2021-04-26 02:08:59 -04:00
* Redux reducers are defined in `./reducers` with a sample web part reducer that stores the web part properties.
Web part reducer implementation follows the [ducks pattern](https://github.com/erikras/ducks-modular-redux).
* Redux store configuration defined in `./store`
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.**
2021-12-20 10:25:30 -05:00
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-redux" />