History

dependabot[bot] 7f6e2414a1 Bump url-parse from 1.5.8 to 1.5.10 in /samples/react-at-a-glance Bumps [url-parse](https://github.com/unshiftio/url-parse) from 1.5.8 to 1.5.10. - [Release notes](https://github.com/unshiftio/url-parse/releases) - [Commits](https://github.com/unshiftio/url-parse/compare/1.5.8...1.5.10) --- updated-dependencies: - dependency-name: url-parse dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>		2022-03-11 21:16:18 +00:00
..
.devcontainer	Added all 1.12.1 and 1.13 containers	2022-02-14 02:52:18 -05:00
assets	Removing unnecessary office product from the sample metadata	2021-12-10 19:55:32 +02: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	Minor update to CSS and functionality	2021-10-20 14:27:31 +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 all 1.12.1 and 1.13 containers	2022-02-14 02:52:18 -05:00
gulpfile.js	Added react-at-a-glance	2021-09-07 21:23:19 +00:00
package-lock.json	Bump url-parse from 1.5.8 to 1.5.10 in /samples/react-at-a-glance	2022-03-11 21:16:18 +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

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 PnPjs
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

Screenshot of the article in mobile view

Large section / desktop view

Screenshot of the article in desktop

Compatibility

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
1.1	October 20, 2021	Minor CSS changes

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

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

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.

References

Getting started with SharePoint Framework
Building for Microsoft teams
Use Microsoft Graph in your solution
Publish SharePoint Framework applications to the Marketplace
Microsoft 365 Patterns and Practices - Guidance, tooling, samples and open-source controls for your Microsoft 365 development

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.

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.