sp-dev-fx-webparts/samples/react-at-a-glance
Anoop Tatti cea92ff55d Added demo images and gif 2021-09-07 22:24:52 +01:00
..
assets Added demo images and gif 2021-09-07 22:24:52 +01:00
config Added react-at-a-glance 2021-09-07 21:23:19 +00:00
fast-serve Added react-at-a-glance 2021-09-07 21:23:19 +00:00
src Added react-at-a-glance 2021-09-07 21:23:19 +00:00
teams Added react-at-a-glance 2021-09-07 21:23:19 +00:00
.gitignore Added react-at-a-glance 2021-09-07 21:23:19 +00:00
.yo-rc.json Added react-at-a-glance 2021-09-07 21:23:19 +00:00
README.md Added react-at-a-glance 2021-09-07 21:23:19 +00:00
gulpfile.js Added react-at-a-glance 2021-09-07 21:23:19 +00:00
package-lock.json Added react-at-a-glance 2021-09-07 21:23:19 +00:00
package.json Added react-at-a-glance 2021-09-07 21:23:19 +00:00
tsconfig.json Added react-at-a-glance 2021-09-07 21:23:19 +00:00
tslint.json Added react-at-a-glance 2021-09-07 21:23:19 +00:00

README.md

react-at-a-glance

Summary

This sample shows a webpart to show the first few sentences of an article in a SharePoint site, so that the article can be looked at a glance.

The idea is based of the At a glance section of a news in the BBC news app (beta).

Highlights

  • Usage of SPHttpClient or PnP JS
  • Conditional property enabling
  • Usage of regex to get the sentences from article content
  • Usage of Carousel for mobile view
  • Usage of the width property to control webpart views (small or learge)

Demo

Small section / mobile view

demo

Large section / desktop view

article-content

Screenshot of the article

article-content

Used SharePoint Framework Version

version

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Prerequisites

Any special pre-requisites?

Solution

Solution Author(s)
react-at-a-glance Anoop Tatti

Version history

Version Date Comments
1.0 September 09, 2021 Initial release

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.


Minimal Path to Awesome

  • Clone this repository
  • Ensure that you are at the solution folder
  • in the command-line run:
    • npm install
    • gulp serve
  • Open a news article
  • Add ?loadSPFX=true&debugManifestsFile=https://localhost:4321/temp/manifests.js to the URL
  • Add the At a glance webpart to the page

Features

The webpart also has properties to show custom text instead of article text. Upto 3 custom sentences can be added in the properties.

custom-props

References