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/js-msgraph-thumbnail
History
dependabot[bot] 3f4a74f701
Bump word-wrap from 1.2.3 to 1.2.4 in /samples/js-msgraph-thumbnail 
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:18:14 +00:00
..
.devcontainer Added SPFx 1.10 containers 2022-02-15 00:50:11 -05:00
assets Changed docs links to learn 2022-10-24 09:42:45 -04:00
config Added Graph thumbnail API sample 2020-01-21 17:02:21 +01:00
src Changed docs links to learn 2022-10-24 09:42:45 -04:00
.editorconfig Added Graph thumbnail API sample 2020-01-21 17:02:21 +01:00
.gitignore Added Graph thumbnail API sample 2020-01-21 17:02:21 +01:00
.yo-rc.json Added Graph thumbnail API sample 2020-01-21 17:02:21 +01:00
README.md Updated contributors for readmes 2023-03-15 00:11:27 -04:00
gulpfile.js Added Graph thumbnail API sample 2020-01-21 17:02:21 +01:00
package-lock.json Bump word-wrap from 1.2.3 to 1.2.4 in /samples/js-msgraph-thumbnail 2023-07-20 21:18:14 +00:00
package.json Bump debug, @microsoft/sp-build-web and @microsoft/sp-webpart-workbench 2023-01-12 08:49:09 -05:00
preview.gif Added preview for the thumbnail sample 2020-01-22 09:09:11 +01:00
tsconfig.json Added Graph thumbnail API sample 2020-01-21 17:02:21 +01:00
tslint.json Added Graph thumbnail API sample 2020-01-21 17:02:21 +01:00

README.md

Thumbnail/preview of pages and files in SharePoint

Summary

A web part showcasing how to call the Microsoft Graph Thumbnails API to generate a preview image for files and pages in SharePoint. The sample illustrates how to craft the preview URL both from a search result as well as from a SharePoint item object.

Note that a preview for all file formats (eg. Excel) might not currently be available.

web part sample

The sample calls the Microsoft Graph API directly directly via the _api/2.0 endpoint in SharePoint Online, but can easily be changed to call the Graph API endpoint directly for scenarios outside of SharePoint as long as an access token is retrieved.

The goal of the sample is to illustrate a single call calling pattern for the thumbnail with the following calling pattern:

<img src="<endpoint>/sites/<site id>/lists/<list id>/items/<item id>/driveItem/thumbnails/0/<custom size>/content">
Token Description
endpoint graph.microsoft.com/v1.0
tenant.sharepoint.com/_api/v2.0
site id Site object id - GUID.
list id List object id - GUID.
item id ListItem object id or unique id - Integer/GUID.
custom size See Requesting custom thumbnail sizes in the official Microsoft Graph documentation.

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.10.0 Node.js 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 Compatible Compatible with Remote Containers

Applies to

Contributors

Version history

Version Date Comments
1.0 January 21st, 2020 Initial release

Minimal Path to Awesome

Local testing

  • Clone this repository
  • In the command line run:
    • npm install
    • gulp serve

Deploy

  • gulp clean
  • gulp bundle --ship
  • gulp package-solution --ship
  • Upload the js-msgraph-thumbnail.sppkg file from sharepoint\solution to your tenant App Catalog
    • E.g.: https://<tenant>.sharepoint.com/sites/AppCatalog/AppCatalog
  • Add the web part Thumbnail to a site collection where you have files in the Shared Documents folder, and test it on a page.
  • Change const libraryPath = "Shared Documents"; if you want to target SitePages or a different library.

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're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

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.