@fluentui/web-components 3.0.0-alpha.3 → 3.0.0-alpha.31

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

@@ -0,0 +1,97 @@
+import { FASTElement } from '@microsoft/fast-element';
+import { AvatarActive, AvatarAppearance, AvatarColor, AvatarNamedColor, AvatarShape, AvatarSize } from './avatar.options.js';
+/**
+ * The base class used for constructing a fluent-avatar custom element
+ * @public
+ */
+export declare class Avatar extends FASTElement {
+    /**
+     * 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;
+    /**
+     * Size of the avatar in pixels.
+     *
+     * Size is restricted to a limited set of supported values recommended for most uses (see `AvatarSizeValue`) and
+     * based on design guidelines for the Avatar control.
+     *
+     * If a non-supported size is neeeded, set `size` to the next-smaller supported size, and set `width` and `height`
+     * to override the rendered size.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: size
+     *
+     */
+    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
+     * * brand: color from the brand palette
+     * * colorful: picks a color from a set of pre-defined colors, based on a hash of the name (or colorId if provided)
+     * * [AvatarNamedColor]: a specific color from the theme
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: color
+     */
+    color?: AvatarColor;
+    /**
+     * 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
+     * @internal
+     */
+    generateColor(): AvatarColor | void;
+    /**
+     * Generates and sets the initials for the template
+     * @internal
+     */
+    generateInitials(): string | 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")[];
+}

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

@@ -0,0 +1,9 @@
+import { Avatar } from './avatar.js';
+/**
+ * The Fluent Avatar Element.
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fluent-badge\>
+ */
+export declare const definition: import("@microsoft/fast-element").FASTElementDefinition<typeof Avatar>;

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

@@ -0,0 +1,142 @@
+import type { ValuesOf } from '@microsoft/fast-foundation/utilities.js';
+/**
+ * The Avatar "active" state
+ */
+export declare const AvatarActive: {
+    readonly active: "active";
+    readonly inactive: "inactive";
+};
+/**
+ * The types of Avatar active state
+ */
+export declare type AvatarActive = ValuesOf<typeof AvatarActive>;
+/**
+ * The Avatar Shape
+ */
+export declare const AvatarShape: {
+    readonly circular: "circular";
+    readonly square: "square";
+};
+/**
+ * The types of Avatar Shape
+ */
+export declare type AvatarShape = ValuesOf<typeof AvatarShape>;
+/**
+ * The Avatar Appearance when "active"
+ */
+export declare const AvatarAppearance: {
+    readonly ring: "ring";
+    readonly shadow: "shadow";
+    readonly ringShadow: "ring-shadow";
+};
+/**
+ * The appearance when "active"
+ */
+export declare type AvatarAppearance = ValuesOf<typeof AvatarAppearance>;
+/**
+ * A specific named color for the Avatar
+ */
+export declare const AvatarNamedColor: {
+    readonly darkRed: "dark-red";
+    readonly cranberry: "cranberry";
+    readonly red: "red";
+    readonly pumpkin: "pumpkin";
+    readonly peach: "peach";
+    readonly marigold: "marigold";
+    readonly gold: "gold";
+    readonly brass: "brass";
+    readonly brown: "brown";
+    readonly forest: "forest";
+    readonly seafoam: "seafoam";
+    readonly darkGreen: "dark-green";
+    readonly lightTeal: "light-teal";
+    readonly teal: "teal";
+    readonly steel: "steel";
+    readonly blue: "blue";
+    readonly royalBlue: "royal-blue";
+    readonly cornflower: "cornflower";
+    readonly navy: "navy";
+    readonly lavender: "lavender";
+    readonly purple: "purple";
+    readonly grape: "grape";
+    readonly lilac: "lilac";
+    readonly pink: "pink";
+    readonly magenta: "magenta";
+    readonly plum: "plum";
+    readonly beige: "beige";
+    readonly mink: "mink";
+    readonly platinum: "platinum";
+    readonly anchor: "anchor";
+};
+/**
+ * An avatar can be one of named colors
+ * @public
+ */
+export declare type AvatarNamedColor = ValuesOf<typeof AvatarNamedColor>;
+/**
+ * Supported Avatar colors
+ */
+export declare const AvatarColor: {
+    readonly darkRed: "dark-red";
+    readonly cranberry: "cranberry";
+    readonly red: "red";
+    readonly pumpkin: "pumpkin";
+    readonly peach: "peach";
+    readonly marigold: "marigold";
+    readonly gold: "gold";
+    readonly brass: "brass";
+    readonly brown: "brown";
+    readonly forest: "forest";
+    readonly seafoam: "seafoam";
+    readonly darkGreen: "dark-green";
+    readonly lightTeal: "light-teal";
+    readonly teal: "teal";
+    readonly steel: "steel";
+    readonly blue: "blue";
+    readonly royalBlue: "royal-blue";
+    readonly cornflower: "cornflower";
+    readonly navy: "navy";
+    readonly lavender: "lavender";
+    readonly purple: "purple";
+    readonly grape: "grape";
+    readonly lilac: "lilac";
+    readonly pink: "pink";
+    readonly magenta: "magenta";
+    readonly plum: "plum";
+    readonly beige: "beige";
+    readonly mink: "mink";
+    readonly platinum: "platinum";
+    readonly anchor: "anchor";
+    readonly neutral: "neutral";
+    readonly brand: "brand";
+    readonly colorful: "colorful";
+};
+/**
+ * The Avatar Color
+ */
+export declare type AvatarColor = ValuesOf<typeof AvatarColor>;
+/**
+ * The Avatar Sizes
+ * @public
+ */
+export declare const AvatarSize: {
+    readonly _16: 16;
+    readonly _20: 20;
+    readonly _24: 24;
+    readonly _28: 28;
+    readonly _32: 32;
+    readonly _36: 36;
+    readonly _40: 40;
+    readonly _48: 48;
+    readonly _56: 56;
+    readonly _64: 64;
+    readonly _72: 72;
+    readonly _96: 96;
+    readonly _120: 120;
+    readonly _128: 128;
+};
+/**
+ * A Avatar can be on of several preset sizes.
+ * @public
+ */
+export declare type AvatarSize = ValuesOf<typeof AvatarSize>;

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

