Skip to content

Commit 5569244

Browse files
authored
Merge pull request #2557 from microsoftgraph/main
chore: fix storybook and update readme
2 parents 8557dd2 + e979212 commit 5569244

File tree

3 files changed

+53
-16
lines changed

3 files changed

+53
-16
lines changed

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,6 @@
170170
"@typescript-eslint/eslint-plugin": "^5.54.0",
171171
"@typescript-eslint/eslint-plugin-tslint": "^5.54.0",
172172
"@typescript-eslint/parser": "^5.54.0",
173-
"commander": "^10.0.0",
174173
"responselike": "2.0.0"
175174
}
176175
}

readme.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,8 @@ In addition to the `@next` preview packages, we also ship packages under several
4343
| Tag | Description |
4444
| --------------- | ------------------------------------------------------------------------ |
4545
| `next` | Next release - updated on each commit to `main` |
46-
| `next.fluentui` | Next major release (v3) with components based on FluentUI web components |
4746

48-
To install these packages, use the tag as the version in your `npm i` command. Ex: `npm i @microsoft/mgt-element@next.fluentui`. Make sure to install the same version for all mgt packages to avoid any conflicts. Keep in mind, these are features in preview and are not recommended for production use.
47+
To install these packages, use the tag as the version in your `npm i` command. Ex: `npm i @microsoft/mgt-element@next`. Make sure to install the same version for all mgt packages to avoid any conflicts. Keep in mind, these are features in preview and are not recommended for production use.
4948

5049

