@fluentui/web-components 3.0.0-beta.1 → 3.0.0-beta.100

package/dist/dts/anchor-button/anchor-button.template.d.ts

@@ -1,5 +1,10 @@
-import { ElementViewTemplate } from '@microsoft/fast-element';
-import type { AnchorButton } from './anchor-button.js';
+import { type ElementViewTemplate, type ViewTemplate } from '@microsoft/fast-element';
+import type { AnchorButton, AnchorOptions } from './anchor-button.js';
+/**
+ * The template for the Button component.
+ * @public
+ */
+export declare function anchorTemplate<T extends AnchorButton>(options?: AnchorOptions): ViewTemplate<T>;
 /**
  * The template for the Button component.
  * @public

package/dist/dts/anchor-button/index.d.ts

@@ -1,4 +1,7 @@
-export * from './anchor-button.js';
-export * from './anchor-button.options.js';
-export { template as AnchorButtonTemplate } from './anchor-button.template.js';
 export { definition as AnchorButtonDefinition } from './anchor-button.definition.js';
+export { BaseAnchor } from './anchor-button.base.js';
+export { AnchorButton } from './anchor-button.js';
+export { AnchorButtonAppearance, AnchorButtonShape, AnchorButtonSize, AnchorTarget } from './anchor-button.options.js';
+export type { AnchorButtonOptions } from './anchor-button.options.js';
+export { styles as AnchorButtonStyles } from './anchor-button.styles.js';
+export { template as AnchorButtonTemplate } from './anchor-button.template.js';

package/dist/dts/avatar/avatar.base.d.ts

@@ -0,0 +1,30 @@
+import { FASTElement } from '@microsoft/fast-element';
+/**
+ * The base class used for constructing a fluent-avatar custom element
+ * @public
+ */
+export declare class BaseAvatar extends FASTElement {
+    /**
+     * The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
+     *
+     * @internal
+     */
+    elementInternals: ElementInternals;
+    /**
+     * The name of the person or entity represented by this Avatar. This should always be provided if it is available.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: name
+     */
+    name?: string | undefined;
+    /**
+     * Provide custom initials rather than one generated via the name
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: name
+     */
+    initials?: string | undefined;
+    constructor();
+}

package/dist/dts/avatar/avatar.bench.d.ts

@@ -0,0 +1,3 @@
+declare const itemRenderer: () => HTMLElement;
+export default itemRenderer;
+export { tests } from '../utils/benchmark-wrapper.js';

package/dist/dts/avatar/avatar.d.ts

@@ -1,26 +1,41 @@
-import { FASTElement } from '@microsoft/fast-element';
-import { AvatarActive, AvatarAppearance, AvatarColor, AvatarNamedColor, AvatarShape, AvatarSize } from './avatar.options.js';
+import { BaseAvatar } from './avatar.base.js';
+import { type AvatarActive, type AvatarAppearance, AvatarColor, AvatarNamedColor, type AvatarShape, type AvatarSize } from './avatar.options.js';
 /**
- * The base class used for constructing a fluent-avatar custom element
+ * An Avatar Custom HTML Element.
+ * Based on BaseAvatar and includes style and layout specific attributes
+ *
+ * @tag fluent-avatar
+ *
  * @public
  */
