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
Hugo Bernier 68f7f67761 Changed from updated to modificationDateTime 2021-05-02 15:39:42 -04:00
..
assets Changed from updated to modificationDateTime 2021-05-02 15:39:42 -04:00
config Added Graph thumbnail API sample 2020-01-21 17:02:21 +01:00
src Added preview for the thumbnail sample 2020-01-22 09:09:11 +01: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 URL dev.office.com to docs.microsoft.com 2020-06-09 09:09:22 +02:00
gulpfile.js Added Graph thumbnail API sample 2020-01-21 17:02:21 +01:00
package-lock.json Added Graph thumbnail API sample 2020-01-21 17:02:21 +01:00
package.json Added Graph thumbnail API sample 2020-01-21 17:02:21 +01: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.

Used SharePoint Framework Version

drop

Applies to

Solution

Solution Author(s)
js-msgraph-thumbnail Mikael Svenson (@mikaelsvenson, techmikael.com)

Version history

Version Date Comments
1.0 January 21st, 2020 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

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.