sp-dev-fx-webparts/samples/react-rxjs-event-emitter
Hugo Bernier 7e97daab76 Added more contributions 2023-03-15 01:23:34 -04:00
..
.devcontainer Added 1.7.x containers 2022-02-16 01:12:30 -05:00
assets Changed docs links to learn 2022-10-24 09:42:45 -04:00
config react-rxjs-event-emitter upgraded to SPFx version 1.7.0 (#721) 2018-12-19 09:19:53 +02:00
src react-rxjs-event-emitter upgraded to SPFx version 1.7.0 (#721) 2018-12-19 09:19:53 +02:00
teams_broadcaster react-rxjs-event-emitter upgraded to SPFx version 1.7.0 (#721) 2018-12-19 09:19:53 +02:00
teams_receiver react-rxjs-event-emitter upgraded to SPFx version 1.7.0 (#721) 2018-12-19 09:19:53 +02:00
typings Two samples on communication between web parts through broadcasting events utilizing the Publish–subscribe pattern (#290) 2017-09-05 12:05:47 +03:00
.editorconfig Two samples on communication between web parts through broadcasting events utilizing the Publish–subscribe pattern (#290) 2017-09-05 12:05:47 +03:00
.gitattributes Two samples on communication between web parts through broadcasting events utilizing the Publish–subscribe pattern (#290) 2017-09-05 12:05:47 +03:00
.gitignore Two samples on communication between web parts through broadcasting events utilizing the Publish–subscribe pattern (#290) 2017-09-05 12:05:47 +03:00
.npmignore Two samples on communication between web parts through broadcasting events utilizing the Publish–subscribe pattern (#290) 2017-09-05 12:05:47 +03:00
.yo-rc.json react-rxjs-event-emitter upgraded to SPFx version 1.7.0 (#721) 2018-12-19 09:19:53 +02:00
README.md Added more contributions 2023-03-15 01:23:34 -04:00
gulpfile.js updated to 1.4.1 (#484) 2018-04-27 18:26:48 +03:00
package-lock.json react-rxjs-event-emitter upgraded to SPFx version 1.7.0 (#721) 2018-12-19 09:19:53 +02:00
package.json react-rxjs-event-emitter upgraded to SPFx version 1.7.0 (#721) 2018-12-19 09:19:53 +02:00
tsconfig.json react-rxjs-event-emitter upgraded to SPFx version 1.7.0 (#721) 2018-12-19 09:19:53 +02:00
tslint.json react-rxjs-event-emitter upgraded to SPFx version 1.7.0 (#721) 2018-12-19 09:19:53 +02:00

README.md

page_type products languages extensions
sample
office-sp
javascript
typescript
contentType technologies platforms createdDate
tools
SharePoint Framework
react
9/1/2017 12:00:00 AM

SPFx ReactiveX (RxJs) Event Emitter Sample

Summary

This sample shows how we can use the ReactiveX (RxJs) library with the SharePoint Framework to communicate between web parts through broadcasting events utilizing the Publishsubscribe pattern. It enables a web part or component to emit event (broadcast message) and that event is received by other web parts or components that have been subscribed to receive it. Please note this is custom implementation of the Publishsubscribe pattern by using the ReactiveX (RxJs) library. The SPFx will nativelly support this in future without the need of custom implementation through new SPFx api called Event Aggregator, but it is still in Alpha.

SPFx ReactiveX (RxJs) Event Emitter Sample

Compatibility

⚠️ 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.

SPFx 1.7.0 Node.js v8 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Compatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Prerequisites

Contributors

Version history

Version Date Comments
0.0.1 August 22, 2017 Initial commit
0.0.2 April 20, 2018 Updated to SPFx v1.4.1
0.0.3 December 10, 2018 Updated to SPFx v1.7.0

Minimal Path to Awesome

  • Clone this repository.
  • Open the command line, navigate to the web part folder and execute:
    • npm i
    • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

This Web Part illustrates the following concepts on top of the SharePoint Framework:

  • Using React for building SharePoint Framework client-side web parts.
  • Using Office UI Fabric React styles for building user experience consistent with SharePoint and Office.
  • The use the ReactiveX (RxJs) Event Emitter to broadcast messages (events).
  • The use the ReactiveX (RxJs) Event Emitter to subscribe and receive broadcasted messages (events).

Making the RxJsEventEmitter external SPFx library

The RxJsEventEmitter library can be turned into external library so it can be used by multiple SPFx solutions. There is a very good blog post by @waldekmastykarz how this can be done.

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.