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

package/dist/dts/radio-group/radio-group.d.ts

@@ -1,104 +1,268 @@
 import { FASTElement } from '@microsoft/fast-element';
+import { Radio } from '../radio/radio.js';
 import { RadioGroupOrientation } from './radio-group.options.js';
 /**
- * The base class used for constructing a fluent-radio-group custom element
+ * A Radio Group Custom HTML Element.
+ * Implements the {@link https://w3c.github.io/aria/#radiogroup | ARIA `radiogroup` role}.
+ *
+ * @tag fluent-radio-group
+ *
  * @public
+ *
+ * @slot - The default slot for the radio group
  */
 export declare class RadioGroup extends FASTElement {
     /**
-     * sets radio layout styles
+     * The index of the checked radio, scoped to the enabled radios.
+     *
+     * @internal
+     */
+    protected checkedIndex: number;
+    /**
+     * Sets the checked state of the nearest enabled radio when the `checkedIndex` changes.
+     *
+     * @param prev - the previous index
+     * @param next - the current index
+     * @internal
+     */
+    protected checkedIndexChanged(prev: number | undefined, next: number): void;
+    /**
+     * Indicates that the value has been changed by the user.
+     */
+    private dirtyState;
+    /**
+     * Disables the radio group and child radios.
      *
      * @public
      * @remarks
-     * HTML Attribute: stacked
+     * HTML Attribute: `disabled`
+     */
+    disabled: boolean;
+    /**
+     * Sets the `disabled` attribute on all child radios when the `disabled` property changes.
+     *
+     * @param prev - the previous disabled value
+     * @param next - the current disabled value
+     * @internal
      */
-    stacked: boolean;
+    protected disabledChanged(prev?: boolean, next?: boolean): void;
     /**
-     * When true, the child radios will be immutable by user interaction. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute} for more information.
+     * The value of the checked radio.
+     *
      * @public
      * @remarks
-     * HTML Attribute: readonly
+     * HTML Attribute: `value`
      */
-    readOnly: boolean;
+    initialValue?: string;
     /**
-     * Disables the radio group and child radios.
+     * Sets the matching radio to checked when the value changes. If no radio matches the value, no radio will be checked.
+     *
+     * @param prev - the previous value
+     * @param next - the current value
+     */
+    initialValueChanged(prev: string | undefined, next: string | undefined): void;
+    /**
+     * The name of the radio group.
      *
      * @public
      * @remarks
-     * HTML Attribute: disabled
+     * HTML Attribute: `name`
      */
-    disabled: boolean;
+    name: string;
+    /**
+     * Sets the `name` attribute on all child radios when the `name` property changes.
+     *
+     * @internal
+     */
+    protected nameChanged(prev: string | undefined, next: string | undefined): void;
     /**
-     * The name of the radio group. Setting this value will set the name value
-     * for all child radio elements.
+     * The orientation of the group.
      *
      * @public
      * @remarks
-     * HTML Attribute: name
+     * HTML Attribute: `orientation`
      */
-    name: string;
-    protected nameChanged(): void;
+    orientation?: RadioGroupOrientation;
+    /**
+     * Sets the ariaOrientation attribute when the orientation changes.
+     *
+     * @param prev - the previous orientation
+     * @param next - the current orientation
+     * @internal
+     */
+    orientationChanged(prev: RadioGroupOrientation | undefined, next: RadioGroupOrientation | undefined): void;
+    /**
+     * The collection of all child radios.
+     *
+     * @public
+     */
+    radios: Radio[];
+    /**
+     * Updates the enabled radios collection when properties on the child radios change.
+     *
+     * @param prev - the previous radios
+     * @param next - the current radios
+     */
+    radiosChanged(prev: Radio[] | undefined, next: Radio[] | undefined): void;
+    /**
+     * Indicates whether the radio group is required.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `required`
+     */
+    required: boolean;
+    /**
+     *
+     * @param prev - the previous required value
+     * @param next - the current required value
+     */
+    requiredChanged(prev: boolean, next: boolean): void;
+    /**
+     * The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
+     *
+     * @internal
+     */
+    elementInternals: ElementInternals;
+    /**
+     * A collection of child radios that are not disabled.
+     *
+     * @internal
+     */
+    get enabledRadios(): Radio[];
+    /**
+     * 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 formAssociated: boolean;
+    /**
+     * The fallback validation message, taken from a native checkbox `<input>` element.
+     *
+     * @internal
+     */
+    private _validationFallbackMessage;
+    /**
+     * The validation message. Uses the browser's default validation message for native checkboxes if not otherwise
+     * specified (e.g., via `setCustomValidity`).
+     *
+     * @internal
+     */
+    get validationMessage(): string;
     /**
-     * The value of the checked radio
+     * The element's validity state.
      *
      * @public
      * @remarks
-     * HTML Attribute: value
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/validity | `ElementInternals.validity`} property.
+     */
+    get validity(): ValidityState;
+    /**
+     * The current value of the checked radio.
+     *
+     * @public
+     */
+    get value(): string | null;
+    set value(next: string | null);
+    /**
+     * Sets the checked state of all radios when any radio emits a `change` event.
+     *
+     * @param e - the change event
+     */
+    changeHandler(e: Event): boolean | void;
+    /**
+     * Checks the radio at the specified index.
+     *
+     * @param index - the index of the radio to check
+     * @internal
      */
-    value: string;
-    protected valueChanged(): void;
+    checkRadio(index?: number, shouldEmit?: boolean): void;
     /**
-     * The orientation of the group
+     * Checks the validity of the element and returns the result.
      *
      * @public
      * @remarks
-     * HTML Attribute: orientation
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/checkValidity | `HTMLInputElement.checkValidity()`} method.
      */
-    orientation: RadioGroupOrientation;
-    childItems: HTMLElement[];
+    checkValidity(): boolean;
     /**
+     * Handles click events for the radio group.
+     *
+     * @param e - the click event
+     * @internal
+     */
+    clickHandler(e: MouseEvent): boolean | void;
+    constructor();
+    /**
+     * Focuses the checked radio or the first enabled radio.
+     *
+     * @internal
+     */
+    focus(): void;
+    /**
+     * Enables tabbing through the radio group when the group receives focus.
+     *
+     * @param e - the focus event
+     * @internal
+     */
+    focusinHandler(e: FocusEvent): boolean | void;
+    /**
+     * Sets the tabindex of the radios based on the checked state when the radio group loses focus.
+     *
+     * @param e - the focusout event
      * @internal
      */
-    slottedRadioButtons: HTMLElement[];
-    protected slottedRadioButtonsChanged(oldValue: unknown, newValue: HTMLElement[]): void;
-    private selectedRadio;
-    private focusedRadio;
-    private direction;
-    private get parentToolbar();
-    private get isInsideToolbar();
-    private get isInsideFoundationToolbar();
+    focusoutHandler(e: FocusEvent): boolean | void;
+    formResetCallback(): void;
+    private getEnabledIndexInBounds;
     /**
+     * Handles keydown events for the radio group.
+     *
+     * @param e - the keyboard event
      * @internal
      */
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    private setupRadioButtons;
-    private radioChangeHandler;
-    private moveToRadioByIndex;
-    private moveRightOffGroup;
-    private moveLeftOffGroup;
+    keydownHandler(e: KeyboardEvent): boolean | void;
+    /**
+     *
+     * @param e - the disabled event
+     */
+    disabledRadioHandler(e: CustomEvent): void;
     /**
+     * Reports the validity of the element.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/reportValidity | `HTMLInputElement.reportValidity()`} method.
+     */
+    reportValidity(): boolean;
+    /**
+     * Resets the `tabIndex` for all child radios when the radio group loses focus.
+     *
      * @internal
      */
-    focusOutHandler: (e: FocusEvent) => boolean | void;
+    private restrictFocus;
     /**
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/setFormValue | `ElementInternals.setFormValue()`} method.
+     *
      * @internal
      */
-    handleDisabledClick: (e: MouseEvent) => void | boolean;
+    setFormValue(value: File | string | FormData | null, state?: File | string | FormData | null): void;
     /**
+     * Sets the validity of the element.
+     *
+     * @param flags - Validity flags to set.
+     * @param message - Optional message to supply. If not provided, the element's `validationMessage` will be used.
+     * @param anchor - Optional anchor to use for the validation message.
+     *
      * @internal
      */
-    clickHandler: (e: MouseEvent) => void | boolean;
-    private shouldMoveOffGroupToTheRight;
-    private shouldMoveOffGroupToTheLeft;
-    private checkFocusedRadio;
-    private moveRight;
-    private moveLeft;
+    setValidity(flags?: Partial<ValidityState>, message?: string, anchor?: HTMLElement): void;
     /**
-     * keyboard handling per https://w3c.github.io/aria-practices/#for-radio-groups-not-contained-in-a-toolbar
-     * navigation is different when there is an ancestor with role='toolbar'
+     * Updates the collection of child radios when the slot changes.
      *
+     * @param e - the slot change event
      * @internal
      */
-    keydownHandler: (e: KeyboardEvent) => boolean | void;
+    slotchangeHandler(e: Event): void;
 }

