@flywheel-io/vision 21.1.1 → 21.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flywheel-io/vision",
-  "version": "21.1.1",
+  "version": "21.1.3",
   "description": "Flywheel UI elements provided as Angular components and native web components",
   "author": "Flywheel",
   "license": "MIT",

package/types/flywheel-io-vision.d.ts

@@ -1236,6 +1236,14 @@ declare class FwMenuItemComponent implements OnChanges, OnDestroy, AfterContentI
     readonly selected: _angular_core.ModelSignal<boolean>;
     subItems: QueryList<FwMenuSubItemComponent>;
     private subscriptions;
+    private isDestroyed;
+    /**
+     * Whether this item's view has been torn down. Owners that iterate their items (`fw-menu`) have to
+     * check this before writing to the item's `model()`s: neither `QueryList` nor a signal query is
+     * emptied by view destruction, so an item can still be reachable from a query after the menu it
+     * lives in was destroyed - writing to it then logs NG0953.
+     */
+    get destroyed(): boolean;
     scrollIntoView(options?: ScrollIntoViewOptions): void;
     focus(): void;
     isFocused(): boolean;
@@ -1649,6 +1657,11 @@ type MenuFilterFn = (filter: string, menuItems: readonly FwMenuItemComponent[])
 declare class FwMenuContainerComponent implements AfterViewInit {
     private sanitizer;
     private ngZone;
+    /**
+     * The container's own element. Exposed because this component is usually rendered into a cdk
+     * overlay, so a consumer holding the instance has no other way to reach the rendered panel.
+     */
+    readonly hostElement: HTMLElement;
     menuWrapperRef: _angular_core.Signal<HTMLElement>;
     canScrollUp: _angular_core.WritableSignal<boolean>;
     canScrollDown: _angular_core.WritableSignal<boolean>;
@@ -1918,10 +1931,31 @@ declare class MenuRegisterDirective implements OnInit, OnDestroy {
  * Form control component for selecting multiple options from a dropdown, displaying selected values as chips
  * @see [Vision storybook](https://cdn.flywheel.io/docs/vision/master/?path=/docs/form-controls-multi-select--docs)
  */
-declare class FwMultiSelectMenuComponent implements ControlValueAccessor, AfterContentInit, OnDestroy {
+declare class FwMultiSelectMenuComponent implements ControlValueAccessor, AfterContentInit, OnInit, OnDestroy {
     private elementRef;
+    private document;
     readonly listboxId: string;
-    outsideClick(event: MouseEvent): void;
+    private readonly documentClickListener;
+    /**
+     * Closes the options panel when a click lands outside of both the trigger and the panel.
+     *
+     * Registered by hand instead of through `@HostListener('document:click')` so that it runs in the
+     * capture phase: a number of components in the library (`fw-menu-item`, `fw-chip`, `fw-navbar-item`,
+     * the dialog backdrop, ...) call `stopPropagation()` on click, which would otherwise keep this
+     * listener from ever seeing the click and leave the panel open.
+     */
+    outsideClick(event: Event): void;
+    /**
+     * Whether the options panel is currently open. The single place this class asks that question -
+     * the trigger owns the state, so there is no local flag to keep in sync.
+     *
+     * ! Deliberately a plain method, not a `computed()` ! The trigger reports its state from the
+     * overlay ref rather than from a signal, so a computed would memoize the first answer and stop
+     * tracking, silently freezing `aria-expanded`.
+     */
+    isMenuOpen(): boolean;
+    /** Whether an event originated on this select's control box or inside its rendered options panel */
+    private isEventInsideSelect;
     readonly options: _angular_core.InputSignal<object[]>;
     readonly valueProperty: _angular_core.InputSignal<string>;
     readonly titleProperty: _angular_core.InputSignal<string>;
@@ -1945,6 +1979,12 @@ declare class FwMultiSelectMenuComponent implements ControlValueAccessor, AfterC
     readonly size: _angular_core.InputSignal<"large" | "medium" | "small">;
     trigger: CdkMenuTrigger;
     menu: FwMenuComponent;
+    /**
+     * The control itself, which is only as wide as `width()`. The host element is a block element and
+     * so can be considerably wider, and a click in that gap is an outside click.
+     */
+    private wrapper;
+    /** The options panel, `undefined` while it is closed since it only exists inside the cdk overlay */
     menuFilter: _angular_core.Signal<FwMenuContainerComponent>;
     renderedMenuItems: QueryList<FwMenuItemComponent>;
     customMenuItems: QueryList<FwMenuItemComponent>;
@@ -1955,7 +1995,6 @@ declare class FwMultiSelectMenuComponent implements ControlValueAccessor, AfterC
     focusedIndex: WritableSignal<number>;
     touched: boolean;
     private subscriptions;
-    private _isOpen;
     change: EventEmitter<any>;
     defaultFilter: MenuFilterFn;
     /**
@@ -1974,6 +2013,7 @@ declare class FwMultiSelectMenuComponent implements ControlValueAccessor, AfterC
     registerOnTouched(fn: () => void): void;
     setDisabledState?(isDisabled: boolean): void;
     writeValue(value: any[]): void;
+    ngOnInit(): void;
     ngOnDestroy(): void;
     ngAfterContentInit(): void;
     private registerCustomMenuItems;
@@ -2000,8 +2040,20 @@ type DisplayFn = (menuItem: FwMenuItemComponent) => string;
  */
 declare class FwSelectMenuComponent implements OnInit, OnDestroy, ControlValueAccessor {
     private ngControl;
+    private document;
     readonly listboxId: string;
-    outsideClick(evt: any): void;
+    private readonly documentClickListener;
+    /**
+     * Closes the options panel when a click lands outside of both the trigger and the panel.
+     *
+     * Registered by hand instead of through `@HostListener('document:click')` so that it runs in the
+     * capture phase: a number of components in the library (`fw-menu-item`, `fw-chip`, `fw-navbar-item`,
+     * the dialog backdrop, ...) call `stopPropagation()` on click, which would otherwise keep this
+     * listener from ever seeing the click and leave the panel open.
+     */
+    outsideClick(event: Event): void;
+    /** Whether an event originated on this select's control box or inside its rendered options panel */
+    private isEventInsideSelect;
     get disabledClass(): boolean;
     options: _angular_core.InputSignal<Object[]>;
     valueProperty: _angular_core.InputSignal<string>;
@@ -2023,6 +2075,13 @@ declare class FwSelectMenuComponent implements OnInit, OnDestroy, ControlValueAc
     trigger: CdkMenuTrigger;
     textInput: FwTextInputComponent;
     menu: _angular_core.Signal<FwMenuComponent>;
+    /**
+     * The control itself, which is only as wide as `width()`. The host element is a block element and
+     * so can be considerably wider, and a click in that gap is an outside click.
+     */
+    private wrapper;
+    /** The options panel, `undefined` while it is closed since it only exists inside the cdk overlay */
+    private panel;
     menuItems: _angular_core.Signal<readonly FwMenuItemComponent[]>;
     viewMenuItems: _angular_core.Signal<readonly FwMenuItemComponent[]>;
     menuItemGroups: _angular_core.Signal<readonly FwMenuItemGroupComponent[]>;
@@ -2034,10 +2093,12 @@ declare class FwSelectMenuComponent implements OnInit, OnDestroy, ControlValueAc
     filterValue: _angular_core.WritableSignal<string>;
     private menuItemClickSubscriptions;
     private subscriptions;
-    private _isOpen;
     focused: number;
     inFocusOpen: boolean;
     preFocusValue: any;
+    /** Displayed value and title as of the last time the panel was opened, used to undo a dismissed filter */
+    private displayValueOnOpen;
+    private displayTitleOnOpen;
     isTyping: _angular_core.WritableSignal<boolean>;
     valueDisplayFn: _angular_core.InputSignal<DisplayFn>;
     custom(menuItem: FwMenuItemComponent): string;
@@ -2074,6 +2135,14 @@ declare class FwSelectMenuComponent implements OnInit, OnDestroy, ControlValueAc
     setDisabledState(isDisabled: boolean): void;
     writeValue(value: any): void;
     handleClick(e: string): void;
+    /**
+     * Whether the options panel is currently open. The single place this class asks that question -
+     * the trigger owns the state, so there is no local flag to keep in sync.
+     *
+     * ! Deliberately a plain method, not a `computed()` ! The trigger reports its state from the
+     * overlay ref rather than from a signal, so a computed would memoize the first answer and stop
+     * tracking, silently freezing `aria-expanded`.
+     */
     isMenuOpen(): boolean;
     /**
      * The DOM id of the currently active/highlighted option, for aria-activedescendant on the combobox input.