Skip to main content

fast-foundation

Classes

ClassDescription
AccordionAn Accordion Custom HTML Element Implements ARIA Accordion.
AccordionItemAn individual item in an Accordion.start - Content which can be provided between the heading and the iconend - Content which can be provided between the start slot and iconheading - Content which serves as the accordion item heading and text of the expand button- The default slot for accordion item contentexpanded-icon - The expanded iconcollapsed-icon - The collapsed iconchange - Fires a custom 'change' event when the button is invokedheading - Wraps the buttonbutton - The button which serves to invoke the itemheading-content - Wraps the slot for the heading content within the buttonicon - The icon containerexpanded-icon - The expanded icon slotcollapsed-icon - The collapsed iconregion - The wrapper for the accordion item content
AnchorAn Anchor Custom HTML Element. Based largely on the <a> element.start - Content which can be provided before the anchor contentend - Content which can be provided after the anchor content- The default slot for anchor contentcontrol - The anchor elementcontent - The element wrapping anchor content
AnchoredRegionAn anchored region Custom HTML Element.- The default slot for the contentloaded - Fires a custom 'loaded' event when the region is loaded and visiblepositionchange - Fires a custom 'positionchange' event when the position has changed
ARIAGlobalStatesAndPropertiesSome states and properties are applicable to all host language elements regardless of whether a role is applied. The following global states and properties are supported by all roles and by all base markup elements. https://www.w3.org/TR/wai-aria-1.1/#global_statesThis is intended to be used as a mixin. Be sure you extend FASTElement.
AvatarAn Avatar Custom HTML Elementmedia - Used for media such as an image- The default slot for avatar text, commonly a name or initialsbadge - Used to provide a badge, such as a status badgebackplate - The wrapping container for the avatarlink - The avatar linkmedia - The media slotcontent - The default slot
BadgeA Badge Custom HTML Element.- The default slot for the badgecontrol - The element representing the badge, which wraps the default slot
BaseProgressAn Progress HTML Element. Implements the ARIA progressbar.indeterminate - The slot for a custom indeterminate indicatorprogress - Represents the progress elementdeterminate - The determinate indicatorindeterminate - The indeterminate indicator
BreadcrumbA Breadcrumb Custom HTML Element.- The default slot for the breadcrumb itemslist - The element wrapping the slotted items
BreadcrumbItemA Breadcrumb Item Custom HTML Element.
ButtonA Button Custom HTML Element. Based largely on the <button> element.start - Content which can be provided before the button contentend - Content which can be provided after the button content- The default slot for button contentcontrol - The button elementcontent - The element wrapping button content
CalendarCalendar component- The default slot for calendar contentdateselected - Fires a custom 'dateselected' event when Enter is invoked via keyboard on a date
CardAn Card Custom HTML Element.- The default slot for the card content
CheckboxA Checkbox Custom HTML Element. Implements the ARIA checkbox.checked-indicator - The checked indicatorindeterminate-indicator - The indeterminate indicator- The default slot for the labelcontrol - The element representing the visual checkbox controllabel - The labelchange - Emits a custom change event when the checked state changes
ComboboxA Combobox Custom HTML Element. Implements the ARIA combobox.start - Content which can be provided before the inputend - Content which can be provided after the inputcontrol - Used to replace the input element representing the comboboxindicator - The visual indicator representing the expanded state- The default slot for the optionscontrol - The wrapper element containing the input area, including start and endselected-value - The input element representing the selected valueindicator - The element wrapping the indicator slotlistbox - The wrapper for the listbox slotted optionschange - Fires a custom 'change' event when the value updates
DataGridA Data Grid Custom HTML Element.- The default slot for custom row elements
DataGridCellA Data Grid Cell Custom HTML Element.cell-focused - Fires a custom 'cell-focused' event when focus is on the cell or its contents- The default slot for cell contents. The "cell contents template" renders here.
DataGridRowA Data Grid Row Custom HTML Element.row-focused - Fires a custom 'row-focused' event when focus is on an element (usually a cell or its contents) in the row- The default slot for custom cell elements
DateFormatterDate formatting utility
DefaultComponentPresentationThe default implementation of ComponentPresentation, used by FoundationElement.
DelegatesARIAButtonIncludes ARIA states and properties relating to the ARIA button role
DelegatesARIAComboboxIncludes ARIA states and properties relating to the ARIA combobox role.
DelegatesARIALinkIncludes ARIA states and properties relating to the ARIA link role
DelegatesARIAListboxIncludes ARIA states and properties relating to the ARIA listbox role
DelegatesARIAListboxOptionStates and properties relating to the ARIA option role.
DelegatesARIASearchIncludes ARIA states and properties relating to the ARIA textbox role
DelegatesARIASelectIncludes ARIA states and properties relating to the ARIA select role.
DelegatesARIATextboxIncludes ARIA states and properties relating to the ARIA textbox role
DelegatesARIAToolbarIncludes ARIA states and properties relating to the ARIA toolbar role
DialogA Switch Custom HTML Element. Implements the ARIA dialog.- The default slot for the dialog contentpositioning-region - A wrapping element used to center the dialog and position the modal overlayoverlay - The modal dialog overlaycontrol - The dialog elementcancel - Fires a custom 'cancel' event when the modal overlay is clickedclose - Fires a custom 'close' event when the dialog is hidden
DisclosureA Disclosure Custom HTML Element. Based largely on the disclosure element.start - Content which can be provided before the summary contentend - Content which can be provided after the summary contenttitle - The summary content- The default slot for the disclosure contenttoggle - fires a toggle event when the summary is toggled
DividerA Divider Custom HTML Element. Implements the ARIA separator or ARIA presentation.
FlipperA Flipper Custom HTML Element. Flippers are a form of button that implies directional content navigation, such as in a carousel.next - The next flipper contentprevious - The previous flipper contentnext - Wraps the next flipper contentprevious - Wraps the previous flipper contentclick - Fires a custom 'click' event when Enter or Space is invoked via keyboard and the flipper is exposed to assistive technologies.
FoundationElementDefines a foundation element class that: 1. Connects the element to its ComponentPresentation 2. Allows resolving the element template from the instance or ComponentPresentation 3. Allows resolving the element styles from the instance or ComponentPresentation
HorizontalScrollA HorizontalScroll Custom HTML Elementstart - Content which can be provided before the scroll areaend - Content which can be provided after the scroll areascroll-area - Wraps the entire scrollable regionscroll-view - The visible scroll areacontent-container - The container for the contentscroll-prev - The previous flipper containerscroll-action-previous - The element wrapping the previous flipperscroll-next - The next flipper containerscroll-action-next - The element wrapping the next flipperscrollstart - Fires a custom 'scrollstart' event when scrollingscrollend - Fires a custom 'scrollend' event when scrolling stops
ListboxA Listbox Custom HTML Element. Implements the ARIA listbox.- The default slot for the listbox options
ListboxElementA Listbox Custom HTML Element. Implements the ARIA listbox.
ListboxOptionAn Option Custom HTML Element. Implements ARIA option.start - Content which can be provided before the listbox option contentend - Content which can be provided after the listbox option content- The default slot for listbox option contentcontent - Wraps the listbox option content
MatchMediaBehaviorAn abstract behavior to react to media queries. Implementations should implement the constructListener method to perform some action based on media query changes.
MatchMediaStyleSheetBehaviorA behavior to add or remove a stylesheet from an element based on a media query. The behavior ensures that styles are applied while the a query matches the environment and that styles are not applied if the query does not match the environment.
MenuA Menu Custom HTML Element. Implements the ARIA menu.- The default slot for the menu items
MenuItemA Switch Custom HTML Element. Implements ARIA menuitem, ARIA menuitemcheckbox, or ARIA menuitemradio.checked-indicator - The checked indicatorradio-indicator - The radio indicatorstart - Content which can be provided before the menu item contentend - Content which can be provided after the menu item content- The default slot for menu item contentexpand-collapse-indicator - The expand/collapse indicatorsubmenu - Used to nest menu's within menu itemsinput-container - The element representing the visual checked or radio indicatorcheckbox - The element wrapping the menuitemcheckbox indicatorradio - The element wrapping the menuitemradio indicatorcontent - The element wrapping the menu item contentexpand-collapse-glyph-container - The element wrapping the expand collapse elementexpand-collapse - The expand/collapse elementsubmenu-region - The container for the submenu, used for positioningexpanded-change - Fires a custom 'expanded-change' event when the expanded state changeschange - Fires a custom 'change' event when a non-submenu item with a role of menuitemcheckbox, menuitemradio, or menuitem is invoked
NumberFieldA Number Field Custom HTML Element. Based largely on the <input type="number" /> element.start - Content which can be provided before the number field inputend - Content which can be provided after the number field input- The default slot for the labelstep-up-glyph - The glyph for the step up controlstep-down-glyph - The glyph for the step down controllabel - The labelroot - The element wrapping the control, including start and end slotscontrol - The element representing the inputcontrols - The step up and step down controlsstep-up - The step up controlstep-down - The step down controlinput - Fires a custom 'input' event when the value has changedchange - Fires a custom 'change' event when the value has changed
PropertyStyleSheetBehaviorA behavior to add or remove a stylesheet from an element based on a property. The behavior ensures that styles are applied while the property matches and that styles are not applied if the property does not match.
RadioA Radio Custom HTML Element. Implements the ARIA radio.checked-indicator - The checked indicator- The default slot for the labelcontrol - The element representing the visual radio controllabel - The labelchange - Emits a custom change event when the checked state changes
RadioGroupAn Radio Group Custom HTML Element. Implements the ARIA radiogroup.label - The slot for the label- The default slot for radio buttonspositioning-region - The positioning region for laying out the radioschange - Fires a custom 'change' event when the value changes
ResolverBuilderA utility class used that constructs and registers resolvers for a dependency injection container. Supports a standard set of object lifetimes.
SearchA Search Custom HTML Element. Based largely on the <input type="search" /> element.start - Content which can be provided before the search inputend - Content which can be provided after the search clear button- The default slot for the labelclose-button - The clear buttonclose-glyph - The clear glyphlabel - The labelroot - The element wrapping the control, including start and end slotscontrol - The element representing the inputclear-button - The button to clear the input
SelectA Select Custom HTML Element. Implements the ARIA select.start - Content which can be provided before the button contentend - Content which can be provided after the button contentbutton-container - The element representing the select buttonselected-value - The selected valueindicator - The visual indicator for the expand/collapse state of the button- The default slot for slotted optionscontrol - The element representing the select invoking elementselected-value - The element wrapping the selected valueindicator - The element wrapping the visual indicatorlistbox - The listbox elementinput - Fires a custom 'input' event when the value updateschange - Fires a custom 'change' event when the value updates
SkeletonA Skeleton Custom HTML Element.- The default slot
SliderA Slider Custom HTML Element. Implements the ARIA slider.track - The track of the slidertrack-start - The track-start visual indicatorthumb - The slider thumb- The default slot for labelspositioning-region - The region used to position the elements of the slidertrack-container - The region containing the track elementstrack-start - The element wrapping the track start slotthumb-container - The thumb container element which is programatically positionedchange - Fires a custom 'change' event when the slider value changes
SliderLabelA label element intended to be used with the Slider component.- The default slot for the label contentroot - The element wrapping the label mark and text
StartEndA mixin class implementing start and end elements. These are generally used to decorate text elements with icons or other visual indicators.
SwitchA Switch Custom HTML Element. Implements the ARIA switch.- The deafult slot for the labelchecked-message - The message when in a checked stateunchecked-message - The message when in an unchecked statelabel - The labelswitch - The element representing the switch, which wraps the indicatorstatus-message - The wrapper for the status messageschecked-message - The checked messageunchecked-message - The unchecked messagechange - Emits a custom change event when the checked state changes
TabA Tab Component to be used with Tabs- The default slot for the tab content
TabPanelA TabPanel Component to be used with Tabs- The default slot for the tabpanel content
TabsA Tabs Custom HTML Element. Implements the ARIA tablist.start - Content which can be provided before the tablist elementend - Content which can be provided after the tablist elementtab - The slot for tabstabpanel - The slot for tabpanelstablist - The element wrapping for the tabstab - The tab slotactiveIndicator - The visual indicatortabpanel - The tabpanel slotchange - Fires a custom 'change' event when a tab is clicked or during keyboard navigation
TextAreaA Text Area Custom HTML Element. Based largely on the <textarea> element.- The default slot for the labellabel - The labelroot - The element wrapping the controlcontrol - The textarea elementchange - Emits a custom 'change' event when the textarea emits a change event
TextFieldA Text Field Custom HTML Element. Based largely on the <input type="text" /> element.start - Content which can be provided before the number field inputend - Content which can be provided after the number field input- The default slot for the labellabel - The labelroot - The element wrapping the control, including start and end slotscontrol - The text field elementchange - Fires a custom 'change' event when the value has changed
ToolbarA Toolbar Custom HTML Element. Implements the ARIA Toolbar.start - Content which can be provided before the slotted itemsend - Content which can be provided after the slotted items- The default slot for slotted itemslabel - The toolbar labelpositioning-region - The element containing the items, start and end slots
TooltipAn Tooltip Custom HTML Element.- The default slot for the tooltip contenttooltip - The tooltip elementdismiss - Fires a custom 'dismiss' event when the tooltip is visible and escape key is pressed
TreeItemA Tree item Custom HTML Element.start - Content which can be provided before the tree item contentend - Content which can be provided after the tree item content- The default slot for tree item text contentitem - The slot for tree items (fast tree items manage this assignment themselves)expand-collapse-button - The expand/collapse buttonpositioning-region - The element used to position the tree item content with exception of any child nodescontent-region - The element containing the expand/collapse, start, and end slotsitems - The element wrapping any child itemsexpand-collapse-button - The expand/collapse buttonexpanded-change - Fires a custom 'expanded-change' event when the expanded state changesselected-change - Fires a custom 'selected-change' event when the selected state changes
TreeViewA Tree view Custom HTML Element. Implements the ARIA TreeView.- The default slot for tree items

