From a10c20ee09a56a22f8edd2dfb7bf3e62a58ee6e9 Mon Sep 17 00:00:00 2001 From: Chris Holt Date: Tue, 4 Aug 2020 13:24:00 -0700 Subject: [PATCH] Change files --- ...hol-update-web-components-package-name.json | 8 ++++++++ packages/web-components/README.md | 18 +++++++++--------- 2 files changed, 17 insertions(+), 9 deletions(-) create mode 100644 change/@fluentui-web-components-2020-08-04-13-24-00-users-chhol-update-web-components-package-name.json diff --git a/change/@fluentui-web-components-2020-08-04-13-24-00-users-chhol-update-web-components-package-name.json b/change/@fluentui-web-components-2020-08-04-13-24-00-users-chhol-update-web-components-package-name.json new file mode 100644 index 00000000000000..dba44067288668 --- /dev/null +++ b/change/@fluentui-web-components-2020-08-04-13-24-00-users-chhol-update-web-components-package-name.json @@ -0,0 +1,8 @@ +{ + "type": "minor", + "comment": "feat: update web components package namespace and opt-in to change and publish process", + "packageName": "@fluentui/web-components", + "email": "chhol@microsoft.com", + "dependentChangeType": "patch", + "date": "2020-08-04T20:24:00.935Z" +} diff --git a/packages/web-components/README.md b/packages/web-components/README.md index cb62dfa6b506f2..c363fc749d6513 100644 --- a/packages/web-components/README.md +++ b/packages/web-components/README.md @@ -1,28 +1,28 @@ -# FAST Components MSFT +# Fluent UI Web Components [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![npm version](https://badge.fury.io/js/%40microsoft%2Ffast-components-msft.svg)](https://badge.fury.io/js/%40microsoft%2Ffast-components-msft) +[![npm version](https://badge.fury.io/js/%40microsoft%2Fweb-components.svg)](https://badge.fury.io/js/%40microsoft%2Fweb-components) -`fast-components-msft` is a library of Web Components that _composes_ `fast-foundation`. `fast-components-msft` uses the same custom element names as `fast-components`, but makes use of different stylesheets that support Microsoft's Fluent design language. +`@fluentui/web-components` is a library of Web Components that _composes_ `@microsoft/fast-foundation` and supports Microsoft's Fluent design language. ## Installation ### From NPM -To install the `fast-components-msft` library, use either `npm` or `yarn` as follows: +To install the `web-components` library, use either `npm` or `yarn` as follows: ```shell -npm install --save @microsoft/fast-components-msft +npm install --save @fluentui/web-components ``` ```shell -yarn add @microsoft/fast-components-msft +yarn add @fluentui/web-components ``` Within your JavaScript or TypeScript code, you can then import library APIs like this: ```ts -import { FASTAnchor } from '@microsoft/fast-components-msft'; +import { FASTAnchor } from '@fluentui/web-components'; ``` Looking for a setup that integrates with a particular front-end framework or bundler? Check out [our integration docs](http://fast.design/docs/integrations/introduction). @@ -35,13 +35,13 @@ A pre-bundled script that contains all APIs needed to use FAST Foundation is ava - + ``` -The above CDN location points to the latest release of `fast-components`. It is advised that when you deploy your site or app, you import the specific version you have developed and tested with. +The above CDN location points to the latest release of `@fluentui/web-components`. It is advised that when you deploy your site or app, you import the specific version you have developed and tested with. For simplicity, examples throughout the documentation will assume the library has been installed from NPM, but you can always replace the import location with the CDN URL.