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-events-aggregator/README.md

4.9 KiB
Raw Blame History

SPFx Event Aggregator Sample

DEPRECATED

The event aggregator is deprecated and no longer available in the SharePoint Framework. Please use dynamic data instead. #

Following issue #659, the event aggregator functionality is no longer working. This feature was in ALPHA state and never made it to general availability state. There is a replacement for the event aggregator. Please have a look at the dynamic data functionality and use it instead https://learn.microsoft.com/sharepoint/dev/spfx/dynamic-data. There is already a sample in this library https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-events-dynamicdata

Summary

This sample shows how we can use the SPFx Event Aggregator to communicate between web parts through broadcasting events utilizing the Publish–subscribe pattern. It enables a web part or component to raise event (broadcast message) through the SPFx event aggregator and that event is received by other web parts or components that have been subscribed to receive it.

Please note the SPFx Event Aggregator is still in Alpha and NOT SUPPORTED IN PRODUCTION USE, but this sample will be updated in future when there are changes from the Alpha version to GA.

SPFx eventAggregator

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.4.1 Node.js v8 | v6 Compatible with SharePoint Online Compatible with SharePoint 2019 Compatible 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 March 20, 2018 Updated to SPFx v1.4.1
0.0.3 November 18, 2018 Sample deprecated

Minimal Path to Awesome

  • Clone this repository.
  • Open the command line, navigate to the web part folder and execute:
    • npm i
    • gulp test (optional)
    • 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 SPFx event aggregator to broadcast messages (events).
  • The use the SPFx event aggregator to subscribe and receive broadcasted messages (events).
  • Unit tests including spies, mocks and faking class methods and properties.

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.