Functions

FunctionDescription
applyMixins(derivedCtor, baseCtors)Apply mixins to a constructor. Sourced from TypeScript Documentation.
composedContains(reference, test)Determines if the reference element contains the test element in a "composed" DOM tree that ignores shadow DOM boundaries.Returns true of the test element is a descendent of the reference, or exist in a shadow DOM that is a logical descendent of the reference. Otherwise returns false.
composedParent(element)Retrieves the "composed parent" element of a node, ignoring DOM tree boundaries. When the parent of a node is a shadow-root, it will return the host element of the shadow root. Otherwise it will return the parent node or null if no parent node exists.
display(displayValue)Applies a CSS display property. Also adds CSS rules to not display the element when the [hidden] attribute is applied to the element.
ignore(target, property, descriptor)A decorator that tells the container not to try to inject a dependency.
isListboxOption(el)Determines if the element is a ListboxOption
isTreeItemElement(el)check if the item is a tree item
reflectAttributes(attributes)(BETA) Reflects attributes from the host element to the target element of the directive.
singleton()Registers the decorated class as a singleton dependency; the class will only be created once. Each consecutive time the dependency is resolved, the same instance will be returned.
singleton(options)
singleton(target)Registers the target class as a singleton dependency; the class will only be created once. Each consecutive time the dependency is resolved, the same instance will be returned.
transient()Registers the decorated class as a transient dependency; each time the dependency is resolved a new instance will be created.
transient(target)Registers the target class as a transient dependency; each time the dependency is resolved a new instance will be created.
whitespaceFilter(value, index, array)a method to filter out any whitespace _only_ nodes, to be used inside a template

