@angular/material
Version:
Angular Material
1,322 lines (1,317 loc) • 57.9 kB
JavaScript
/**
* @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 { Attribute, ChangeDetectionStrategy, ChangeDetectorRef, Component, ContentChild, ContentChildren, Directive, ElementRef, EventEmitter, Inject, InjectionToken, Input, NgModule, NgZone, Optional, Output, Self, ViewChild, ViewEncapsulation, isDevMode } from '@angular/core';
import { CommonModule } from '@angular/common';
import { ActiveDescendantKeyManager } from '@angular/cdk/a11y';
import { Directionality } from '@angular/cdk/bidi';
import { coerceBooleanProperty } from '@angular/cdk/coercion';
import { SelectionModel } from '@angular/cdk/collections';
import { DOWN_ARROW, END, ENTER, HOME, LEFT_ARROW, RIGHT_ARROW, SPACE, UP_ARROW } from '@angular/cdk/keycodes';
import { CdkConnectedOverlay, Overlay, OverlayModule, ViewportRuler } from '@angular/cdk/overlay';
import { filter } from 'rxjs/operators/filter';
import { take } from 'rxjs/operators/take';
import { map } from 'rxjs/operators/map';
import { switchMap } from 'rxjs/operators/switchMap';
import { startWith } from 'rxjs/operators/startWith';
import { takeUntil } from 'rxjs/operators/takeUntil';
import { FormGroupDirective, NgControl, NgForm } from '@angular/forms';
import { ErrorStateMatcher, MAT_OPTION_PARENT_COMPONENT, MatCommonModule, MatOptgroup, MatOption, MatOptionModule, _countGroupLabelsBeforeOption, _getOptionScrollPosition, mixinDisableRipple, mixinDisabled, mixinErrorState, mixinTabIndex } from '@angular/material/core';
import { MatFormField, MatFormFieldControl, MatFormFieldModule } from '@angular/material/form-field';
import 'rxjs/Observable';
import { merge } from 'rxjs/observable/merge';
import { Subject } from 'rxjs/Subject';
import { defer } from 'rxjs/observable/defer';
import { animate, state, style, transition, trigger } from '@angular/animations';
/**
* @fileoverview added by tsickle
* @suppress {checkTypes} 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.
*/
const matSelectAnimations = {
/**
* 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('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 => *', [
style({
opacity: 0,
minWidth: '100%',
transform: 'scaleY(0)'
}),
animate('150ms cubic-bezier(0.25, 0.8, 0.25, 1)')
]),
transition('* => void', [
animate('250ms 100ms 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.
*/
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
* \@deletion-target 7.0.0
*/
const transformPanel = matSelectAnimations.transformPanel;
/**
* @deprecated
* \@deletion-target 7.0.0
*/
const fadeInContent = matSelectAnimations.fadeInContent;
/**
* @fileoverview added by tsickle
* @suppress {checkTypes} 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} checked by tsc
*/
let nextUniqueId = 0;
/**
* The max height of the select's overlay panel
*/
const SELECT_PANEL_MAX_HEIGHT = 256;
/**
* The panel's padding on the x-axis
*/
const SELECT_PANEL_PADDING_X = 16;
/**
* The panel's x axis padding if it is indented (e.g. there is an option group).
*/
const SELECT_PANEL_INDENT_PADDING_X = SELECT_PANEL_PADDING_X * 2;
/**
* The height of the select items in `em` units.
*/
const SELECT_ITEM_HEIGHT_EM = 3;
/**
* Distance between the panel edge and the option text in
* multi-selection mode.
*
* (SELECT_PANEL_PADDING_X * 1.5) + 20 = 44
* The padding is multiplied by 1.5 because the checkbox's margin is half the padding.
* The checkbox width is 20px.
*/
const SELECT_MULTIPLE_PANEL_PADDING_X = SELECT_PANEL_PADDING_X * 1.5 + 20;
/**
* The select panel will only "fit" inside the viewport if it is positioned at
* this value or more away from the viewport boundary.
*/
const SELECT_PANEL_VIEWPORT_PADDING = 8;
/**
* Injection token that determines the scroll handling while a select is open.
*/
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 () => overlay.scrollStrategies.reposition();
}
/**
* \@docs-private
*/
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;
}
}
/**
* \@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;
}
}
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'
},] },
];
/** @nocollapse */
MatSelectTrigger.ctorParameters = () => [];
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
*/
constructor(_viewportRuler, _changeDetectorRef, _ngZone, _defaultErrorStateMatcher, elementRef, _dir, _parentForm, _parentFormGroup, _parentFormField, ngControl, tabIndex, _scrollStrategyFactory) {
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._scrollStrategyFactory = _scrollStrategyFactory;
/**
* 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 = (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 = () => { };
/**
* `View -> model callback called when select has been touched`
*/
this._onTouched = () => { };
/**
* 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';
/**
* Whether the panel's animation is done.
*/
this._panelDoneAnimating = false;
/**
* Strategy that will be used to handle scrolling while the select panel is open.
*/
this._scrollStrategy = this._scrollStrategyFactory();
/**
* 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 select is focused.
*/
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 = defer(() => {
if (this.options) {
return merge(...this.options.map(option => option.onSelectionChange));
}
return this._ngZone.onStable
.asObservable()
.pipe(take(1), switchMap(() => this.optionSelectionChanges));
});
/**
* Event emitted when the select panel has been toggled.
*/
this.openedChange = new EventEmitter();
/**
* Event emitted when the select has been opened.
* @deprecated Use `openedChange` instead.
* \@deletion-target 6.0.0
*/
this.onOpen = this._openedStream;
/**
* Event emitted when the select has been closed.
* @deprecated Use `openedChange` instead.
* \@deletion-target 6.0.0
*/
this.onClose = this._closedStream;
/**
* Event emitted when the selected value has been changed by the user.
*/
this.selectionChange = new EventEmitter();
/**
* Event emitted when the selected value has been changed by the user.
* @deprecated Use `selectionChange` instead.
* \@deletion-target 6.0.0
*/
this.change = this.selectionChange;
/**
* 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.tabIndex = parseInt(tabIndex) || 0;
// Force setter to be called in case id was not specified.
this.id = this.id;
}
/**
* 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);
}
/**
* A 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();
}
/**
* Event emitted when the select has been opened.
* @return {?}
*/
get _openedStream() {
return this.openedChange.pipe(filter(o => o), map(() => { }));
}
/**
* Event emitted when the select has been closed.
* @return {?}
*/
get _closedStream() {
return this.openedChange.pipe(filter(o => !o), map(() => { }));
}
/**
* @return {?}
*/
ngOnInit() {
this._selectionModel = new SelectionModel(this.multiple, undefined, false);
this.stateChanges.next();
}
/**
* @return {?}
*/
ngAfterContentInit() {
this._initKeyManager();
this.options.changes.pipe(startWith(null), takeUntil(this._destroy)).subscribe(() => {
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();
}
}
/**
* @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) {
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)['font-size']);
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(() => {
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) {
const /** @type {?} */ selectedOptions = this._selectionModel.selected.map(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.
* @param {?} event
* @return {?}
*/
_handleClosedKeydown(event) {
const /** @type {?} */ keyCode = event.keyCode;
const /** @type {?} */ isArrowKey = keyCode === DOWN_ARROW || keyCode === UP_ARROW ||
keyCode === LEFT_ARROW || keyCode === RIGHT_ARROW;
const /** @type {?} */ isOpenKey = keyCode === ENTER || keyCode === SPACE;
// Open the select on ALT + arrow key to match the native <select>
if (isOpenKey || ((this.multiple || event.altKey) && isArrowKey)) {
event.preventDefault(); // prevents the page from scrolling down when pressing space
this.open();
}
else if (!this.multiple) {
this._keyManager.onKeydown(event);
}
}
/**
* Handles keyboard events when the selected is open.
* @param {?} event
* @return {?}
*/
_handleOpenKeydown(event) {
const /** @type {?} */ keyCode = event.keyCode;
const /** @type {?} */ isArrowKey = keyCode === DOWN_ARROW || keyCode === UP_ARROW;
const /** @type {?} */ 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) {
event.preventDefault();
manager.activeItem._selectViaInteraction();
}
else {
const /** @type {?} */ previouslyFocusedIndex = manager.activeItemIndex;
manager.onKeydown(event);
if (this._multiple && isArrowKey && event.shiftKey && manager.activeItem &&
manager.activeItemIndex !== previouslyFocusedIndex) {
manager.activeItem._selectViaInteraction();
}
}
}
/**
* When the panel element is finished transforming in (though not fading in), it
* emits an event and focuses an option if the panel is open.
* @return {?}
*/
_onPanelDone() {
if (this.panelOpen) {
this._scrollTop = 0;
this.openedChange.emit(true);
}
else {
this.openedChange.emit(false);
this._panelDoneAnimating = false;
this.overlayDir.offsetX = 0;
this._changeDetectorRef.markForCheck();
}
}
/**
* When the panel content is done fading in, the _panelDoneAnimating property is
* set so the proper class can be added to the panel.
* @return {?}
*/
_onFadeInDone() {
this._panelDoneAnimating = this.panelOpen;
this._changeDetectorRef.markForCheck();
}
/**
* @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(() => {
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();
}
/**
* @return {?}
*/
_initializeSelection() {
// Defer setting the value in order to avoid the "Expression
// has changed after it was checked" errors from Angular.
Promise.resolve().then(() => {
this._setSelectionByValue(this.ngControl ? this.ngControl.value : this._value);
});
}
/**
* Sets the selected option based on a value. If no option can be
* found with the designated value, the select trigger is cleared.
* @param {?} value
* @param {?=} isUserInput
* @return {?}
*/
_setSelectionByValue(value, isUserInput = false) {
if (this.multiple && value) {
if (!Array.isArray(value)) {
throw getMatSelectNonArrayValueError();
}
this._clearSelection();
value.forEach((currentValue) => this._selectValue(currentValue, isUserInput));
this._sortValues();
}
else {
this._clearSelection();
const /** @type {?} */ correspondingOption = this._selectValue(value, isUserInput);
// 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(this.options.toArray().indexOf(correspondingOption));
}
}
this._changeDetectorRef.markForCheck();
}
/**
* Finds and selects and option based on its value.
* @param {?} value
* @param {?=} isUserInput
* @return {?} Option that has the corresponding value.
*/
_selectValue(value, isUserInput = false) {
const /** @type {?} */ correspondingOption = this.options.find((option) => {
try {
// Treat null as a special reset value.
return option.value != null && this._compareWith(option.value, value);
}
catch (/** @type {?} */ error) {
if (isDevMode()) {
// Notify developers of errors in their comparator.
console.warn(error);
}
return false;
}
});
if (correspondingOption) {
isUserInput ? correspondingOption._selectViaInteraction() : correspondingOption.select();
this._selectionModel.select(correspondingOption);
this.stateChanges.next();
}
return correspondingOption;
}
/**
* Clears the select trigger and deselects every option in the list.
* @param {?=} skip Option that should not be deselected.
* @return {?}
*/
_clearSelection(skip) {
this._selectionModel.clear();
this.options.forEach(option => {
if (option !== skip) {
option.deselect();
}
});
this.stateChanges.next();
}
/**
* Sets up a key manager to listen to keyboard events on the overlay panel.
* @return {?}
*/
_initKeyManager() {
this._keyManager = new ActiveDescendantKeyManager(this.options)
.withTypeAhead()
.withVerticalOrientation()
.withHorizontalOrientation(this._isRtl() ? 'rtl' : 'ltr');
this._keyManager.tabOut.pipe(takeUntil(this._destroy)).subscribe(() => this.close());
this._keyManager.change.pipe(takeUntil(this._destroy)).subscribe(() => {
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.
* @return {?}
*/
_resetOptions() {
const /** @type {?} */ changedOrDestroyed = merge(this.options.changes, this._destroy);
this.optionSelectionChanges
.pipe(takeUntil(changedOrDestroyed), filter(event => event.isUserInput))
.subscribe(event => {
this._onSelect(event.source);
if (!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(option => option._stateChanges))
.pipe(takeUntil(changedOrDestroyed))
.subscribe(() => {
this._changeDetectorRef.markForCheck();
this.stateChanges.next();
});
this._setOptionIds();
}
/**
* Invoked when an option is clicked.
* @param {?} option
* @return {?}
*/
_onSelect(option) {
const /** @type {?} */ wasSelected = this._selectionModel.isSelected(option);
// TODO(crisbeto): handle blank/null options inside multi-select.
if (this.multiple) {
this._selectionModel.toggle(option);
this.stateChanges.next();
wasSelected ? option.deselect() : option.select();
this._keyManager.setActiveItem(/** @type {?} */ ((this._getOptionIndex(option))));
this._sortValues();
}
else {
this._clearSelection(option.value == null ? undefined : option);
if (option.value == null) {
this._propagateChanges(option.value);
}
else {
this._selectionModel.select(option);
this.stateChanges.next();
}
}
if (wasSelected !== this._selectionModel.isSelected(option)) {
this._propagateChanges();
}
}
/**
* Sorts the model values, ensuring that they keep the same
* order that they have in the panel.
* @return {?}
*/
_sortValues() {
if (this._multiple) {
this._selectionModel.clear();
this.options.forEach(option => {
if (option.selected) {
this._selectionModel.select(option);
}
});
this.stateChanges.next();
}
}
/**
* Emits change event to set the model value.
* @param {?=} fallbackValue
* @return {?}
*/
_propagateChanges(fallbackValue) {
let /** @type {?} */ valueToEmit = null;
if (this.multiple) {
valueToEmit = (/** @type {?} */ (this.selected)).map(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.
* @return {?}
*/
_setOptionIds() {
this._optionIds = this.options.map(option => option.id).join(' ');
}
/**
* Highlights the selected item. If no option is selected, it will highlight
* the first item instead.
* @return {?}
*/
_highlightCorrectOption() {
if (this._keyManager) {
if (this.empty) {
this._keyManager.setFirstItemActive();
}
else {
this._keyManager.setActiveItem(/** @type {?} */ ((this._getOptionIndex(this._selectionModel.selected[0]))));
}
}
}
/**
* Scrolls the active option into view.
* @return {?}
*/
_scrollActiveOptionIntoView() {
const /** @type {?} */ activeOptionIndex = this._keyManager.activeItemIndex || 0;
const /** @type {?} */ 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.
* @return {?}
*/
focus() {
this._elementRef.nativeElement.focus();
}
/**
* Gets the index of the provided option in the option list.
* @param {?} option
* @return {?}
*/
_getOptionIndex(option) {
return this.options.reduce((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.
* @return {?}
*/
_calculateOverlayPosition() {
const /** @type {?} */ itemHeight = this._getItemHeight();
const /** @type {?} */ items = this._getItemCount();
const /** @type {?} */ panelHeight = Math.min(items * itemHeight, SELECT_PANEL_MAX_HEIGHT);
const /** @type {?} */ scrollContainerHeight = items * itemHeight;
// The farthest the panel can be scrolled before it hits the bottom
const /** @type {?} */ maxScroll = scrollContainerHeight - panelHeight;
// If no value is selected we open the popup to the first item.
let /** @type {?} */ 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.
const /** @type {?} */ 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) {
const /** @type {?} */ itemHeight = this._getItemHeight();
const /** @type {?} */ optionOffsetFromScrollTop = itemHeight * selectedIndex;
const /** @type {?} */ 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.
const /** @type {?} */ optimalScrollPosition = optionOffsetFromScrollTop - scrollBuffer + halfOptionHeight;
return Math.min(Math.max(0, optimalScrollPosition), maxScroll);
}
/**
* Returns the aria-label of the select component.
* @return {?}
*/
get _ariaLabel() {
// If an ariaLabelledby value has been set, the select should not overwrite the
// `aria-labelledby` value by setting the ariaLabel to the placeholder.
return this.ariaLabelledby ? null : this.ariaLabel || this.placeholder;
}
/**
* 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.
* @return {?}
*/
_calculateOverlayOffsetX() {
const /** @type {?} */ overlayRect = this.overlayDir.overlayRef.overlayElement.getBoundingClientRect();
const /** @type {?} */ viewportSize = this._viewportRuler.getViewportSize();
const /** @type {?} */ isRtl = this._isRtl();
const /** @type {?} */ paddingWidth = this.multiple ? SELECT_MULTIPLE_PANEL_PADDING_X + SELECT_PANEL_PADDING_X :
SELECT_PANEL_PADDING_X * 2;
let /** @type {?} */ offsetX;
// Adjust the offset, depending on the option padding.
if (this.multiple) {
offsetX = SELECT_MULTIPLE_PANEL_PADDING_X;
}
else {
let /** @type {?} */ 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.
const /** @type {?} */ leftOverflow = 0 - (overlayRect.left + offsetX - (isRtl ? paddingWidth : 0));
const /** @type {?} */ 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.
this.overlayDir.offsetX = 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.
* @param {?} selectedIndex
* @param {?} scrollBuffer
* @param {?} maxScroll
* @return {?}
*/
_calculateOverlayOffsetY(selectedIndex, scrollBuffer, maxScroll) {
const /** @type {?} */ itemHeight = this._getItemHeight();
const /** @type {?} */ optionHeightAdjustment = (itemHeight - this._triggerRect.height) / 2;
const /** @type {?} */ maxOptionsDisplayed = Math.floor(SELECT_PANEL_MAX_HEIGHT / itemHeight);
let /** @type {?} */ optionOffsetFromPanelTop;
if (this._scrollTop === 0) {
optionOffsetFromPanelTop = selectedIndex * itemHeight;
}
else if (this._scrollTop === maxScroll) {
const /** @type {?} */ firstDisplayedIndex = this._getItemCount() - maxOptionsDisplayed;
const /** @type {?} */ selectedDisplayIndex = selectedIndex - firstDisplayedIndex;
// The first item is partially out of the viewport. Therefore we need to calculate what
// portion of it is shown in the viewport and account for it in our offset.
let /** @type {?} */ partialItemHeight = itemHeight - (this._getItemCount() * itemHeight - SELECT_PANEL_MAX_HEIGHT) % itemHeight;
// Because the panel height is longer than the height of the options alone,
// there is always extra padding at the top or bottom of the panel. When
// scrolled to the very bottom, this padding is at the top of the panel and
// must be added to the offset.
optionOffsetFromPanelTop = selectedDisplayIndex * itemHeight + partialItemHeight;
}
else {
// If the option was scrolled to the middle of the panel using a scroll buffer,
// its offset will be the scroll buffer minus the half height that was added to
// center it.
optionOffsetFromPanelTop = scrollBuffer - itemHeight / 2;
}
// The final offset is the option's offset from the top, adjusted for the height
// difference, multiplied by -1 to ensure that the overlay moves in the correct
// direction up the page.
return optionOffsetFromPanelTop * -1 - optionHeightAdjustment;
}
/**
* Checks that the attempted overlay position will fit within the viewport.
* If it will not fit, tries to adjust the scroll position and the associated
* y-offset so the panel can open fully on-screen. If it still won't fit,
* sets the offset back to 0 to allow the fallback position to take over.
* @param {?} maxScroll
* @return {?}
*/
_checkOverlayWithinViewport(maxScroll) {
const /** @type {?} */ itemHeight = this._getItemHeight();
const /** @type {?} */ viewportSize = this._viewportRuler.getViewportSize();
const /** @type {?} */ topSpaceAvailable = this._triggerRect.top - SELECT_PANEL_VIEWPORT_PADDING;
const /** @type {?} */ bottomSpaceAvailable = viewportSize.height - this._triggerRect.bottom - SELECT_PANEL_VIEWPORT_PADDING;
const /** @type {?} */ panelHeightTop = Math.abs(this._offsetY);
const /** @type {?} */ totalPanelHeight = Math.min(this._getItemCount() * itemHeight, SELECT_PANEL_MAX_HEIGHT);
const /** @type {?} */ panelHeightBottom = totalPanelHeight - panelHeightTop - this._triggerRect.height;
if (panelHeightBottom > bottomSpaceAvailable) {
this._adjustPanelUp(panelHeightBottom, bottomSpaceAvailable);
}
else if (panelHeightTop > topSpaceAvailable) {
this._adjustPanelDown(panelHeightTop, topSpaceAvailable, maxScroll);
}
else {
this._transformOrigin = this._getOriginBasedOnOption();
}
}
/**
* Adjusts the overlay panel up to fit in the viewport.
* @param {?} panelHeightBottom
* @param {?} bottomSpaceAvailable
* @return {?}
*/
_adjustPanelUp(panelHeightBottom, bottomSpaceAvailable) {
// Browsers ignore fractional scroll offsets, so we need to round.
const /** @type {?} */ distanceBelowViewport = Math.round(panelHeightBottom - bottomSpaceAvailable);
// Scrolls the panel up by the distance it was extending past the boundary, then
// adjusts the offset by that amount to move the panel up into the viewport.
this._scrollTop -= distanceBelowViewport;
this._offsetY -= distanceBelowViewport;
this._transformOrigin = this._getOriginBasedOnOption();
// If the panel is scrolled to the very top, it won't be able to fit the panel
// by scrolling, so set the offset to 0 to allow the fallback position to take
// effect.
if (this._scrollTop <= 0) {
this._scrollTop = 0;
this._offsetY = 0;
this._transformOrigin = `50% bottom 0px`;
}
}
/**
* Adjusts the overlay panel down to fit in the viewport.
* @param {?} panelHeightTop
* @param {?} topSpaceAvailable
* @param {?} maxScroll
* @return {?}
*/
_adjustPanelDown(panelHeightTop, topSpaceAvailable, maxScroll) {
// Browsers ignore fractional scroll offsets, so we need to round.
const /** @type {?} */ distanceAboveViewport = Math.round(panelHeightTop - topSpaceAvailable);
// Scrolls the panel down by the distance it was extending past the boundary, then
// adjusts the offset by that amount to move the panel down into the viewport.
this._scrollTop += distanceAboveViewport;
this._offsetY += distanceAboveViewport;
this._transformOrigin = this._getOriginBasedOnOption();
// If the panel is scrolled to the very bottom, it won't be able to fit the
// panel by scrolling, so set the offset to 0 to allow the fallback position
// to take effect.
if (this._scrollTop >= maxScroll) {
this._scrollTop = maxScroll;
this._offsetY = 0;
this._transformOrigin = `50% top 0px`;
return;
}
}
/**
* Sets the transform origin point based on the selected option.
* @return {?}
*/
_getOriginBasedOnOption() {
const /** @type {?} */ itemHeight = this._getItemHeight();
const /** @type {?} */ optionHeightAdjustment = (itemHeight - this._triggerRect.height) / 2;
const /** @type {?} */ originY = Math.abs(this._offsetY) - optionHeightAdjustment + itemHeight / 2;
return `50% ${originY}px 0px`;
}
/**
* Calculates the amount of items in the select. This includes options and group labels.
* @return {?}
*/
_getItemCount() {
return this.options.length + this.optionGroups.length;
}
/**
* Calculates the height of the select's options.
* @return {?}
*/
_getItemHeight() {
return this._triggerFontSize * SELECT_ITEM_HEIGHT_EM;
}
/**
* Implemented as part of MatFormFieldControl.
* \@docs-private
* @param {?} ids
* @return {?}
*/
setDescribedByIds(ids) {
this._ariaDescribedby = ids.join(' ');
}
/**
* Implemented as part of MatFormFieldControl.
* \@docs-private
* @return {?}
*/
onContainerClick() {
this.focus();
this.open();
}
/**
* Implemented as part of MatFormFieldControl.
* \@docs-private
* @return {?}
*/
get shouldPlaceholderFloat() {
return this._panelOpen || !this.empty;
}
}
MatSelect.decorators = [
{ type: Component, args: [{selector: 'mat-select',
exportAs: 'matSelect',
template: "<div cdk-overlay-origin class=\"mat-select-trigger\" aria-hidden=\"true\" (click)=\"toggle()\" #origin=\"cdkOverlayOrigin\" #trigger><div class=\"mat-select-value\" [ngSwitch]=\"empty\"><span class=\"mat-select-placeholder\" *ngSwitchCase=\"true\">{{placeholder || '\u00A0'}}</span> <span class=\"mat-select-value-text\" *ngSwitchCase=\"false\" [ngSwitch]=\"!!customTrigger\"><span