| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407 |
- /**
- * @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 { DOCUMENT, CommonModule } from '@angular/common';
- import { Inject, Injectable, Optional, SkipSelf, QueryList, Directive, ElementRef, Input, NgZone, isDevMode, InjectionToken, EventEmitter, Output, NgModule, ɵɵdefineInjectable, ɵɵinject } from '@angular/core';
- import { Subject, Subscription, of } from 'rxjs';
- import { UP_ARROW, DOWN_ARROW, LEFT_ARROW, RIGHT_ARROW, TAB, A, Z, ZERO, NINE, hasModifierKey } from '@angular/cdk/keycodes';
- import { debounceTime, filter, map, tap, take } from 'rxjs/operators';
- import { Platform, normalizePassiveListenerOptions, PlatformModule } from '@angular/cdk/platform';
- import { coerceBooleanProperty, coerceElement } from '@angular/cdk/coercion';
- import { ContentObserver, ObserversModule } from '@angular/cdk/observers';
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * IDs are deliminated by an empty space, as per the spec.
- * @type {?}
- */
- const ID_DELIMINATOR = ' ';
- /**
- * Adds the given ID to the specified ARIA attribute on an element.
- * Used for attributes such as aria-labelledby, aria-owns, etc.
- * @param {?} el
- * @param {?} attr
- * @param {?} id
- * @return {?}
- */
- function addAriaReferencedId(el, attr, id) {
- /** @type {?} */
- const ids = getAriaReferenceIds(el, attr);
- if (ids.some((/**
- * @param {?} existingId
- * @return {?}
- */
- existingId => existingId.trim() == id.trim()))) {
- return;
- }
- ids.push(id.trim());
- el.setAttribute(attr, ids.join(ID_DELIMINATOR));
- }
- /**
- * Removes the given ID from the specified ARIA attribute on an element.
- * Used for attributes such as aria-labelledby, aria-owns, etc.
- * @param {?} el
- * @param {?} attr
- * @param {?} id
- * @return {?}
- */
- function removeAriaReferencedId(el, attr, id) {
- /** @type {?} */
- const ids = getAriaReferenceIds(el, attr);
- /** @type {?} */
- const filteredIds = ids.filter((/**
- * @param {?} val
- * @return {?}
- */
- val => val != id.trim()));
- if (filteredIds.length) {
- el.setAttribute(attr, filteredIds.join(ID_DELIMINATOR));
- }
- else {
- el.removeAttribute(attr);
- }
- }
- /**
- * Gets the list of IDs referenced by the given ARIA attribute on an element.
- * Used for attributes such as aria-labelledby, aria-owns, etc.
- * @param {?} el
- * @param {?} attr
- * @return {?}
- */
- function getAriaReferenceIds(el, attr) {
- // Get string array of all individual ids (whitespace deliminated) in the attribute value
- return (el.getAttribute(attr) || '').match(/\S+/g) || [];
- }
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * ID used for the body container where all messages are appended.
- * @type {?}
- */
- const MESSAGES_CONTAINER_ID = 'cdk-describedby-message-container';
- /**
- * ID prefix used for each created message element.
- * @type {?}
- */
- const CDK_DESCRIBEDBY_ID_PREFIX = 'cdk-describedby-message';
- /**
- * Attribute given to each host element that is described by a message element.
- * @type {?}
- */
- const CDK_DESCRIBEDBY_HOST_ATTRIBUTE = 'cdk-describedby-host';
- /**
- * Global incremental identifier for each registered message element.
- * @type {?}
- */
- let nextId = 0;
- /**
- * Global map of all registered message elements that have been placed into the document.
- * @type {?}
- */
- const messageRegistry = new Map();
- /**
- * Container for all registered messages.
- * @type {?}
- */
- let messagesContainer = null;
- /**
- * Utility that creates visually hidden elements with a message content. Useful for elements that
- * want to use aria-describedby to further describe themselves without adding additional visual
- * content.
- */
- class AriaDescriber {
- /**
- * @param {?} _document
- */
- constructor(_document) {
- this._document = _document;
- }
- /**
- * Adds to the host element an aria-describedby reference to a hidden element that contains
- * the message. If the same message has already been registered, then it will reuse the created
- * message element.
- * @param {?} hostElement
- * @param {?} message
- * @return {?}
- */
- describe(hostElement, message) {
- if (!this._canBeDescribed(hostElement, message)) {
- return;
- }
- if (typeof message !== 'string') {
- // We need to ensure that the element has an ID.
- this._setMessageId(message);
- messageRegistry.set(message, { messageElement: message, referenceCount: 0 });
- }
- else if (!messageRegistry.has(message)) {
- this._createMessageElement(message);
- }
- if (!this._isElementDescribedByMessage(hostElement, message)) {
- this._addMessageReference(hostElement, message);
- }
- }
- /**
- * Removes the host element's aria-describedby reference to the message element.
- * @param {?} hostElement
- * @param {?} message
- * @return {?}
- */
- removeDescription(hostElement, message) {
- if (!this._isElementNode(hostElement)) {
- return;
- }
- if (this._isElementDescribedByMessage(hostElement, message)) {
- this._removeMessageReference(hostElement, message);
- }
- // If the message is a string, it means that it's one that we created for the
- // consumer so we can remove it safely, otherwise we should leave it in place.
- if (typeof message === 'string') {
- /** @type {?} */
- const registeredMessage = messageRegistry.get(message);
- if (registeredMessage && registeredMessage.referenceCount === 0) {
- this._deleteMessageElement(message);
- }
- }
- if (messagesContainer && messagesContainer.childNodes.length === 0) {
- this._deleteMessagesContainer();
- }
- }
- /**
- * Unregisters all created message elements and removes the message container.
- * @return {?}
- */
- ngOnDestroy() {
- /** @type {?} */
- const describedElements = this._document.querySelectorAll(`[${CDK_DESCRIBEDBY_HOST_ATTRIBUTE}]`);
- for (let i = 0; i < describedElements.length; i++) {
- this._removeCdkDescribedByReferenceIds(describedElements[i]);
- describedElements[i].removeAttribute(CDK_DESCRIBEDBY_HOST_ATTRIBUTE);
- }
- if (messagesContainer) {
- this._deleteMessagesContainer();
- }
- messageRegistry.clear();
- }
- /**
- * Creates a new element in the visually hidden message container element with the message
- * as its content and adds it to the message registry.
- * @private
- * @param {?} message
- * @return {?}
- */
- _createMessageElement(message) {
- /** @type {?} */
- const messageElement = this._document.createElement('div');
- this._setMessageId(messageElement);
- messageElement.textContent = message;
- this._createMessagesContainer();
- (/** @type {?} */ (messagesContainer)).appendChild(messageElement);
- messageRegistry.set(message, { messageElement, referenceCount: 0 });
- }
- /**
- * Assigns a unique ID to an element, if it doesn't have one already.
- * @private
- * @param {?} element
- * @return {?}
- */
- _setMessageId(element) {
- if (!element.id) {
- element.id = `${CDK_DESCRIBEDBY_ID_PREFIX}-${nextId++}`;
- }
- }
- /**
- * Deletes the message element from the global messages container.
- * @private
- * @param {?} message
- * @return {?}
- */
- _deleteMessageElement(message) {
- /** @type {?} */
- const registeredMessage = messageRegistry.get(message);
- /** @type {?} */
- const messageElement = registeredMessage && registeredMessage.messageElement;
- if (messagesContainer && messageElement) {
- messagesContainer.removeChild(messageElement);
- }
- messageRegistry.delete(message);
- }
- /**
- * Creates the global container for all aria-describedby messages.
- * @private
- * @return {?}
- */
- _createMessagesContainer() {
- if (!messagesContainer) {
- /** @type {?} */
- const preExistingContainer = this._document.getElementById(MESSAGES_CONTAINER_ID);
- // When going from the server to the client, we may end up in a situation where there's
- // already a container on the page, but we don't have a reference to it. Clear the
- // old container so we don't get duplicates. Doing this, instead of emptying the previous
- // container, should be slightly faster.
- if (preExistingContainer) {
- (/** @type {?} */ (preExistingContainer.parentNode)).removeChild(preExistingContainer);
- }
- messagesContainer = this._document.createElement('div');
- messagesContainer.id = MESSAGES_CONTAINER_ID;
- messagesContainer.setAttribute('aria-hidden', 'true');
- messagesContainer.style.display = 'none';
- this._document.body.appendChild(messagesContainer);
- }
- }
- /**
- * Deletes the global messages container.
- * @private
- * @return {?}
- */
- _deleteMessagesContainer() {
- if (messagesContainer && messagesContainer.parentNode) {
- messagesContainer.parentNode.removeChild(messagesContainer);
- messagesContainer = null;
- }
- }
- /**
- * Removes all cdk-describedby messages that are hosted through the element.
- * @private
- * @param {?} element
- * @return {?}
- */
- _removeCdkDescribedByReferenceIds(element) {
- // Remove all aria-describedby reference IDs that are prefixed by CDK_DESCRIBEDBY_ID_PREFIX
- /** @type {?} */
- const originalReferenceIds = getAriaReferenceIds(element, 'aria-describedby')
- .filter((/**
- * @param {?} id
- * @return {?}
- */
- id => id.indexOf(CDK_DESCRIBEDBY_ID_PREFIX) != 0));
- element.setAttribute('aria-describedby', originalReferenceIds.join(' '));
- }
- /**
- * Adds a message reference to the element using aria-describedby and increments the registered
- * message's reference count.
- * @private
- * @param {?} element
- * @param {?} message
- * @return {?}
- */
- _addMessageReference(element, message) {
- /** @type {?} */
- const registeredMessage = (/** @type {?} */ (messageRegistry.get(message)));
- // Add the aria-describedby reference and set the
- // describedby_host attribute to mark the element.
- addAriaReferencedId(element, 'aria-describedby', registeredMessage.messageElement.id);
- element.setAttribute(CDK_DESCRIBEDBY_HOST_ATTRIBUTE, '');
- registeredMessage.referenceCount++;
- }
- /**
- * Removes a message reference from the element using aria-describedby
- * and decrements the registered message's reference count.
- * @private
- * @param {?} element
- * @param {?} message
- * @return {?}
- */
- _removeMessageReference(element, message) {
- /** @type {?} */
- const registeredMessage = (/** @type {?} */ (messageRegistry.get(message)));
- registeredMessage.referenceCount--;
- removeAriaReferencedId(element, 'aria-describedby', registeredMessage.messageElement.id);
- element.removeAttribute(CDK_DESCRIBEDBY_HOST_ATTRIBUTE);
- }
- /**
- * Returns true if the element has been described by the provided message ID.
- * @private
- * @param {?} element
- * @param {?} message
- * @return {?}
- */
- _isElementDescribedByMessage(element, message) {
- /** @type {?} */
- const referenceIds = getAriaReferenceIds(element, 'aria-describedby');
- /** @type {?} */
- const registeredMessage = messageRegistry.get(message);
- /** @type {?} */
- const messageId = registeredMessage && registeredMessage.messageElement.id;
- return !!messageId && referenceIds.indexOf(messageId) != -1;
- }
- /**
- * Determines whether a message can be described on a particular element.
- * @private
- * @param {?} element
- * @param {?} message
- * @return {?}
- */
- _canBeDescribed(element, message) {
- if (!this._isElementNode(element)) {
- return false;
- }
- if (message && typeof message === 'object') {
- // We'd have to make some assumptions about the description element's text, if the consumer
- // passed in an element. Assume that if an element is passed in, the consumer has verified
- // that it can be used as a description.
- return true;
- }
- /** @type {?} */
- const trimmedMessage = message == null ? '' : `${message}`.trim();
- /** @type {?} */
- const ariaLabel = element.getAttribute('aria-label');
- // We shouldn't set descriptions if they're exactly the same as the `aria-label` of the
- // element, because screen readers will end up reading out the same text twice in a row.
- return trimmedMessage ? (!ariaLabel || ariaLabel.trim() !== trimmedMessage) : false;
- }
- /**
- * Checks whether a node is an Element node.
- * @private
- * @param {?} element
- * @return {?}
- */
- _isElementNode(element) {
- return element.nodeType === this._document.ELEMENT_NODE;
- }
- }
- AriaDescriber.decorators = [
- { type: Injectable, args: [{ providedIn: 'root' },] },
- ];
- /** @nocollapse */
- AriaDescriber.ctorParameters = () => [
- { type: undefined, decorators: [{ type: Inject, args: [DOCUMENT,] }] }
- ];
- /** @nocollapse */ AriaDescriber.ngInjectableDef = ɵɵdefineInjectable({ factory: function AriaDescriber_Factory() { return new AriaDescriber(ɵɵinject(DOCUMENT)); }, token: AriaDescriber, providedIn: "root" });
- /**
- * \@docs-private \@deprecated \@breaking-change 8.0.0
- * @param {?} parentDispatcher
- * @param {?} _document
- * @return {?}
- */
- function ARIA_DESCRIBER_PROVIDER_FACTORY(parentDispatcher, _document) {
- return parentDispatcher || new AriaDescriber(_document);
- }
- /**
- * \@docs-private \@deprecated \@breaking-change 8.0.0
- * @type {?}
- */
- const ARIA_DESCRIBER_PROVIDER = {
- // If there is already an AriaDescriber available, use that. Otherwise, provide a new one.
- provide: AriaDescriber,
- deps: [
- [new Optional(), new SkipSelf(), AriaDescriber],
- (/** @type {?} */ (DOCUMENT))
- ],
- useFactory: ARIA_DESCRIBER_PROVIDER_FACTORY
- };
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * This class manages keyboard events for selectable lists. If you pass it a query list
- * of items, it will set the active item correctly when arrow events occur.
- * @template T
- */
- class ListKeyManager {
- /**
- * @param {?} _items
- */
- constructor(_items) {
- this._items = _items;
- this._activeItemIndex = -1;
- this._activeItem = null;
- this._wrap = false;
- this._letterKeyStream = new Subject();
- this._typeaheadSubscription = Subscription.EMPTY;
- this._vertical = true;
- this._allowedModifierKeys = [];
- /**
- * Predicate function that can be used to check whether an item should be skipped
- * by the key manager. By default, disabled items are skipped.
- */
- this._skipPredicateFn = (/**
- * @param {?} item
- * @return {?}
- */
- (item) => item.disabled);
- // Buffer for the letters that the user has pressed when the typeahead option is turned on.
- this._pressedLetters = [];
- /**
- * Stream that emits any time the TAB key is pressed, so components can react
- * when focus is shifted off of the list.
- */
- this.tabOut = new Subject();
- /**
- * Stream that emits whenever the active item of the list manager changes.
- */
- this.change = new Subject();
- // We allow for the items to be an array because, in some cases, the consumer may
- // not have access to a QueryList of the items they want to manage (e.g. when the
- // items aren't being collected via `ViewChildren` or `ContentChildren`).
- if (_items instanceof QueryList) {
- _items.changes.subscribe((/**
- * @param {?} newItems
- * @return {?}
- */
- (newItems) => {
- if (this._activeItem) {
- /** @type {?} */
- const itemArray = newItems.toArray();
- /** @type {?} */
- const newIndex = itemArray.indexOf(this._activeItem);
- if (newIndex > -1 && newIndex !== this._activeItemIndex) {
- this._activeItemIndex = newIndex;
- }
- }
- }));
- }
- }
- /**
- * Sets the predicate function that determines which items should be skipped by the
- * list key manager.
- * @template THIS
- * @this {THIS}
- * @param {?} predicate Function that determines whether the given item should be skipped.
- * @return {THIS}
- */
- skipPredicate(predicate) {
- (/** @type {?} */ (this))._skipPredicateFn = predicate;
- return (/** @type {?} */ (this));
- }
- /**
- * Configures wrapping mode, which determines whether the active item will wrap to
- * the other end of list when there are no more items in the given direction.
- * @template THIS
- * @this {THIS}
- * @param {?=} shouldWrap Whether the list should wrap when reaching the end.
- * @return {THIS}
- */
- withWrap(shouldWrap = true) {
- (/** @type {?} */ (this))._wrap = shouldWrap;
- return (/** @type {?} */ (this));
- }
- /**
- * Configures whether the key manager should be able to move the selection vertically.
- * @template THIS
- * @this {THIS}
- * @param {?=} enabled Whether vertical selection should be enabled.
- * @return {THIS}
- */
- withVerticalOrientation(enabled = true) {
- (/** @type {?} */ (this))._vertical = enabled;
- return (/** @type {?} */ (this));
- }
- /**
- * Configures the key manager to move the selection horizontally.
- * Passing in `null` will disable horizontal movement.
- * @template THIS
- * @this {THIS}
- * @param {?} direction Direction in which the selection can be moved.
- * @return {THIS}
- */
- withHorizontalOrientation(direction) {
- (/** @type {?} */ (this))._horizontal = direction;
- return (/** @type {?} */ (this));
- }
- /**
- * Modifier keys which are allowed to be held down and whose default actions will be prevented
- * as the user is pressing the arrow keys. Defaults to not allowing any modifier keys.
- * @template THIS
- * @this {THIS}
- * @param {?} keys
- * @return {THIS}
- */
- withAllowedModifierKeys(keys) {
- (/** @type {?} */ (this))._allowedModifierKeys = keys;
- return (/** @type {?} */ (this));
- }
- /**
- * Turns on typeahead mode which allows users to set the active item by typing.
- * @template THIS
- * @this {THIS}
- * @param {?=} debounceInterval Time to wait after the last keystroke before setting the active item.
- * @return {THIS}
- */
- withTypeAhead(debounceInterval = 200) {
- if ((/** @type {?} */ (this))._items.length && (/** @type {?} */ (this))._items.some((/**
- * @param {?} item
- * @return {?}
- */
- item => typeof item.getLabel !== 'function'))) {
- throw Error('ListKeyManager items in typeahead mode must implement the `getLabel` method.');
- }
- (/** @type {?} */ (this))._typeaheadSubscription.unsubscribe();
- // Debounce the presses of non-navigational keys, collect the ones that correspond to letters
- // and convert those letters back into a string. Afterwards find the first item that starts
- // with that string and select it.
- (/** @type {?} */ (this))._typeaheadSubscription = (/** @type {?} */ (this))._letterKeyStream.pipe(tap((/**
- * @param {?} keyCode
- * @return {?}
- */
- keyCode => (/** @type {?} */ (this))._pressedLetters.push(keyCode))), debounceTime(debounceInterval), filter((/**
- * @return {?}
- */
- () => (/** @type {?} */ (this))._pressedLetters.length > 0)), map((/**
- * @return {?}
- */
- () => (/** @type {?} */ (this))._pressedLetters.join('')))).subscribe((/**
- * @param {?} inputString
- * @return {?}
- */
- inputString => {
- /** @type {?} */
- const items = (/** @type {?} */ (this))._getItemsArray();
- // Start at 1 because we want to start searching at the item immediately
- // following the current active item.
- for (let i = 1; i < items.length + 1; i++) {
- /** @type {?} */
- const index = ((/** @type {?} */ (this))._activeItemIndex + i) % items.length;
- /** @type {?} */
- const item = items[index];
- if (!(/** @type {?} */ (this))._skipPredicateFn(item) &&
- (/** @type {?} */ (item.getLabel))().toUpperCase().trim().indexOf(inputString) === 0) {
- (/** @type {?} */ (this)).setActiveItem(index);
- break;
- }
- }
- (/** @type {?} */ (this))._pressedLetters = [];
- }));
- return (/** @type {?} */ (this));
- }
- /**
- * @param {?} item
- * @return {?}
- */
- setActiveItem(item) {
- /** @type {?} */
- const previousIndex = this._activeItemIndex;
- this.updateActiveItem(item);
- if (this._activeItemIndex !== previousIndex) {
- this.change.next(this._activeItemIndex);
- }
- }
- /**
- * Sets the active item depending on the key event passed in.
- * @param {?} event Keyboard event to be used for determining which element should be active.
- * @return {?}
- */
- onKeydown(event) {
- /** @type {?} */
- const keyCode = event.keyCode;
- /** @type {?} */
- const modifiers = ['altKey', 'ctrlKey', 'metaKey', 'shiftKey'];
- /** @type {?} */
- const isModifierAllowed = modifiers.every((/**
- * @param {?} modifier
- * @return {?}
- */
- modifier => {
- return !event[modifier] || this._allowedModifierKeys.indexOf(modifier) > -1;
- }));
- switch (keyCode) {
- case TAB:
- this.tabOut.next();
- return;
- case DOWN_ARROW:
- if (this._vertical && isModifierAllowed) {
- this.setNextItemActive();
- break;
- }
- else {
- return;
- }
- case UP_ARROW:
- if (this._vertical && isModifierAllowed) {
- this.setPreviousItemActive();
- break;
- }
- else {
- return;
- }
- case RIGHT_ARROW:
- if (this._horizontal && isModifierAllowed) {
- this._horizontal === 'rtl' ? this.setPreviousItemActive() : this.setNextItemActive();
- break;
- }
- else {
- return;
- }
- case LEFT_ARROW:
- if (this._horizontal && isModifierAllowed) {
- this._horizontal === 'rtl' ? this.setNextItemActive() : this.setPreviousItemActive();
- break;
- }
- else {
- return;
- }
- default:
- if (isModifierAllowed || hasModifierKey(event, 'shiftKey')) {
- // Attempt to use the `event.key` which also maps it to the user's keyboard language,
- // otherwise fall back to resolving alphanumeric characters via the keyCode.
- if (event.key && event.key.length === 1) {
- this._letterKeyStream.next(event.key.toLocaleUpperCase());
- }
- else if ((keyCode >= A && keyCode <= Z) || (keyCode >= ZERO && keyCode <= NINE)) {
- this._letterKeyStream.next(String.fromCharCode(keyCode));
- }
- }
- // Note that we return here, in order to avoid preventing
- // the default action of non-navigational keys.
- return;
- }
- this._pressedLetters = [];
- event.preventDefault();
- }
- /**
- * Index of the currently active item.
- * @return {?}
- */
- get activeItemIndex() {
- return this._activeItemIndex;
- }
- /**
- * The active item.
- * @return {?}
- */
- get activeItem() {
- return this._activeItem;
- }
- /**
- * Sets the active item to the first enabled item in the list.
- * @return {?}
- */
- setFirstItemActive() {
- this._setActiveItemByIndex(0, 1);
- }
- /**
- * Sets the active item to the last enabled item in the list.
- * @return {?}
- */
- setLastItemActive() {
- this._setActiveItemByIndex(this._items.length - 1, -1);
- }
- /**
- * Sets the active item to the next enabled item in the list.
- * @return {?}
- */
- setNextItemActive() {
- this._activeItemIndex < 0 ? this.setFirstItemActive() : this._setActiveItemByDelta(1);
- }
- /**
- * Sets the active item to a previous enabled item in the list.
- * @return {?}
- */
- setPreviousItemActive() {
- this._activeItemIndex < 0 && this._wrap ? this.setLastItemActive()
- : this._setActiveItemByDelta(-1);
- }
- /**
- * @param {?} item
- * @return {?}
- */
- updateActiveItem(item) {
- /** @type {?} */
- const itemArray = this._getItemsArray();
- /** @type {?} */
- const index = typeof item === 'number' ? item : itemArray.indexOf(item);
- /** @type {?} */
- const activeItem = itemArray[index];
- // Explicitly check for `null` and `undefined` because other falsy values are valid.
- this._activeItem = activeItem == null ? null : activeItem;
- this._activeItemIndex = index;
- }
- /**
- * Allows setting of the activeItemIndex without any other effects.
- * @deprecated Use `updateActiveItem` instead.
- * \@breaking-change 8.0.0
- * @param {?} index The new activeItemIndex.
- * @return {?}
- */
- updateActiveItemIndex(index) {
- this.updateActiveItem(index);
- }
- /**
- * This method sets the active item, given a list of items and the delta between the
- * currently active item and the new active item. It will calculate differently
- * depending on whether wrap mode is turned on.
- * @private
- * @param {?} delta
- * @return {?}
- */
- _setActiveItemByDelta(delta) {
- this._wrap ? this._setActiveInWrapMode(delta) : this._setActiveInDefaultMode(delta);
- }
- /**
- * Sets the active item properly given "wrap" mode. In other words, it will continue to move
- * down the list until it finds an item that is not disabled, and it will wrap if it
- * encounters either end of the list.
- * @private
- * @param {?} delta
- * @return {?}
- */
- _setActiveInWrapMode(delta) {
- /** @type {?} */
- const items = this._getItemsArray();
- for (let i = 1; i <= items.length; i++) {
- /** @type {?} */
- const index = (this._activeItemIndex + (delta * i) + items.length) % items.length;
- /** @type {?} */
- const item = items[index];
- if (!this._skipPredicateFn(item)) {
- this.setActiveItem(index);
- return;
- }
- }
- }
- /**
- * Sets the active item properly given the default mode. In other words, it will
- * continue to move down the list until it finds an item that is not disabled. If
- * it encounters either end of the list, it will stop and not wrap.
- * @private
- * @param {?} delta
- * @return {?}
- */
- _setActiveInDefaultMode(delta) {
- this._setActiveItemByIndex(this._activeItemIndex + delta, delta);
- }
- /**
- * Sets the active item to the first enabled item starting at the index specified. If the
- * item is disabled, it will move in the fallbackDelta direction until it either
- * finds an enabled item or encounters the end of the list.
- * @private
- * @param {?} index
- * @param {?} fallbackDelta
- * @return {?}
- */
- _setActiveItemByIndex(index, fallbackDelta) {
- /** @type {?} */
- const items = this._getItemsArray();
- if (!items[index]) {
- return;
- }
- while (this._skipPredicateFn(items[index])) {
- index += fallbackDelta;
- if (!items[index]) {
- return;
- }
- }
- this.setActiveItem(index);
- }
- /**
- * Returns the items as an array.
- * @private
- * @return {?}
- */
- _getItemsArray() {
- return this._items instanceof QueryList ? this._items.toArray() : this._items;
- }
- }
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * @template T
- */
- class ActiveDescendantKeyManager extends ListKeyManager {
- /**
- * @param {?} index
- * @return {?}
- */
- setActiveItem(index) {
- if (this.activeItem) {
- this.activeItem.setInactiveStyles();
- }
- super.setActiveItem(index);
- if (this.activeItem) {
- this.activeItem.setActiveStyles();
- }
- }
- }
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * @template T
- */
- class FocusKeyManager extends ListKeyManager {
- constructor() {
- super(...arguments);
- this._origin = 'program';
- }
- /**
- * Sets the focus origin that will be passed in to the items for any subsequent `focus` calls.
- * @template THIS
- * @this {THIS}
- * @param {?} origin Focus origin to be used when focusing items.
- * @return {THIS}
- */
- setFocusOrigin(origin) {
- (/** @type {?} */ (this))._origin = origin;
- return (/** @type {?} */ (this));
- }
- /**
- * @param {?} item
- * @return {?}
- */
- setActiveItem(item) {
- super.setActiveItem(item);
- if (this.activeItem) {
- this.activeItem.focus(this._origin);
- }
- }
- }
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- // The InteractivityChecker leans heavily on the ally.js accessibility utilities.
- // Methods like `isTabbable` are only covering specific edge-cases for the browsers which are
- // supported.
- /**
- * Utility for checking the interactivity of an element, such as whether is is focusable or
- * tabbable.
- */
- class InteractivityChecker {
- /**
- * @param {?} _platform
- */
- constructor(_platform) {
- this._platform = _platform;
- }
- /**
- * Gets whether an element is disabled.
- *
- * @param {?} element Element to be checked.
- * @return {?} Whether the element is disabled.
- */
- isDisabled(element) {
- // This does not capture some cases, such as a non-form control with a disabled attribute or
- // a form control inside of a disabled form, but should capture the most common cases.
- return element.hasAttribute('disabled');
- }
- /**
- * Gets whether an element is visible for the purposes of interactivity.
- *
- * This will capture states like `display: none` and `visibility: hidden`, but not things like
- * being clipped by an `overflow: hidden` parent or being outside the viewport.
- *
- * @param {?} element
- * @return {?} Whether the element is visible.
- */
- isVisible(element) {
- return hasGeometry(element) && getComputedStyle(element).visibility === 'visible';
- }
- /**
- * Gets whether an element can be reached via Tab key.
- * Assumes that the element has already been checked with isFocusable.
- *
- * @param {?} element Element to be checked.
- * @return {?} Whether the element is tabbable.
- */
- isTabbable(element) {
- // Nothing is tabbable on the server 😎
- if (!this._platform.isBrowser) {
- return false;
- }
- /** @type {?} */
- const frameElement = getFrameElement(getWindow(element));
- if (frameElement) {
- /** @type {?} */
- const frameType = frameElement && frameElement.nodeName.toLowerCase();
- // Frame elements inherit their tabindex onto all child elements.
- if (getTabIndexValue(frameElement) === -1) {
- return false;
- }
- // Webkit and Blink consider anything inside of an <object> element as non-tabbable.
- if ((this._platform.BLINK || this._platform.WEBKIT) && frameType === 'object') {
- return false;
- }
- // Webkit and Blink disable tabbing to an element inside of an invisible frame.
- if ((this._platform.BLINK || this._platform.WEBKIT) && !this.isVisible(frameElement)) {
- return false;
- }
- }
- /** @type {?} */
- let nodeName = element.nodeName.toLowerCase();
- /** @type {?} */
- let tabIndexValue = getTabIndexValue(element);
- if (element.hasAttribute('contenteditable')) {
- return tabIndexValue !== -1;
- }
- if (nodeName === 'iframe') {
- // The frames may be tabbable depending on content, but it's not possibly to reliably
- // investigate the content of the frames.
- return false;
- }
- if (nodeName === 'audio') {
- if (!element.hasAttribute('controls')) {
- // By default an <audio> element without the controls enabled is not tabbable.
- return false;
- }
- else if (this._platform.BLINK) {
- // In Blink <audio controls> elements are always tabbable.
- return true;
- }
- }
- if (nodeName === 'video') {
- if (!element.hasAttribute('controls') && this._platform.TRIDENT) {
- // In Trident a <video> element without the controls enabled is not tabbable.
- return false;
- }
- else if (this._platform.BLINK || this._platform.FIREFOX) {
- // In Chrome and Firefox <video controls> elements are always tabbable.
- return true;
- }
- }
- if (nodeName === 'object' && (this._platform.BLINK || this._platform.WEBKIT)) {
- // In all Blink and WebKit based browsers <object> elements are never tabbable.
- return false;
- }
- // In iOS the browser only considers some specific elements as tabbable.
- if (this._platform.WEBKIT && this._platform.IOS && !isPotentiallyTabbableIOS(element)) {
- return false;
- }
- return element.tabIndex >= 0;
- }
- /**
- * Gets whether an element can be focused by the user.
- *
- * @param {?} element Element to be checked.
- * @return {?} Whether the element is focusable.
- */
- isFocusable(element) {
- // Perform checks in order of left to most expensive.
- // Again, naive approach that does not capture many edge cases and browser quirks.
- return isPotentiallyFocusable(element) && !this.isDisabled(element) && this.isVisible(element);
- }
- }
- InteractivityChecker.decorators = [
- { type: Injectable, args: [{ providedIn: 'root' },] },
- ];
- /** @nocollapse */
- InteractivityChecker.ctorParameters = () => [
- { type: Platform }
- ];
- /** @nocollapse */ InteractivityChecker.ngInjectableDef = ɵɵdefineInjectable({ factory: function InteractivityChecker_Factory() { return new InteractivityChecker(ɵɵinject(Platform)); }, token: InteractivityChecker, providedIn: "root" });
- /**
- * Returns the frame element from a window object. Since browsers like MS Edge throw errors if
- * the frameElement property is being accessed from a different host address, this property
- * should be accessed carefully.
- * @param {?} window
- * @return {?}
- */
- function getFrameElement(window) {
- try {
- return (/** @type {?} */ (window.frameElement));
- }
- catch (_a) {
- return null;
- }
- }
- /**
- * Checks whether the specified element has any geometry / rectangles.
- * @param {?} element
- * @return {?}
- */
- function hasGeometry(element) {
- // Use logic from jQuery to check for an invisible element.
- // See https://github.com/jquery/jquery/blob/master/src/css/hiddenVisibleSelectors.js#L12
- return !!(element.offsetWidth || element.offsetHeight ||
- (typeof element.getClientRects === 'function' && element.getClientRects().length));
- }
- /**
- * Gets whether an element's
- * @param {?} element
- * @return {?}
- */
- function isNativeFormElement(element) {
- /** @type {?} */
- let nodeName = element.nodeName.toLowerCase();
- return nodeName === 'input' ||
- nodeName === 'select' ||
- nodeName === 'button' ||
- nodeName === 'textarea';
- }
- /**
- * Gets whether an element is an `<input type="hidden">`.
- * @param {?} element
- * @return {?}
- */
- function isHiddenInput(element) {
- return isInputElement(element) && element.type == 'hidden';
- }
- /**
- * Gets whether an element is an anchor that has an href attribute.
- * @param {?} element
- * @return {?}
- */
- function isAnchorWithHref(element) {
- return isAnchorElement(element) && element.hasAttribute('href');
- }
- /**
- * Gets whether an element is an input element.
- * @param {?} element
- * @return {?}
- */
- function isInputElement(element) {
- return element.nodeName.toLowerCase() == 'input';
- }
- /**
- * Gets whether an element is an anchor element.
- * @param {?} element
- * @return {?}
- */
- function isAnchorElement(element) {
- return element.nodeName.toLowerCase() == 'a';
- }
- /**
- * Gets whether an element has a valid tabindex.
- * @param {?} element
- * @return {?}
- */
- function hasValidTabIndex(element) {
- if (!element.hasAttribute('tabindex') || element.tabIndex === undefined) {
- return false;
- }
- /** @type {?} */
- let tabIndex = element.getAttribute('tabindex');
- // IE11 parses tabindex="" as the value "-32768"
- if (tabIndex == '-32768') {
- return false;
- }
- return !!(tabIndex && !isNaN(parseInt(tabIndex, 10)));
- }
- /**
- * Returns the parsed tabindex from the element attributes instead of returning the
- * evaluated tabindex from the browsers defaults.
- * @param {?} element
- * @return {?}
- */
- function getTabIndexValue(element) {
- if (!hasValidTabIndex(element)) {
- return null;
- }
- // See browser issue in Gecko https://bugzilla.mozilla.org/show_bug.cgi?id=1128054
- /** @type {?} */
- const tabIndex = parseInt(element.getAttribute('tabindex') || '', 10);
- return isNaN(tabIndex) ? -1 : tabIndex;
- }
- /**
- * Checks whether the specified element is potentially tabbable on iOS
- * @param {?} element
- * @return {?}
- */
- function isPotentiallyTabbableIOS(element) {
- /** @type {?} */
- let nodeName = element.nodeName.toLowerCase();
- /** @type {?} */
- let inputType = nodeName === 'input' && ((/** @type {?} */ (element))).type;
- return inputType === 'text'
- || inputType === 'password'
- || nodeName === 'select'
- || nodeName === 'textarea';
- }
- /**
- * Gets whether an element is potentially focusable without taking current visible/disabled state
- * into account.
- * @param {?} element
- * @return {?}
- */
- function isPotentiallyFocusable(element) {
- // Inputs are potentially focusable *unless* they're type="hidden".
- if (isHiddenInput(element)) {
- return false;
- }
- return isNativeFormElement(element) ||
- isAnchorWithHref(element) ||
- element.hasAttribute('contenteditable') ||
- hasValidTabIndex(element);
- }
- /**
- * Gets the parent window of a DOM node with regards of being inside of an iframe.
- * @param {?} node
- * @return {?}
- */
- function getWindow(node) {
- // ownerDocument is null if `node` itself *is* a document.
- return node.ownerDocument && node.ownerDocument.defaultView || window;
- }
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * Class that allows for trapping focus within a DOM element.
- *
- * This class currently uses a relatively simple approach to focus trapping.
- * It assumes that the tab order is the same as DOM order, which is not necessarily true.
- * Things like `tabIndex > 0`, flex `order`, and shadow roots can cause to two to misalign.
- */
- class FocusTrap {
- /**
- * @param {?} _element
- * @param {?} _checker
- * @param {?} _ngZone
- * @param {?} _document
- * @param {?=} deferAnchors
- */
- constructor(_element, _checker, _ngZone, _document, deferAnchors = false) {
- this._element = _element;
- this._checker = _checker;
- this._ngZone = _ngZone;
- this._document = _document;
- this._hasAttached = false;
- // Event listeners for the anchors. Need to be regular functions so that we can unbind them later.
- this.startAnchorListener = (/**
- * @return {?}
- */
- () => this.focusLastTabbableElement());
- this.endAnchorListener = (/**
- * @return {?}
- */
- () => this.focusFirstTabbableElement());
- this._enabled = true;
- if (!deferAnchors) {
- this.attachAnchors();
- }
- }
- /**
- * Whether the focus trap is active.
- * @return {?}
- */
- get enabled() { return this._enabled; }
- /**
- * @param {?} value
- * @return {?}
- */
- set enabled(value) {
- this._enabled = value;
- if (this._startAnchor && this._endAnchor) {
- this._toggleAnchorTabIndex(value, this._startAnchor);
- this._toggleAnchorTabIndex(value, this._endAnchor);
- }
- }
- /**
- * Destroys the focus trap by cleaning up the anchors.
- * @return {?}
- */
- destroy() {
- /** @type {?} */
- const startAnchor = this._startAnchor;
- /** @type {?} */
- const endAnchor = this._endAnchor;
- if (startAnchor) {
- startAnchor.removeEventListener('focus', this.startAnchorListener);
- if (startAnchor.parentNode) {
- startAnchor.parentNode.removeChild(startAnchor);
- }
- }
- if (endAnchor) {
- endAnchor.removeEventListener('focus', this.endAnchorListener);
- if (endAnchor.parentNode) {
- endAnchor.parentNode.removeChild(endAnchor);
- }
- }
- this._startAnchor = this._endAnchor = null;
- }
- /**
- * Inserts the anchors into the DOM. This is usually done automatically
- * in the constructor, but can be deferred for cases like directives with `*ngIf`.
- * @return {?} Whether the focus trap managed to attach successfuly. This may not be the case
- * if the target element isn't currently in the DOM.
- */
- attachAnchors() {
- // If we're not on the browser, there can be no focus to trap.
- if (this._hasAttached) {
- return true;
- }
- this._ngZone.runOutsideAngular((/**
- * @return {?}
- */
- () => {
- if (!this._startAnchor) {
- this._startAnchor = this._createAnchor();
- (/** @type {?} */ (this._startAnchor)).addEventListener('focus', this.startAnchorListener);
- }
- if (!this._endAnchor) {
- this._endAnchor = this._createAnchor();
- (/** @type {?} */ (this._endAnchor)).addEventListener('focus', this.endAnchorListener);
- }
- }));
- if (this._element.parentNode) {
- this._element.parentNode.insertBefore((/** @type {?} */ (this._startAnchor)), this._element);
- this._element.parentNode.insertBefore((/** @type {?} */ (this._endAnchor)), this._element.nextSibling);
- this._hasAttached = true;
- }
- return this._hasAttached;
- }
- /**
- * Waits for the zone to stabilize, then either focuses the first element that the
- * user specified, or the first tabbable element.
- * @return {?} Returns a promise that resolves with a boolean, depending
- * on whether focus was moved successfuly.
- */
- focusInitialElementWhenReady() {
- return new Promise((/**
- * @param {?} resolve
- * @return {?}
- */
- resolve => {
- this._executeOnStable((/**
- * @return {?}
- */
- () => resolve(this.focusInitialElement())));
- }));
- }
- /**
- * Waits for the zone to stabilize, then focuses
- * the first tabbable element within the focus trap region.
- * @return {?} Returns a promise that resolves with a boolean, depending
- * on whether focus was moved successfuly.
- */
- focusFirstTabbableElementWhenReady() {
- return new Promise((/**
- * @param {?} resolve
- * @return {?}
- */
- resolve => {
- this._executeOnStable((/**
- * @return {?}
- */
- () => resolve(this.focusFirstTabbableElement())));
- }));
- }
- /**
- * Waits for the zone to stabilize, then focuses
- * the last tabbable element within the focus trap region.
- * @return {?} Returns a promise that resolves with a boolean, depending
- * on whether focus was moved successfuly.
- */
- focusLastTabbableElementWhenReady() {
- return new Promise((/**
- * @param {?} resolve
- * @return {?}
- */
- resolve => {
- this._executeOnStable((/**
- * @return {?}
- */
- () => resolve(this.focusLastTabbableElement())));
- }));
- }
- /**
- * Get the specified boundary element of the trapped region.
- * @private
- * @param {?} bound The boundary to get (start or end of trapped region).
- * @return {?} The boundary element.
- */
- _getRegionBoundary(bound) {
- // Contains the deprecated version of selector, for temporary backwards comparability.
- /** @type {?} */
- let markers = (/** @type {?} */ (this._element.querySelectorAll(`[cdk-focus-region-${bound}], ` +
- `[cdkFocusRegion${bound}], ` +
- `[cdk-focus-${bound}]`)));
- for (let i = 0; i < markers.length; i++) {
- // @breaking-change 8.0.0
- if (markers[i].hasAttribute(`cdk-focus-${bound}`)) {
- console.warn(`Found use of deprecated attribute 'cdk-focus-${bound}', ` +
- `use 'cdkFocusRegion${bound}' instead. The deprecated ` +
- `attribute will be removed in 8.0.0.`, markers[i]);
- }
- else if (markers[i].hasAttribute(`cdk-focus-region-${bound}`)) {
- console.warn(`Found use of deprecated attribute 'cdk-focus-region-${bound}', ` +
- `use 'cdkFocusRegion${bound}' instead. The deprecated attribute ` +
- `will be removed in 8.0.0.`, markers[i]);
- }
- }
- if (bound == 'start') {
- return markers.length ? markers[0] : this._getFirstTabbableElement(this._element);
- }
- return markers.length ?
- markers[markers.length - 1] : this._getLastTabbableElement(this._element);
- }
- /**
- * Focuses the element that should be focused when the focus trap is initialized.
- * @return {?} Whether focus was moved successfuly.
- */
- focusInitialElement() {
- // Contains the deprecated version of selector, for temporary backwards comparability.
- /** @type {?} */
- const redirectToElement = (/** @type {?} */ (this._element.querySelector(`[cdk-focus-initial], ` +
- `[cdkFocusInitial]`)));
- if (redirectToElement) {
- // @breaking-change 8.0.0
- if (redirectToElement.hasAttribute(`cdk-focus-initial`)) {
- console.warn(`Found use of deprecated attribute 'cdk-focus-initial', ` +
- `use 'cdkFocusInitial' instead. The deprecated attribute ` +
- `will be removed in 8.0.0`, redirectToElement);
- }
- // Warn the consumer if the element they've pointed to
- // isn't focusable, when not in production mode.
- if (isDevMode() && !this._checker.isFocusable(redirectToElement)) {
- console.warn(`Element matching '[cdkFocusInitial]' is not focusable.`, redirectToElement);
- }
- redirectToElement.focus();
- return true;
- }
- return this.focusFirstTabbableElement();
- }
- /**
- * Focuses the first tabbable element within the focus trap region.
- * @return {?} Whether focus was moved successfuly.
- */
- focusFirstTabbableElement() {
- /** @type {?} */
- const redirectToElement = this._getRegionBoundary('start');
- if (redirectToElement) {
- redirectToElement.focus();
- }
- return !!redirectToElement;
- }
- /**
- * Focuses the last tabbable element within the focus trap region.
- * @return {?} Whether focus was moved successfuly.
- */
- focusLastTabbableElement() {
- /** @type {?} */
- const redirectToElement = this._getRegionBoundary('end');
- if (redirectToElement) {
- redirectToElement.focus();
- }
- return !!redirectToElement;
- }
- /**
- * Checks whether the focus trap has successfuly been attached.
- * @return {?}
- */
- hasAttached() {
- return this._hasAttached;
- }
- /**
- * Get the first tabbable element from a DOM subtree (inclusive).
- * @private
- * @param {?} root
- * @return {?}
- */
- _getFirstTabbableElement(root) {
- if (this._checker.isFocusable(root) && this._checker.isTabbable(root)) {
- return root;
- }
- // Iterate in DOM order. Note that IE doesn't have `children` for SVG so we fall
- // back to `childNodes` which includes text nodes, comments etc.
- /** @type {?} */
- let children = root.children || root.childNodes;
- for (let i = 0; i < children.length; i++) {
- /** @type {?} */
- let tabbableChild = children[i].nodeType === this._document.ELEMENT_NODE ?
- this._getFirstTabbableElement((/** @type {?} */ (children[i]))) :
- null;
- if (tabbableChild) {
- return tabbableChild;
- }
- }
- return null;
- }
- /**
- * Get the last tabbable element from a DOM subtree (inclusive).
- * @private
- * @param {?} root
- * @return {?}
- */
- _getLastTabbableElement(root) {
- if (this._checker.isFocusable(root) && this._checker.isTabbable(root)) {
- return root;
- }
- // Iterate in reverse DOM order.
- /** @type {?} */
- let children = root.children || root.childNodes;
- for (let i = children.length - 1; i >= 0; i--) {
- /** @type {?} */
- let tabbableChild = children[i].nodeType === this._document.ELEMENT_NODE ?
- this._getLastTabbableElement((/** @type {?} */ (children[i]))) :
- null;
- if (tabbableChild) {
- return tabbableChild;
- }
- }
- return null;
- }
- /**
- * Creates an anchor element.
- * @private
- * @return {?}
- */
- _createAnchor() {
- /** @type {?} */
- const anchor = this._document.createElement('div');
- this._toggleAnchorTabIndex(this._enabled, anchor);
- anchor.classList.add('cdk-visually-hidden');
- anchor.classList.add('cdk-focus-trap-anchor');
- anchor.setAttribute('aria-hidden', 'true');
- return anchor;
- }
- /**
- * Toggles the `tabindex` of an anchor, based on the enabled state of the focus trap.
- * @private
- * @param {?} isEnabled Whether the focus trap is enabled.
- * @param {?} anchor Anchor on which to toggle the tabindex.
- * @return {?}
- */
- _toggleAnchorTabIndex(isEnabled, anchor) {
- // Remove the tabindex completely, rather than setting it to -1, because if the
- // element has a tabindex, the user might still hit it when navigating with the arrow keys.
- isEnabled ? anchor.setAttribute('tabindex', '0') : anchor.removeAttribute('tabindex');
- }
- /**
- * Executes a function when the zone is stable.
- * @private
- * @param {?} fn
- * @return {?}
- */
- _executeOnStable(fn) {
- if (this._ngZone.isStable) {
- fn();
- }
- else {
- this._ngZone.onStable.asObservable().pipe(take(1)).subscribe(fn);
- }
- }
- }
- /**
- * Factory that allows easy instantiation of focus traps.
- */
- class FocusTrapFactory {
- /**
- * @param {?} _checker
- * @param {?} _ngZone
- * @param {?} _document
- */
- constructor(_checker, _ngZone, _document) {
- this._checker = _checker;
- this._ngZone = _ngZone;
- this._document = _document;
- }
- /**
- * Creates a focus-trapped region around the given element.
- * @param {?} element The element around which focus will be trapped.
- * @param {?=} deferCaptureElements Defers the creation of focus-capturing elements to be done
- * manually by the user.
- * @return {?} The created focus trap instance.
- */
- create(element, deferCaptureElements = false) {
- return new FocusTrap(element, this._checker, this._ngZone, this._document, deferCaptureElements);
- }
- }
- FocusTrapFactory.decorators = [
- { type: Injectable, args: [{ providedIn: 'root' },] },
- ];
- /** @nocollapse */
- FocusTrapFactory.ctorParameters = () => [
- { type: InteractivityChecker },
- { type: NgZone },
- { type: undefined, decorators: [{ type: Inject, args: [DOCUMENT,] }] }
- ];
- /** @nocollapse */ FocusTrapFactory.ngInjectableDef = ɵɵdefineInjectable({ factory: function FocusTrapFactory_Factory() { return new FocusTrapFactory(ɵɵinject(InteractivityChecker), ɵɵinject(NgZone), ɵɵinject(DOCUMENT)); }, token: FocusTrapFactory, providedIn: "root" });
- /**
- * Directive for trapping focus within a region.
- */
- class CdkTrapFocus {
- /**
- * @param {?} _elementRef
- * @param {?} _focusTrapFactory
- * @param {?} _document
- */
- constructor(_elementRef, _focusTrapFactory, _document) {
- this._elementRef = _elementRef;
- this._focusTrapFactory = _focusTrapFactory;
- /**
- * Previously focused element to restore focus to upon destroy when using autoCapture.
- */
- this._previouslyFocusedElement = null;
- this._document = _document;
- this.focusTrap = this._focusTrapFactory.create(this._elementRef.nativeElement, true);
- }
- /**
- * Whether the focus trap is active.
- * @return {?}
- */
- get enabled() { return this.focusTrap.enabled; }
- /**
- * @param {?} value
- * @return {?}
- */
- set enabled(value) { this.focusTrap.enabled = coerceBooleanProperty(value); }
- /**
- * Whether the directive should automatially move focus into the trapped region upon
- * initialization and return focus to the previous activeElement upon destruction.
- * @return {?}
- */
- get autoCapture() { return this._autoCapture; }
- /**
- * @param {?} value
- * @return {?}
- */
- set autoCapture(value) { this._autoCapture = coerceBooleanProperty(value); }
- /**
- * @return {?}
- */
- ngOnDestroy() {
- this.focusTrap.destroy();
- // If we stored a previously focused element when using autoCapture, return focus to that
- // element now that the trapped region is being destroyed.
- if (this._previouslyFocusedElement) {
- this._previouslyFocusedElement.focus();
- this._previouslyFocusedElement = null;
- }
- }
- /**
- * @return {?}
- */
- ngAfterContentInit() {
- this.focusTrap.attachAnchors();
- if (this.autoCapture) {
- this._previouslyFocusedElement = (/** @type {?} */ (this._document.activeElement));
- this.focusTrap.focusInitialElementWhenReady();
- }
- }
- /**
- * @return {?}
- */
- ngDoCheck() {
- if (!this.focusTrap.hasAttached()) {
- this.focusTrap.attachAnchors();
- }
- }
- }
- CdkTrapFocus.decorators = [
- { type: Directive, args: [{
- selector: '[cdkTrapFocus]',
- exportAs: 'cdkTrapFocus',
- },] },
- ];
- /** @nocollapse */
- CdkTrapFocus.ctorParameters = () => [
- { type: ElementRef },
- { type: FocusTrapFactory },
- { type: undefined, decorators: [{ type: Inject, args: [DOCUMENT,] }] }
- ];
- CdkTrapFocus.propDecorators = {
- enabled: [{ type: Input, args: ['cdkTrapFocus',] }],
- autoCapture: [{ type: Input, args: ['cdkTrapFocusAutoCapture',] }]
- };
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /** @type {?} */
- const LIVE_ANNOUNCER_ELEMENT_TOKEN = new InjectionToken('liveAnnouncerElement', {
- providedIn: 'root',
- factory: LIVE_ANNOUNCER_ELEMENT_TOKEN_FACTORY,
- });
- /**
- * \@docs-private
- * @return {?}
- */
- function LIVE_ANNOUNCER_ELEMENT_TOKEN_FACTORY() {
- return null;
- }
- /**
- * Injection token that can be used to configure the default options for the LiveAnnouncer.
- * @type {?}
- */
- const LIVE_ANNOUNCER_DEFAULT_OPTIONS = new InjectionToken('LIVE_ANNOUNCER_DEFAULT_OPTIONS');
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- class LiveAnnouncer {
- /**
- * @param {?} elementToken
- * @param {?} _ngZone
- * @param {?} _document
- * @param {?=} _defaultOptions
- */
- constructor(elementToken, _ngZone, _document, _defaultOptions) {
- this._ngZone = _ngZone;
- this._defaultOptions = _defaultOptions;
- // We inject the live element and document as `any` because the constructor signature cannot
- // reference browser globals (HTMLElement, Document) on non-browser environments, since having
- // a class decorator causes TypeScript to preserve the constructor signature types.
- this._document = _document;
- this._liveElement = elementToken || this._createLiveElement();
- }
- /**
- * @param {?} message
- * @param {...?} args
- * @return {?}
- */
- announce(message, ...args) {
- /** @type {?} */
- const defaultOptions = this._defaultOptions;
- /** @type {?} */
- let politeness;
- /** @type {?} */
- let duration;
- if (args.length === 1 && typeof args[0] === 'number') {
- duration = args[0];
- }
- else {
- [politeness, duration] = args;
- }
- this.clear();
- clearTimeout(this._previousTimeout);
- if (!politeness) {
- politeness =
- (defaultOptions && defaultOptions.politeness) ? defaultOptions.politeness : 'polite';
- }
- if (duration == null && defaultOptions) {
- duration = defaultOptions.duration;
- }
- // TODO: ensure changing the politeness works on all environments we support.
- this._liveElement.setAttribute('aria-live', politeness);
- // This 100ms timeout is necessary for some browser + screen-reader combinations:
- // - Both JAWS and NVDA over IE11 will not announce anything without a non-zero timeout.
- // - With Chrome and IE11 with NVDA or JAWS, a repeated (identical) message won't be read a
- // second time without clearing and then using a non-zero delay.
- // (using JAWS 17 at time of this writing).
- return this._ngZone.runOutsideAngular((/**
- * @return {?}
- */
- () => {
- return new Promise((/**
- * @param {?} resolve
- * @return {?}
- */
- resolve => {
- clearTimeout(this._previousTimeout);
- this._previousTimeout = setTimeout((/**
- * @return {?}
- */
- () => {
- this._liveElement.textContent = message;
- resolve();
- if (typeof duration === 'number') {
- this._previousTimeout = setTimeout((/**
- * @return {?}
- */
- () => this.clear()), duration);
- }
- }), 100);
- }));
- }));
- }
- /**
- * Clears the current text from the announcer element. Can be used to prevent
- * screen readers from reading the text out again while the user is going
- * through the page landmarks.
- * @return {?}
- */
- clear() {
- if (this._liveElement) {
- this._liveElement.textContent = '';
- }
- }
- /**
- * @return {?}
- */
- ngOnDestroy() {
- clearTimeout(this._previousTimeout);
- if (this._liveElement && this._liveElement.parentNode) {
- this._liveElement.parentNode.removeChild(this._liveElement);
- this._liveElement = (/** @type {?} */ (null));
- }
- }
- /**
- * @private
- * @return {?}
- */
- _createLiveElement() {
- /** @type {?} */
- const elementClass = 'cdk-live-announcer-element';
- /** @type {?} */
- const previousElements = this._document.getElementsByClassName(elementClass);
- /** @type {?} */
- const liveEl = this._document.createElement('div');
- // Remove any old containers. This can happen when coming in from a server-side-rendered page.
- for (let i = 0; i < previousElements.length; i++) {
- (/** @type {?} */ (previousElements[i].parentNode)).removeChild(previousElements[i]);
- }
- liveEl.classList.add(elementClass);
- liveEl.classList.add('cdk-visually-hidden');
- liveEl.setAttribute('aria-atomic', 'true');
- liveEl.setAttribute('aria-live', 'polite');
- this._document.body.appendChild(liveEl);
- return liveEl;
- }
- }
- LiveAnnouncer.decorators = [
- { type: Injectable, args: [{ providedIn: 'root' },] },
- ];
- /** @nocollapse */
- LiveAnnouncer.ctorParameters = () => [
- { type: undefined, decorators: [{ type: Optional }, { type: Inject, args: [LIVE_ANNOUNCER_ELEMENT_TOKEN,] }] },
- { type: NgZone },
- { type: undefined, decorators: [{ type: Inject, args: [DOCUMENT,] }] },
- { type: undefined, decorators: [{ type: Optional }, { type: Inject, args: [LIVE_ANNOUNCER_DEFAULT_OPTIONS,] }] }
- ];
- /** @nocollapse */ LiveAnnouncer.ngInjectableDef = ɵɵdefineInjectable({ factory: function LiveAnnouncer_Factory() { return new LiveAnnouncer(ɵɵinject(LIVE_ANNOUNCER_ELEMENT_TOKEN, 8), ɵɵinject(NgZone), ɵɵinject(DOCUMENT), ɵɵinject(LIVE_ANNOUNCER_DEFAULT_OPTIONS, 8)); }, token: LiveAnnouncer, providedIn: "root" });
- /**
- * A directive that works similarly to aria-live, but uses the LiveAnnouncer to ensure compatibility
- * with a wider range of browsers and screen readers.
- */
- class CdkAriaLive {
- /**
- * @param {?} _elementRef
- * @param {?} _liveAnnouncer
- * @param {?} _contentObserver
- * @param {?} _ngZone
- */
- constructor(_elementRef, _liveAnnouncer, _contentObserver, _ngZone) {
- this._elementRef = _elementRef;
- this._liveAnnouncer = _liveAnnouncer;
- this._contentObserver = _contentObserver;
- this._ngZone = _ngZone;
- this._politeness = 'off';
- }
- /**
- * The aria-live politeness level to use when announcing messages.
- * @return {?}
- */
- get politeness() { return this._politeness; }
- /**
- * @param {?} value
- * @return {?}
- */
- set politeness(value) {
- this._politeness = value === 'polite' || value === 'assertive' ? value : 'off';
- if (this._politeness === 'off') {
- if (this._subscription) {
- this._subscription.unsubscribe();
- this._subscription = null;
- }
- }
- else if (!this._subscription) {
- this._subscription = this._ngZone.runOutsideAngular((/**
- * @return {?}
- */
- () => {
- return this._contentObserver
- .observe(this._elementRef)
- .subscribe((/**
- * @return {?}
- */
- () => {
- // Note that we use textContent here, rather than innerText, in order to avoid a reflow.
- /** @type {?} */
- const elementText = this._elementRef.nativeElement.textContent;
- // The `MutationObserver` fires also for attribute
- // changes which we don't want to announce.
- if (elementText !== this._previousAnnouncedText) {
- this._liveAnnouncer.announce(elementText, this._politeness);
- this._previousAnnouncedText = elementText;
- }
- }));
- }));
- }
- }
- /**
- * @return {?}
- */
- ngOnDestroy() {
- if (this._subscription) {
- this._subscription.unsubscribe();
- }
- }
- }
- CdkAriaLive.decorators = [
- { type: Directive, args: [{
- selector: '[cdkAriaLive]',
- exportAs: 'cdkAriaLive',
- },] },
- ];
- /** @nocollapse */
- CdkAriaLive.ctorParameters = () => [
- { type: ElementRef },
- { type: LiveAnnouncer },
- { type: ContentObserver },
- { type: NgZone }
- ];
- CdkAriaLive.propDecorators = {
- politeness: [{ type: Input, args: ['cdkAriaLive',] }]
- };
- /**
- * \@docs-private \@deprecated \@breaking-change 8.0.0
- * @param {?} parentAnnouncer
- * @param {?} liveElement
- * @param {?} _document
- * @param {?} ngZone
- * @return {?}
- */
- function LIVE_ANNOUNCER_PROVIDER_FACTORY(parentAnnouncer, liveElement, _document, ngZone) {
- return parentAnnouncer || new LiveAnnouncer(liveElement, ngZone, _document);
- }
- /**
- * \@docs-private \@deprecated \@breaking-change 8.0.0
- * @type {?}
- */
- const LIVE_ANNOUNCER_PROVIDER = {
- // If there is already a LiveAnnouncer available, use that. Otherwise, provide a new one.
- provide: LiveAnnouncer,
- deps: [
- [new Optional(), new SkipSelf(), LiveAnnouncer],
- [new Optional(), new Inject(LIVE_ANNOUNCER_ELEMENT_TOKEN)],
- DOCUMENT,
- NgZone,
- ],
- useFactory: LIVE_ANNOUNCER_PROVIDER_FACTORY
- };
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- // This is the value used by AngularJS Material. Through trial and error (on iPhone 6S) they found
- // that a value of around 650ms seems appropriate.
- /** @type {?} */
- const TOUCH_BUFFER_MS = 650;
- /**
- * Event listener options that enable capturing and also
- * mark the listener as passive if the browser supports it.
- * @type {?}
- */
- const captureEventListenerOptions = normalizePassiveListenerOptions({
- passive: true,
- capture: true
- });
- /**
- * Monitors mouse and keyboard events to determine the cause of focus events.
- */
- class FocusMonitor {
- /**
- * @param {?} _ngZone
- * @param {?} _platform
- */
- constructor(_ngZone, _platform) {
- this._ngZone = _ngZone;
- this._platform = _platform;
- /**
- * The focus origin that the next focus event is a result of.
- */
- this._origin = null;
- /**
- * Whether the window has just been focused.
- */
- this._windowFocused = false;
- /**
- * Map of elements being monitored to their info.
- */
- this._elementInfo = new Map();
- /**
- * The number of elements currently being monitored.
- */
- this._monitoredElementCount = 0;
- /**
- * Event listener for `keydown` events on the document.
- * Needs to be an arrow function in order to preserve the context when it gets bound.
- */
- this._documentKeydownListener = (/**
- * @return {?}
- */
- () => {
- // On keydown record the origin and clear any touch event that may be in progress.
- this._lastTouchTarget = null;
- this._setOriginForCurrentEventQueue('keyboard');
- });
- /**
- * Event listener for `mousedown` events on the document.
- * Needs to be an arrow function in order to preserve the context when it gets bound.
- */
- this._documentMousedownListener = (/**
- * @return {?}
- */
- () => {
- // On mousedown record the origin only if there is not touch
- // target, since a mousedown can happen as a result of a touch event.
- if (!this._lastTouchTarget) {
- this._setOriginForCurrentEventQueue('mouse');
- }
- });
- /**
- * Event listener for `touchstart` events on the document.
- * Needs to be an arrow function in order to preserve the context when it gets bound.
- */
- this._documentTouchstartListener = (/**
- * @param {?} event
- * @return {?}
- */
- (event) => {
- // When the touchstart event fires the focus event is not yet in the event queue. This means
- // we can't rely on the trick used above (setting timeout of 1ms). Instead we wait 650ms to
- // see if a focus happens.
- if (this._touchTimeoutId != null) {
- clearTimeout(this._touchTimeoutId);
- }
- // Since this listener is bound on the `document` level, any events coming from the shadow DOM
- // will have their `target` set to the shadow root. If available, use `composedPath` to
- // figure out the event target.
- this._lastTouchTarget = event.composedPath ? event.composedPath()[0] : event.target;
- this._touchTimeoutId = setTimeout((/**
- * @return {?}
- */
- () => this._lastTouchTarget = null), TOUCH_BUFFER_MS);
- });
- /**
- * Event listener for `focus` events on the window.
- * Needs to be an arrow function in order to preserve the context when it gets bound.
- */
- this._windowFocusListener = (/**
- * @return {?}
- */
- () => {
- // Make a note of when the window regains focus, so we can
- // restore the origin info for the focused element.
- this._windowFocused = true;
- this._windowFocusTimeoutId = setTimeout((/**
- * @return {?}
- */
- () => this._windowFocused = false));
- });
- }
- /**
- * @param {?} element
- * @param {?=} checkChildren
- * @return {?}
- */
- monitor(element, checkChildren = false) {
- // Do nothing if we're not on the browser platform.
- if (!this._platform.isBrowser) {
- return of(null);
- }
- /** @type {?} */
- const nativeElement = coerceElement(element);
- // Check if we're already monitoring this element.
- if (this._elementInfo.has(nativeElement)) {
- /** @type {?} */
- let cachedInfo = this._elementInfo.get(nativeElement);
- (/** @type {?} */ (cachedInfo)).checkChildren = checkChildren;
- return (/** @type {?} */ (cachedInfo)).subject.asObservable();
- }
- // Create monitored element info.
- /** @type {?} */
- let info = {
- unlisten: (/**
- * @return {?}
- */
- () => { }),
- checkChildren: checkChildren,
- subject: new Subject()
- };
- this._elementInfo.set(nativeElement, info);
- this._incrementMonitoredElementCount();
- // Start listening. We need to listen in capture phase since focus events don't bubble.
- /** @type {?} */
- let focusListener = (/**
- * @param {?} event
- * @return {?}
- */
- (event) => this._onFocus(event, nativeElement));
- /** @type {?} */
- let blurListener = (/**
- * @param {?} event
- * @return {?}
- */
- (event) => this._onBlur(event, nativeElement));
- this._ngZone.runOutsideAngular((/**
- * @return {?}
- */
- () => {
- nativeElement.addEventListener('focus', focusListener, true);
- nativeElement.addEventListener('blur', blurListener, true);
- }));
- // Create an unlisten function for later.
- info.unlisten = (/**
- * @return {?}
- */
- () => {
- nativeElement.removeEventListener('focus', focusListener, true);
- nativeElement.removeEventListener('blur', blurListener, true);
- });
- return info.subject.asObservable();
- }
- /**
- * @param {?} element
- * @return {?}
- */
- stopMonitoring(element) {
- /** @type {?} */
- const nativeElement = coerceElement(element);
- /** @type {?} */
- const elementInfo = this._elementInfo.get(nativeElement);
- if (elementInfo) {
- elementInfo.unlisten();
- elementInfo.subject.complete();
- this._setClasses(nativeElement);
- this._elementInfo.delete(nativeElement);
- this._decrementMonitoredElementCount();
- }
- }
- /**
- * @param {?} element
- * @param {?} origin
- * @param {?=} options
- * @return {?}
- */
- focusVia(element, origin, options) {
- /** @type {?} */
- const nativeElement = coerceElement(element);
- this._setOriginForCurrentEventQueue(origin);
- // `focus` isn't available on the server
- if (typeof nativeElement.focus === 'function') {
- // Cast the element to `any`, because the TS typings don't have the `options` parameter yet.
- ((/** @type {?} */ (nativeElement))).focus(options);
- }
- }
- /**
- * @return {?}
- */
- ngOnDestroy() {
- this._elementInfo.forEach((/**
- * @param {?} _info
- * @param {?} element
- * @return {?}
- */
- (_info, element) => this.stopMonitoring(element)));
- }
- /**
- * @private
- * @param {?} element
- * @param {?} className
- * @param {?} shouldSet
- * @return {?}
- */
- _toggleClass(element, className, shouldSet) {
- if (shouldSet) {
- element.classList.add(className);
- }
- else {
- element.classList.remove(className);
- }
- }
- /**
- * Sets the focus classes on the element based on the given focus origin.
- * @private
- * @param {?} element The element to update the classes on.
- * @param {?=} origin The focus origin.
- * @return {?}
- */
- _setClasses(element, origin) {
- /** @type {?} */
- const elementInfo = this._elementInfo.get(element);
- if (elementInfo) {
- this._toggleClass(element, 'cdk-focused', !!origin);
- this._toggleClass(element, 'cdk-touch-focused', origin === 'touch');
- this._toggleClass(element, 'cdk-keyboard-focused', origin === 'keyboard');
- this._toggleClass(element, 'cdk-mouse-focused', origin === 'mouse');
- this._toggleClass(element, 'cdk-program-focused', origin === 'program');
- }
- }
- /**
- * Sets the origin and schedules an async function to clear it at the end of the event queue.
- * @private
- * @param {?} origin The origin to set.
- * @return {?}
- */
- _setOriginForCurrentEventQueue(origin) {
- this._ngZone.runOutsideAngular((/**
- * @return {?}
- */
- () => {
- this._origin = origin;
- // Sometimes the focus origin won't be valid in Firefox because Firefox seems to focus *one*
- // tick after the interaction event fired. To ensure the focus origin is always correct,
- // the focus origin will be determined at the beginning of the next tick.
- this._originTimeoutId = setTimeout((/**
- * @return {?}
- */
- () => this._origin = null), 1);
- }));
- }
- /**
- * Checks whether the given focus event was caused by a touchstart event.
- * @private
- * @param {?} event The focus event to check.
- * @return {?} Whether the event was caused by a touch.
- */
- _wasCausedByTouch(event) {
- // Note(mmalerba): This implementation is not quite perfect, there is a small edge case.
- // Consider the following dom structure:
- //
- // <div #parent tabindex="0" cdkFocusClasses>
- // <div #child (click)="#parent.focus()"></div>
- // </div>
- //
- // If the user touches the #child element and the #parent is programmatically focused as a
- // result, this code will still consider it to have been caused by the touch event and will
- // apply the cdk-touch-focused class rather than the cdk-program-focused class. This is a
- // relatively small edge-case that can be worked around by using
- // focusVia(parentEl, 'program') to focus the parent element.
- //
- // If we decide that we absolutely must handle this case correctly, we can do so by listening
- // for the first focus event after the touchstart, and then the first blur event after that
- // focus event. When that blur event fires we know that whatever follows is not a result of the
- // touchstart.
- /** @type {?} */
- let focusTarget = event.target;
- return this._lastTouchTarget instanceof Node && focusTarget instanceof Node &&
- (focusTarget === this._lastTouchTarget || focusTarget.contains(this._lastTouchTarget));
- }
- /**
- * Handles focus events on a registered element.
- * @private
- * @param {?} event The focus event.
- * @param {?} element The monitored element.
- * @return {?}
- */
- _onFocus(event, element) {
- // NOTE(mmalerba): We currently set the classes based on the focus origin of the most recent
- // focus event affecting the monitored element. If we want to use the origin of the first event
- // instead we should check for the cdk-focused class here and return if the element already has
- // it. (This only matters for elements that have includesChildren = true).
- // NOTE(mmalerba): We currently set the classes based on the focus origin of the most recent
- // focus event affecting the monitored element. If we want to use the origin of the first event
- // instead we should check for the cdk-focused class here and return if the element already has
- // it. (This only matters for elements that have includesChildren = true).
- // If we are not counting child-element-focus as focused, make sure that the event target is the
- // monitored element itself.
- /** @type {?} */
- const elementInfo = this._elementInfo.get(element);
- if (!elementInfo || (!elementInfo.checkChildren && element !== event.target)) {
- return;
- }
- // If we couldn't detect a cause for the focus event, it's due to one of three reasons:
- // 1) The window has just regained focus, in which case we want to restore the focused state of
- // the element from before the window blurred.
- // 2) It was caused by a touch event, in which case we mark the origin as 'touch'.
- // 3) The element was programmatically focused, in which case we should mark the origin as
- // 'program'.
- /** @type {?} */
- let origin = this._origin;
- if (!origin) {
- if (this._windowFocused && this._lastFocusOrigin) {
- origin = this._lastFocusOrigin;
- }
- else if (this._wasCausedByTouch(event)) {
- origin = 'touch';
- }
- else {
- origin = 'program';
- }
- }
- this._setClasses(element, origin);
- this._emitOrigin(elementInfo.subject, origin);
- this._lastFocusOrigin = origin;
- }
- /**
- * Handles blur events on a registered element.
- * @param {?} event The blur event.
- * @param {?} element The monitored element.
- * @return {?}
- */
- _onBlur(event, element) {
- // If we are counting child-element-focus as focused, make sure that we aren't just blurring in
- // order to focus another child of the monitored element.
- /** @type {?} */
- const elementInfo = this._elementInfo.get(element);
- if (!elementInfo || (elementInfo.checkChildren && event.relatedTarget instanceof Node &&
- element.contains(event.relatedTarget))) {
- return;
- }
- this._setClasses(element);
- this._emitOrigin(elementInfo.subject, null);
- }
- /**
- * @private
- * @param {?} subject
- * @param {?} origin
- * @return {?}
- */
- _emitOrigin(subject, origin) {
- this._ngZone.run((/**
- * @return {?}
- */
- () => subject.next(origin)));
- }
- /**
- * @private
- * @return {?}
- */
- _incrementMonitoredElementCount() {
- // Register global listeners when first element is monitored.
- if (++this._monitoredElementCount == 1 && this._platform.isBrowser) {
- // Note: we listen to events in the capture phase so we
- // can detect them even if the user stops propagation.
- this._ngZone.runOutsideAngular((/**
- * @return {?}
- */
- () => {
- document.addEventListener('keydown', this._documentKeydownListener, captureEventListenerOptions);
- document.addEventListener('mousedown', this._documentMousedownListener, captureEventListenerOptions);
- document.addEventListener('touchstart', this._documentTouchstartListener, captureEventListenerOptions);
- window.addEventListener('focus', this._windowFocusListener);
- }));
- }
- }
- /**
- * @private
- * @return {?}
- */
- _decrementMonitoredElementCount() {
- // Unregister global listeners when last element is unmonitored.
- if (!--this._monitoredElementCount) {
- document.removeEventListener('keydown', this._documentKeydownListener, captureEventListenerOptions);
- document.removeEventListener('mousedown', this._documentMousedownListener, captureEventListenerOptions);
- document.removeEventListener('touchstart', this._documentTouchstartListener, captureEventListenerOptions);
- window.removeEventListener('focus', this._windowFocusListener);
- // Clear timeouts for all potentially pending timeouts to prevent the leaks.
- clearTimeout(this._windowFocusTimeoutId);
- clearTimeout(this._touchTimeoutId);
- clearTimeout(this._originTimeoutId);
- }
- }
- }
- FocusMonitor.decorators = [
- { type: Injectable, args: [{ providedIn: 'root' },] },
- ];
- /** @nocollapse */
- FocusMonitor.ctorParameters = () => [
- { type: NgZone },
- { type: Platform }
- ];
- /** @nocollapse */ FocusMonitor.ngInjectableDef = ɵɵdefineInjectable({ factory: function FocusMonitor_Factory() { return new FocusMonitor(ɵɵinject(NgZone), ɵɵinject(Platform)); }, token: FocusMonitor, providedIn: "root" });
- /**
- * Directive that determines how a particular element was focused (via keyboard, mouse, touch, or
- * programmatically) and adds corresponding classes to the element.
- *
- * There are two variants of this directive:
- * 1) cdkMonitorElementFocus: does not consider an element to be focused if one of its children is
- * focused.
- * 2) cdkMonitorSubtreeFocus: considers an element focused if it or any of its children are focused.
- */
- class CdkMonitorFocus {
- /**
- * @param {?} _elementRef
- * @param {?} _focusMonitor
- */
- constructor(_elementRef, _focusMonitor) {
- this._elementRef = _elementRef;
- this._focusMonitor = _focusMonitor;
- this.cdkFocusChange = new EventEmitter();
- this._monitorSubscription = this._focusMonitor.monitor(this._elementRef, this._elementRef.nativeElement.hasAttribute('cdkMonitorSubtreeFocus'))
- .subscribe((/**
- * @param {?} origin
- * @return {?}
- */
- origin => this.cdkFocusChange.emit(origin)));
- }
- /**
- * @return {?}
- */
- ngOnDestroy() {
- this._focusMonitor.stopMonitoring(this._elementRef);
- this._monitorSubscription.unsubscribe();
- }
- }
- CdkMonitorFocus.decorators = [
- { type: Directive, args: [{
- selector: '[cdkMonitorElementFocus], [cdkMonitorSubtreeFocus]',
- },] },
- ];
- /** @nocollapse */
- CdkMonitorFocus.ctorParameters = () => [
- { type: ElementRef },
- { type: FocusMonitor }
- ];
- CdkMonitorFocus.propDecorators = {
- cdkFocusChange: [{ type: Output }]
- };
- /**
- * \@docs-private \@deprecated \@breaking-change 8.0.0
- * @param {?} parentDispatcher
- * @param {?} ngZone
- * @param {?} platform
- * @return {?}
- */
- function FOCUS_MONITOR_PROVIDER_FACTORY(parentDispatcher, ngZone, platform) {
- return parentDispatcher || new FocusMonitor(ngZone, platform);
- }
- /**
- * \@docs-private \@deprecated \@breaking-change 8.0.0
- * @type {?}
- */
- const FOCUS_MONITOR_PROVIDER = {
- // If there is already a FocusMonitor available, use that. Otherwise, provide a new one.
- provide: FocusMonitor,
- deps: [[new Optional(), new SkipSelf(), FocusMonitor], NgZone, Platform],
- useFactory: FOCUS_MONITOR_PROVIDER_FACTORY
- };
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * Screenreaders will often fire fake mousedown events when a focusable element
- * is activated using the keyboard. We can typically distinguish between these faked
- * mousedown events and real mousedown events using the "buttons" property. While
- * real mousedowns will indicate the mouse button that was pressed (e.g. "1" for
- * the left mouse button), faked mousedowns will usually set the property value to 0.
- * @param {?} event
- * @return {?}
- */
- function isFakeMousedownFromScreenReader(event) {
- return event.buttons === 0;
- }
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- class A11yModule {
- }
- A11yModule.decorators = [
- { type: NgModule, args: [{
- imports: [CommonModule, PlatformModule, ObserversModule],
- declarations: [CdkAriaLive, CdkTrapFocus, CdkMonitorFocus],
- exports: [CdkAriaLive, CdkTrapFocus, CdkMonitorFocus],
- },] },
- ];
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- /**
- * @fileoverview added by tsickle
- * @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
- */
- export { ARIA_DESCRIBER_PROVIDER_FACTORY, MESSAGES_CONTAINER_ID, CDK_DESCRIBEDBY_ID_PREFIX, CDK_DESCRIBEDBY_HOST_ATTRIBUTE, AriaDescriber, ARIA_DESCRIBER_PROVIDER, ActiveDescendantKeyManager, FocusKeyManager, ListKeyManager, FocusTrap, FocusTrapFactory, CdkTrapFocus, InteractivityChecker, LIVE_ANNOUNCER_PROVIDER_FACTORY, LiveAnnouncer, CdkAriaLive, LIVE_ANNOUNCER_PROVIDER, LIVE_ANNOUNCER_ELEMENT_TOKEN_FACTORY, LIVE_ANNOUNCER_ELEMENT_TOKEN, LIVE_ANNOUNCER_DEFAULT_OPTIONS, FOCUS_MONITOR_PROVIDER_FACTORY, TOUCH_BUFFER_MS, FocusMonitor, CdkMonitorFocus, FOCUS_MONITOR_PROVIDER, isFakeMousedownFromScreenReader, A11yModule };
- //# sourceMappingURL=a11y.js.map
|