@@ -0,0 +1,4 @@
+/** Avatar styles
+ * @public
+ */
+export declare const styles: import("@microsoft/fast-element").ElementStyles;

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

@@ -0,0 +1,8 @@
+import { ElementViewTemplate } from '@microsoft/fast-element';
+import type { Avatar } from './avatar.js';
+/**
+ * The template for the Avatar component.
+ * @public
+ */
+export declare function avatarTemplate<T extends Avatar>(): ElementViewTemplate<T>;
+export declare const template: ElementViewTemplate<Avatar>;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,5 @@
+export * from './avatar.js';
+export * 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.d.ts

@@ -1,5 +1,5 @@
 import { FASTElement } from '@microsoft/fast-element';
-import { StartEnd } from '@microsoft/fast-foundation';
+import { StartEnd } from '@microsoft/fast-foundation/patterns.js';
 import { BadgeAppearance, BadgeColor, BadgeShape, BadgeSize } from './badge.options.js';
 /**
  * The base class used for constructing a fluent-badge custom element
@@ -29,7 +29,7 @@ export declare class Badge extends FASTElement {
      * @remarks
      * HTML Attribute: shape
      */
-    shape: BadgeShape;
+    shape?: BadgeShape;
     /**
      * The size the badge should have.
      *
@@ -37,7 +37,7 @@ export declare class Badge extends FASTElement {
      * @remarks
      * HTML Attribute: size
      */
-    size: BadgeSize;
+    size?: BadgeSize;
 }
 /**
  * Mark internal because exporting class and interface of the same name

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

@@ -1,4 +1,5 @@
-import { StartEndOptions, StaticallyComposableHTML, ValuesOf } from '@microsoft/fast-foundation';
+import { StartEndOptions } from '@microsoft/fast-foundation/patterns.js';
+import type { StaticallyComposableHTML, ValuesOf } from '@microsoft/fast-foundation/utilities.js';
 import type { Badge } from './badge.js';
 /**
  * @internal - marking as internal update when Badge PR for start/end is in

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

@@ -0,0 +1,55 @@
+import { FASTButton } from '@microsoft/fast-foundation/button.js';
+import { ButtonAppearance, ButtonShape, ButtonSize } from './button.options.js';
+/**
+ * The base class used for constructing a fluent-button custom element
+ * @public
+ */
+export declare class Button extends FASTButton {
+    /**
+     * The appearance the button should have.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: appearance
+     */
+    appearance?: ButtonAppearance | undefined;
+    /**
+     * The shape the button should have.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: shape
+     */
+    shape?: ButtonShape | undefined;
+    /**
+     * The size the button should have.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: size
+     */
+    size?: ButtonSize;
+    /**
+     * The button has an icon only, no text content
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: icon-only
+     */
+    iconOnly: boolean;
+    /**
+     * The button is disabled but focusable
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: disabled-focusable
+     */
+    disabledFocusable?: boolean;
+    protected disabledFocusableChanged(prev: boolean, next: boolean): void;
+    /**
+     * Prevents disabledFocusable click events
+     */
+    private handleDisabledFocusableClick;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+}

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

