Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 3.66 KB

README.md

File metadata and controls

77 lines (52 loc) · 3.66 KB
Raw

Introduction

This project is an SPFx application customizer built for Modern SharePoint sites / pages. It will place itself in the header placeholder of your site and show alerts from a list within your site. Check out the blog.

Rebuilt fresh on SPFx v1.13.1 so that it will support:

Environments

  • Office 365

Browers

  • Edge
  • Chrome
  • FireFox

Why does this project exist?

This is just an interesting example of a site alerts that would be useful on your SharePoint intranet page. This would show users important announcements when they visit the home page. It can be set to show / expire based on dates and times.

Modern Page Demonstration

Designed for Modern Sites demo on modern

Prerequisites to Build

  1. SPFx Development Environment
  2. Tenant App Catalog
  3. Node 14.x.x
  4. SPFx v1.13.1

Installation & Deployment

The following steps assume that you've cloned this repository or downloaded the files and successfully installed all the dependencies using 'npm install'. Make sure to use the same version of node to get a successfull build.

Overview

  1. Build the SPFx Application Customizer
  2. Deploy the SPFx Application Customizer
  3. Add the App to your site

Step 1 - Build the Solution

It is recommended to run the 'build.cmd' file from the projects root folder. This file does all the normal SPFx build commands such as build, bundle, package-solution. The 'build.cmd' also does a number of other things out of scope for guide. Please refer to the following blogs posts for more information on this file.

Modern App Build

When the build script completes you will have the app package for modern sites located in './sharepoint/solution/alerts-header.sppkg'

App Package

Step 2 - Deploy the Application Customizer

Modern Deployment

Modern site deployment is straightforward. For more information about this process see official MS Docs

  1. Navigate to your tenant App Catalog
  2. Click Apps for SharePoint in the Quick Launch menu
  3. Click and drag the .sppkg file into the tenant App Catalog

deploy app customizer

Step 3 - Activate the App

Activation on a Modern site deployment is straightforward. For more information about this process see official MS Docs

  1. Navigate to your Modern site
  2. From the gear icon, click 'Add an App'
  3. In the left menu, click 'From your Organization'
  4. Click 'alerts-header-client-side-solution'

In a minute or two it will be activated on that modern site

adding to site

Modifications

Updating the Styles + Changing Colors, Adding Alert Types and Icons

This project was setup with three different styles: Alert, Actionable and Information. More types can be added with your own custom styles. Font Awesome is used for the fonts which provides plenty of free icons. Please read the blog post for more information blog.

How To Use

It's super easy to use, once activated just add items to the list.

Alerts List

In Site Contents you'll see a new list called "Alerts" list, just add new list items.