package/dist/dts/radio-group/radio-group.options.d.ts

@@ -14,4 +14,4 @@ export declare const RadioGroupOrientation: {
  * Types of Radio Group orientation
  * @public
  */
-export declare type RadioGroupOrientation = ValuesOf<typeof RadioGroupOrientation>;
+export type RadioGroupOrientation = ValuesOf<typeof RadioGroupOrientation>;

package/dist/dts/radio-group/radio-group.template.d.ts

@@ -1,4 +1,4 @@
-import type { ElementViewTemplate } from '@microsoft/fast-element';
+import { type ElementViewTemplate } from '@microsoft/fast-element';
 import type { RadioGroup } from './radio-group.js';
 export declare function radioGroupTemplate<T extends RadioGroup>(): ElementViewTemplate<T>;
 export declare const template: ElementViewTemplate<RadioGroup>;

package/dist/dts/rating-display/define.d.ts

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

package/dist/dts/rating-display/index.d.ts

@@ -0,0 +1,6 @@
+export { BaseRatingDisplay } from './rating-display.base.js';
+export { RatingDisplay } from './rating-display.js';
+export { RatingDisplayColor, RatingDisplaySize } from './rating-display.options.js';
+export { template as RatingDisplayTemplate } from './rating-display.template.js';
+export { styles as RatingDisplayStyles } from './rating-display.styles.js';
+export { definition as RatingDisplayDefinition } from './rating-display.definition.js';

package/dist/dts/rating-display/rating-display.base.d.ts

@@ -0,0 +1,89 @@
+import { FASTElement } from '@microsoft/fast-element';
+/**
+ * The base class used for constructing a fluent-rating-display custom element
+ *
+ * @slot icon - SVG element used as the rating icon
+ *
+ * @public
+ */
+export declare class BaseRatingDisplay extends FASTElement {
+    /**
+     * The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
+     *
+     * @internal
+     */
+    elementInternals: ElementInternals;
+    /**
+     * The number of ratings.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `count`
+     */
+    count?: number;
+    /**
+     * The `viewBox` attribute of the icon <svg> element.
+     *
+     * @public
+     * @default `0 0 20 20`
+     * @remarks
+     * HTML Attribute: `icon-view-box`
+     */
+    iconViewBox?: string;
+    /**
+     * The maximum possible value of the rating.
+     * This attribute determines the number of icons displayed.
+     * Must be a whole number greater than 1.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `max`
+     */
+    max?: number;
+    /**
+     * The value of the rating.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `value`
+     */
+    value?: number;
+    /**
+     * @internal
+     */
+    slottedIcon: HTMLElement[];
+    /**
+     * @internal
+     */
+    slottedIconChanged(): void;
+    /**
+     * @internal
+     */
+    private customIcon?;
+    private intlNumberFormatter;
+    constructor();
+    /**
+     * Returns "count" as string, formatted according to the locale.
+     *
+     * @internal
+     */
+    get formattedCount(): string;
+    /**
+     * Gets the selected value
+     *
+     * @protected
+     */
+    protected getSelectedValue(): number;
+    /**
+     * Gets the maximum icons to render
+     *
+     * @protected
+     */
+    protected getMaxIcons(): number;
+    /**
+     * Generates the icon SVG elements based on the "max" attribute.
+     *
+     * @internal
+     */
+    generateIcons(): string;
+}

package/dist/dts/rating-display/rating-display.d.ts

@@ -0,0 +1,50 @@
+import { BaseRatingDisplay } from './rating-display.base.js';
+import { RatingDisplayColor, RatingDisplaySize } from './rating-display.options.js';
+/**
+ * A Rating Display Custom HTML Element.
+ * Based on BaseRatingDisplay and includes style and layout specific attributes
+ *
+ * @tag fluent-rating-display
+ *
+ * @public
+ */
+export declare class RatingDisplay extends BaseRatingDisplay {
+    /**
+     * The color of the rating display icons.
+     *
+     * @public
+     * @default `marigold`
+     * @remarks
+     * HTML Attribute: `color`
+     */
+    color?: RatingDisplayColor;
+    /**
+     * The size of the component.
+     *
+     * @public
+     * @default 'medium'
+     * @remarks
+     * HTML Attribute: `size`
+     */
+    size?: RatingDisplaySize;
+    /**
+     * Renders a single filled icon with a label next to it.
+     *
+     * @public
+     * @remarks
+     * HTML Attribute: `compact`
+     */
+    compact: boolean;
+    /**
+     * Overrides the selected value and returns 1 if compact is true.
+     *
+     * @override
+     */
+    protected getSelectedValue(): number;
+    /**
+     * Overrides the maximum icons and returns a max of 1 if compact is true.
+     *
+     * @override
+     */
+    protected getMaxIcons(): number;
+}

package/dist/dts/rating-display/rating-display.definition.d.ts

@@ -0,0 +1,9 @@
+import { RatingDisplay } from './rating-display.js';
+/**
+ * The definition for the Fluent Rating Display component.
+ *
+ * @public
+ * @remarks
+ * HTML Element: `<fluent-rating-display>`
+ */
+export declare const definition: import("@microsoft/fast-element").FASTElementDefinition<typeof RatingDisplay>;

package/dist/dts/rating-display/rating-display.options.d.ts

@@ -0,0 +1,29 @@
+import type { ValuesOf } from '../utils/index.js';
+/**
+ * The color of the Rating Display items can be `neutral`, `brand`, or `marigold`.
+ * @public
+ */
+export declare const RatingDisplayColor: {
+    readonly neutral: "neutral";
+    readonly brand: "brand";
+    readonly marigold: "marigold";
+};
+/**
+ * The size of a Rating Display can be `small`, `medium`, or `large`.
+ * @public
+ */
+export declare const RatingDisplaySize: {
+    readonly small: "small";
+    readonly medium: "medium";
+    readonly large: "large";
+};
+/**
+ * The Rating Display items can be one of several colors.
+ * @public
+ */
+export type RatingDisplayColor = ValuesOf<typeof RatingDisplayColor>;
+/**
+ * A Rating Display can be one of several preset sizes.
+ * @public
+ */
+export type RatingDisplaySize = ValuesOf<typeof RatingDisplaySize>;

package/dist/dts/rating-display/rating-display.styles.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The styles for the Rating Display component.
+ *
+ * @public
+ */
+export declare const styles: import("@microsoft/fast-element").ElementStyles;

package/dist/dts/rating-display/rating-display.template.d.ts

@@ -0,0 +1,14 @@
+import { type ElementViewTemplate } from '@microsoft/fast-element';
+import type { RatingDisplay } from './rating-display.js';
+/**
+ * Generates a template for the Rating Display component.
+ *
+ * @public
+ */
+export declare function ratingDisplayTemplate<T extends RatingDisplay>(): ElementViewTemplate<T>;
+/**
+ * The template for the Rating Display component.
+ *
+ * @public
+ */
+export declare const template: ElementViewTemplate<RatingDisplay>;

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

@@ -1,5 +1,6 @@
-export * from './slider.js';
-export * from './slider.options.js';
 export { definition as SliderDefinition } from './slider.definition.js';
+export { Slider } from './slider.js';
+export { SliderMode, SliderOrientation, SliderSize } from './slider.options.js';
+export type { SliderConfiguration, SliderOptions } from './slider.options.js';
 export { styles as SliderStyles } from './slider.styles.js';
 export { template as SliderTemplate } from './slider.template.js';

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

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