@fluentui/web-components 3.0.0-beta.9 → 3.0.0-beta.91

package/dist/esm/dropdown/dropdown.base.js

@@ -0,0 +1,781 @@
+import { __decorate } from "tslib";
+import { attr, FASTElement, Observable, observable, Updates, volatile } from '@microsoft/fast-element';
+import { isListbox } from '../listbox/listbox.options.js';
+import { isDropdownOption } from '../option/option.options.js';
+import { toggleState } from '../utils/element-internals.js';
+import { getLanguage } from '../utils/language.js';
+import { uniqueId } from '../utils/unique-id.js';
+import { DropdownType } from './dropdown.options.js';
+import { dropdownButtonTemplate, dropdownInputTemplate } from './dropdown.template.js';
+/**
+ * A Dropdown Custom HTML Element.
+ * Implements the {@link https://w3c.github.io/aria/#combobox | ARIA combobox } role.
+ *
+ * @remarks
+ * The Dropdown element does not provide a form association value. Instead, the slotted Option elements handle form
+ * association the same way as {@link (Checkbox:class)} elements. See the {@link (DropdownOption:class)} element for
+ * more details.
+ *
+ * @slot - The default slot. Accepts a {@link (Listbox:class)} element.
+ * @slot indicator - The indicator slot.
+ * @slot control - The control slot. This slot is automatically populated and should not be manually manipulated.
+ *
+ * @public
+ */
+export class BaseDropdown extends FASTElement {
+    /**
+     * The ID of the current active descendant.
+     *
+     * @public
+     */
+    get activeDescendant() {
+        if (this.open) {
+            return this.enabledOptions[this.activeIndex]?.id;
+        }
+        return undefined;
+    }
+    /**
+     * Sets the active index when the active index property changes.
+     *
+     * @param prev - the previous active index
+     * @param next - the current active index
+     * @internal
+     */
+    activeIndexChanged(prev, next) {
+        if (typeof next === 'number') {
+            const optionIndex = this.matches(':has(:focus-visible)') ? next : -1;
+            this.enabledOptions.forEach((option, index) => {
+                option.active = index === optionIndex;
+            });
+            if (this.open) {
+                this.enabledOptions[optionIndex]?.scrollIntoView({ block: 'nearest' });
+            }
+        }
+    }
+    /**
+     * Updates properties on the control element when the control slot changes.
+     *
+     * @param prev - the previous control element
+     * @param next - the current control element
+     * @internal
+     * @remarks
+     * The control element is assigned to the dropdown via the control slot with manual slot assignment.
+     */
+    controlChanged(prev, next) {
+        if (next) {
+            next.id = next.id || uniqueId('input-');
+            this.controlSlot?.assign(next);
+        }
+    }
+    /**
+     * Updates the disabled state of the options when the disabled property changes.
+     *
+     * @param prev - the previous disabled state
+     * @param next - the current disabled state
+     */
+    disabledChanged(prev, next) {
+        Updates.enqueue(() => {
+            this.options.forEach(option => {
+                option.disabled = option.disabledAttribute || this.disabled;
+            });
+        });
+    }
+    /**
+     * The display value for the control.
+     *
+     * @public
+     */
+    get displayValue() {
+        if (!this.$fastController.isConnected || !this.control || (this.isCombobox && this.multiple)) {
+            toggleState(this.elementInternals, 'placeholder-shown', false);
+            return '';
+        }
+        this.listFormatter =
+            this.listFormatter ??
+                new Intl.ListFormat(getLanguage(this), {
+                    type: 'conjunction',
+                    style: 'narrow',
+                });
+        const displayValue = this.listFormatter.format(this.selectedOptions.map(x => x.text));
+        toggleState(this.elementInternals, 'placeholder-shown', !displayValue);
+        if (this.isCombobox) {
+            // comboboxes use an input element for the control, which provides the placeholder behavior
+            return displayValue;
+        }
+        return displayValue || this.placeholder;
+    }
+    /**
+     * Updates properties on the listbox element when the listbox reference changes.
+     *
+     * @param prev - the previous listbox element
+     * @param next - the current listbox element
+     * @internal
+     *
+     * @remarks
+     * The listbox element is assigned to the dropdown via the default slot with manual slot assignment.
+     */
+    listboxChanged(prev, next) {
+        if (prev) {
+            Observable.getNotifier(this).unsubscribe(prev);
+        }
+        if (next) {
+            next.dropdown = this;
+            next.popover = 'manual';
+            this.listboxSlot.assign(next);
+            const notifier = Observable.getNotifier(this);
+            notifier.subscribe(next);
+            for (const key of ['disabled', 'multiple']) {
+                notifier.notify(key);
+            }
+            Updates.enqueue(() => {
+                this.enabledOptions
+                    .filter(x => x.defaultSelected)
+                    .forEach((x, i) => {
+                    x.selected = this.multiple || i === 0;
+                });
+                this.setValidity();
+            });
+        }
+    }
+    /**
+     * Toggles between single and multiple selection modes when the `multiple` property changes.
+     *
+     * @param prev - the previous multiple state
+     * @param next - the next multiple state
+     * @internal
+     */
+    multipleChanged(prev, next) {
+        this.elementInternals.ariaMultiSelectable = next ? 'true' : 'false';
+        toggleState(this.elementInternals, 'multiple', next);
+        this.value = null;
+    }
+    /**
+     * Updates the name of the options when the name property changes.
+     *
+     * @param prev - the previous name
+     * @param next - the current name
+     */
+    nameChanged(prev, next) {
+        Updates.enqueue(() => {
+            this.options.forEach(option => {
+                option.name = next;
+            });
+        });
+    }
+    /**
+     * Handles the open state of the dropdown.
+     *
+     * @param prev - the previous open state
+     * @param next - the current open state
+     *
+     * @internal
+     */
+    openChanged(prev, next) {
+        toggleState(this.elementInternals, 'open', next);
+        this.elementInternals.ariaExpanded = next ? 'true' : 'false';
+        this.activeIndex = this.selectedIndex ?? -1;
+        if (next) {
+            BaseDropdown.AnchorPositionFallbackObserver?.observe(this.listbox);
+            return;
+        }
+        BaseDropdown.AnchorPositionFallbackObserver?.unobserve(this.listbox);
+    }
+    /**
+     * Changes the slotted control element based on the dropdown type.
+     *
+     * @param prev - the previous dropdown type
+     * @param next - the current dropdown type
+     * @internal
+     */
+    typeChanged(prev, next) {
+        if (this.$fastController.isConnected) {
+            this.insertControl();
+        }
+    }
+    /**
+     * The collection of enabled options.
+     * @public
+     */
+    get enabledOptions() {
+        return this.listbox?.enabledOptions ?? [];
+    }
+    /**
+     * 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 { this.formAssociated = true; }
+    /**
+     * Resets the form value to its initial value when the form is reset.
+     *
+     * @internal
+     */
+    formResetCallback() {
+        this.enabledOptions.forEach((x, i) => {
+            if (this.multiple) {
+                x.selected = !!x.defaultSelected;
+                return;
+            }
+            if (!x.defaultSelected) {
+                x.selected = false;
+                return;
+            }
+            this.selectOption(i);
+        });
+        this.setValidity();
+    }
+    /**
+     * A reference to the first freeform option, if present.
+     *
+     * @internal
+     */
+    get freeformOption() {
+        return this.enabledOptions.find(x => x.freeform);
+    }
+    /**
+     * Indicates whether the dropdown is a combobox.
+     *
+     * @internal
+     */
+    get isCombobox() {
+        return this.type === DropdownType.combobox;
+    }
+    /**
+     * A reference to all associated label elements.
+     *
+     * @public
+     */
+    get labels() {
+        return Object.freeze(Array.from(this.elementInternals.labels));
+    }
+    /**
+     * The collection of all child options.
+     *
+     * @public
+     */
+    get options() {
+        return this.listbox?.options ?? [];
+    }
+    /**
+     * The index of the first selected option, scoped to the enabled options.
+     *
+     * @internal
+     * @remarks
+     * This property is a reflection of {@link Listbox.selectedIndex}.
+     */
+    get selectedIndex() {
+        return this.enabledOptions.findIndex(x => x.selected) ?? -1;
+    }
+    /**
+     * The collection of selected options.
+     *
+     * @public
+     * @remarks
+     * This property is a reflection of {@link Listbox.selectedOptions}.
+     */
+    get selectedOptions() {
+        return this.listbox?.selectedOptions ?? [];
+    }
+    /**
+     * The validation message. Uses the browser's default validation message for native checkboxes if not otherwise
+     * specified (e.g., via `setCustomValidity`).
+     *
+     * @internal
+     */
+    get validationMessage() {
+        if (this.elementInternals.validationMessage) {
+            return this.elementInternals.validationMessage;
+        }
+        if (!this._validationFallbackMessage) {
+            const validationMessageFallbackControl = document.createElement('input');
+            validationMessageFallbackControl.type = 'radio';
+            validationMessageFallbackControl.name = 'validation-message-fallback';
+            validationMessageFallbackControl.required = true;
+            validationMessageFallbackControl.checked = false;
+            this._validationFallbackMessage = validationMessageFallbackControl.validationMessage;
+        }
+        if (!this.disabled && this.required && this.listbox.selectedOptions.length === 0) {
+            return this._validationFallbackMessage;
+        }
+        return '';
+    }
+    /**
+     * The element's validity state.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/validity | `ElementInternals.validity`} property.
+     */
+    get validity() {
+        return this.elementInternals.validity;
+    }
+    /**
+     * The current value of the selected option.
+     *
+     * @public
+     */
+    get value() {
+        Observable.notify(this, 'value');
+        return this.enabledOptions.find(x => x.selected)?.value ?? null;
+    }
+    set value(next) {
+        if (this.multiple) {
+            return;
+        }
+        this.selectOption(this.enabledOptions.findIndex(x => x.value === next));
+        Observable.track(this, 'value');
+    }
+    /**
+     * Determines if the control can be submitted for constraint validation.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/willValidate | `ElementInternals.willValidate`} property.
+     */
+    get willValidate() {
+        return this.elementInternals.willValidate;
+    }
+    /**
+     * Handles the change events for the dropdown.
+     *
+     * @param e - the event object
+     *
+     * @public
+     */
+    changeHandler(e) {
+        if (this === e.target) {
+            return true;
+        }
+        const optionIndex = this.isCombobox
+            ? this.enabledOptions.findIndex(x => x.text === this.control.value)
+            : this.enabledOptions.indexOf(e.target);
+        this.selectOption(optionIndex, true);
+        return true;
+    }
+    /**
+     * Checks the validity of the element and returns the result.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/checkValidity | `HTMLInputElement.checkValidity()`} method.
+     */
+    checkValidity() {
+        return this.elementInternals.checkValidity();
+    }
+    /**
+     * Handles the click events for the dropdown.
+     *
+     * @param e - the event object
+     *
+     * @public
+     */
+    clickHandler(e) {
+        if (this.disabled) {
+            return;
+        }
+        const target = e.target;
+        this.focus();
+        if (target === this.control && !this.isCombobox) {
+            this.listbox.togglePopover();
+            return true;
+        }
+        if (!this.open) {
+            this.listbox.showPopover();
+            return true;
+        }
+        if (isDropdownOption(target)) {
+            if (target.disabled) {
+                return;
+            }
+            this.selectOption(this.enabledOptions.indexOf(target), true);
+            if (!this.multiple) {
+                if (this.isCombobox) {
+                    this.control.value = target.text;
+                    this.updateFreeformOption();
+                }
+                this.listbox.hidePopover();
+            }
+        }
+        return true;
+    }
+    constructor() {
+        super();
+        /**
+         * The index of the currently active option.
+         *
+         * @internal
+         */
+        this.activeIndex = 0;
+        /**
+         * Sets the listbox ID to a unique value if one is not provided.
+         *
+         * @override
+         * @public
+         * @remarks
+         * HTML Attribute: `id`
+         */
+        this.id = uniqueId('dropdown-');
+        /**
+         * The required state of the dropdown.
+         *
+         * @public
+         * @remarks
+         * HTML Attribute: `required`
+         */
+        this.required = false;
+        /**
+         * The dropdown type.
+         *
+         * @public
+         * @remarks
+         * HTML Attribute: `type`
+         */
+        this.type = DropdownType.dropdown;
+        /**
+         * The initial value of the control. When the control is a combobox, this value is used to set the value of the
+         * control when the dropdown is initialized.
+         *
+         * @public
+         * @remarks
+         * HTML Attribute: `value`
+         */
+        this.valueAttribute = '';
+        /**
+         * The internal {@link https://developer.mozilla.org/docs/Web/API/ElementInternals | `ElementInternals`} instance for the component.
+         *
+         * @internal
+         */
+        this.elementInternals = this.attachInternals();
+        this.elementInternals.role = 'presentation';
+        this.addEventListener('connected', this.listboxConnectedHandler);
+        Updates.enqueue(() => {
+            this.insertControl();
+        });
+    }
+    /**
+     * Filters the options based on the input value.
+     *
+     * @param value - the input value to filter the options by
+     * @param collection - the collection of options to filter
+     * @returns the filtered options
+     * @internal
+     */
+    filterOptions(value, collection = this.enabledOptions) {
+        if (!this.listCollator) {
+            this.listCollator = new Intl.Collator(getLanguage(this), { usage: 'search', sensitivity: 'base' });
+        }
+        return collection.filter(x => {
+            return this.listCollator.compare(x.text.substring(0, Math.min(x.text.length, value.length)), value) === 0;
+        });
+    }
+    /**
+     * Focuses the control when the dropdown receives focus.
+     *
+     * @internal
+     */
+    focus(options) {
+        if (this.disabled) {
+            return;
+        }
+        this.control.focus(options);
+    }
+    /**
+     * Toggles the listbox when the control element loses focus.
+     *
+     * @param e - the focus event
+     * @internal
+     */
+    focusoutHandler(e) {
+        const relatedTarget = e.relatedTarget;
+        if (this.open && !this.contains(relatedTarget)) {
+            this.listbox.togglePopover();
+        }
+        return true;
+    }
+    /**
+     * Ensures the active index is within bounds of the enabled options. Out-of-bounds indices are wrapped to the opposite
+     * end of the range.
+     *
+     * @param index - the desired index
+     * @param upperBound - the upper bound of the range
+     * @returns the index in bounds
+     * @internal
+     */
+    getEnabledIndexInBounds(index, upperBound = this.enabledOptions.length || 0) {
+        if (upperBound === 0) {
+            return -1;
+        }
+        return (index + upperBound) % upperBound;
+    }
+    /**
+     * Handles the input events for the dropdown from the control element.
+     *
+     * @param e - the input event
+     * @public
+     */
+    inputHandler(e) {
+        if (!this.open) {
+            this.listbox.showPopover();
+        }
+        this.updateFreeformOption();
+        const controlValue = this.control.value;
+        const index = this.enabledOptions.indexOf(this.filterOptions(controlValue)[0] ?? null);
+        this.activeIndex = index;
+        return true;
+    }
+    /**
+     * Inserts the control element based on the dropdown type.
+     *
+     * @public
+     * @remarks
+     * This method can be overridden in derived classes to provide custom control elements, though this is not recommended.
+     */
+    insertControl() {
+        this.controlSlot?.assignedNodes().forEach(x => this.removeChild(x));
+        if (this.type === DropdownType.combobox) {
+            dropdownInputTemplate.render(this, this);
+            return;
+        }
+        dropdownButtonTemplate.render(this, this);
+    }
+    /**
+     * Handles the keydown events for the dropdown.
+     *
+     * @param e - the keyboard event
+     * @public
+     */
+    keydownHandler(e) {
+        let increment = 0;
+        switch (e.key) {
+            case 'ArrowUp': {
+                e.preventDefault();
+                increment = -1;
+                break;
+            }
+            case 'ArrowDown': {
+                e.preventDefault();
+                increment = 1;
+                break;
+            }
+            case ' ': {
+                if (this.isCombobox) {
+                    break;
+                }
+                e.preventDefault();
+            }
+            case 'Enter':
+            case 'Tab': {
+                if (this.open) {
+                    this.selectOption(this.activeIndex, true);
+                    if (this.multiple) {
+                        break;
+                    }
+                    this.listbox.hidePopover();
+                    return e.key === 'Tab';
+                }
+                this.listbox.showPopover();
+                break;
+            }
+            case 'Escape': {
+                this.activeIndex = this.multiple ? 0 : this.selectedIndex;
+                this.listbox.hidePopover();
+                break;
+            }
+        }
+        if (!increment) {
+            return true;
+        }
+        if (!this.open) {
+            this.listbox.showPopover();
+            return;
+        }
+        let nextIndex = this.activeIndex;
+        nextIndex += increment;
+        let indexInBounds = this.getEnabledIndexInBounds(nextIndex);
+        if (indexInBounds === 0 && this.freeformOption?.hidden) {
+            indexInBounds = this.getEnabledIndexInBounds(nextIndex + increment);
+        }
+        this.activeIndex = indexInBounds;
+        return true;
+    }
+    /**
+     * Prevents the default behavior of the mousedown event. This is necessary to prevent the input from losing focus
+     * when the dropdown is open.
+     *
+     * @param e - the mouse event
+     *
+     * @internal
+     */
+    mousedownHandler(e) {
+        if (this.disabled || (e.target === this.control && !this.isCombobox)) {
+            return;
+        }
+        return !isDropdownOption(e.target);
+    }
+    /**
+     * Reports the validity of the element.
+     *
+     * @public
+     * @remarks
+     * Reflects the {@link https://developer.mozilla.org/docs/Web/API/ElementInternals/reportValidity | `HTMLInputElement.reportValidity()`} method.
+     */
+    reportValidity() {
+        return this.elementInternals.reportValidity();
+    }
+    /**
+     * Selects an option by index.
+     *
+     * @param index - The index of the option to select.
+     * @public
+     */
+    selectOption(index = this.selectedIndex, shouldEmit = false) {
+        this.listbox.selectOption(index);
+        this.control.value = this.displayValue;
+        this.setValidity();
+        this.updateFreeformOption();
+        if (shouldEmit) {
+            this.$emit('change');
+        }
+    }
+    /**
+     * 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
+     */
+    setValidity(flags, message, anchor) {
+        if (this.$fastController.isConnected) {
+            if (this.disabled || !this.required) {
+                this.elementInternals.setValidity({});
+                return;
+            }
+            const valueMissing = this.required && this.listbox.selectedOptions.length === 0;
+            this.elementInternals.setValidity({ valueMissing, ...flags }, message ?? this.validationMessage, anchor ?? this.control);
+        }
+    }
+    /**
+     * Updates the freeform option with the provided value.
+     *
+     * @param value - the value to update the freeform option with
+     * @internal
+     */
+    updateFreeformOption(value = this.control.value) {
+        if (!this.freeformOption) {
+            return;
+        }
+        if (value === '' ||
+            this.filterOptions(value, this.enabledOptions.filter(x => !x.freeform)).length) {
+            this.freeformOption.value = '';
+            this.freeformOption.selected = false;
+            this.freeformOption.hidden = true;
+            return;
+        }
+        this.freeformOption.value = value;
+        this.freeformOption.hidden = false;
+    }
+    connectedCallback() {
+        super.connectedCallback();
+        this.anchorPositionFallback();
+    }
+    disconnectedCallback() {
+        BaseDropdown.AnchorPositionFallbackObserver?.unobserve(this.listbox);
+        super.disconnectedCallback();
+    }
+    /**
+     * Handles the connected event for the listbox.
+     *
+     * @param e - the event object
+     * @internal
+     */
+    listboxConnectedHandler(e) {
+        const target = e.target;
+        if (isListbox(target)) {
+            this.listbox = target;
+        }
+    }
+    /**
+     * When anchor positioning isn't supported, an intersection observer is used to flip the listbox when it hits the
+     * viewport bounds. One static observer is used for all dropdowns.
+     *
+     * @internal
+     */
+    anchorPositionFallback() {
+        BaseDropdown.AnchorPositionFallbackObserver =
+            BaseDropdown.AnchorPositionFallbackObserver ??
+                new IntersectionObserver((entries) => {
+                    entries.forEach(({ boundingClientRect, isIntersecting, target }) => {
+                        if (isListbox(target) && !isIntersecting) {
+                            if (boundingClientRect.bottom > window.innerHeight) {
+                                toggleState(target.dropdown.elementInternals, 'flip-block', true);
+                                return;
+                            }
+                            if (boundingClientRect.top < 0) {
+                                toggleState(target.dropdown.elementInternals, 'flip-block', false);
+                            }
+                        }
+                    });
+                }, { threshold: 1 });
+    }
+}
+__decorate([
+    volatile
+], BaseDropdown.prototype, "activeDescendant", null);
+__decorate([
+    observable
+], BaseDropdown.prototype, "activeIndex", void 0);
+__decorate([
+    attr({ attribute: 'aria-labelledby', mode: 'fromView' })
+], BaseDropdown.prototype, "ariaLabelledBy", void 0);
+__decorate([
+    observable
+], BaseDropdown.prototype, "control", void 0);
+__decorate([
+    attr({ mode: 'boolean' })
+], BaseDropdown.prototype, "disabled", void 0);
+__decorate([
+    volatile
+], BaseDropdown.prototype, "displayValue", null);
+__decorate([
+    attr({ attribute: 'id' })
+], BaseDropdown.prototype, "id", void 0);
+__decorate([
+    observable
+], BaseDropdown.prototype, "indicator", void 0);
+__decorate([
+    observable
+], BaseDropdown.prototype, "indicatorSlot", void 0);
+__decorate([
+    attr({ attribute: 'value', mode: 'fromView' })
+], BaseDropdown.prototype, "initialValue", void 0);
+__decorate([
+    observable
+], BaseDropdown.prototype, "listbox", void 0);
+__decorate([
+    observable
+], BaseDropdown.prototype, "listboxSlot", void 0);
+__decorate([
+    attr({ mode: 'boolean' })
+], BaseDropdown.prototype, "multiple", void 0);
+__decorate([
+    attr
+], BaseDropdown.prototype, "name", void 0);
+__decorate([
+    observable
+], BaseDropdown.prototype, "open", void 0);
+__decorate([
+    attr
+], BaseDropdown.prototype, "placeholder", void 0);
+__decorate([
+    attr({ mode: 'boolean' })
+], BaseDropdown.prototype, "required", void 0);
+__decorate([
+    attr
+], BaseDropdown.prototype, "type", void 0);
+__decorate([
+    attr({ attribute: 'value' })
+], BaseDropdown.prototype, "valueAttribute", void 0);
+//# sourceMappingURL=dropdown.base.js.map