sp-dev-fx-webparts/samples/react-onedrive-finder/README.md

123 lines
7.1 KiB
Markdown
Raw Normal View History

2021-04-16 05:21:04 -04:00
# OneDrive finder
## Summary
2022-10-24 09:42:45 -04:00
This sample access drives from OneDrive and navigate between his content using **Graph OneDrive and Site API and [Microsoft Graph Toolkit](https://github.com/microsoftgraph/microsoft-graph-toolkit) react controls "@microsoft/mgt-react**" with the addition of new controls **Mgt-File-List [FileList](https://learn.microsoft.com/graph/toolkit/components/file-list)** and **Mgt-File [File](https://learn.microsoft.com/graph/toolkit/components/file)** . This new control provides the ability to retrieve the Drive Library with associated Files and folders making easier to develop and navigate between tenant content and access to file.
2021-04-16 05:21:04 -04:00
2022-10-24 09:42:45 -04:00
**[FileList](https://learn.microsoft.com/graph/toolkit/components/file-list)** control allow to load files base on graph querys or parameters ids.
2022-10-24 09:42:45 -04:00
**[File](https://learn.microsoft.com/graph/toolkit/components/file)** control allow to File component is used to represent an individual file/folder from OneDrive or SharePoint base on graph querys or parameters ids.
Below a draw resuming the custom query's made and what control uses to retrieve associated folders and files from different locations.
2021-11-06 01:12:58 -04:00
![Demo](./assets/OneDrivefinderSample4.PNG)
2021-04-16 05:21:04 -04:00
### Retrieve Sites with drives associate
2021-04-21 23:17:37 -04:00
2021-11-06 01:12:58 -04:00
![Demo](./assets/OneDrivefinderSample1.PNG)
2021-04-21 23:17:37 -04:00
2021-04-16 05:21:04 -04:00
### Navigate between folders and Breadcrumb
2021-04-21 23:17:37 -04:00
2021-11-06 01:12:58 -04:00
![Demo](./assets/OneDrivefinderSample2.PNG)
2021-04-16 05:21:04 -04:00
### Navigate, search Files and filter extensions
2021-11-06 01:12:58 -04:00
![Demo](./assets/OneDrivefinderSample3.gif)
2021-04-16 05:21:04 -04:00
2021-04-21 23:17:37 -04:00
## Compatibility
2021-10-30 22:29:04 -04:00
![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg)
2021-11-01 21:07:49 -04:00
![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg)
2021-10-30 22:29:04 -04:00
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Teams Incompatible](https://img.shields.io/badge/Teams-Incompatible-lightgrey.svg)
![Local Workbench Incompatible](https://img.shields.io/badge/Local%20Workbench-Incompatible-red.svg "This solution requires access to Microsoft Graph")
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
2022-02-15 00:37:36 -05:00
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
2021-04-16 05:21:04 -04:00
## Applies to
- [SharePoint Framework](https://aka.ms/spfx)
2022-10-24 09:42:45 -04:00
- [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
2021-04-16 05:21:04 -04:00
## Solution
Solution|Author(s)
--------|---------
2021-05-23 12:34:41 -04:00
react-onedrive-finder | [André Lage](https://github.com/aaclage) ([http://aaclage.blogspot.com](http://aaclage.blogspot.com), [@aaclage](https://twitter.com/aaclage))
2021-04-16 05:21:04 -04:00
## Version history
Version|Date|Comments
-------|----|--------
2021-05-20 18:20:02 -04:00
2.0|May 20, 2021|Update MGT to version 2.2.0, include new Features (Localization, cache refresh).
1.2|April 30, 2021|Include content Search on Drive Library, file details and Minimal style change.
2021-04-26 21:28:04 -04:00
1.1|April 24, 2021|Fixes, optimization, Styling and extension filter included
2021-04-16 05:21:04 -04:00
1.0|April 16, 2021|Initial release
## Minimal Path to Awesome
- Clone this repository
- Ensure that you are at the solution folder
- in the command-line run:
2021-05-23 12:34:41 -04:00
- `npm install`
- `gulp serve`
- `gulp bundle --ship`
- `gulp package-solution --ship`
2021-04-16 05:21:04 -04:00
- Add to AppCatalog and deploy
2022-02-15 00:37:36 -05:00
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.
2021-05-23 12:34:41 -04:00
## Prerequisites
### Grant the service principal permission to the Microsoft Graph API
2021-04-16 05:21:04 -04:00
Once installed, the solution will request the required permissions via the **Office 365 admin portal > SharePoint > Advanced > API access**.
2021-04-21 23:17:37 -04:00
If you prefer to approve the permissions in advance, for example when testing the solution in the Workbench page without installing it, you can do so using the [CLI for Microsoft 365](https://pnp.github.io/cli-microsoft365/):
2021-04-16 05:21:04 -04:00
```bash
o365 spo login https://contoso-admin.sharepoint.com
o365 spo serviceprincipal grant add --resource 'Microsoft Graph' --scope 'Files.Read'
o365 spo serviceprincipal grant add --resource 'Microsoft Graph' --scope 'Files.Read.All'
o365 spo serviceprincipal grant add --resource 'Microsoft Graph' --scope 'Sites.Read.All'
```
## Features
Description of the extension that expands upon high-level summary above.
This extension illustrates the following concepts:
- Easy to navigate between shared Drives using **Graph API and Breadcrumb**
- Search in OneDrive Library
- Filter by File Extension
2021-05-20 18:20:02 -04:00
- Change theme of control and Localization
- Caching refresh
2022-10-24 09:42:45 -04:00
- **[FileList](https://learn.microsoft.com/graph/toolkit/components/file-list)** New mgt-file-list control.
- **[File](https://learn.microsoft.com/graph/toolkit/components/file)** New mgt-file control.
2021-04-16 05:21:04 -04:00
2021-11-06 01:12:58 -04:00
## Video
[![Using Microsoft Graph Toolkit to easily access files in Sites and in OneDrive](./assets/video-thumbnail.jpg)](https://www.youtube.com/watch?v=Xgna1iH55k8 "Using Microsoft Graph Toolkit to easily access files in Sites and in OneDrive")
2021-05-23 12:34:41 -04:00
2021-11-01 21:07:49 -04:00
## Help
2021-05-23 12:34:41 -04:00
2021-11-06 01:12:58 -04:00
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](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-onedrive-finder") to see if anybody else is having the same issues.
2021-11-06 01:12:58 -04:00
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-onedrive-finder) and see what the community is saying.
2021-05-23 12:34:41 -04:00
2021-11-20 23:55:10 -05:00
If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-onedrive-finder&template=bug-report.yml&sample=react-onedrive-finder&authors=@aaclage&title=react-onedrive-finder%20-%20).
2021-05-23 12:34:41 -04:00
2021-11-20 23:55:10 -05:00
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-onedrive-finder&template=question.yml&sample=react-onedrive-finder&authors=@aaclage&title=react-onedrive-finder%20-%20).
2021-05-23 12:34:41 -04:00
2021-11-20 23:55:10 -05:00
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-onedrive-finder&template=question.yml&sample=react-onedrive-finder&authors=@aaclage&title=react-onedrive-finder%20-%20).
2021-05-23 12:34:41 -04:00
2021-12-20 10:25:30 -05:00
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-onedrive-finder" />
2021-04-16 05:21:04 -04:00