@angular/material
Version:
Angular Material
1,242 lines (1,235 loc) • 70.7 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
*/
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@angular/common'), require('@angular/common/http'), require('@angular/core'), require('@angular/platform-browser'), require('rxjs'), require('rxjs/operators'), require('@angular/cdk/coercion'), require('@angular/material/core')) :
typeof define === 'function' && define.amd ? define('@angular/material/icon', ['exports', '@angular/common', '@angular/common/http', '@angular/core', '@angular/platform-browser', 'rxjs', 'rxjs/operators', '@angular/cdk/coercion', '@angular/material/core'], factory) :
(factory((global.ng = global.ng || {}, global.ng.material = global.ng.material || {}, global.ng.material.icon = {}),global.ng.common,global.ng.common.http,global.ng.core,global.ng.platformBrowser,global.rxjs,global.rxjs.operators,global.ng.cdk.coercion,global.ng.material.core));
}(this, (function (exports,common,http,core,platformBrowser,rxjs,operators,coercion,core$1) { 'use strict';
/*! *****************************************************************************
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at http://www.apache.org/licenses/LICENSE-2.0
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
MERCHANTABLITY OR NON-INFRINGEMENT.
See the Apache Version 2.0 License for specific language governing permissions
and limitations under the License.
***************************************************************************** */
/* global Reflect, Promise */
var extendStatics = function(d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
function __extends(d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
}
/**
* @fileoverview added by tsickle
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* Returns an exception to be thrown in the case when attempting to
* load an icon with a name that cannot be found.
* \@docs-private
* @param {?} iconName
* @return {?}
*/
function getMatIconNameNotFoundError(iconName) {
return Error("Unable to find icon with the name \"" + iconName + "\"");
}
/**
* Returns an exception to be thrown when the consumer attempts to use
* `<mat-icon>` without including \@angular/common/http.
* \@docs-private
* @return {?}
*/
function getMatIconNoHttpProviderError() {
return Error('Could not find HttpClient provider for use with Angular Material icons. ' +
'Please include the HttpClientModule from @angular/common/http in your ' +
'app imports.');
}
/**
* Returns an exception to be thrown when a URL couldn't be sanitized.
* \@docs-private
* @param {?} url URL that was attempted to be sanitized.
* @return {?}
*/
function getMatIconFailedToSanitizeUrlError(url) {
return Error("The URL provided to MatIconRegistry was not trusted as a resource URL " +
("via Angular's DomSanitizer. Attempted URL was \"" + url + "\"."));
}
/**
* Returns an exception to be thrown when a HTML string couldn't be sanitized.
* \@docs-private
* @param {?} literal HTML that was attempted to be sanitized.
* @return {?}
*/
function getMatIconFailedToSanitizeLiteralError(literal) {
return Error("The literal provided to MatIconRegistry was not trusted as safe HTML by " +
("Angular's DomSanitizer. Attempted literal was \"" + literal + "\"."));
}
/**
* Configuration for an icon, including the URL and possibly the cached SVG element.
* \@docs-private
*/
var /**
* Configuration for an icon, including the URL and possibly the cached SVG element.
* \@docs-private
*/
SvgIconConfig = /** @class */ (function () {
function SvgIconConfig(data, options) {
this.options = options;
// Note that we can't use `instanceof SVGElement` here,
// because it'll break during server-side rendering.
if (!!((/** @type {?} */ (data))).nodeName) {
this.svgElement = (/** @type {?} */ (data));
}
else {
this.url = (/** @type {?} */ (data));
}
}
return SvgIconConfig;
}());
/**
* Service to register and display icons used by the `<mat-icon>` component.
* - Registers icon URLs by namespace and name.
* - Registers icon set URLs by namespace.
* - Registers aliases for CSS classes, for use with icon fonts.
* - Loads icons from URLs and extracts individual icons from icon sets.
*/
var MatIconRegistry = /** @class */ (function () {
function MatIconRegistry(_httpClient, _sanitizer, document, _errorHandler) {
this._httpClient = _httpClient;
this._sanitizer = _sanitizer;
this._errorHandler = _errorHandler;
/**
* URLs and cached SVG elements for individual icons. Keys are of the format "[namespace]:[icon]".
*/
this._svgIconConfigs = new Map();
/**
* SvgIconConfig objects and cached SVG elements for icon sets, keyed by namespace.
* Multiple icon sets can be registered under the same namespace.
*/
this._iconSetConfigs = new Map();
/**
* Cache for icons loaded by direct URLs.
*/
this._cachedIconsByUrl = new Map();
/**
* In-progress icon fetches. Used to coalesce multiple requests to the same URL.
*/
this._inProgressUrlFetches = new Map();
/**
* Map from font identifiers to their CSS class names. Used for icon fonts.
*/
this._fontCssClassesByAlias = new Map();
/**
* The CSS class to apply when an `<mat-icon>` component has no icon name, url, or font specified.
* The default 'material-icons' value assumes that the material icon font has been loaded as
* described at http://google.github.io/material-design-icons/#icon-font-for-the-web
*/
this._defaultFontSetClass = 'material-icons';
this._document = document;
}
/**
* Registers an icon by URL in the default namespace.
* @param iconName Name under which the icon should be registered.
* @param url
*/
/**
* Registers an icon by URL in the default namespace.
* @template THIS
* @this {THIS}
* @param {?} iconName Name under which the icon should be registered.
* @param {?} url
* @param {?=} options
* @return {THIS}
*/
MatIconRegistry.prototype.addSvgIcon = /**
* Registers an icon by URL in the default namespace.
* @template THIS
* @this {THIS}
* @param {?} iconName Name under which the icon should be registered.
* @param {?} url
* @param {?=} options
* @return {THIS}
*/
function (iconName, url, options) {
return (/** @type {?} */ (this)).addSvgIconInNamespace('', iconName, url, options);
};
/**
* Registers an icon using an HTML string in the default namespace.
* @param iconName Name under which the icon should be registered.
* @param literal SVG source of the icon.
*/
/**
* Registers an icon using an HTML string in the default namespace.
* @template THIS
* @this {THIS}
* @param {?} iconName Name under which the icon should be registered.
* @param {?} literal SVG source of the icon.
* @param {?=} options
* @return {THIS}
*/
MatIconRegistry.prototype.addSvgIconLiteral = /**
* Registers an icon using an HTML string in the default namespace.
* @template THIS
* @this {THIS}
* @param {?} iconName Name under which the icon should be registered.
* @param {?} literal SVG source of the icon.
* @param {?=} options
* @return {THIS}
*/
function (iconName, literal, options) {
return (/** @type {?} */ (this)).addSvgIconLiteralInNamespace('', iconName, literal, options);
};
/**
* Registers an icon by URL in the specified namespace.
* @param namespace Namespace in which the icon should be registered.
* @param iconName Name under which the icon should be registered.
* @param url
*/
/**
* Registers an icon by URL in the specified namespace.
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which the icon should be registered.
* @param {?} iconName Name under which the icon should be registered.
* @param {?} url
* @param {?=} options
* @return {THIS}
*/
MatIconRegistry.prototype.addSvgIconInNamespace = /**
* Registers an icon by URL in the specified namespace.
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which the icon should be registered.
* @param {?} iconName Name under which the icon should be registered.
* @param {?} url
* @param {?=} options
* @return {THIS}
*/
function (namespace, iconName, url, options) {
return (/** @type {?} */ (this))._addSvgIconConfig(namespace, iconName, new SvgIconConfig(url, options));
};
/**
* Registers an icon using an HTML string in the specified namespace.
* @param namespace Namespace in which the icon should be registered.
* @param iconName Name under which the icon should be registered.
* @param literal SVG source of the icon.
*/
/**
* Registers an icon using an HTML string in the specified namespace.
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which the icon should be registered.
* @param {?} iconName Name under which the icon should be registered.
* @param {?} literal SVG source of the icon.
* @param {?=} options
* @return {THIS}
*/
MatIconRegistry.prototype.addSvgIconLiteralInNamespace = /**
* Registers an icon using an HTML string in the specified namespace.
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which the icon should be registered.
* @param {?} iconName Name under which the icon should be registered.
* @param {?} literal SVG source of the icon.
* @param {?=} options
* @return {THIS}
*/
function (namespace, iconName, literal, options) {
/** @type {?} */
var sanitizedLiteral = (/** @type {?} */ (this))._sanitizer.sanitize(core.SecurityContext.HTML, literal);
if (!sanitizedLiteral) {
throw getMatIconFailedToSanitizeLiteralError(literal);
}
/** @type {?} */
var svgElement = (/** @type {?} */ (this))._createSvgElementForSingleIcon(sanitizedLiteral, options);
return (/** @type {?} */ (this))._addSvgIconConfig(namespace, iconName, new SvgIconConfig(svgElement, options));
};
/**
* Registers an icon set by URL in the default namespace.
* @param url
*/
/**
* Registers an icon set by URL in the default namespace.
* @template THIS
* @this {THIS}
* @param {?} url
* @param {?=} options
* @return {THIS}
*/
MatIconRegistry.prototype.addSvgIconSet = /**
* Registers an icon set by URL in the default namespace.
* @template THIS
* @this {THIS}
* @param {?} url
* @param {?=} options
* @return {THIS}
*/
function (url, options) {
return (/** @type {?} */ (this)).addSvgIconSetInNamespace('', url, options);
};
/**
* Registers an icon set using an HTML string in the default namespace.
* @param literal SVG source of the icon set.
*/
/**
* Registers an icon set using an HTML string in the default namespace.
* @template THIS
* @this {THIS}
* @param {?} literal SVG source of the icon set.
* @param {?=} options
* @return {THIS}
*/
MatIconRegistry.prototype.addSvgIconSetLiteral = /**
* Registers an icon set using an HTML string in the default namespace.
* @template THIS
* @this {THIS}
* @param {?} literal SVG source of the icon set.
* @param {?=} options
* @return {THIS}
*/
function (literal, options) {
return (/** @type {?} */ (this)).addSvgIconSetLiteralInNamespace('', literal, options);
};
/**
* Registers an icon set by URL in the specified namespace.
* @param namespace Namespace in which to register the icon set.
* @param url
*/
/**
* Registers an icon set by URL in the specified namespace.
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which to register the icon set.
* @param {?} url
* @param {?=} options
* @return {THIS}
*/
MatIconRegistry.prototype.addSvgIconSetInNamespace = /**
* Registers an icon set by URL in the specified namespace.
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which to register the icon set.
* @param {?} url
* @param {?=} options
* @return {THIS}
*/
function (namespace, url, options) {
return (/** @type {?} */ (this))._addSvgIconSetConfig(namespace, new SvgIconConfig(url, options));
};
/**
* Registers an icon set using an HTML string in the specified namespace.
* @param namespace Namespace in which to register the icon set.
* @param literal SVG source of the icon set.
*/
/**
* Registers an icon set using an HTML string in the specified namespace.
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which to register the icon set.
* @param {?} literal SVG source of the icon set.
* @param {?=} options
* @return {THIS}
*/
MatIconRegistry.prototype.addSvgIconSetLiteralInNamespace = /**
* Registers an icon set using an HTML string in the specified namespace.
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which to register the icon set.
* @param {?} literal SVG source of the icon set.
* @param {?=} options
* @return {THIS}
*/
function (namespace, literal, options) {
/** @type {?} */
var sanitizedLiteral = (/** @type {?} */ (this))._sanitizer.sanitize(core.SecurityContext.HTML, literal);
if (!sanitizedLiteral) {
throw getMatIconFailedToSanitizeLiteralError(literal);
}
/** @type {?} */
var svgElement = (/** @type {?} */ (this))._svgElementFromString(sanitizedLiteral);
return (/** @type {?} */ (this))._addSvgIconSetConfig(namespace, new SvgIconConfig(svgElement, options));
};
/**
* Defines an alias for a CSS class name to be used for icon fonts. Creating an matIcon
* component with the alias as the fontSet input will cause the class name to be applied
* to the `<mat-icon>` element.
*
* @param alias Alias for the font.
* @param className Class name override to be used instead of the alias.
*/
/**
* Defines an alias for a CSS class name to be used for icon fonts. Creating an matIcon
* component with the alias as the fontSet input will cause the class name to be applied
* to the `<mat-icon>` element.
*
* @template THIS
* @this {THIS}
* @param {?} alias Alias for the font.
* @param {?=} className Class name override to be used instead of the alias.
* @return {THIS}
*/
MatIconRegistry.prototype.registerFontClassAlias = /**
* Defines an alias for a CSS class name to be used for icon fonts. Creating an matIcon
* component with the alias as the fontSet input will cause the class name to be applied
* to the `<mat-icon>` element.
*
* @template THIS
* @this {THIS}
* @param {?} alias Alias for the font.
* @param {?=} className Class name override to be used instead of the alias.
* @return {THIS}
*/
function (alias, className) {
if (className === void 0) { className = alias; }
(/** @type {?} */ (this))._fontCssClassesByAlias.set(alias, className);
return (/** @type {?} */ (this));
};
/**
* Returns the CSS class name associated with the alias by a previous call to
* registerFontClassAlias. If no CSS class has been associated, returns the alias unmodified.
*/
/**
* Returns the CSS class name associated with the alias by a previous call to
* registerFontClassAlias. If no CSS class has been associated, returns the alias unmodified.
* @param {?} alias
* @return {?}
*/
MatIconRegistry.prototype.classNameForFontAlias = /**
* Returns the CSS class name associated with the alias by a previous call to
* registerFontClassAlias. If no CSS class has been associated, returns the alias unmodified.
* @param {?} alias
* @return {?}
*/
function (alias) {
return this._fontCssClassesByAlias.get(alias) || alias;
};
/**
* Sets the CSS class name to be used for icon fonts when an `<mat-icon>` component does not
* have a fontSet input value, and is not loading an icon by name or URL.
*
* @param className
*/
/**
* Sets the CSS class name to be used for icon fonts when an `<mat-icon>` component does not
* have a fontSet input value, and is not loading an icon by name or URL.
*
* @template THIS
* @this {THIS}
* @param {?} className
* @return {THIS}
*/
MatIconRegistry.prototype.setDefaultFontSetClass = /**
* Sets the CSS class name to be used for icon fonts when an `<mat-icon>` component does not
* have a fontSet input value, and is not loading an icon by name or URL.
*
* @template THIS
* @this {THIS}
* @param {?} className
* @return {THIS}
*/
function (className) {
(/** @type {?} */ (this))._defaultFontSetClass = className;
return (/** @type {?} */ (this));
};
/**
* Returns the CSS class name to be used for icon fonts when an `<mat-icon>` component does not
* have a fontSet input value, and is not loading an icon by name or URL.
*/
/**
* Returns the CSS class name to be used for icon fonts when an `<mat-icon>` component does not
* have a fontSet input value, and is not loading an icon by name or URL.
* @return {?}
*/
MatIconRegistry.prototype.getDefaultFontSetClass = /**
* Returns the CSS class name to be used for icon fonts when an `<mat-icon>` component does not
* have a fontSet input value, and is not loading an icon by name or URL.
* @return {?}
*/
function () {
return this._defaultFontSetClass;
};
/**
* Returns an Observable that produces the icon (as an `<svg>` DOM element) from the given URL.
* The response from the URL may be cached so this will not always cause an HTTP request, but
* the produced element will always be a new copy of the originally fetched icon. (That is,
* it will not contain any modifications made to elements previously returned).
*
* @param safeUrl URL from which to fetch the SVG icon.
*/
/**
* Returns an Observable that produces the icon (as an `<svg>` DOM element) from the given URL.
* The response from the URL may be cached so this will not always cause an HTTP request, but
* the produced element will always be a new copy of the originally fetched icon. (That is,
* it will not contain any modifications made to elements previously returned).
*
* @param {?} safeUrl URL from which to fetch the SVG icon.
* @return {?}
*/
MatIconRegistry.prototype.getSvgIconFromUrl = /**
* Returns an Observable that produces the icon (as an `<svg>` DOM element) from the given URL.
* The response from the URL may be cached so this will not always cause an HTTP request, but
* the produced element will always be a new copy of the originally fetched icon. (That is,
* it will not contain any modifications made to elements previously returned).
*
* @param {?} safeUrl URL from which to fetch the SVG icon.
* @return {?}
*/
function (safeUrl) {
var _this = this;
/** @type {?} */
var url = this._sanitizer.sanitize(core.SecurityContext.RESOURCE_URL, safeUrl);
if (!url) {
throw getMatIconFailedToSanitizeUrlError(safeUrl);
}
/** @type {?} */
var cachedIcon = this._cachedIconsByUrl.get(url);
if (cachedIcon) {
return rxjs.of(cloneSvg(cachedIcon));
}
return this._loadSvgIconFromConfig(new SvgIconConfig(safeUrl)).pipe(operators.tap((/**
* @param {?} svg
* @return {?}
*/
function (svg) { return _this._cachedIconsByUrl.set((/** @type {?} */ (url)), svg); })), operators.map((/**
* @param {?} svg
* @return {?}
*/
function (svg) { return cloneSvg(svg); })));
};
/**
* Returns an Observable that produces the icon (as an `<svg>` DOM element) with the given name
* and namespace. The icon must have been previously registered with addIcon or addIconSet;
* if not, the Observable will throw an error.
*
* @param name Name of the icon to be retrieved.
* @param namespace Namespace in which to look for the icon.
*/
/**
* Returns an Observable that produces the icon (as an `<svg>` DOM element) with the given name
* and namespace. The icon must have been previously registered with addIcon or addIconSet;
* if not, the Observable will throw an error.
*
* @param {?} name Name of the icon to be retrieved.
* @param {?=} namespace Namespace in which to look for the icon.
* @return {?}
*/
MatIconRegistry.prototype.getNamedSvgIcon = /**
* Returns an Observable that produces the icon (as an `<svg>` DOM element) with the given name
* and namespace. The icon must have been previously registered with addIcon or addIconSet;
* if not, the Observable will throw an error.
*
* @param {?} name Name of the icon to be retrieved.
* @param {?=} namespace Namespace in which to look for the icon.
* @return {?}
*/
function (name, namespace) {
if (namespace === void 0) { namespace = ''; }
// Return (copy of) cached icon if possible.
/** @type {?} */
var key = iconKey(namespace, name);
/** @type {?} */
var config = this._svgIconConfigs.get(key);
if (config) {
return this._getSvgFromConfig(config);
}
// See if we have any icon sets registered for the namespace.
/** @type {?} */
var iconSetConfigs = this._iconSetConfigs.get(namespace);
if (iconSetConfigs) {
return this._getSvgFromIconSetConfigs(name, iconSetConfigs);
}
return rxjs.throwError(getMatIconNameNotFoundError(key));
};
/**
* @return {?}
*/
MatIconRegistry.prototype.ngOnDestroy = /**
* @return {?}
*/
function () {
this._svgIconConfigs.clear();
this._iconSetConfigs.clear();
this._cachedIconsByUrl.clear();
};
/**
* Returns the cached icon for a SvgIconConfig if available, or fetches it from its URL if not.
*/
/**
* Returns the cached icon for a SvgIconConfig if available, or fetches it from its URL if not.
* @private
* @param {?} config
* @return {?}
*/
MatIconRegistry.prototype._getSvgFromConfig = /**
* Returns the cached icon for a SvgIconConfig if available, or fetches it from its URL if not.
* @private
* @param {?} config
* @return {?}
*/
function (config) {
if (config.svgElement) {
// We already have the SVG element for this icon, return a copy.
return rxjs.of(cloneSvg(config.svgElement));
}
else {
// Fetch the icon from the config's URL, cache it, and return a copy.
return this._loadSvgIconFromConfig(config).pipe(operators.tap((/**
* @param {?} svg
* @return {?}
*/
function (svg) { return config.svgElement = svg; })), operators.map((/**
* @param {?} svg
* @return {?}
*/
function (svg) { return cloneSvg(svg); })));
}
};
/**
* Attempts to find an icon with the specified name in any of the SVG icon sets.
* First searches the available cached icons for a nested element with a matching name, and
* if found copies the element to a new `<svg>` element. If not found, fetches all icon sets
* that have not been cached, and searches again after all fetches are completed.
* The returned Observable produces the SVG element if possible, and throws
* an error if no icon with the specified name can be found.
*/
/**
* Attempts to find an icon with the specified name in any of the SVG icon sets.
* First searches the available cached icons for a nested element with a matching name, and
* if found copies the element to a new `<svg>` element. If not found, fetches all icon sets
* that have not been cached, and searches again after all fetches are completed.
* The returned Observable produces the SVG element if possible, and throws
* an error if no icon with the specified name can be found.
* @private
* @param {?} name
* @param {?} iconSetConfigs
* @return {?}
*/
MatIconRegistry.prototype._getSvgFromIconSetConfigs = /**
* Attempts to find an icon with the specified name in any of the SVG icon sets.
* First searches the available cached icons for a nested element with a matching name, and
* if found copies the element to a new `<svg>` element. If not found, fetches all icon sets
* that have not been cached, and searches again after all fetches are completed.
* The returned Observable produces the SVG element if possible, and throws
* an error if no icon with the specified name can be found.
* @private
* @param {?} name
* @param {?} iconSetConfigs
* @return {?}
*/
function (name, iconSetConfigs) {
var _this = this;
// For all the icon set SVG elements we've fetched, see if any contain an icon with the
// requested name.
/** @type {?} */
var namedIcon = this._extractIconWithNameFromAnySet(name, iconSetConfigs);
if (namedIcon) {
// We could cache namedIcon in _svgIconConfigs, but since we have to make a copy every
// time anyway, there's probably not much advantage compared to just always extracting
// it from the icon set.
return rxjs.of(namedIcon);
}
// Not found in any cached icon sets. If there are icon sets with URLs that we haven't
// fetched, fetch them now and look for iconName in the results.
/** @type {?} */
var iconSetFetchRequests = iconSetConfigs
.filter((/**
* @param {?} iconSetConfig
* @return {?}
*/
function (iconSetConfig) { return !iconSetConfig.svgElement; }))
.map((/**
* @param {?} iconSetConfig
* @return {?}
*/
function (iconSetConfig) {
return _this._loadSvgIconSetFromConfig(iconSetConfig).pipe(operators.catchError((/**
* @param {?} err
* @return {?}
*/
function (err) {
/** @type {?} */
var url = _this._sanitizer.sanitize(core.SecurityContext.RESOURCE_URL, iconSetConfig.url);
// Swallow errors fetching individual URLs so the
// combined Observable won't necessarily fail.
/** @type {?} */
var errorMessage = "Loading icon set URL: " + url + " failed: " + err.message;
// @breaking-change 9.0.0 _errorHandler parameter to be made required
if (_this._errorHandler) {
_this._errorHandler.handleError(new Error(errorMessage));
}
else {
console.error(errorMessage);
}
return rxjs.of(null);
})));
}));
// Fetch all the icon set URLs. When the requests complete, every IconSet should have a
// cached SVG element (unless the request failed), and we can check again for the icon.
return rxjs.forkJoin(iconSetFetchRequests).pipe(operators.map((/**
* @return {?}
*/
function () {
/** @type {?} */
var foundIcon = _this._extractIconWithNameFromAnySet(name, iconSetConfigs);
if (!foundIcon) {
throw getMatIconNameNotFoundError(name);
}
return foundIcon;
})));
};
/**
* Searches the cached SVG elements for the given icon sets for a nested icon element whose "id"
* tag matches the specified name. If found, copies the nested element to a new SVG element and
* returns it. Returns null if no matching element is found.
*/
/**
* Searches the cached SVG elements for the given icon sets for a nested icon element whose "id"
* tag matches the specified name. If found, copies the nested element to a new SVG element and
* returns it. Returns null if no matching element is found.
* @private
* @param {?} iconName
* @param {?} iconSetConfigs
* @return {?}
*/
MatIconRegistry.prototype._extractIconWithNameFromAnySet = /**
* Searches the cached SVG elements for the given icon sets for a nested icon element whose "id"
* tag matches the specified name. If found, copies the nested element to a new SVG element and
* returns it. Returns null if no matching element is found.
* @private
* @param {?} iconName
* @param {?} iconSetConfigs
* @return {?}
*/
function (iconName, iconSetConfigs) {
// Iterate backwards, so icon sets added later have precedence.
for (var i = iconSetConfigs.length - 1; i >= 0; i--) {
/** @type {?} */
var config = iconSetConfigs[i];
if (config.svgElement) {
/** @type {?} */
var foundIcon = this._extractSvgIconFromSet(config.svgElement, iconName, config.options);
if (foundIcon) {
return foundIcon;
}
}
}
return null;
};
/**
* Loads the content of the icon URL specified in the SvgIconConfig and creates an SVG element
* from it.
*/
/**
* Loads the content of the icon URL specified in the SvgIconConfig and creates an SVG element
* from it.
* @private
* @param {?} config
* @return {?}
*/
MatIconRegistry.prototype._loadSvgIconFromConfig = /**
* Loads the content of the icon URL specified in the SvgIconConfig and creates an SVG element
* from it.
* @private
* @param {?} config
* @return {?}
*/
function (config) {
var _this = this;
return this._fetchUrl(config.url)
.pipe(operators.map((/**
* @param {?} svgText
* @return {?}
*/
function (svgText) { return _this._createSvgElementForSingleIcon(svgText, config.options); })));
};
/**
* Loads the content of the icon set URL specified in the SvgIconConfig and creates an SVG element
* from it.
*/
/**
* Loads the content of the icon set URL specified in the SvgIconConfig and creates an SVG element
* from it.
* @private
* @param {?} config
* @return {?}
*/
MatIconRegistry.prototype._loadSvgIconSetFromConfig = /**
* Loads the content of the icon set URL specified in the SvgIconConfig and creates an SVG element
* from it.
* @private
* @param {?} config
* @return {?}
*/
function (config) {
var _this = this;
// If the SVG for this icon set has already been parsed, do nothing.
if (config.svgElement) {
return rxjs.of(config.svgElement);
}
return this._fetchUrl(config.url).pipe(operators.map((/**
* @param {?} svgText
* @return {?}
*/
function (svgText) {
// It is possible that the icon set was parsed and cached by an earlier request, so parsing
// only needs to occur if the cache is yet unset.
if (!config.svgElement) {
config.svgElement = _this._svgElementFromString(svgText);
}
return config.svgElement;
})));
};
/**
* Creates a DOM element from the given SVG string, and adds default attributes.
*/
/**
* Creates a DOM element from the given SVG string, and adds default attributes.
* @private
* @param {?} responseText
* @param {?=} options
* @return {?}
*/
MatIconRegistry.prototype._createSvgElementForSingleIcon = /**
* Creates a DOM element from the given SVG string, and adds default attributes.
* @private
* @param {?} responseText
* @param {?=} options
* @return {?}
*/
function (responseText, options) {
/** @type {?} */
var svg = this._svgElementFromString(responseText);
this._setSvgAttributes(svg, options);
return svg;
};
/**
* Searches the cached element of the given SvgIconConfig for a nested icon element whose "id"
* tag matches the specified name. If found, copies the nested element to a new SVG element and
* returns it. Returns null if no matching element is found.
*/
/**
* Searches the cached element of the given SvgIconConfig for a nested icon element whose "id"
* tag matches the specified name. If found, copies the nested element to a new SVG element and
* returns it. Returns null if no matching element is found.
* @private
* @param {?} iconSet
* @param {?} iconName
* @param {?=} options
* @return {?}
*/
MatIconRegistry.prototype._extractSvgIconFromSet = /**
* Searches the cached element of the given SvgIconConfig for a nested icon element whose "id"
* tag matches the specified name. If found, copies the nested element to a new SVG element and
* returns it. Returns null if no matching element is found.
* @private
* @param {?} iconSet
* @param {?} iconName
* @param {?=} options
* @return {?}
*/
function (iconSet, iconName, options) {
// Use the `id="iconName"` syntax in order to escape special
// characters in the ID (versus using the #iconName syntax).
/** @type {?} */
var iconSource = iconSet.querySelector("[id=\"" + iconName + "\"]");
if (!iconSource) {
return null;
}
// Clone the element and remove the ID to prevent multiple elements from being added
// to the page with the same ID.
/** @type {?} */
var iconElement = (/** @type {?} */ (iconSource.cloneNode(true)));
iconElement.removeAttribute('id');
// If the icon node is itself an <svg> node, clone and return it directly. If not, set it as
// the content of a new <svg> node.
if (iconElement.nodeName.toLowerCase() === 'svg') {
return this._setSvgAttributes((/** @type {?} */ (iconElement)), options);
}
// If the node is a <symbol>, it won't be rendered so we have to convert it into <svg>. Note
// that the same could be achieved by referring to it via <use href="#id">, however the <use>
// tag is problematic on Firefox, because it needs to include the current page path.
if (iconElement.nodeName.toLowerCase() === 'symbol') {
return this._setSvgAttributes(this._toSvgElement(iconElement), options);
}
// createElement('SVG') doesn't work as expected; the DOM ends up with
// the correct nodes, but the SVG content doesn't render. Instead we
// have to create an empty SVG node using innerHTML and append its content.
// Elements created using DOMParser.parseFromString have the same problem.
// http://stackoverflow.com/questions/23003278/svg-innerhtml-in-firefox-can-not-display
/** @type {?} */
var svg = this._svgElementFromString('<svg></svg>');
// Clone the node so we don't remove it from the parent icon set element.
svg.appendChild(iconElement);
return this._setSvgAttributes(svg, options);
};
/**
* Creates a DOM element from the given SVG string.
*/
/**
* Creates a DOM element from the given SVG string.
* @private
* @param {?} str
* @return {?}
*/
MatIconRegistry.prototype._svgElementFromString = /**
* Creates a DOM element from the given SVG string.
* @private
* @param {?} str
* @return {?}
*/
function (str) {
/** @type {?} */
var div = this._document.createElement('DIV');
div.innerHTML = str;
/** @type {?} */
var svg = (/** @type {?} */ (div.querySelector('svg')));
if (!svg) {
throw Error('<svg> tag not found');
}
return svg;
};
/**
* Converts an element into an SVG node by cloning all of its children.
*/
/**
* Converts an element into an SVG node by cloning all of its children.
* @private
* @param {?} element
* @return {?}
*/
MatIconRegistry.prototype._toSvgElement = /**
* Converts an element into an SVG node by cloning all of its children.
* @private
* @param {?} element
* @return {?}
*/
function (element) {
/** @type {?} */
var svg = this._svgElementFromString('<svg></svg>');
/** @type {?} */
var attributes = element.attributes;
// Copy over all the attributes from the `symbol` to the new SVG, except the id.
for (var i = 0; i < attributes.length; i++) {
var _a = attributes[i], name_1 = _a.name, value = _a.value;
if (name_1 !== 'id') {
svg.setAttribute(name_1, value);
}
}
for (var i = 0; i < element.childNodes.length; i++) {
if (element.childNodes[i].nodeType === this._document.ELEMENT_NODE) {
svg.appendChild(element.childNodes[i].cloneNode(true));
}
}
return svg;
};
/**
* Sets the default attributes for an SVG element to be used as an icon.
*/
/**
* Sets the default attributes for an SVG element to be used as an icon.
* @private
* @param {?} svg
* @param {?=} options
* @return {?}
*/
MatIconRegistry.prototype._setSvgAttributes = /**
* Sets the default attributes for an SVG element to be used as an icon.
* @private
* @param {?} svg
* @param {?=} options
* @return {?}
*/
function (svg, options) {
svg.setAttribute('fit', '');
svg.setAttribute('height', '100%');
svg.setAttribute('width', '100%');
svg.setAttribute('preserveAspectRatio', 'xMidYMid meet');
svg.setAttribute('focusable', 'false'); // Disable IE11 default behavior to make SVGs focusable.
if (options && options.viewBox) {
svg.setAttribute('viewBox', options.viewBox);
}
return svg;
};
/**
* Returns an Observable which produces the string contents of the given URL. Results may be
* cached, so future calls with the same URL may not cause another HTTP request.
*/
/**
* Returns an Observable which produces the string contents of the given URL. Results may be
* cached, so future calls with the same URL may not cause another HTTP request.
* @private
* @param {?} safeUrl
* @return {?}
*/
MatIconRegistry.prototype._fetchUrl = /**
* Returns an Observable which produces the string contents of the given URL. Results may be
* cached, so future calls with the same URL may not cause another HTTP request.
* @private
* @param {?} safeUrl
* @return {?}
*/
function (safeUrl) {
var _this = this;
if (!this._httpClient) {
throw getMatIconNoHttpProviderError();
}
if (safeUrl == null) {
throw Error("Cannot fetch icon from URL \"" + safeUrl + "\".");
}
/** @type {?} */
var url = this._sanitizer.sanitize(core.SecurityContext.RESOURCE_URL, safeUrl);
if (!url) {
throw getMatIconFailedToSanitizeUrlError(safeUrl);
}
// Store in-progress fetches to avoid sending a duplicate request for a URL when there is
// already a request in progress for that URL. It's necessary to call share() on the
// Observable returned by http.get() so that multiple subscribers don't cause multiple XHRs.
/** @type {?} */
var inProgressFetch = this._inProgressUrlFetches.get(url);
if (inProgressFetch) {
return inProgressFetch;
}
// TODO(jelbourn): for some reason, the `finalize` operator "loses" the generic type on the
// Observable. Figure out why and fix it.
/** @type {?} */
var req = this._httpClient.get(url, { responseType: 'text' }).pipe(operators.finalize((/**
* @return {?}
*/
function () { return _this._inProgressUrlFetches.delete(url); })), operators.share());
this._inProgressUrlFetches.set(url, req);
return req;
};
/**
* Registers an icon config by name in the specified namespace.
* @param namespace Namespace in which to register the icon config.
* @param iconName Name under which to register the config.
* @param config Config to be registered.
*/
/**
* Registers an icon config by name in the specified namespace.
* @private
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which to register the icon config.
* @param {?} iconName Name under which to register the config.
* @param {?} config Config to be registered.
* @return {THIS}
*/
MatIconRegistry.prototype._addSvgIconConfig = /**
* Registers an icon config by name in the specified namespace.
* @private
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which to register the icon config.
* @param {?} iconName Name under which to register the config.
* @param {?} config Config to be registered.
* @return {THIS}
*/
function (namespace, iconName, config) {
(/** @type {?} */ (this))._svgIconConfigs.set(iconKey(namespace, iconName), config);
return (/** @type {?} */ (this));
};
/**
* Registers an icon set config in the specified namespace.
* @param namespace Namespace in which to register the icon config.
* @param config Config to be registered.
*/
/**
* Registers an icon set config in the specified namespace.
* @private
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which to register the icon config.
* @param {?} config Config to be registered.
* @return {THIS}
*/
MatIconRegistry.prototype._addSvgIconSetConfig = /**
* Registers an icon set config in the specified namespace.
* @private
* @template THIS
* @this {THIS}
* @param {?} namespace Namespace in which to register the icon config.
* @param {?} config Config to be registered.
* @return {THIS}
*/
function (namespace, config) {
/** @type {?} */
var configNamespace = (/** @type {?} */ (this))._iconSetConfigs.get(namespace);
if (configNamespace) {
configNamespace.push(config);
}
else {
(/** @type {?} */ (this))._iconSetConfigs.set(namespace, [config]);
}
return (/** @type {?} */ (this));
};
MatIconRegistry.decorators = [
{ type: core.Injectable, args: [{ providedIn: 'root' },] },
];
/** @nocollapse */
MatIconRegistry.ctorParameters = function () { return [
{ type: http.HttpClient, decorators: [{ type: core.Optional }] },
{ type: platformBrowser.DomSanitizer },
{ type: undefined, decorators: [{ type: core.Optional }, { type: core.Inject, args: [common.DOCUMENT,] }] },
{ type: core.ErrorHandler, decorators: [{ type: core.Optional }] }
]; };
/** @nocollapse */ MatIconRegistry.ngInjectableDef = core.ɵɵdefineInjectable({ factory: function MatIconRegistry_Factory() { return new MatIconRegistry(core.ɵɵinject(http.HttpClient, 8), core.ɵɵinject(platformBrowser.DomSanitizer), core.ɵɵinject(common.DOCUMENT, 8), core.ɵɵinject(core.ErrorHandler, 8)); }, token: MatIconRegistry, providedIn: "root" });
return MatIconRegistry;
}());
/**
* \@docs-private
* @param {?} parentRegistry
* @param {?} httpClient
* @param {?} sanitizer
* @param {?=} document
* @param {?=} errorHandler
* @return {?}
*/
function ICON_REGISTRY_PROVIDER_FACTORY(parentRegistry, httpClient, sanitizer, document, errorHandler) {
return parentRegistry || new MatIconRegistry(httpClient, sanitizer, document, errorHandler);
}
/**
* \@docs-private
* @type {?}
*/
var ICON_REGISTRY_PROVIDER = {
// If there is already an MatIconRegistry available, use that. Otherwise, provide a new one.
provide: MatIconRegistry,
deps: [
[new core.Optional(), new core.SkipSelf(), MatIconRegistry],
[new core.Optional(), http.HttpClient],
platformBrowser.DomSanitizer,
[new core.Optional(), core.ErrorHandler],
[new core.Optional(), (/** @type {?} */ (common.DOCUMENT))],
],
useFactory: ICON_REGISTRY_PROVIDER_FACTORY,
};
/**
* Clones an SVGElement while preserving type information.
* @param {?} svg
* @return {?}
*/
function cloneSvg(svg) {
return (/** @type {?} */ (svg.cloneNode(true)));
}
/**
* Returns the cache key to use for an icon namespace and name.
* @param {?} namespace
* @param {?} name
* @return {?}
*/
function iconKey(namespace, name) {
return namespace + ':' + name;
}
/**
* @fileoverview added by tsickle
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
// Boilerplate for applying mixins to MatIcon.
/**
* \@docs-private
*/
var
// Boilerplate for applying mixins to MatIcon.
/**
* \@docs-private
*/
MatIconBase = /** @class */ (function () {
function MatIconBase(_elementRef) {
this._elementRef = _elementRef;
}
return MatIconBase;
}());
/** @type {?} */
var _MatIconMixinBase = core$1.mixinColor(MatIconBase);
/**
* Injection token used to provide the current location to `MatIcon`.
* Used to handle server-side rendering and to stub out during unit tests.
* \@docs-private
* @type {?}
*/
var MAT_ICON_LOCATION = new core.InjectionToken('mat-icon-location', {
providedIn: 'root',
factory: MAT_ICON_LOCATION_FACTORY
});
/**
* \@docs-private
* @return {?}
*/
function MAT_ICON_LOCATION_FACTORY() {
/** @type {?} */
var _document = core.inject(common.DOCUMENT);
/** @type {?} */
var _location = _document ? _document.location : null;
return {
// Note that this needs to be a function, rather than a property, because Angular
// will only resolve it once, but we want the current path on each call.
getPathname: (/**
* @return {?}
*/
function () { return _location ? (_location.pathname + _location.search) : ''; })
};
}
/**
* SVG attributes that accept a FuncIRI (e.g. `url(<something>)`).
* @type {?}
*/
var funcIriAttributes = [
'clip-path',
'color-profile',
'src',
'cursor',
'fill',
'filter',
'marker',
'marker-start',
'marker-mid',
'marker-end',
'mask',
'stroke'
];
var ɵ0 = /**
* @param {?} attr
* @return {?}
*/
function (attr) { return "[" + attr + "]"; };
/**
* Selector that can be used to find all elements that are using a `FuncIRI`.
* @type {?}
*/
var funcIriAttributeSelector = funcIriAttributes.map((ɵ0)).join(', ');
/**
* Regex that can be used to extract the id out of a FuncIRI.
* @type {?}
*/
var funcIriPattern = /^url\(['"]?#(.*?)['"]?\)$/;
/**
* Component to display an icon. It can be used in the following ways:
*
* - Specify the svgIcon input to load an SVG icon from a URL previously registered with the
* addSvgIcon, addSvgIconInNamespace, addSvgIconSet, or addSvgIconSetInNamespace methods of
* MatIconRegistry. If the svgIcon value contains a colon it is assumed to be in the format
* "[namespace]:[name]", if not the value will be the name of an icon in the default namespace.
* Examples:
* `<mat-icon svgIcon="left-arrow"></mat-icon>
* <mat-icon svgIcon="animals:cat"></mat-icon>`
*
* - Use a font ligature as an icon by putting the ligature text in the content of the `<mat-icon>`
* component. By default the Material icons font is used as described at
* http://google.github.io/material-design-icons/#icon-font-for-the-web. You can specify an
* alternat