Interfaces

InterfaceDescription
AnchoredRegionConfigA utility interface to store anchored region configurations that correspond to various common flyout positioning schemes
ColumnDefinitionDefines a column in the grid
ComponentPresentationApplies presentation details, such as template and styles, to a component instance.
ContainerImplemented by dependency injection containers.
ContainerConfigurationConfiguration for a dependency injection container.
CSSDesignTokenA that emits a CSS custom property.
DesignSystemRepresents a configurable design system.
DesignSystemRegistrationContextDesign system contextual APIs and configuration usable within component registries.
DesignTokenDescribes a DesignToken instance.
DesignTokenChangeRecordChange record provided to to a DesignTokenSubscriber when a token changes for a target.
DesignTokenConfigurationDescribes a configuration
DesignTokenSubscriberA subscriber that should receive change records when a token changes for a target
ElementDefinitionContextThe design system context in which an element can be defined.
ElementDefinitionParamsThe element definition context interface. Designed to be used in tryDefineElement
FactoryUsed by the default Resolver to create instances of objects when needed.
FoundationElementDefinitionAn element definition used to define a FoundationElement when registered through the design system registry.
InterfaceConfigurationUsed to configure a dependency injection interface key.
RegistrationImplemented by objects that wish to register dependencies in the container by creating resolvers.
RegistryImplemented by objects that which to register dependencies in a container.
ResolverInternally, the DI system maps "keys" to "resolvers". A resolver controls how a dependency is resolved. Resolvers for transient, singleton, etc. are provided out of the box, but you can also implement Resolver yourself and supply custom logic for resolution.
ServiceLocatorImplemented by objects capable of resolving services and other dependencies.
SliderConfigurationThe configuration structure of Slider.

