This is a prerelease version of FAST (3.0.0-rc.3).

@microsoft/fast-element > FASTElementConstructor > define

FASTElementConstructor.define() method

Defines a platform custom element based on the provided type and definition.

Signature:

define<TType extends Constructable<HTMLElement> = Constructable<HTMLElement>>(type: TType, nameOrDef?: string | PartialFASTElementDefinition<TType>, extensions?: FASTElementExtension[]): Promise<TType>;

Parameters

Parameter

Type

Description

type

TType

The custom element type to define.

nameOrDef

string | PartialFASTElementDefinition<TType>

(Optional) The name of the element to define or a definition object.

extensions

FASTElementExtension[]

(Optional) Optional callbacks to run before registration.

Returns:

Promise<TType>