UNPKG

@angular/material

Version:
1,431 lines (1,427 loc) 66.3 kB
/** * @license * Copyright Google LLC All Rights Reserved. * * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.io/license */ import { animate, animateChild, query, state, style, transition, trigger } from '@angular/animations'; import { ActiveDescendantKeyManager, LiveAnnouncer } from '@angular/cdk/a11y'; import { Directionality } from '@angular/cdk/bidi'; import { coerceBooleanProperty } from '@angular/cdk/coercion'; import { SelectionModel } from '@angular/cdk/collections'; import { A, DOWN_ARROW, END, ENTER, HOME, LEFT_ARROW, RIGHT_ARROW, SPACE, UP_ARROW, hasModifierKey } from '@angular/cdk/keycodes'; import { CdkConnectedOverlay, Overlay, OverlayModule } from '@angular/cdk/overlay'; import { ViewportRuler } from '@angular/cdk/scrolling'; import { Attribute, ChangeDetectionStrategy, ChangeDetectorRef, Component, ContentChild, ContentChildren, Directive, ElementRef, EventEmitter, Inject, InjectionToken, Input, isDevMode, NgZone, Optional, Output, Self, ViewChild, ViewEncapsulation, NgModule } from '@angular/core'; import { FormGroupDirective, NgControl, NgForm } from '@angular/forms'; import { _countGroupLabelsBeforeOption, _getOptionScrollPosition, ErrorStateMatcher, MAT_OPTION_PARENT_COMPONENT, MatOptgroup, MatOption, mixinDisabled, mixinDisableRipple, mixinErrorState, mixinTabIndex, MatCommonModule, MatOptionModule } from '@angular/material/core'; import { MatFormField, MatFormFieldControl, MatFormFieldModule } from '@angular/material/form-field'; import { defer, merge, Subject } from 'rxjs'; import { distinctUntilChanged, filter, map, startWith, switchMap, take, takeUntil } from 'rxjs/operators'; import { CommonModule } from '@angular/common'; /** * @fileoverview added by tsickle * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc */ /** * The following are all the animations for the mat-select component, with each * const containing the metadata for one animation. * * The values below match the implementation of the AngularJS Material mat-select animation. * \@docs-private * @type {?} */ const matSelectAnimations = { /** * This animation ensures the select's overlay panel animation (transformPanel) is called when * closing the select. * This is needed due to https://github.com/angular/angular/issues/23302 */ transformPanelWrap: trigger('transformPanelWrap', [ transition('* => void', query('@transformPanel', [animateChild()], { optional: true })) ]), /** * This animation transforms the select's overlay panel on and off the page. * * When the panel is attached to the DOM, it expands its width by the amount of padding, scales it * up to 100% on the Y axis, fades in its border, and translates slightly up and to the * side to ensure the option text correctly overlaps the trigger text. * * When the panel is removed from the DOM, it simply fades out linearly. */ transformPanel: trigger('transformPanel', [ state('void', style({ transform: 'scaleY(0.8)', minWidth: '100%', opacity: 0 })), state('showing', style({ opacity: 1, minWidth: 'calc(100% + 32px)', // 32px = 2 * 16px padding transform: 'scaleY(1)' })), state('showing-multiple', style({ opacity: 1, minWidth: 'calc(100% + 64px)', // 64px = 48px padding on the left + 16px padding on the right transform: 'scaleY(1)' })), transition('void => *', animate('120ms cubic-bezier(0, 0, 0.2, 1)')), transition('* => void', animate('100ms 25ms linear', style({ opacity: 0 }))) ]), /** * This animation fades in the background color and text content of the * select's options. It is time delayed to occur 100ms after the overlay * panel has transformed in. * @deprecated Not used anymore. To be removed. * \@breaking-change 8.0.0 */ fadeInContent: trigger('fadeInContent', [ state('showing', style({ opacity: 1 })), transition('void => showing', [ style({ opacity: 0 }), animate('150ms 100ms cubic-bezier(0.55, 0, 0.55, 0.2)') ]) ]) }; /** * @deprecated * \@breaking-change 8.0.0 * \@docs-private * @type {?} */ const transformPanel = matSelectAnimations.transformPanel; /** * @deprecated * \@breaking-change 8.0.0 * \@docs-private * @type {?} */ const fadeInContent = matSelectAnimations.fadeInContent; /** * @fileoverview added by tsickle * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc */ /** * Returns an exception to be thrown when attempting to change a select's `multiple` option * after initialization. * \@docs-private * @return {?} */ function getMatSelectDynamicMultipleError() { return Error('Cannot change `multiple` mode of select after initialization.'); } /** * Returns an exception to be thrown when attempting to assign a non-array value to a select * in `multiple` mode. Note that `undefined` and `null` are still valid values to allow for * resetting the value. * \@docs-private * @return {?} */ function getMatSelectNonArrayValueError() { return Error('Value must be an array in multiple-selection mode.'); } /** * Returns an exception to be thrown when assigning a non-function value to the comparator * used to determine if a value corresponds to an option. Note that whether the function * actually takes two values and returns a boolean is not checked. * @return {?} */ function getMatSelectNonFunctionValueError() { return Error('`compareWith` must be a function.'); } /** * @fileoverview added by tsickle * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc */ /** @type {?} */ let nextUniqueId = 0; /** * The max height of the select's overlay panel * @type {?} */ const SELECT_PANEL_MAX_HEIGHT = 256; /** * The panel's padding on the x-axis * @type {?} */ const SELECT_PANEL_PADDING_X = 16; /** * The panel's x axis padding if it is indented (e.g. there is an option group). * @type {?} */ const SELECT_PANEL_INDENT_PADDING_X = SELECT_PANEL_PADDING_X * 2; /** * The height of the select items in `em` units. * @type {?} */ const SELECT_ITEM_HEIGHT_EM = 3; // TODO(josephperrott): Revert to a constant after 2018 spec updates are fully merged. /** * Distance between the panel edge and the option text in * multi-selection mode. * * Calculated as: * (SELECT_PANEL_PADDING_X * 1.5) + 16 = 40 * The padding is multiplied by 1.5 because the checkbox's margin is half the padding. * The checkbox width is 16px. * @type {?} */ const SELECT_MULTIPLE_PANEL_PADDING_X = SELECT_PANEL_PADDING_X * 1.5 + 16; /** * The select panel will only "fit" inside the viewport if it is positioned at * this value or more away from the viewport boundary. * @type {?} */ const SELECT_PANEL_VIEWPORT_PADDING = 8; /** * Injection token that determines the scroll handling while a select is open. * @type {?} */ const MAT_SELECT_SCROLL_STRATEGY = new InjectionToken('mat-select-scroll-strategy'); /** * \@docs-private * @param {?} overlay * @return {?} */ function MAT_SELECT_SCROLL_STRATEGY_PROVIDER_FACTORY(overlay) { return (/** * @return {?} */ () => overlay.scrollStrategies.reposition()); } /** * \@docs-private * @type {?} */ const MAT_SELECT_SCROLL_STRATEGY_PROVIDER = { provide: MAT_SELECT_SCROLL_STRATEGY, deps: [Overlay], useFactory: MAT_SELECT_SCROLL_STRATEGY_PROVIDER_FACTORY, }; /** * Change event object that is emitted when the select value has changed. */ class MatSelectChange { /** * @param {?} source * @param {?} value */ constructor(source, value) { this.source = source; this.value = value; } } // Boilerplate for applying mixins to MatSelect. /** * \@docs-private */ class MatSelectBase { /** * @param {?} _elementRef * @param {?} _defaultErrorStateMatcher * @param {?} _parentForm * @param {?} _parentFormGroup * @param {?} ngControl */ constructor(_elementRef, _defaultErrorStateMatcher, _parentForm, _parentFormGroup, ngControl) { this._elementRef = _elementRef; this._defaultErrorStateMatcher = _defaultErrorStateMatcher; this._parentForm = _parentForm; this._parentFormGroup = _parentFormGroup; this.ngControl = ngControl; } } /** @type {?} */ const _MatSelectMixinBase = mixinDisableRipple(mixinTabIndex(mixinDisabled(mixinErrorState(MatSelectBase)))); /** * Allows the user to customize the trigger that is displayed when the select has a value. */ class MatSelectTrigger { } MatSelectTrigger.decorators = [ { type: Directive, args: [{ selector: 'mat-select-trigger' },] }, ]; class MatSelect extends _MatSelectMixinBase { /** * @param {?} _viewportRuler * @param {?} _changeDetectorRef * @param {?} _ngZone * @param {?} _defaultErrorStateMatcher * @param {?} elementRef * @param {?} _dir * @param {?} _parentForm * @param {?} _parentFormGroup * @param {?} _parentFormField * @param {?} ngControl * @param {?} tabIndex * @param {?} scrollStrategyFactory * @param {?=} _liveAnnouncer */ constructor(_viewportRuler, _changeDetectorRef, _ngZone, _defaultErrorStateMatcher, elementRef, _dir, _parentForm, _parentFormGroup, _parentFormField, ngControl, tabIndex, scrollStrategyFactory, _liveAnnouncer) { super(elementRef, _defaultErrorStateMatcher, _parentForm, _parentFormGroup, ngControl); this._viewportRuler = _viewportRuler; this._changeDetectorRef = _changeDetectorRef; this._ngZone = _ngZone; this._dir = _dir; this._parentFormField = _parentFormField; this.ngControl = ngControl; this._liveAnnouncer = _liveAnnouncer; /** * Whether or not the overlay panel is open. */ this._panelOpen = false; /** * Whether filling out the select is required in the form. */ this._required = false; /** * The scroll position of the overlay panel, calculated to center the selected option. */ this._scrollTop = 0; /** * Whether the component is in multiple selection mode. */ this._multiple = false; /** * Comparison function to specify which option is displayed. Defaults to object equality. */ this._compareWith = (/** * @param {?} o1 * @param {?} o2 * @return {?} */ (o1, o2) => o1 === o2); /** * Unique id for this input. */ this._uid = `mat-select-${nextUniqueId++}`; /** * Emits whenever the component is destroyed. */ this._destroy = new Subject(); /** * The cached font-size of the trigger element. */ this._triggerFontSize = 0; /** * `View -> model callback called when value changes` */ this._onChange = (/** * @return {?} */ () => { }); /** * `View -> model callback called when select has been touched` */ this._onTouched = (/** * @return {?} */ () => { }); /** * The IDs of child options to be passed to the aria-owns attribute. */ this._optionIds = ''; /** * The value of the select panel's transform-origin property. */ this._transformOrigin = 'top'; /** * Emits when the panel element is finished transforming in. */ this._panelDoneAnimatingStream = new Subject(); /** * The y-offset of the overlay panel in relation to the trigger's top start corner. * This must be adjusted to align the selected option text over the trigger text. * when the panel opens. Will change based on the y-position of the selected option. */ this._offsetY = 0; /** * This position config ensures that the top "start" corner of the overlay * is aligned with with the top "start" of the origin by default (overlapping * the trigger completely). If the panel cannot fit below the trigger, it * will fall back to a position above the trigger. */ this._positions = [ { originX: 'start', originY: 'top', overlayX: 'start', overlayY: 'top', }, { originX: 'start', originY: 'bottom', overlayX: 'start', overlayY: 'bottom', }, ]; /** * Whether the component is disabling centering of the active option over the trigger. */ this._disableOptionCentering = false; this._focused = false; /** * A name for this control that can be used by `mat-form-field`. */ this.controlType = 'mat-select'; /** * Aria label of the select. If not specified, the placeholder will be used as label. */ this.ariaLabel = ''; /** * Combined stream of all of the child options' change events. */ this.optionSelectionChanges = (/** @type {?} */ (defer((/** * @return {?} */ () => { /** @type {?} */ const options = this.options; if (options) { return options.changes.pipe(startWith(options), switchMap((/** * @return {?} */ () => merge(...options.map((/** * @param {?} option * @return {?} */ option => option.onSelectionChange)))))); } return this._ngZone.onStable .asObservable() .pipe(take(1), switchMap((/** * @return {?} */ () => this.optionSelectionChanges))); })))); /** * Event emitted when the select panel has been toggled. */ this.openedChange = new EventEmitter(); /** * Event emitted when the select has been opened. */ this._openedStream = this.openedChange.pipe(filter((/** * @param {?} o * @return {?} */ o => o)), map((/** * @return {?} */ () => { }))); /** * Event emitted when the select has been closed. */ this._closedStream = this.openedChange.pipe(filter((/** * @param {?} o * @return {?} */ o => !o)), map((/** * @return {?} */ () => { }))); /** * Event emitted when the selected value has been changed by the user. */ this.selectionChange = new EventEmitter(); /** * Event that emits whenever the raw value of the select changes. This is here primarily * to facilitate the two-way binding for the `value` input. * \@docs-private */ this.valueChange = new EventEmitter(); if (this.ngControl) { // Note: we provide the value accessor through here, instead of // the `providers` to avoid running into a circular import. this.ngControl.valueAccessor = this; } this._scrollStrategyFactory = scrollStrategyFactory; this._scrollStrategy = this._scrollStrategyFactory(); this.tabIndex = parseInt(tabIndex) || 0; // Force setter to be called in case id was not specified. this.id = this.id; } /** * Whether the select is focused. * @return {?} */ get focused() { return this._focused || this._panelOpen; } /** * @deprecated Setter to be removed as this property is intended to be readonly. * \@breaking-change 8.0.0 * @param {?} value * @return {?} */ set focused(value) { this._focused = value; } /** * Placeholder to be shown if no value has been selected. * @return {?} */ get placeholder() { return this._placeholder; } /** * @param {?} value * @return {?} */ set placeholder(value) { this._placeholder = value; this.stateChanges.next(); } /** * Whether the component is required. * @return {?} */ get required() { return this._required; } /** * @param {?} value * @return {?} */ set required(value) { this._required = coerceBooleanProperty(value); this.stateChanges.next(); } /** * Whether the user should be allowed to select multiple options. * @return {?} */ get multiple() { return this._multiple; } /** * @param {?} value * @return {?} */ set multiple(value) { if (this._selectionModel) { throw getMatSelectDynamicMultipleError(); } this._multiple = coerceBooleanProperty(value); } /** * Whether to center the active option over the trigger. * @return {?} */ get disableOptionCentering() { return this._disableOptionCentering; } /** * @param {?} value * @return {?} */ set disableOptionCentering(value) { this._disableOptionCentering = coerceBooleanProperty(value); } /** * Function to compare the option values with the selected values. The first argument * is a value from an option. The second is a value from the selection. A boolean * should be returned. * @return {?} */ get compareWith() { return this._compareWith; } /** * @param {?} fn * @return {?} */ set compareWith(fn) { if (typeof fn !== 'function') { throw getMatSelectNonFunctionValueError(); } this._compareWith = fn; if (this._selectionModel) { // A different comparator means the selection could change. this._initializeSelection(); } } /** * Value of the select control. * @return {?} */ get value() { return this._value; } /** * @param {?} newValue * @return {?} */ set value(newValue) { if (newValue !== this._value) { this.writeValue(newValue); this._value = newValue; } } /** * Unique id of the element. * @return {?} */ get id() { return this._id; } /** * @param {?} value * @return {?} */ set id(value) { this._id = value || this._uid; this.stateChanges.next(); } /** * @return {?} */ ngOnInit() { this._selectionModel = new SelectionModel(this.multiple); this.stateChanges.next(); // We need `distinctUntilChanged` here, because some browsers will // fire the animation end event twice for the same animation. See: // https://github.com/angular/angular/issues/24084 this._panelDoneAnimatingStream .pipe(distinctUntilChanged(), takeUntil(this._destroy)) .subscribe((/** * @return {?} */ () => { if (this.panelOpen) { this._scrollTop = 0; this.openedChange.emit(true); } else { this.openedChange.emit(false); this.overlayDir.offsetX = 0; this._changeDetectorRef.markForCheck(); } })); this._viewportRuler.change() .pipe(takeUntil(this._destroy)) .subscribe((/** * @return {?} */ () => { if (this._panelOpen) { this._triggerRect = this.trigger.nativeElement.getBoundingClientRect(); this._changeDetectorRef.markForCheck(); } })); } /** * @return {?} */ ngAfterContentInit() { this._initKeyManager(); this._selectionModel.onChange.pipe(takeUntil(this._destroy)).subscribe((/** * @param {?} event * @return {?} */ event => { event.added.forEach((/** * @param {?} option * @return {?} */ option => option.select())); event.removed.forEach((/** * @param {?} option * @return {?} */ option => option.deselect())); })); this.options.changes.pipe(startWith(null), takeUntil(this._destroy)).subscribe((/** * @return {?} */ () => { this._resetOptions(); this._initializeSelection(); })); } /** * @return {?} */ ngDoCheck() { if (this.ngControl) { this.updateErrorState(); } } /** * @param {?} changes * @return {?} */ ngOnChanges(changes) { // Updating the disabled state is handled by `mixinDisabled`, but we need to additionally let // the parent form field know to run change detection when the disabled state changes. if (changes['disabled']) { this.stateChanges.next(); } if (changes['typeaheadDebounceInterval'] && this._keyManager) { this._keyManager.withTypeAhead(this.typeaheadDebounceInterval); } } /** * @return {?} */ ngOnDestroy() { this._destroy.next(); this._destroy.complete(); this.stateChanges.complete(); } /** * Toggles the overlay panel open or closed. * @return {?} */ toggle() { this.panelOpen ? this.close() : this.open(); } /** * Opens the overlay panel. * @return {?} */ open() { if (this.disabled || !this.options || !this.options.length || this._panelOpen) { return; } this._triggerRect = this.trigger.nativeElement.getBoundingClientRect(); // Note: The computed font-size will be a string pixel value (e.g. "16px"). // `parseInt` ignores the trailing 'px' and converts this to a number. this._triggerFontSize = parseInt(getComputedStyle(this.trigger.nativeElement).fontSize || '0'); this._panelOpen = true; this._keyManager.withHorizontalOrientation(null); this._calculateOverlayPosition(); this._highlightCorrectOption(); this._changeDetectorRef.markForCheck(); // Set the font size on the panel element once it exists. this._ngZone.onStable.asObservable().pipe(take(1)).subscribe((/** * @return {?} */ () => { if (this._triggerFontSize && this.overlayDir.overlayRef && this.overlayDir.overlayRef.overlayElement) { this.overlayDir.overlayRef.overlayElement.style.fontSize = `${this._triggerFontSize}px`; } })); } /** * Closes the overlay panel and focuses the host element. * @return {?} */ close() { if (this._panelOpen) { this._panelOpen = false; this._keyManager.withHorizontalOrientation(this._isRtl() ? 'rtl' : 'ltr'); this._changeDetectorRef.markForCheck(); this._onTouched(); } } /** * Sets the select's value. Part of the ControlValueAccessor interface * required to integrate with Angular's core forms API. * * @param {?} value New value to be written to the model. * @return {?} */ writeValue(value) { if (this.options) { this._setSelectionByValue(value); } } /** * Saves a callback function to be invoked when the select's value * changes from user input. Part of the ControlValueAccessor interface * required to integrate with Angular's core forms API. * * @param {?} fn Callback to be triggered when the value changes. * @return {?} */ registerOnChange(fn) { this._onChange = fn; } /** * Saves a callback function to be invoked when the select is blurred * by the user. Part of the ControlValueAccessor interface required * to integrate with Angular's core forms API. * * @param {?} fn Callback to be triggered when the component has been touched. * @return {?} */ registerOnTouched(fn) { this._onTouched = fn; } /** * Disables the select. Part of the ControlValueAccessor interface required * to integrate with Angular's core forms API. * * @param {?} isDisabled Sets whether the component is disabled. * @return {?} */ setDisabledState(isDisabled) { this.disabled = isDisabled; this._changeDetectorRef.markForCheck(); this.stateChanges.next(); } /** * Whether or not the overlay panel is open. * @return {?} */ get panelOpen() { return this._panelOpen; } /** * The currently selected option. * @return {?} */ get selected() { return this.multiple ? this._selectionModel.selected : this._selectionModel.selected[0]; } /** * The value displayed in the trigger. * @return {?} */ get triggerValue() { if (this.empty) { return ''; } if (this._multiple) { /** @type {?} */ const selectedOptions = this._selectionModel.selected.map((/** * @param {?} option * @return {?} */ option => option.viewValue)); if (this._isRtl()) { selectedOptions.reverse(); } // TODO(crisbeto): delimiter should be configurable for proper localization. return selectedOptions.join(', '); } return this._selectionModel.selected[0].viewValue; } /** * Whether the element is in RTL mode. * @return {?} */ _isRtl() { return this._dir ? this._dir.value === 'rtl' : false; } /** * Handles all keydown events on the select. * @param {?} event * @return {?} */ _handleKeydown(event) { if (!this.disabled) { this.panelOpen ? this._handleOpenKeydown(event) : this._handleClosedKeydown(event); } } /** * Handles keyboard events while the select is closed. * @private * @param {?} event * @return {?} */ _handleClosedKeydown(event) { /** @type {?} */ const keyCode = event.keyCode; /** @type {?} */ const isArrowKey = keyCode === DOWN_ARROW || keyCode === UP_ARROW || keyCode === LEFT_ARROW || keyCode === RIGHT_ARROW; /** @type {?} */ const isOpenKey = keyCode === ENTER || keyCode === SPACE; /** @type {?} */ const manager = this._keyManager; // Open the select on ALT + arrow key to match the native <select> if ((isOpenKey && !hasModifierKey(event)) || ((this.multiple || event.altKey) && isArrowKey)) { event.preventDefault(); // prevents the page from scrolling down when pressing space this.open(); } else if (!this.multiple) { /** @type {?} */ const previouslySelectedOption = this.selected; if (keyCode === HOME || keyCode === END) { keyCode === HOME ? manager.setFirstItemActive() : manager.setLastItemActive(); event.preventDefault(); } else { manager.onKeydown(event); } /** @type {?} */ const selectedOption = this.selected; // Since the value has changed, we need to announce it ourselves. // @breaking-change 8.0.0 remove null check for _liveAnnouncer. if (this._liveAnnouncer && selectedOption && previouslySelectedOption !== selectedOption) { // We set a duration on the live announcement, because we want the live element to be // cleared after a while so that users can't navigate to it using the arrow keys. this._liveAnnouncer.announce(((/** @type {?} */ (selectedOption))).viewValue, 10000); } } } /** * Handles keyboard events when the selected is open. * @private * @param {?} event * @return {?} */ _handleOpenKeydown(event) { /** @type {?} */ const keyCode = event.keyCode; /** @type {?} */ const isArrowKey = keyCode === DOWN_ARROW || keyCode === UP_ARROW; /** @type {?} */ const manager = this._keyManager; if (keyCode === HOME || keyCode === END) { event.preventDefault(); keyCode === HOME ? manager.setFirstItemActive() : manager.setLastItemActive(); } else if (isArrowKey && event.altKey) { // Close the select on ALT + arrow key to match the native <select> event.preventDefault(); this.close(); } else if ((keyCode === ENTER || keyCode === SPACE) && manager.activeItem && !hasModifierKey(event)) { event.preventDefault(); manager.activeItem._selectViaInteraction(); } else if (this._multiple && keyCode === A && event.ctrlKey) { event.preventDefault(); /** @type {?} */ const hasDeselectedOptions = this.options.some((/** * @param {?} opt * @return {?} */ opt => !opt.disabled && !opt.selected)); this.options.forEach((/** * @param {?} option * @return {?} */ option => { if (!option.disabled) { hasDeselectedOptions ? option.select() : option.deselect(); } })); } else { /** @type {?} */ const previouslyFocusedIndex = manager.activeItemIndex; manager.onKeydown(event); if (this._multiple && isArrowKey && event.shiftKey && manager.activeItem && manager.activeItemIndex !== previouslyFocusedIndex) { manager.activeItem._selectViaInteraction(); } } } /** * @return {?} */ _onFocus() { if (!this.disabled) { this._focused = true; this.stateChanges.next(); } } /** * Calls the touched callback only if the panel is closed. Otherwise, the trigger will * "blur" to the panel when it opens, causing a false positive. * @return {?} */ _onBlur() { this._focused = false; if (!this.disabled && !this.panelOpen) { this._onTouched(); this._changeDetectorRef.markForCheck(); this.stateChanges.next(); } } /** * Callback that is invoked when the overlay panel has been attached. * @return {?} */ _onAttached() { this.overlayDir.positionChange.pipe(take(1)).subscribe((/** * @return {?} */ () => { this._changeDetectorRef.detectChanges(); this._calculateOverlayOffsetX(); this.panel.nativeElement.scrollTop = this._scrollTop; })); } /** * Returns the theme to be used on the panel. * @return {?} */ _getPanelTheme() { return this._parentFormField ? `mat-${this._parentFormField.color}` : ''; } /** * Whether the select has a value. * @return {?} */ get empty() { return !this._selectionModel || this._selectionModel.isEmpty(); } /** * @private * @return {?} */ _initializeSelection() { // Defer setting the value in order to avoid the "Expression // has changed after it was checked" errors from Angular. Promise.resolve().then((/** * @return {?} */ () => { this._setSelectionByValue(this.ngControl ? this.ngControl.value : this._value); this.stateChanges.next(); })); } /** * Sets the selected option based on a value. If no option can be * found with the designated value, the select trigger is cleared. * @private * @param {?} value * @return {?} */ _setSelectionByValue(value) { if (this.multiple && value) { if (!Array.isArray(value)) { throw getMatSelectNonArrayValueError(); } this._selectionModel.clear(); value.forEach((/** * @param {?} currentValue * @return {?} */ (currentValue) => this._selectValue(currentValue))); this._sortValues(); } else { this._selectionModel.clear(); /** @type {?} */ const correspondingOption = this._selectValue(value); // Shift focus to the active item. Note that we shouldn't do this in multiple // mode, because we don't know what option the user interacted with last. if (correspondingOption) { this._keyManager.setActiveItem(correspondingOption); } else if (!this.panelOpen) { // Otherwise reset the highlighted option. Note that we only want to do this while // closed, because doing it while open can shift the user's focus unnecessarily. this._keyManager.setActiveItem(-1); } } this._changeDetectorRef.markForCheck(); } /** * Finds and selects and option based on its value. * @private * @param {?} value * @return {?} Option that has the corresponding value. */ _selectValue(value) { /** @type {?} */ const correspondingOption = this.options.find((/** * @param {?} option * @return {?} */ (option) => { try { // Treat null as a special reset value. return option.value != null && this._compareWith(option.value, value); } catch (error) { if (isDevMode()) { // Notify developers of errors in their comparator. console.warn(error); } return false; } })); if (correspondingOption) { this._selectionModel.select(correspondingOption); } return correspondingOption; } /** * Sets up a key manager to listen to keyboard events on the overlay panel. * @private * @return {?} */ _initKeyManager() { this._keyManager = new ActiveDescendantKeyManager(this.options) .withTypeAhead(this.typeaheadDebounceInterval) .withVerticalOrientation() .withHorizontalOrientation(this._isRtl() ? 'rtl' : 'ltr') .withAllowedModifierKeys(['shiftKey']); this._keyManager.tabOut.pipe(takeUntil(this._destroy)).subscribe((/** * @return {?} */ () => { // Restore focus to the trigger before closing. Ensures that the focus // position won't be lost if the user got focus into the overlay. this.focus(); this.close(); })); this._keyManager.change.pipe(takeUntil(this._destroy)).subscribe((/** * @return {?} */ () => { if (this._panelOpen && this.panel) { this._scrollActiveOptionIntoView(); } else if (!this._panelOpen && !this.multiple && this._keyManager.activeItem) { this._keyManager.activeItem._selectViaInteraction(); } })); } /** * Drops current option subscriptions and IDs and resets from scratch. * @private * @return {?} */ _resetOptions() { /** @type {?} */ const changedOrDestroyed = merge(this.options.changes, this._destroy); this.optionSelectionChanges.pipe(takeUntil(changedOrDestroyed)).subscribe((/** * @param {?} event * @return {?} */ event => { this._onSelect(event.source, event.isUserInput); if (event.isUserInput && !this.multiple && this._panelOpen) { this.close(); this.focus(); } })); // Listen to changes in the internal state of the options and react accordingly. // Handles cases like the labels of the selected options changing. merge(...this.options.map((/** * @param {?} option * @return {?} */ option => option._stateChanges))) .pipe(takeUntil(changedOrDestroyed)) .subscribe((/** * @return {?} */ () => { this._changeDetectorRef.markForCheck(); this.stateChanges.next(); })); this._setOptionIds(); } /** * Invoked when an option is clicked. * @private * @param {?} option * @param {?} isUserInput * @return {?} */ _onSelect(option, isUserInput) { /** @type {?} */ const wasSelected = this._selectionModel.isSelected(option); if (option.value == null && !this._multiple) { option.deselect(); this._selectionModel.clear(); this._propagateChanges(option.value); } else { if (wasSelected !== option.selected) { option.selected ? this._selectionModel.select(option) : this._selectionModel.deselect(option); } if (isUserInput) { this._keyManager.setActiveItem(option); } if (this.multiple) { this._sortValues(); if (isUserInput) { // In case the user selected the option with their mouse, we // want to restore focus back to the trigger, in order to // prevent the select keyboard controls from clashing with // the ones from `mat-option`. this.focus(); } } } if (wasSelected !== this._selectionModel.isSelected(option)) { this._propagateChanges(); } this.stateChanges.next(); } /** * Sorts the selected values in the selected based on their order in the panel. * @private * @return {?} */ _sortValues() { if (this.multiple) { /** @type {?} */ const options = this.options.toArray(); this._selectionModel.sort((/** * @param {?} a * @param {?} b * @return {?} */ (a, b) => { return this.sortComparator ? this.sortComparator(a, b, options) : options.indexOf(a) - options.indexOf(b); })); this.stateChanges.next(); } } /** * Emits change event to set the model value. * @private * @param {?=} fallbackValue * @return {?} */ _propagateChanges(fallbackValue) { /** @type {?} */ let valueToEmit = null; if (this.multiple) { valueToEmit = ((/** @type {?} */ (this.selected))).map((/** * @param {?} option * @return {?} */ option => option.value)); } else { valueToEmit = this.selected ? ((/** @type {?} */ (this.selected))).value : fallbackValue; } this._value = valueToEmit; this.valueChange.emit(valueToEmit); this._onChange(valueToEmit); this.selectionChange.emit(new MatSelectChange(this, valueToEmit)); this._changeDetectorRef.markForCheck(); } /** * Records option IDs to pass to the aria-owns property. * @private * @return {?} */ _setOptionIds() { this._optionIds = this.options.map((/** * @param {?} option * @return {?} */ option => option.id)).join(' '); } /** * Highlights the selected item. If no option is selected, it will highlight * the first item instead. * @private * @return {?} */ _highlightCorrectOption() { if (this._keyManager) { if (this.empty) { this._keyManager.setFirstItemActive(); } else { this._keyManager.setActiveItem(this._selectionModel.selected[0]); } } } /** * Scrolls the active option into view. * @private * @return {?} */ _scrollActiveOptionIntoView() { /** @type {?} */ const activeOptionIndex = this._keyManager.activeItemIndex || 0; /** @type {?} */ const labelCount = _countGroupLabelsBeforeOption(activeOptionIndex, this.options, this.optionGroups); this.panel.nativeElement.scrollTop = _getOptionScrollPosition(activeOptionIndex + labelCount, this._getItemHeight(), this.panel.nativeElement.scrollTop, SELECT_PANEL_MAX_HEIGHT); } /** * Focuses the select element. * @param {?=} options * @return {?} */ focus(options) { this._elementRef.nativeElement.focus(options); } /** * Gets the index of the provided option in the option list. * @private * @param {?} option * @return {?} */ _getOptionIndex(option) { return this.options.reduce((/** * @param {?} result * @param {?} current * @param {?} index * @return {?} */ (result, current, index) => { return result === undefined ? (option === current ? index : undefined) : result; }), undefined); } /** * Calculates the scroll position and x- and y-offsets of the overlay panel. * @private * @return {?} */ _calculateOverlayPosition() { /** @type {?} */ const itemHeight = this._getItemHeight(); /** @type {?} */ const items = this._getItemCount(); /** @type {?} */ const panelHeight = Math.min(items * itemHeight, SELECT_PANEL_MAX_HEIGHT); /** @type {?} */ const scrollContainerHeight = items * itemHeight; // The farthest the panel can be scrolled before it hits the bottom /** @type {?} */ const maxScroll = scrollContainerHeight - panelHeight; // If no value is selected we open the popup to the first item. /** @type {?} */ let selectedOptionOffset = this.empty ? 0 : (/** @type {?} */ (this._getOptionIndex(this._selectionModel.selected[0]))); selectedOptionOffset += _countGroupLabelsBeforeOption(selectedOptionOffset, this.options, this.optionGroups); // We must maintain a scroll buffer so the selected option will be scrolled to the // center of the overlay panel rather than the top. /** @type {?} */ const scrollBuffer = panelHeight / 2; this._scrollTop = this._calculateOverlayScroll(selectedOptionOffset, scrollBuffer, maxScroll); this._offsetY = this._calculateOverlayOffsetY(selectedOptionOffset, scrollBuffer, maxScroll); this._checkOverlayWithinViewport(maxScroll); } /** * Calculates the scroll position of the select's overlay panel. * * Attempts to center the selected option in the panel. If the option is * too high or too low in the panel to be scrolled to the center, it clamps the * scroll position to the min or max scroll positions respectively. * @param {?} selectedIndex * @param {?} scrollBuffer * @param {?} maxScroll * @return {?} */ _calculateOverlayScroll(selectedIndex, scrollBuffer, maxScroll) { /** @type {?} */ const itemHeight = this._getItemHeight(); /** @type {?} */ const optionOffsetFromScrollTop = itemHeight * selectedIndex; /** @type {?} */ const halfOptionHeight = itemHeight / 2; // Starts at the optionOffsetFromScrollTop, which scrolls the option to the top of the // scroll container, then subtracts the scroll buffer to scroll the option down to // the center of the overlay panel. Half the option height must be re-added to the // scrollTop so the option is centered based on its middle, not its top edge. /** @type {?} */ const optimalScrollPosition = optionOffsetFromScrollTop - scrollBuffer + halfOptionHeight; return Math.min(Math.max(0, optimalScrollPosition), maxScroll); } /** * Returns the aria-label of the select component. * @return {?} */ _getAriaLabel() { // If an ariaLabelledby value has been set by the consumer, the select should not overwrite the // `aria-labelledby` value by setting the ariaLabel to the placeholder. return this.ariaLabelledby ? null : this.ariaLabel || this.placeholder; } /** * Returns the aria-labelledby of the select component. * @return {?} */ _getAriaLabelledby() { if (this.ariaLabelledby) { return this.ariaLabelledby; } // Note: we use `_getAriaLabel` here, because we want to check whether there's a // computed label. `this.ariaLabel` is only the user-specified label. if (!this._parentFormField || !this._parentFormField._hasFloatingLabel() || this._getAriaLabel()) { return null; } return this._parentFormField._labelId || null; } /** * Determines the `aria-activedescendant` to be set on the host. * @return {?} */ _getAriaActiveDescendant() { if (this.panelOpen && this._keyManager && this._keyManager.activeItem) { return this._keyManager.activeItem.id; } return null; } /** * Sets the x-offset of the overlay panel in relation to the trigger's top start corner. * This must be adjusted to align the selected option text over the trigger text when * the panel opens. Will change based on LTR or RTL text direction. Note that the offset * can't be calculated until the panel has been attached, because we need to know the * content width in order to constrain the panel within the viewport. * @private * @return {?} */ _calculateOverlayOffsetX() { /** @type {?} */ const overlayRect = this.overlayDir.overlayRef.overlayElement.getBoundingClientRect(); /** @type {?} */ const viewportSize = this._viewportRuler.getViewportSize(); /** @type {?} */ const isRtl = this._isRtl(); /** @type {?} */ const paddingWidth = this.multiple ? SELECT_MULTIPLE_PANEL_PADDING_X + SELECT_PANEL_PADDING_X : SELECT_PANEL_PADDING_X * 2; /** @type {?} */ let offsetX; // Adjust the offset, depending on the option padding. if (this.multiple) { offsetX = SELECT_MULTIPLE_PANEL_PADDING_X; } else { /** @type {?} */ let selected = this._selectionModel.selected[0] || this.options.first; offsetX = selected && selected.group ? SELECT_PANEL_INDENT_PADDING_X : SELECT_PANEL_PADDING_X; } // Invert the offset in LTR. if (!isRtl) { offsetX *= -1; } // Determine how much the select overflows on each side. /** @type {?} */ const leftOverflow = 0 - (overlayRect.left + offsetX - (isRtl ? paddingWidth : 0)); /** @type {?} */ const rightOverflow = overlayRect.right + offsetX - viewportSize.width + (isRtl ? 0 : paddingWidth); // If the element overflows on either side, reduce the offset to allow it to fit. if (leftOverflow > 0) { offsetX += leftOverflow + SELECT_PANEL_VIEWPORT_PADDING; } else if (rightOverflow > 0) { offsetX -= rightOverflow + SELECT_PANEL_VIEWPORT_PADDING; } // Set the offset directly in order to avoid having to go through change detection and // potentially triggering "changed after it was checked" errors. Round the value to avoid // blurry content in some browsers. this.overlayDir.offsetX = Math.round(offsetX); this.overlayDir.overlayRef.updatePosition(); } /** * Calculates the y-offset of the select's overlay panel in relation to the * top start corner of the trigger. It has to be adjusted in order for the * selected option to be aligned over the trigger when the panel opens. * @private * @param {?} selectedIndex * @param {?} scrollBuffer * @param {?} maxScroll * @return {?} */ _calculateOverlayOffsetY(selectedIndex, scrollBuffer, maxScroll) { /** @type {?} */ const itemHeight = this._getItemHeight(); /** @type {?} */ const optionHeightAdjustment = (itemHeight - this._triggerRect.height) / 2; /** @type {?} */ const maxOptionsDisplayed = Math.floor(SELECT_PANEL_MAX_HEIGHT / itemHeight); /** @type {?} */ let optionOffsetFromPanelTop; // Disable offset if requested by user by returning 0 as value to offset if (this._disableOptionCentering) { return 0; } if (this._scrollTop === 0) { optionOffsetFromPanelTop = selectedIndex * itemHeight; } else if (this._scrollTop === maxScroll) { /**