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
dependabot[bot] a1bbe4907a
Bump word-wrap from 1.2.3 to 1.2.4 in /samples/react-at-a-glance 
Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.4.
- [Release notes](https://github.com/jonschlinkert/word-wrap/releases)
- [Commits](https://github.com/jonschlinkert/word-wrap/compare/1.2.3...1.2.4)

---
updated-dependencies:
- dependency-name: word-wrap
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 		2023-07-20 21:17:54 +00:00
..
.devcontainer Added all 1.12.1 and 1.13 containers 2022-02-14 02:52:18 -05:00
assets Changed docs links to learn 2022-10-24 09:42:45 -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 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 Updated contributors for readmes 2023-03-15 00:11:27 -04:00
gulpfile.js Added react-at-a-glance 2021-09-07 21:23:19 +00:00
package-lock.json Bump word-wrap from 1.2.3 to 1.2.4 in /samples/react-at-a-glance 2023-07-20 21:17:54 +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

http://aka.ms/m365devprogramhttp://aka.ms/m365devprogramhttp://aka.ms/m365devprogramhttp://aka.ms/m365devprogram# 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

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

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

SPFx 1.12.1 Node.js v14 | v12 | v10 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Incompatible Hosted Workbench Partially Compatible with Remote Containers

Applies to

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

Prerequisites

None

Contributors

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.

custom-props

References

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.