Getting Started with FAST Element

License: MIT npm version

The fast-element library is a lightweight means to easily build performant, memory-efficient, standards-compliant Web Components. FAST Elements work in every major browser and can be used in combination with any front-end framework or even without a framework.

Installation

From NPM

To install the fast-element library, use either npm or yarn as follows:

npm install --save @microsoft/fast-element
yarn add @microsoft/fast-element

Within your JavaScript or TypeScript code, you can then import library APIs like this:

import { FASTElement } from '@microsoft/fast-element';
tip

Looking for a setup that integrates with a particular front-end framework or bundler? Check out our integration docs.

From CDN

A pre-bundled script that contains all APIs needed to build web components with FAST Element is available on CDN. You can use this script by adding type="module" to the script element and then importing from the CDN.

<!DOCTYPE html>
<html lang="en">
<head>
<script type="module">
import { FASTElement } from "https://unpkg.com/@microsoft/fast-element";
// your code here
</script>
</head>
<!-- ... -->
</html>
important

The above CDN location points to the latest release of fast-element. It is advised that when you deploy your site or app, you import the specific version you have developed and tested with.

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.