Skip to content

Latest commit

 

History

History
124 lines (78 loc) · 6.28 KB

readme.md

File metadata and controls

124 lines (78 loc) · 6.28 KB
Raw

Microsoft Graph Toolkit

NPM Licence code style: prettier stackoverflow Build Status Published on webcomponents.org

The Microsoft Graph Toolkit is a collection of web components powered by the Microsoft Graph.

Components are functional and work automatically with the Microsoft Graph

Components work with any web framework and on all modern browsers. IE 11 is also supported

Here is a quick jsfiddle

Components & Documentation

The toolkit currently includes the following components:

And the following providers:

View the full documentation

Getting Started

Watch the Getting Started Video

You can use the components by referencing the loader directly (via unpkg), or installing the npm package

Use via mgt-loader:

<script src="https://unpkg.com/@microsoft/mgt/dist/bundle/mgt-loader.js"></script>

You can then start using the components in your html page. Here is a full working example with the Msal provider:

<script src="https://unpkg.com/@microsoft/mgt/dist/bundle/mgt-loader.js"></script>
<mgt-msal-provider client-id="[CLIENT-ID]"></mgt-msal-provider>
<mgt-login></mgt-login>

<!-- <script>
    // alternatively, you can set the provider in code and provide more options
    mgt.Providers.globalProvider = new mgt.MsalProvider({clientId: '[CLIENT-ID]'});
</script> -->

NOTE: MSAL requires the page to be hosted in a web server for the authentication redirects. If you are just getting started and want to play around, the quickest way is to use something like live server in vscode.

Use via NPM:

The benefits of using MGT through NPM is that you have full control of the bundling process and you can bundle only the code you need for your site. First, add the npm package:

npm install @microsoft/mgt

Now you can reference all components at the page you are using:

<script src="node_modules/@microsoft/mgt/dist/es6/components.js"></script>

Or, just reference the component you need and avoid loading everything else:

<script src="node_modules/@microsoft/mgt/dist/es6/components/mgt-login/mgt-login.js"></script>

Similarly, to add a provider, you can add it as a component:

<script src="node_modules/@microsoft/mgt/dist/es6/components/providers/mgt-msal-provider.js"></script>

<mgt-msal-provider client-id="[CLIENT-ID]"></mgt-msal-provider>

or, add it in your code:

<script type="module">
  import { Providers, MsalProvider } from '@microsoft/mgt';

  Providers.globalProvider = new MsalProvider({ clientId: '[CLIENT-ID]' });
</script>

Providers

The components work best when used with a provider. The provider exposes authentication and Microsoft Graph apis used by the components to call into the Microsoft Graph.

The toolkit contains providers for MSAL, SharePoint, and Teams. You can also create your own providers by extending the IProvider abstract class.

Contribute

We enthusiastically welcome contributions and feedback. Please read the contributing guide before you begin.

Feedback and Requests

For general questions and support, please use Stack Overflow where questions should be tagged with microsoft-graph-toolkit

Please use GitHub Issues for bug reports and feature requests. We highly recommend you browse existing issues before opening new issues.

License

Copyright (c) Microsoft and Contributors. All right reserved. Licensed under the MIT License

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.