Skip to content

Commit a0ce2f4

Browse files
musalegavinbarron
andauthored
chore(docs): update README docs for mgt packages (#2626)
Update README docs for mgt Update the README docs for mgt-components Add links to mgt-picker component --------- Signed-off-by: Martin Musale <[email protected]> Co-authored-by: Gavin Barron <[email protected]>
1 parent 28703c9 commit a0ce2f4

File tree

3 files changed

+35
-20
lines changed

3 files changed

+35
-20
lines changed

packages/mgt-components/README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,23 @@ You can explore components and samples with the [playground](https://mgt.dev) po
1313

1414
The Toolkit currently includes the following components:
1515

16+
* [mgt-agenda](https://learn.microsoft.com/graph/toolkit/components/agenda)
17+
* [mgt-file](https://learn.microsoft.com/graph/toolkit/components/file)
18+
* [mgt-file-list](https://learn.microsoft.com/graph/toolkit/components/file-list)
19+
* [mgt-get](https://learn.microsoft.com/graph/toolkit/components/get)
1620
* [mgt-login](https://learn.microsoft.com/graph/toolkit/components/login)
17-
* [mgt-person](https://learn.microsoft.com/graph/toolkit/components/person)
18-
* [mgt-person-card](https://learn.microsoft.com/graph/toolkit/components/person-card)
1921
* [mgt-people](https://learn.microsoft.com/graph/toolkit/components/people)
2022
* [mgt-people-picker](https://learn.microsoft.com/graph/toolkit/components/people-picker)
21-
* [mgt-agenda](https://learn.microsoft.com/graph/toolkit/components/agenda)
23+
* [mgt-person](https://learn.microsoft.com/graph/toolkit/components/person)
24+
* [mgt-person-card](https://learn.microsoft.com/graph/toolkit/components/person-card)
25+
* [mgt-picker](https://learn.microsoft.com/en-us/graph/toolkit/components/picker)
26+
* [mgt-search-box](https://learn.microsoft.com/graph/toolkit/components/person-box)
27+
* [mgt-search-results](https://learn.microsoft.com/graph/toolkit/components/search-results)
2228
* [mgt-tasks](https://learn.microsoft.com/graph/toolkit/components/tasks)
23-
* [mgt-todo](https://learn.microsoft.com/graph/toolkit/components/todo)
24-
* [mgt-get](https://learn.microsoft.com/graph/toolkit/components/get)
29+
* [mgt-taxonomy-picker](https://learn.microsoft.com/graph/toolkit/components/taxonomy-picker)
2530
* [mgt-teams-channel-picker](https://learn.microsoft.com/graph/toolkit/components/teams-channel-picker)
31+
* [mgt-theme-toggle](https://learn.microsoft.com/graph/toolkit/components/theme-toggle)
32+
* [mgt-todo](https://learn.microsoft.com/graph/toolkit/components/todo)
2633

2734
The components work best when used with a [provider](https://learn.microsoft.com/graph/toolkit/providers). The provider handles authentication and the requests to the Microsoft Graph APIs used by the components.
2835

packages/mgt/README.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,34 @@ The Microsoft Graph Toolkit includes a collection of web components for the most
1515

1616
The components are also available as [React components](https://learn.microsoft.com/graph/toolkit/get-started/mgt-react).
1717

18+
* [mgt-agenda](https://learn.microsoft.com/graph/toolkit/components/agenda)
19+
* [mgt-file](https://learn.microsoft.com/graph/toolkit/components/file)
20+
* [mgt-file-list](https://learn.microsoft.com/graph/toolkit/components/file-list)
21+
* [mgt-get](https://learn.microsoft.com/graph/toolkit/components/get)
1822
* [mgt-login](https://learn.microsoft.com/graph/toolkit/components/login)
19-
* [mgt-person](https://learn.microsoft.com/graph/toolkit/components/person)
20-
* [mgt-person-card](https://learn.microsoft.com/graph/toolkit/components/person-card)
2123
* [mgt-people](https://learn.microsoft.com/graph/toolkit/components/people)
2224
* [mgt-people-picker](https://learn.microsoft.com/graph/toolkit/components/people-picker)
23-
* [mgt-agenda](https://learn.microsoft.com/graph/toolkit/components/agenda)
25+
* [mgt-person](https://learn.microsoft.com/graph/toolkit/components/person)
26+
* [mgt-person-card](https://learn.microsoft.com/graph/toolkit/components/person-card)
27+
* [mgt-picker](https://learn.microsoft.com/en-us/graph/toolkit/components/picker)
28+
* [mgt-search-box](https://learn.microsoft.com/graph/toolkit/components/person-box)
29+
* [mgt-search-results](https://learn.microsoft.com/graph/toolkit/components/search-results)
2430
* [mgt-tasks](https://learn.microsoft.com/graph/toolkit/components/tasks)
25-
* [mgt-todo](https://learn.microsoft.com/graph/toolkit/components/todo)
26-
* [mgt-get](https://learn.microsoft.com/graph/toolkit/components/get)
31+
* [mgt-taxonomy-picker](https://learn.microsoft.com/graph/toolkit/components/taxonomy-picker)
2732
* [mgt-teams-channel-picker](https://learn.microsoft.com/graph/toolkit/components/teams-channel-picker)
33+
* [mgt-theme-toggle](https://learn.microsoft.com/graph/toolkit/components/theme-toggle)
34+
* [mgt-todo](https://learn.microsoft.com/graph/toolkit/components/todo)
2835

2936
## Providers
3037
[Providers](https://learn.microsoft.com/graph/toolkit/providers) enable authentication and provide the implementation for acquiring access tokens on various platforms and expose a Microsoft Graph Client for calling the Microsoft Graph APIs. The components work best when used with a provider, but the providers can be used on their own.
3138

32-
* [Msal Provider](https://learn.microsoft.com/graph/toolkit/providers/msal)
33-
* [Msal2 Provider](https://learn.microsoft.com/graph/toolkit/providers/msal2)
34-
* [SharePoint Provider](https://learn.microsoft.com/graph/toolkit/providers/sharepoint)
35-
* [Teams Provider](https://learn.microsoft.com/graph/toolkit/providers/teams)
36-
* [Teams Msal2 Provider](https://learn.microsoft.com/graph/toolkit/providers/teams-msal2)
37-
* [Proxy Provider](https://learn.microsoft.com/graph/toolkit/providers/proxy)
38-
* [Simple Provider](https://learn.microsoft.com/graph/toolkit/providers/custom)
39+
* [Msal2Provider](https://learn.microsoft.com/graph/toolkit/providers/msal2)
40+
* [SharePointProvider](https://learn.microsoft.com/graph/toolkit/providers/sharepoint)
41+
* [TeamsFxProvider](https://learn.microsoft.com/graph/toolkit/providers/teamsfx)
42+
* [ProxyProvider](https://learn.microsoft.com/graph/toolkit/providers/proxy)
43+
* [SimpleProvider](https://learn.microsoft.com/graph/toolkit/providers/custom)
44+
* [ElectronProvider](https://learn.microsoft.com/graph/toolkit/providers/electron)
45+
3946

4047
## Getting Started
4148

@@ -46,15 +53,15 @@ You can use the components by referencing the loader directly (via unpkg), or in
4653
### Use via mgt-loader:
4754

4855
```html
49-
<script src="https://unpkg.com/@microsoft/mgt@2/dist/bundle/mgt-loader.js"></script>
56+
<script src="https://unpkg.com/@microsoft/mgt@3/dist/bundle/mgt-loader.js"></script>
5057
```
5158

52-
> NOTE: This link will load the highest available version of @microsoft/mgt in the range `>= 2.0.0 < 3.0.0`, omitting the `@2` fragment from the url results in loading the latest version. This could result in loading a new major version and breaking the application.
59+
> NOTE: This link will load the highest available version of @microsoft/mgt in the range `>= 3.0.0 < 4.0.0`, omitting the `@3` fragment from the url results in loading the latest version. This could result in loading a new major version and breaking the application.
5360
5461
You can then start using the components in your html page. Here is a full working example with the Msal2 provider:
5562

5663
```html
57-
<script src="https://unpkg.com/@microsoft/mgt@2/dist/bundle/mgt-loader.js"></script>
64+
<script src="https://unpkg.com/@microsoft/mgt@3/dist/bundle/mgt-loader.js"></script>
5865

5966
<mgt-msal2-provider client-id="[CLIENT-ID]"></mgt-msal2-provider>
6067

readme.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ The Toolkit currently includes the following components:
6262
* [mgt-people-picker](https://learn.microsoft.com/graph/toolkit/components/people-picker)
6363
* [mgt-person](https://learn.microsoft.com/graph/toolkit/components/person)
6464
* [mgt-person-card](https://learn.microsoft.com/graph/toolkit/components/person-card)
65+
* [mgt-picker](https://learn.microsoft.com/en-us/graph/toolkit/components/picker)
6566
* [mgt-search-box](https://learn.microsoft.com/graph/toolkit/components/person-box)
6667
* [mgt-search-results](https://learn.microsoft.com/graph/toolkit/components/search-results)
6768
* [mgt-tasks](https://learn.microsoft.com/graph/toolkit/components/tasks)

0 commit comments

Comments
 (0)