This application customizer provides you the ability to show notifications on the pages in the top / header area.
This extension is dependent on a explicit Alerts list to be located in a hub site to which current site collection is associated. If site collection is the actual hub site, alerts list has to exist in the root of that site collection.
| Display Name | Name | Type | Required | Description |
|---|---|---|---|---|
| Alert type | PnPAlertType | choice | yes | Type of Alert to display. Urgent = Red. Information = Yellow. |
| Alert message | PnPAlertMessage | string | yes | The message you want to display in the alert |
| Start date-time | PnPAlertStartDateTime | date time | yes | The Date/Time the alert should show in the header placeholder |
| End date-time | PnPAlertEndDateTime | date time | yes | The Date/Time the alert stops showing in the header placeholder |
| More information link | PnPAlertMoreInformation | URL | no | Provides a clickable link at the end of the alert message |
Notice that in default SharePoint Starter Kit installation this list is automatically provisioned on the hub site.
See getting started from SP-Starter-Kit repository readme.
You can also download just the SharePoint Framework solution package (spppkg) file and install that to your tenant. This extension does not have external dependencies.
As this is a SharePoint Framework extension, you will need to explicitly enable that in the site using CSOM or REST APIs.
https://github.com/SharePoint/sp-starter-kit/tree/master/solution/src/extensions/alertNotitication
- Clone this repository
- Move to Solution folder
- in the command line run:
npm installgulp serve
Since this is an extension, debugging requires slightly more advance settings. Please see more from the official SharePoint development documentation around the debugging options with SharePoint Framework extensions.
| Version | Date | Comments |
|---|---|---|
| 1.0 | May 2018 | Initial release |