Variables

VariableDescription
AccordionExpandModeExpand mode for Accordion
accordionItemTemplateThe template for the AccordionItem component.
accordionTemplateThe template for the Accordion component.
allA decorator and DI resolver that will resolve an array of all dependencies registered with the specified key.
anchoredRegionTemplateThe template for the AnchoredRegion component.
anchorTemplateThe template for the Anchor component.
avatarTemplateThe template for Avatar component.
badgeTemplateThe template for the Badge component.
breadcrumbItemTemplateThe template for the BreadcrumbItem component.
breadcrumbTemplateThe template for the Breadcrumb component.
buttonTemplateThe template for the Button component.
calendarCellTemplateA calendar day template
calendarRowTemplate
calendarTemplateThe template for the Calendar component.
CalendarTitleTemplateA basic Calendar title template that includes the month and year
calendarWeekdayTemplateCalendar weekday label template
cardTemplateThe template for the Card component.
checkboxTemplateThe template for the Checkbox component.
ComboboxAutocompleteAutocomplete values for combobox.
comboboxTemplateThe template for the Combobox component.
ComponentPresentationAn API gateway to component presentation features.
ContainerThe interface key that resolves the dependency injection container itself.
ContainerConfigurationConfiguration for a dependency injection container.
darkModeStylesheetBehaviorThis can be used to construct a behavior to apply a prefers color scheme: dark only stylesheet.
dataGridCellTemplateGenerates a template for the DataGridCell component using the provided prefix.
DataGridCellTypesEnumerates possible data grid cell types.
dataGridRowTemplateGenerates a template for the DataGridRow component using the provided prefix.
DataGridRowTypesEnumerates possible data grid row types
dataGridTemplateGenerates a template for the DataGrid component using the provided prefix.
DefaultResolverA set of default resolvers useful in configuring a container.
DesignSystemAn API gateway to design system features.
DesignTokenFactory object for creating instances.
DIThe gateway to dependency injection APIs.
dialogTemplateThe template for the Dialog component.
disabledCursorThe CSS value for disabled cursors.
disclosureTemplateThe template for the Disclosure component.
DividerRoleDivider roles
dividerTemplateThe template for the Divider component.
ElementDisambiguationIndicates what to do with an ambiguous (duplicate) element.
endSlotTemplateThe template for the end element. For use with StartEnd
endTemplateThe template for the end element. For use with StartEnd
FlipperDirectionThe direction options for flipper.
flipperTemplateThe template for the Flipper component.
FlyoutPosBottomA region that always places itself below the anchor, has a width to match the anchor, and is sized vertically by content
FlyoutPosBottomFillA region that always places itself below the anchor, has a width to match the anchor, and is sized vertically by available space
FlyoutPosTallestA region that places itself above or below the anchor based on available space, has a width to match the anchor, and is sized vertically by content
FlyoutPosTallestFillA region that places itself above or below the anchor based on available space, has a width to match the anchor, and is sized vertically by available space
FlyoutPosTopA region that always places itself above the anchor, has a width to match the anchor, and is sized vertically by content
FlyoutPosTopFillA region that always places itself above the anchor, has a width to match the anchor, and is sized vertically by available space
focusVisibleThe string representing the focus selector to be used. Value will be "focus-visible" when https://drafts.csswg.org/selectors-4/\#the-focus-visible-pseudo is supported and "focus" when it is not.
forcedColorsStylesheetBehaviorThis can be used to construct a behavior to apply a forced-colors only stylesheet.
GenerateHeaderOptionsEnumerates the data grid auto generated header options default option generates a non-sticky header row
getDirectiona method to determine the current localization direction of the view
hiddenA CSS fragment to set display: none; when the host is hidden using the [hidden] attribute.
horizontalScrollTemplate
injectA decorator that specifies what to inject into its target.
lazyA decorator that lazily injects a dependency depending on whether the Key is present at the time of function call.
lightModeStylesheetBehaviorThis can be used to construct a behavior to apply a prefers color scheme: light only stylesheet.
listboxOptionTemplateThe template for the ListboxOption component.
listboxTemplateThe template for the Listbox component.
MenuItemRoleMenu items roles.
menuItemTemplateGenerates a template for the MenuItem component using the provided prefix.
menuTemplateThe template for the Menu component.
newInstanceForScopeA decorator that indicates that a new instance should be injected scoped to the container that requested the instance.
newInstanceOfA decorator that indicates that a new instance should be injected.
numberFieldTemplateThe template for the NumberField component.
optionalA decorator that allows you to optionally inject a dependency depending on whether the [[Key]] is present, for example:
pickerListItemTemplate
pickerListTemplate
pickerMenuOptionTemplate
pickerMenuTemplateThe template for the List Picker component.
pickerTemplateThe template for the List Picker component.
progressRingTemplateThe template for the BaseProgress component.
progressTemplateThe template for the BaseProgress component.
radioGroupTemplateThe template for the RadioGroup component.
radioTemplateThe template for the Radio component.
RegistrationYou can use the resulting Registration of any of the factory methods to register with the container.
searchTemplateThe template for the Search component.
SelectPositionPositioning directions for the listbox when a select is open.
selectTemplateThe template for the Select component.
ServiceLocatorThe interface key that resolves the service locator itself.
skeletonTemplateThe template for the fast-skeleton component
sliderLabelTemplateThe template for the SliderLabel component.
SliderModeThe selection modes of a Slider.
sliderTemplateThe template for the Slider component.
startSlotTemplateThe template for the start element. For use with StartEnd
startTemplateThe template for the start element. For use with StartEnd
switchTemplateThe template for the Switch component.
tabPanelTemplateThe template for the TabPanel component.
TabsOrientationThe orientation of the Tabs component
tabsTemplateThe template for the Tabs component.
tabTemplateThe template for the Tab component.
TextAreaResizeResize mode for a TextArea
textAreaTemplateThe template for the TextArea component.
textFieldTemplateThe template for the TextField component.
TextFieldTypeText field sub-types
toolbarTemplateThe template for the Toolbar component.
TooltipPositionEnumerates possible tooltip positions
tooltipTemplateCreates a template for the Tooltip component using the provided prefix.
treeItemTemplateThe template for the TreeItem component.
treeViewTemplateThe template for the TreeView component.