-export declare class Avatar extends FASTElement {
+export declare class Avatar extends BaseAvatar {
     /**
-     * The name of the person or entity represented by this Avatar. This should always be provided if it is available.
+     * Optional activity indicator
+     * * active: the avatar will be decorated according to activeAppearance
+     * * inactive: the avatar will be reduced in size and partially transparent
+     * * undefined: normal display
      *
      * @public
      * @remarks
-     * HTML Attribute: name
+     * HTML Attribute: active
+     */
+    active?: AvatarActive | undefined;
+    /**
+     * The avatar can have a circular or square shape.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: shape
      */
-    name?: string | undefined;
+    shape?: AvatarShape | undefined;
     /**
-     * Provide custom initials rather than one generated via the name
+     * The appearance when `active="active"`
      *
      * @public
      * @remarks
-     * HTML Attribute: name
+     * HTML Attribute: appearance
      */
-    initials?: string | undefined;
+    appearance?: AvatarAppearance | undefined;
     /**
      * Size of the avatar in pixels.
      *
@@ -36,33 +51,6 @@ export declare class Avatar extends FASTElement {
      *
      */
     size?: AvatarSize | undefined;
-    /**
-     * The avatar can have a circular or square shape.
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: shape
-     */
-    shape?: AvatarShape | undefined;
-    /**
-     * Optional activity indicator
-     * * active: the avatar will be decorated according to activeAppearance
-     * * inactive: the avatar will be reduced in size and partially transparent
-     * * undefined: normal display
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: active
-     */
-    active?: AvatarActive | undefined;
-    /**
-     * The appearance when `active="active"`
-     *
-     * @public
-     * @remarks
-     * HTML Attribute: appearance
-     */
-    appearance?: AvatarAppearance | undefined;
     /**
      * The color when displaying either an icon or initials.
      * * neutral (default): gray
@@ -74,24 +62,37 @@ export declare class Avatar extends FASTElement {
      * @remarks
      * HTML Attribute: color
      */
-    color?: AvatarColor;
+    color?: AvatarColor | undefined;
     /**
      * Specify a string to be used instead of the name, to determine which color to use when color="colorful".
      * Use this when a name is not available, but there is another unique identifier that can be used instead.
      */
     colorId?: AvatarNamedColor | undefined;
     /**
-     * Sets the data-color attribute used for the visual presentation
+     * Holds the current color state
+     */
+    private currentColor;
+    /**
+     * Handles changes to observable properties
      * @internal
+     * @param source - the source of the change
+     * @param propertyName - the property name being changed
      */
-    generateColor(): AvatarColor | void;
+    handleChange(source: any, propertyName: string): void;
     /**
      * Generates and sets the initials for the template
      * @internal
      */
     generateInitials(): string | void;
+    /**
+     * Sets the data-color attribute used for the visual presentation
+     * @internal
+     */
+    generateColor(): void;
     /**
      * An array of the available Avatar named colors
      */
     static colors: ("anchor" | "dark-red" | "cranberry" | "red" | "pumpkin" | "peach" | "marigold" | "gold" | "brass" | "brown" | "forest" | "seafoam" | "dark-green" | "light-teal" | "teal" | "steel" | "blue" | "royal-blue" | "cornflower" | "navy" | "lavender" | "purple" | "grape" | "lilac" | "pink" | "magenta" | "plum" | "beige" | "mink" | "platinum")[];
+    connectedCallback(): void;
+    disconnectedCallback(): void;
 }

package/dist/dts/avatar/avatar.options.d.ts

@@ -1,4 +1,4 @@
-import type { ValuesOf } from '@microsoft/fast-foundation/utilities.js';
+import type { ValuesOf } from '../utils/index.js';
 /**
  * The Avatar "active" state
  */
@@ -9,7 +9,7 @@ export declare const AvatarActive: {
 /**
  * The types of Avatar active state
  */
-export declare type AvatarActive = ValuesOf<typeof AvatarActive>;
+export type AvatarActive = ValuesOf<typeof AvatarActive>;
 /**
  * The Avatar Shape
  */
@@ -20,7 +20,7 @@ export declare const AvatarShape: {
 /**
  * The types of Avatar Shape
  */
-export declare type AvatarShape = ValuesOf<typeof AvatarShape>;
+export type AvatarShape = ValuesOf<typeof AvatarShape>;
 /**
  * The Avatar Appearance when "active"
  */
@@ -32,7 +32,7 @@ export declare const AvatarAppearance: {
 /**
  * The appearance when "active"
  */
-export declare type AvatarAppearance = ValuesOf<typeof AvatarAppearance>;
+export type AvatarAppearance = ValuesOf<typeof AvatarAppearance>;
 /**
  * A specific named color for the Avatar
  */
@@ -72,7 +72,7 @@ export declare const AvatarNamedColor: {
  * An avatar can be one of named colors
  * @public
  */
-export declare type AvatarNamedColor = ValuesOf<typeof AvatarNamedColor>;
+export type AvatarNamedColor = ValuesOf<typeof AvatarNamedColor>;
 /**
  * Supported Avatar colors
  */
@@ -114,7 +114,7 @@ export declare const AvatarColor: {
 /**
  * The Avatar Color
  */
-export declare type AvatarColor = ValuesOf<typeof AvatarColor>;
+export type AvatarColor = ValuesOf<typeof AvatarColor>;
 /**
  * The Avatar Sizes
  * @public
@@ -139,4 +139,4 @@ export declare const AvatarSize: {
  * A Avatar can be on of several preset sizes.
  * @public
  */
-export declare type AvatarSize = ValuesOf<typeof AvatarSize>;
+export type AvatarSize = ValuesOf<typeof AvatarSize>;

package/dist/dts/avatar/avatar.template.d.ts

@@ -1,4 +1,4 @@
-import { ElementViewTemplate } from '@microsoft/fast-element';
+import { type ElementViewTemplate } from '@microsoft/fast-element';
 import type { Avatar } from './avatar.js';
 /**
  * The template for the Avatar component.

package/dist/dts/avatar/index.d.ts

@@ -1,5 +1,6 @@
-export * from './avatar.js';
-export * from './avatar.options.js';
+export { Avatar } from './avatar.js';
+export { BaseAvatar } from './avatar.base.js';
+export { AvatarActive, AvatarAppearance, AvatarColor, AvatarNamedColor, AvatarShape, AvatarSize, } from './avatar.options.js';
 export { template as AvatarTemplate } from './avatar.template.js';
 export { styles as AvatarStyles } from './avatar.styles.js';
 export { definition as AvatarDefinition } from './avatar.definition.js';

package/dist/dts/badge/badge.bench.d.ts

@@ -0,0 +1,3 @@
+declare const itemRenderer: () => HTMLElement;
+export default itemRenderer;
+export { tests } from '../utils/benchmark-wrapper.js';

package/dist/dts/badge/badge.d.ts

@@ -1,5 +1,5 @@
 import { FASTElement } from '@microsoft/fast-element';
-import { StartEnd } from '@microsoft/fast-foundation/patterns.js';
+import { StartEnd } from '../patterns/index.js';
 import { BadgeAppearance, BadgeColor, BadgeShape, BadgeSize } from './badge.options.js';
 /**
  * The base class used for constructing a fluent-badge custom element
@@ -9,6 +9,8 @@ export declare class Badge extends FASTElement {
     /**
      * The appearance the badge should have.
      *
+     * @tag fluent-badge
+     *
      * @public
      * @remarks
      * HTML Attribute: appearance

package/dist/dts/badge/badge.definition.d.ts

@@ -1,8 +1,5 @@
 import { Badge } from './badge.js';
 /**
- * The Fluent Badge Element. Implements {@link @microsoft/fast-foundation#Badge },
- * {@link @microsoft/fast-foundation#badgeTemplate}
- *
  *
  * @public
  * @remarks

package/dist/dts/badge/badge.options.d.ts

@@ -1,10 +1,10 @@
-import { StartEndOptions } from '@microsoft/fast-foundation/patterns.js';
-import type { StaticallyComposableHTML, ValuesOf } from '@microsoft/fast-foundation/utilities.js';
+import type { StartEndOptions } from '../patterns/index.js';
+import type { StaticallyComposableHTML, ValuesOf } from '../utils/index.js';
 import type { Badge } from './badge.js';
 /**
  * @internal - marking as internal update when Badge PR for start/end is in
  */
-export declare type BadgeOptions = StartEndOptions<Badge> & {
+export type BadgeOptions = StartEndOptions<Badge> & {
     defaultContent?: StaticallyComposableHTML;
 };
 /**
@@ -21,7 +21,7 @@ export declare const BadgeAppearance: {
  * A Badge can be filled, outline, ghost, inverted
  * @public
  */
-export declare type BadgeAppearance = ValuesOf<typeof BadgeAppearance>;
+export type BadgeAppearance = ValuesOf<typeof BadgeAppearance>;
 /**
  * BadgeColor constants
  * @public
@@ -40,7 +40,7 @@ export declare const BadgeColor: {
  * A Badge can be one of preset colors
  * @public
  */
-export declare type BadgeColor = ValuesOf<typeof BadgeColor>;
+export type BadgeColor = ValuesOf<typeof BadgeColor>;
 /**
  * A Badge can be square, circular or rounded.
  * @public
@@ -54,7 +54,7 @@ export declare const BadgeShape: {
  * A Badge can be one of preset colors
  * @public
  */
-export declare type BadgeShape = ValuesOf<typeof BadgeShape>;
+export type BadgeShape = ValuesOf<typeof BadgeShape>;
 /**
  * A Badge can be square, circular or rounded.
  * @public
@@ -71,4 +71,4 @@ export declare const BadgeSize: {
  * A Badge can be on of several preset sizes.
  * @public
  */
-export declare type BadgeSize = ValuesOf<typeof BadgeSize>;
+export type BadgeSize = ValuesOf<typeof BadgeSize>;

package/dist/dts/badge/badge.template.d.ts

@@ -1,4 +1,4 @@
-import { ElementViewTemplate } from '@microsoft/fast-element';
+import { type ElementViewTemplate } from '@microsoft/fast-element';
 import type { Badge } from './badge.js';
 import type { BadgeOptions } from './badge.options.js';
 /**

package/dist/dts/badge/index.d.ts

@@ -1,5 +1,5 @@
-export * from './badge.js';
-export * from './badge.options.js';
+export { Badge } from './badge.js';
+export { BadgeAppearance, BadgeColor, BadgeShape, BadgeSize } from './badge.options.js';
 export { template as BadgeTemplate } from './badge.template.js';
 export { styles as BadgeStyles } from './badge.styles.js';
 export { definition as BadgeDefinition } from './badge.definition.js';

package/dist/dts/button/button.base.d.ts

@@ -0,0 +1,242 @@
+import { FASTElement } from '@microsoft/fast-element';
+import { ButtonFormTarget, ButtonType } from './button.options.js';
+/**
+ * A Button Custom HTML Element.
+ * Based largely on the {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button | `<button>`} element.
+ *
+ * @slot start - Content which can be provided before the button content
+ * @slot end - Content which can be provided after the button content
+ * @slot - The default slot for button content
+ * @csspart content - The button content container
+ *
+ * @public
+ */
+export declare class BaseButton extends FASTElement {
+    /**
+     * Indicates the button should be focused when the page is loaded.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#autofocus | `autofocus`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `autofocus`
+     */
+    autofocus: boolean;
+    /**
+     * Default slotted content.
+     *
+     * @public
+     */
+    defaultSlottedContent: HTMLElement[];
+    /**
+     * Sets the element's disabled state.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#disabled | `disabled`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `disabled`
+     */
+    disabled?: boolean;
+    /**
+     * Indicates that the button is focusable while disabled.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `disabled-focusable`
+     */
+    disabledFocusable: boolean;
+    /**
+     * Sets that the button tabindex attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `tabindex`
+     */
+    tabIndex: number;
+    /**
+     * Sets the element's internal disabled state when the element is focusable while disabled.
+     *
+     * @param previous - the previous disabledFocusable value
+     * @param next - the current disabledFocusable value
+     * @internal
+     */
+    disabledFocusableChanged(previous: boolean, next: boolean): void;
+    /**
+     * The internal {@link https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
+     *
+     * @internal
+     */
+    elementInternals: ElementInternals;
+    /**
+     * The associated form element.
+     *
+     * @public
+     */
+    get form(): HTMLFormElement | null;
+    /**
+     * The URL that processes the form submission.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#formaction | `formaction`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `formaction`
+     */
+    formAction?: string;
+    /**
+     * The form-associated flag.
+     * @see {@link https://html.spec.whatwg.org/multipage/custom-elements.html#custom-elements-face-example | Form-associated custom elements}
+     *
+     * @public
+     */
+    static readonly formAssociated = true;
+    /**
+     * The id of a form to associate the element to.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#form | `form`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `form`
+     */
+    formAttribute?: string;
+    /**
+     * The encoding type for the form submission.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#formenctype | `formenctype`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `formenctype`
+     */
+    formEnctype?: string;
+    /**
+     * The HTTP method that the browser uses to submit the form.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#formmethod | `formmethod`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `formmethod`
+     */
+    formMethod?: string;
+    /**
+     * Indicates that the form will not be validated when submitted.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#formnovalidate | `formnovalidate`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `formnovalidate`
+     */
+    formNoValidate?: boolean;
+    /**
+     * The internal form submission fallback control.
+     *
+     * @internal
+     */
+    private formSubmissionFallbackControl?;
+    /**
+     * The internal slot for the form submission fallback control.
+     *
+     * @internal
+     */
+    private formSubmissionFallbackControlSlot?;
+    /**
+     * The target frame or window to open the form submission in.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#formtarget | `formtarget`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `formtarget`
+     */
+    formTarget?: ButtonFormTarget;
+    /**
+     * A reference to all associated label elements.
+     *
+     * @public
+     */
+    get labels(): ReadonlyArray<Node>;
+    /**
+     * The name of the element. This element's value will be surfaced during form submission under the provided name.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#name | `name`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `name`
+     */
+    name?: string;
+    /**
+     * The button type.
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#type | `type`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `type`
+     */
+    type: ButtonType;
+    /**
+     * Removes the form submission fallback control when the type changes.
+     *
+     * @param previous - the previous type value
+     * @param next - the new type value
+     * @internal
+     */
+    typeChanged(previous: ButtonType, next: ButtonType): void;
+    /**
+     * The value attribute.
+     *
+     * @see The {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#value | `value`} attribute
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `value`
+     */
+    value?: string;
+    /**
+     * Handles the button click event.
+     *
+     * @param e - The event object
+     * @internal
+     */
+    clickHandler(e: Event): boolean | void;
+    connectedCallback(): void;
+    constructor();
+    /**
+     * This fallback creates a new slot, then creates a submit button to mirror the custom element's
+     * properties. The submit button is then appended to the slot and the form is submitted.
+     *
+     * @internal
+     * @privateRemarks
+     * This is a workaround until {@link https://github.com/WICG/webcomponents/issues/814 | WICG/webcomponents/issues/814} is resolved.
+     */
+    private createAndInsertFormSubmissionFallbackControl;
+    /**
+     * Invoked when a connected component's form or fieldset has its disabled state changed.
+     *
+     * @param disabled - the disabled value of the form / fieldset
+     *
+     * @internal
+     */
+    formDisabledCallback(disabled: boolean): void;
+    /**
+     * Handles keypress events for the button.
+     *
+     * @param e - the keyboard event
+     * @returns - the return value of the click handler
+     * @public
+     */
+    keypressHandler(e: KeyboardEvent): boolean | void;
+    /**
+     * Presses the button.
+     *
+     * @public
+     */
+    protected press(): void;
+    /**
+     * Resets the associated form.
+     *
+     * @public
+     */
+    resetForm(): void;
+    /**
+     * Submits the associated form.
+     *
+     * @internal
+     */
+    private submitForm;
+}

package/dist/dts/button/button.bench.d.ts

@@ -0,0 +1,3 @@
+declare const itemRenderer: () => HTMLElement;
+export default itemRenderer;
+export { tests } from '../utils/benchmark-wrapper.js';