5150
## Components
@@ -54,18 +53,23 @@ You can explore components and samples with the [playground](https://mgt.dev) po
5453

5554
The Toolkit currently includes the following components:
5655

56+
* [mgt-agenda](https://learn.microsoft.com/graph/toolkit/components/agenda)
57+
* [mgt-file](https://learn.microsoft.com/graph/toolkit/components/file)
58+
* [mgt-file-list](https://learn.microsoft.com/graph/toolkit/components/file-list)
59+
* [mgt-get](https://learn.microsoft.com/graph/toolkit/components/get)
5760
* [mgt-login](https://learn.microsoft.com/graph/toolkit/components/login)
58-
* [mgt-person](https://learn.microsoft.com/graph/toolkit/components/person)
59-
* [mgt-person-card](https://learn.microsoft.com/graph/toolkit/components/person-card)
6061
* [mgt-people](https://learn.microsoft.com/graph/toolkit/components/people)
6162
* [mgt-people-picker](https://learn.microsoft.com/graph/toolkit/components/people-picker)
62-
* [mgt-agenda](https://learn.microsoft.com/graph/toolkit/components/agenda)
63+
* [mgt-person](https://learn.microsoft.com/graph/toolkit/components/person)
64+
* [mgt-person-card](https://learn.microsoft.com/graph/toolkit/components/person-card)
65+
* [mgt-search-box](https://learn.microsoft.com/graph/toolkit/components/person-box)
66+
* [mgt-search-results](https://learn.microsoft.com/graph/toolkit/components/search-results)
6367
* [mgt-tasks](https://learn.microsoft.com/graph/toolkit/components/tasks)
64-
* [mgt-todo](https://learn.microsoft.com/graph/toolkit/components/todo)
68+
* [mgt-taxonomy-picker](https://learn.microsoft.com/graph/toolkit/components/taxonomy-picker)
6569
* [mgt-teams-channel-picker](https://learn.microsoft.com/graph/toolkit/components/teams-channel-picker)
66-
* [mgt-file](https://learn.microsoft.com/graph/toolkit/components/file)
67-
* [mgt-file-list](https://learn.microsoft.com/graph/toolkit/components/file-list)
68-
* [mgt-get](https://learn.microsoft.com/graph/toolkit/components/get)
70+
* [mgt-theme-toggle](https://learn.microsoft.com/graph/toolkit/components/theme-toggle)
71+
* [mgt-todo](https://learn.microsoft.com/graph/toolkit/components/todo)
72+
6973

7074
All web components are also available as React component - see [@microsoft/mgt-react documentation](https://learn.microsoft.com/graph/toolkit/get-started/mgt-react).
7175

@@ -90,7 +94,6 @@ The following guides are available to help you get started with the Toolkit:
9094
* [Build a web application (JavaScript)](https://learn.microsoft.com/graph/toolkit/get-started/build-a-web-app)
9195
* [Build a SharePoint web part Part](https://learn.microsoft.com/graph/toolkit/get-started/build-a-sharepoint-web-part)
9296
* [Build a Microsoft Teams tab](https://learn.microsoft.com/graph/toolkit/get-started/build-a-microsoft-teams-tab)
93-
* [Build a Microsoft Teams tab with SSO](https://learn.microsoft.com/en-us/graph/toolkit/get-started/build-a-microsoft-teams-sso-tab)
9497
* [Build an Electron app](https://learn.microsoft.com/en-us/graph/toolkit/get-started/build-an-electron-app)
9598
* [Use the Toolkit with React](https://learn.microsoft.com/graph/toolkit/get-started/use-toolkit-with-react)
9699
* [Use the Toolkit with Angular](https://learn.microsoft.com/graph/toolkit/get-started/use-toolkit-with-angular)
@@ -101,15 +104,15 @@ You can use the components by referencing the loader directly (via unpkg), or in
101104
### Use via mgt-loader:
102105

103106
```html
104-
<script src="https://unpkg.com/@microsoft/mgt@2/dist/bundle/mgt-loader.js"></script>
107+
<script src="https://unpkg.com/@microsoft/mgt@3/dist/bundle/mgt-loader.js"></script>
105108
```
106109

107-
> 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.
110+
> 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.
108111
109-
You can then start using the components in your html page. Here is a full working example with the Msal2 provider:
112+
You can then start using the components in your html page. Here is a full working example with the MSAL2 provider:
110113

111114
```html
112-
<script src="https://unpkg.com/@microsoft/mgt@2/dist/bundle/mgt-loader.js"></script>
115+
<script src="https://unpkg.com/@microsoft/mgt@3/dist/bundle/mgt-loader.js"></script>
113116
<mgt-msal2-provider client-id="[CLIENT-ID]"></mgt-msal2-provider>
114117
<mgt-login></mgt-login>
115118

yarn.lock

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14270,11 +14270,46 @@ command-line-usage@^7.0.0, command-line-usage@^7.0.1:
1427014270
table-layout "^3.0.0"
1427114271
typical "^7.1.1"
1427214272

14273-
commander@*, commander@2.17.x, commander@^10.0.0, commander@^2.11.0, commander@^2.12.1, commander@^2.18.0, commander@^2.20.0, commander@^2.7.1, commander@^4.0.0, commander@^4.1.1, commander@^6.2.1, commander@^7.0.0, commander@^7.2.0, commander@^8.3.0, commander@~2.19.0:
14273+
commander@*, commander@^10.0.0:
1427414274
version "10.0.1"
1427514275
resolved "https://registry.npmjs.org/commander/-/commander-10.0.1.tgz"
1427614276
integrity sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==
1427714277

14278+
14279+
version "2.17.1"
14280+
resolved "https://registry.yarnpkg.com/commander/-/commander-2.17.1.tgz#bd77ab7de6de94205ceacc72f1716d29f20a77bf"
14281+
integrity sha512-wPMUt6FnH2yzG95SA6mzjQOEKUU3aLaDEmzs1ti+1E9h+CsrZghRlqEM/EJ4KscsQVG8uNN4uVreUeT8+drlgg==
14282+
14283+
commander@^2.11.0, commander@^2.12.1, commander@^2.18.0, commander@^2.20.0, commander@^2.7.1:
14284+
version "2.20.3"
14285+
resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"
14286+
integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==
14287+
14288+
commander@^4.0.0, commander@^4.1.1:
14289+
version "4.1.1"
14290+
resolved "https://registry.yarnpkg.com/commander/-/commander-4.1.1.tgz#9fd602bd936294e9e9ef46a3f4d6964044b18068"
14291+
integrity sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==
14292+
14293+
commander@^6.2.1:
14294+
version "6.2.1"
14295+
resolved "https://registry.yarnpkg.com/commander/-/commander-6.2.1.tgz#0792eb682dfbc325999bb2b84fddddba110ac73c"
14296+
integrity sha512-U7VdrJFnJgo4xjrHpTzu0yrHPGImdsmD95ZlgYSEajAn2JKzDhDTPG9kBTefmObL2w/ngeZnilk+OV9CG3d7UA==
14297+
14298+
commander@^7.0.0, commander@^7.2.0:
14299+
version "7.2.0"
14300+
resolved "https://registry.yarnpkg.com/commander/-/commander-7.2.0.tgz#a36cb57d0b501ce108e4d20559a150a391d97ab7"
14301+
integrity sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==
14302+
14303+
commander@^8.3.0:
14304+
version "8.3.0"
14305+
resolved "https://registry.yarnpkg.com/commander/-/commander-8.3.0.tgz#4837ea1b2da67b9c616a67afbb0fafee567bca66"
14306+
integrity sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==
14307+
14308+
commander@~2.19.0:
14309+
version "2.19.0"
14310+
resolved "https://registry.yarnpkg.com/commander/-/commander-2.19.0.tgz#f6198aa84e5b83c46054b94ddedbfed5ee9ff12a"
14311+
integrity sha512-6tvAOO+D6OENvRAh524Dh9jcfKTYDQAqvqezbCW82xj5X0pSrcpxtvRKHLG0yBY6SD7PSDrJaj+0AiOcKVd1Xg==
14312+
1427814313
1427914314
version "1.2.4"
1428014315
resolved "https://registry.npmjs.org/comment-parser/-/comment-parser-1.2.4.tgz"

0 commit comments

Comments
 (0)