Type Aliases

Type AliasDescription
AccordionExpandModeType for the Accordion Expand Mode
AccordionItemOptionsAccordion Item configuration options
AnchoredRegionPositionLabelDescribes the possible positions of the region relative to its anchor. Depending on the axis start = left/top, end = right/bottom
AnchorOptionsAnchor configuration options
AutoUpdateModeDefines if the component updates its position automatically. Calling update() always provokes an update. anchor - the component only updates its position when the anchor resizes (default) auto - the component updates its position when: - update() is called - the anchor resizes - the window resizes - the viewport resizes - any scroll event in the document
AvatarOptionsAvatar configuration options
AxisPositioningModeDefines the base behavior of an anchored region on a particular axis
AxisScalingModeDefines the scaling behavior of an anchored region on a particular axis
BreadcrumbItemOptionsBreadcrumb Item configuration options- The default slot for when no href is provided or for providing your own custom elementsseparator - The slot for providing a custom separatorlistitem - The wrapping container for the item, represents a semantic listitemseparator - The wrapping element for the separator
ButtonOptionsButton configuration options
CalendarDateInfoCaldendar date info used to represent a date
CalendarInfoCalendar information needed for rendering including the next and previous months
CalendarOptionsCalendar configuration options
CheckboxOptionsCheckbox configuration options
ComboboxAutocompleteAutocomplete type for combobox.
ComboboxOptionsCombobox configuration options
ContextualElementDefinitionEnables defining an element within the context of a design system.
CSSDisplayPropertyValueDefine all possible CSS display values.
DataGridCellTypesThe possible cell types.
DataGridRowTypesThe possible data grid row types
DayFormatA type representing the different day formats
DerivedDesignTokenValueA value that is derived. These values can depend on other s or arbitrary observable properties.
DesignTokenValueThe type that a can be set to.
DividerRoleThe types for Divider roles
ElementDefinitionCallbackThe callback type that is invoked when an element can be defined by a design system.
ElementDisambiguationCallbackThe callback type that is invoked when two elements are trying to define themselves with the same name.
ElementDisambiguationResultRepresents the return values expected from an ElementDisambiguationCallback.
EndOptionsEnd configuration options
FlipperDirectionThe types for the flipper direction options.
FlipperOptionsFlipper configuration options
FoundationElementTemplateA foundation element template function.
GenerateHeaderOptionsThe types for the data grid auto generated header options
HorizontalPositionDefines the horizontal positioning options for an anchored region
HorizontalScrollOptionsHorizontal scroll configuration options
HorizontalScrollViewThe views types for a horizontal-scroll HorizontalScroll
InjectableA class that declares constructor injected dependencies through a static "inject" field array of keys.
InterfaceSymbolA constant key that can be used to represent an interface to a registered dependency. The key can be used in DI registrations but also doubles as a decorator for resolving the associated, registered dependency.
KeyA key that is used to register dependencies with a dependency injection container.
ListboxOptionOptionsListbox option configuration options
MediaQueryListListenerAn event listener fired by a MediaQueryList.
menuConfigs(BETA) Defines the vertical positioning options for an anchored region
MenuItemColumnCountTypes of menu item column count.
MenuItemOptionsMenu Item configuration options
MenuItemRoleThe types for menu item roles
MonthFormatA type representing the different month formats
MonthInfoInformation about a month
NumberFieldOptionsNumber Field configuration options
OverrideFoundationElementDefinitionA set of properties which the component consumer can override during the element registration process.
ParentLocatorA function capable of locating the parent container based on a container's owner.
ProgressOptionsProgress configuration options
ProgressRingOptionsProgressRing configuration options
RadioControlA structure representing a Radio element
RadioOptionsRadio configuration options
RegisterSelfRepresents an object that can register itself.
ResolveCallbackRepresents a custom callback for resolving a request from the container. The handler is the container that is invoking the callback. The requestor is the original container that made the request. The handler and the requestor may not be the same if the request has bubbled up to a parent container in the DI hierarchy. The resolver is the instance of the resolver that stores the callback. This is provided in case the callback needs a place or key against which to store state across resolutions.
ResolvedRepresents something resolved from a service locator.
ScrollEasingThe easing types available for the horizontal-scroll HorizontalScroll
SearchOptionsSearch configuration options
SelectOptionsSelect configuration options
SelectPositionTypes for positioning the select element listbox when open
SkeletonShapeA structure representing skeleton shapes
SliderModeThe types for the selection mode of the slider
SliderOptionsSlider configuration options
StartEndOptionsStart/End configuration options
StartOptionsStart configuration options
StaticDesignTokenValueA design token value with no observable dependencies
SwitchOptionsSwitch configuration options
TabsOptionsTabs option configuration options
TabsOrientationThe types for the Tabs component
TextAreaResizeTypes for the Text Area resize mode
TextFieldOptionsText field configuration options
TextFieldTypeTypes for the text field sub-types
ToolbarOptionsToolbar configuration options
TooltipPositionThe possible tooltip positions
Transformer_2Transforms an object after it is created but before it is returned to the requestor.
TreeItemOptionsTree Item configuration options
VerticalPositionDefines the vertical positioning options for an anchored region
WeekdayFormatA type representing the different weekday formats
YearFormatA type representing the different year formats