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-at-a-glance
History
Hugo Bernier fc2e5a3170 Updated readme and sample.json 2021-09-08 22:48:46 -04:00
..
assets Updated readme and sample.json 2021-09-08 22:48:46 -04: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 Updated readme and sample.json 2021-09-08 22:48:46 -04: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 web part 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 web part views (small or learge)

Demo

Small section / mobile view

demo

Screenshot of the article in mobile view

article-content-mobile

Large section / desktop view

article-content

Screenshot of the article in desktop

article-content-desktop

Compatibility

SPFx 1.12.1 Node.js LTS v14 | LTS v12 | LTS v10 SharePoint Online Teams N/A: Untested with Microsoft Teams Workbench Hosted: Does not work with local workbench

Applies to

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

Prerequisites

None

Solution

Solution Author(s)
react-at-a-glance Anoop Tatti (https://linktr.ee/anoopt)

Version history

Version Date Comments
1.0 September 07, 2021 Initial release

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 web part to the page

Features

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

custom-props

References

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.

Help

We do not support samples, but we 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 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.