ARCHITECTURE_OVERVIEW.md

General FAST usage

FASTElement is an extension of HTMLElement which makes use of Custom Element APIs native to the browser. It also supplies the following methods:

• The compose method combines the Custom Element name, template, style, and other options to create the definition for the Custom Element.
• The define method makes use of the native Custom Element define() to register the Custom Element with a Custom Element Registry.
• The from method allows the use of Customized Built-in elements, which extend from native elements such as HTMLButtonElement.

Creating a Custom Element from FASTElement

A basic developer flow for defining a custom element looks like this:

flowchart TD
    A[Create a <code>FASTElement</code> web component by extending the <code>FASTElement</code> class] --> F
    F[Compose with <code>FASTElement.compose</code> to include template and styles] --> G[Define the component in the browser with <code>FASTElement.define</code>]

Loading

Let's take a look at the compose step to see what the FAST architecture is doing at this stage.

Composing a Custom Element

The FASTElement.compose() function creates a new FASTElementDefinition, which includes all metadata needed for the element (such as templates, attributes, and styles). The element definition is registered with the global FAST for re-use, and the FASTElementDefinition is returned. The resulting object can be retrieved via ElementController.definition.

A Custom Element in JavaScript is sent to the Browser

Let's step back from defining the Custom Element and consider what is happening when we import from the @microsoft/fast-element package.

First, a global FAST property will be created if one does not already exist, typically in browser on the window.

Additionally, when Custom Elements are included in a script a few things might happen even before a Custom Element gets detected by the browser. First, there are initial side effects caused by the use of decorators. These include the attr decorator from @microsoft/fast-element and the observable decorator from @microsoft/fast-element.

Here is a basic flow of what code is executed and when during initial load of a script that contains a FAST defined Custom Element:

flowchart TD
    A@{ shape: circle, label: "The browser loads the JavaScript file containing FAST and FAST Custom Element definitions" }
    B@{ shape: rect, label: "The FAST global is added to the window" }
    A --> B
    C@{ shape: rect, label: "A Custom Element executes the <code>compose</code> step"}
    B --> C
    D@{ shape: procs, label: "<ul style='text-align: left'><li>Any defined observable decorators are added to the FAST global</li><li>An attribute decorator locates the associated Custom Elements constructor which it uses to push itself to the Custom Elements attribute collection</li></ul>"}
    C --> D
    F@{ shape: rect, label: "An HTML tagged template literal is executed for the FAST Custom Element and applied to the definition" }
    D --> F
    G@{ shape: rect, label: "The <code>define</code> step is hit and the <code>customElement</code> is registered with the Custom Element Registry" }
    F --> G
    H@{ shape: rect, label: "A Custom Element is detected on the page and the browser initializes it" }
    I@{ shape: dbl-circ, label: "The lifecycle steps for <code>FASTElement</code> are executed" }
    G --> H
    H --> I

Loading