@@ -0,0 +1,10 @@
+import { Button } from './button.js';
+/**
+ * The Fluent Button Element. Implements {@link @microsoft/fast-foundation#Button },
+ * {@link @microsoft/fast-foundation#buttonTemplate}
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fluent-button\>
+ */
+export declare const definition: import("@microsoft/fast-element").FASTElementDefinition<typeof Button>;

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

@@ -0,0 +1,47 @@
+import type { ButtonOptions } from '@microsoft/fast-foundation/button.js';
+import type { ValuesOf } from '@microsoft/fast-foundation/utilities.js';
+/**
+ * ButtonAppearance constants
+ * @public
+ */
+export declare const ButtonAppearance: {
+    readonly primary: "primary";
+    readonly outline: "outline";
+    readonly subtle: "subtle";
+    readonly secondary: "secondary";
+    readonly transparent: "transparent";
+};
+/**
+ * A Button can be secondary, primary, outline, subtle, transparent
+ * @public
+ */
+export declare type ButtonAppearance = ValuesOf<typeof ButtonAppearance>;
+/**
+ * A Button can be square, circular or rounded.
+ * @public
+ */
+export declare const ButtonShape: {
+    readonly circular: "circular";
+    readonly rounded: "rounded";
+    readonly square: "square";
+};
+/**
+ * A Button can be square, circular or rounded
+ * @public
+ */
+export declare type ButtonShape = ValuesOf<typeof ButtonShape>;
+/**
+ * A Button can be a size of small, medium or large.
+ * @public
+ */
+export declare const ButtonSize: {
+    readonly small: "small";
+    readonly medium: "medium";
+    readonly large: "large";
+};
+/**
+ * A Button can be on of several preset sizes.
+ * @public
+ */
+export declare type ButtonSize = ValuesOf<typeof ButtonSize>;
+export { ButtonOptions };

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

@@ -0,0 +1 @@
+export declare const styles: import("@microsoft/fast-element").ElementStyles;

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

@@ -0,0 +1,7 @@
+import { ElementViewTemplate } from '@microsoft/fast-element';
+import type { Button } from './button.js';
+/**
+ * The template for the Button component.
+ * @public
+ */
+export declare const template: ElementViewTemplate<Button>;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,5 @@
+export * from './button.js';
+export * from './button.options.js';
+export { template as ButtonTemplate } from './button.template.js';
+export { styles as ButtonStyles } from './button.styles.js';
+export { definition as ButtonDefinition } from './button.definition.js';

package/dist/dts/checkbox/checkbox.d.ts

@@ -0,0 +1,35 @@
+import { FASTCheckbox } from '@microsoft/fast-foundation/checkbox.js';
+import { CheckboxLabelPosition, CheckboxShape, CheckboxSize } from './checkbox.options.js';
+/**
+ * The base class used for constucting a fluent checkbox custom element
+ * @public
+ */
+export declare class Checkbox extends FASTCheckbox {
+    /**
+     * Sets shape of the checkbox.
+     *
+     * @public
+     * @default 'square'
+     * @remarks
+     * HTML Attribute: shape
+     */
+    shape?: CheckboxShape;
+    /**
+     * Sets size of the checkbox.
+     *
+     * @public
+     * @default 'medium'
+     * @remarks
+     * HTML Attribute: size
+     */
+    size?: CheckboxSize;
+    /**
+     * Sets position of the label relative to the input
+     *
+     * @public
+     * @default 'after'
+     * @remarks
+     * HTML Attribute: label-position
+     */
+    labelPosition?: CheckboxLabelPosition;
+}

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

@@ -0,0 +1,9 @@
+import { Checkbox } from './checkbox.js';
+/**
+ * The Fluent Checkbox Element
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fluent-checkbox\>
+ */
+export declare const definition: import("@microsoft/fast-element").FASTElementDefinition<typeof Checkbox>;

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

@@ -0,0 +1,28 @@
+import type { ValuesOf } from '@microsoft/fast-foundation/utilities.js';
+/**
+ * Checkbox shape
+ * @public
+ */
+export declare const CheckboxShape: {
+    readonly circular: "circular";
+    readonly square: "square";
+};
+export declare type CheckboxShape = ValuesOf<typeof CheckboxShape>;
+/**
+ * Checkbox size
+ * @public
+ */
+export declare const CheckboxSize: {
+    readonly medium: "medium";
+    readonly large: "large";
+};
+export declare type CheckboxSize = ValuesOf<typeof CheckboxSize>;
+/**
+ * Checkbox label position
+ * @public
+ */
+export declare const CheckboxLabelPosition: {
+    readonly before: "before";
+    readonly after: "after";
+};
+export declare type CheckboxLabelPosition = ValuesOf<typeof CheckboxLabelPosition>;

