# FAST 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.svg)](https://badge.fury.io/js/%40microsoft%2Ffast-components) `@microsoft/fast-components` is a library of Web Components that *composes* the exports of `@microsoft/fast-foundation` with stylesheets aligning to the FAST design language. This composition step registers a custom element. See the [quick start](https://fast.design/docs/components/getting-started) to get started using the components. ## Installation ### From NPM To install the `@microsoft/fast-components` library, use either `npm` or `yarn` as follows: ```shell npm install --save @microsoft/fast-components @microsoft/fast-foundation ``` ```shell yarn add @microsoft/fast-components @microsoft/fast-foundation ``` Within your JavaScript or TypeScript code, import and register desired components with the `DesignSystem`: ```ts import { DesignSystem } from "@microsoft/fast-foundation" import { fastAnchor } from '@microsoft/fast-components'; DesignSystem.getOrCreate().register( fastAnchor() ); ``` Alternatively you can easily register all components: ```ts import { DesignSystem } from "@microsoft/fast-foundation" import { allComponents } from '@microsoft/fast-components'; DesignSystem.getOrCreate().register( Object.values(allComponents).map(definition => definition()) ); ``` Looking for a setup that integrates with a particular front-end framework or bundler? Check out [our integration docs](https://fast.design/docs/integrations/introduction). ### From CDN A pre-bundled script that contains all APIs needed to use FAST Foundation is available on CDN. You can use this script by adding [`type="module"`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) to the script element and then importing from the CDN. ```html ``` The markup above always references the latest release. When deploying to production, you will want to ship with a specific version. Here's an example of the markup for that: ```html ``` :::note 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. ::: ## Development To start the component development environment, run `yarn start`. ### Known issue with Storybook site hot-reloading Storybook will watch modules for changes and hot-reload the module when necessary. This is usually great but poses a problem when the module being hot-reloaded defines a custom element. A custom element name can only be defined by the `CustomElementsRegistry` once, so reloading a module that defines a custom element will attempt to re-register the custom element name, throwing an error because the name has already been defined. This error will manifest with the following message: `Failed to execute 'define' on 'CustomElementRegistry': the name "my-custom-element-name" has already been used with this registry` This is a known issue and will indicate that you need to refresh the page. We're working on surfacing a more instructive error message for this case.

	Stars	Issues	Version	Updated	Created
@microsoft/fast-components	9,041	439	2.30.6	2 years ago	4 years ago
@stencil/core			4.18.0	2 days ago	7 years ago
@vue/web-component-wrapper			1.3.0	3 years ago	6 years ago
lit-html	17,614	495	3.1.3	22 days ago	7 years ago

@microsoft/fast-components vs @stencil/core vs @vue/web-component-wrapper vs lit-html

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past