package/dist/dts/checkbox/checkbox.styles.d.ts

@@ -0,0 +1,5 @@
+/** Checkbox styles
+ *
+ * @public
+ */
+export declare const styles: import("@microsoft/fast-element").ElementStyles;

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

@@ -0,0 +1,7 @@
+import { ElementViewTemplate } from '@microsoft/fast-element';
+import type { Checkbox } from './checkbox.js';
+/**
+ * Template for the Checkbox component
+ * @public
+ */
+export declare const template: ElementViewTemplate<Checkbox>;

package/dist/dts/checkbox/define.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,5 @@
+export * from './checkbox.js';
+export * from './checkbox.options.js';
+export { definition as CheckboxDefinition } from './checkbox.definition.js';
+export { template as CheckboxTemplate } from './checkbox.template.js';
+export { styles as CheckboxStyles } from './checkbox.styles.js';

package/dist/dts/compound-button/compound-button.d.ts

@@ -0,0 +1,7 @@
+import { Button } from '../button/button.js';
+/**
+ * The base class used for constructing a fluent-compound-button custom element
+ * @public
+ */
+export declare class CompoundButton extends Button {
+}

package/dist/dts/compound-button/compound-button.definition.d.ts

@@ -0,0 +1,10 @@
+import { CompoundButton } from './compound-button.js';
+/**
+ * The Fluent Compound Button Element. Implements {@link @microsoft/fast-foundation#Button },
+ * {@link @microsoft/fast-foundation#buttonTemplate}
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fluent-comopund-button\>
+ */
+export declare const definition: import("@microsoft/fast-element").FASTElementDefinition<typeof CompoundButton>;

package/dist/dts/compound-button/compound-button.options.d.ts

@@ -0,0 +1,51 @@
+import type { ButtonOptions } from '@microsoft/fast-foundation/button.js';
+import type { ValuesOf } from '@microsoft/fast-foundation/utilities.js';
+/**
+ * Compound Button Appearance constants
+ * @public
+ */
+export declare const CompoundButtonAppearance: {
+    readonly primary: "primary";
+    readonly outline: "outline";
+    readonly subtle: "subtle";
+    readonly secondary: "secondary";
+    readonly transparent: "transparent";
+};
+/**
+ * A Compound Button can be secondary, primary, outline, subtle, transparent
+ * @public
+ */
+export declare type CompoundButtonAppearance = ValuesOf<typeof CompoundButtonAppearance>;
+/**
+ * A Compound Button can be square, circular or rounded.
+ * @public
+ */
+export declare const CompoundButtonShape: {
+    readonly circular: "circular";
+    readonly rounded: "rounded";
+    readonly square: "square";
+};
+/**
+ * A Compound Button can be square, circular or rounded
+ * @public
+ */
+export declare type CompoundButtonShape = ValuesOf<typeof CompoundButtonShape>;
+/**
+ * A Compound Button can be a size of small, medium or large.
+ * @public
+ */
+export declare const CompoundButtonSize: {
+    readonly small: "small";
+    /**
+     * A Compound Button can be on of several preset sizes.
+     * @public
+     */
+    readonly medium: "medium";
+    readonly large: "large";
+};
+/**
+ * A Compound Button can be on of several preset sizes.
+ * @public
+ */
+export declare type CompoundButtonSize = ValuesOf<typeof CompoundButtonSize>;
+export { ButtonOptions as CompoundButtonOptions };

package/dist/dts/compound-button/compound-button.styles.d.ts

@@ -0,0 +1 @@
+export declare const styles: import("@microsoft/fast-element").ElementStyles;

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

@@ -0,0 +1,13 @@
+import { ElementViewTemplate } from '@microsoft/fast-element';
+import type { CompoundButton } from './compound-button.js';
+import type { CompoundButtonOptions } from './compound-button.options.js';
+/**
+ * The template for the Compound Button component.
+ * @public
+ */
+export declare function buttonTemplate<T extends CompoundButton>(options?: CompoundButtonOptions): ElementViewTemplate<T>;
+/**
+ * The template for the Button component.
+ * @public
+ */
+export declare const template: ElementViewTemplate<CompoundButton>;

package/dist/dts/compound-button/define.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,5 @@
+export * from './compound-button.js';
+export * from './compound-button.options.js';
+export { template as CompoundButtonTemplate } from './compound-button.template.js';
+export { styles as CompoundButtonStyles } from './compound-button.styles.js';
+export { definition as CompoundButtonDefinition } from './compound-button.definition.js';