| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005 |
- import * as i0 from '@angular/core';
- import { SecurityContext, Injectable, Optional, Inject, SkipSelf, ErrorHandler, InjectionToken, inject, Component, ViewEncapsulation, ChangeDetectionStrategy, Attribute, Input, NgModule } from '@angular/core';
- import { mixinColor, MatCommonModule } from '@angular/material/core';
- import { coerceBooleanProperty } from '@angular/cdk/coercion';
- import { DOCUMENT } from '@angular/common';
- import { of, throwError, forkJoin, Subscription } from 'rxjs';
- import { tap, map, catchError, finalize, share, take } from 'rxjs/operators';
- import * as i1 from '@angular/common/http';
- import { HttpClient } from '@angular/common/http';
- import * as i2 from '@angular/platform-browser';
- import { DomSanitizer } from '@angular/platform-browser';
- /**
- * The Trusted Types policy, or null if Trusted Types are not
- * enabled/supported, or undefined if the policy has not been created yet.
- */
- let policy;
- /**
- * Returns the Trusted Types policy, or null if Trusted Types are not
- * enabled/supported. The first call to this function will create the policy.
- */
- function getPolicy() {
- if (policy === undefined) {
- policy = null;
- if (typeof window !== 'undefined') {
- const ttWindow = window;
- if (ttWindow.trustedTypes !== undefined) {
- policy = ttWindow.trustedTypes.createPolicy('angular#components', {
- createHTML: (s) => s,
- });
- }
- }
- }
- return policy;
- }
- /**
- * Unsafely promote a string to a TrustedHTML, falling back to strings when
- * Trusted Types are not available.
- * @security This is a security-sensitive function; any use of this function
- * must go through security review. In particular, it must be assured that the
- * provided string will never cause an XSS vulnerability if used in a context
- * that will be interpreted as HTML by a browser, e.g. when assigning to
- * element.innerHTML.
- */
- function trustedHTMLFromString(html) {
- return getPolicy()?.createHTML(html) || html;
- }
- /**
- * Returns an exception to be thrown in the case when attempting to
- * load an icon with a name that cannot be found.
- * @docs-private
- */
- 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
- */
- 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.
- * @param url URL that was attempted to be sanitized.
- * @docs-private
- */
- 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.
- * @param literal HTML that was attempted to be sanitized.
- * @docs-private
- */
- 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
- */
- class SvgIconConfig {
- constructor(url, svgText, options) {
- this.url = url;
- this.svgText = svgText;
- this.options = options;
- }
- }
- /**
- * 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.
- */
- class MatIconRegistry {
- constructor(_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();
- /** Registered icon resolver functions. */
- this._resolvers = [];
- /**
- * The CSS classes 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', 'mat-ligature-font'];
- this._document = document;
- }
- /**
- * Registers an icon by URL in the default namespace.
- * @param iconName Name under which the icon should be registered.
- * @param url
- */
- addSvgIcon(iconName, url, options) {
- return 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.
- */
- addSvgIconLiteral(iconName, literal, options) {
- return 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
- */
- addSvgIconInNamespace(namespace, iconName, url, options) {
- return this._addSvgIconConfig(namespace, iconName, new SvgIconConfig(url, null, options));
- }
- /**
- * Registers an icon resolver function with the registry. The function will be invoked with the
- * name and namespace of an icon when the registry tries to resolve the URL from which to fetch
- * the icon. The resolver is expected to return a `SafeResourceUrl` that points to the icon,
- * an object with the icon URL and icon options, or `null` if the icon is not supported. Resolvers
- * will be invoked in the order in which they have been registered.
- * @param resolver Resolver function to be registered.
- */
- addSvgIconResolver(resolver) {
- this._resolvers.push(resolver);
- return this;
- }
- /**
- * 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.
- */
- addSvgIconLiteralInNamespace(namespace, iconName, literal, options) {
- const cleanLiteral = this._sanitizer.sanitize(SecurityContext.HTML, literal);
- // TODO: add an ngDevMode check
- if (!cleanLiteral) {
- throw getMatIconFailedToSanitizeLiteralError(literal);
- }
- // Security: The literal is passed in as SafeHtml, and is thus trusted.
- const trustedLiteral = trustedHTMLFromString(cleanLiteral);
- return this._addSvgIconConfig(namespace, iconName, new SvgIconConfig('', trustedLiteral, options));
- }
- /**
- * Registers an icon set by URL in the default namespace.
- * @param url
- */
- addSvgIconSet(url, options) {
- return this.addSvgIconSetInNamespace('', url, options);
- }
- /**
- * Registers an icon set using an HTML string in the default namespace.
- * @param literal SVG source of the icon set.
- */
- addSvgIconSetLiteral(literal, options) {
- return 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
- */
- addSvgIconSetInNamespace(namespace, url, options) {
- return this._addSvgIconSetConfig(namespace, new SvgIconConfig(url, null, 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.
- */
- addSvgIconSetLiteralInNamespace(namespace, literal, options) {
- const cleanLiteral = this._sanitizer.sanitize(SecurityContext.HTML, literal);
- if (!cleanLiteral) {
- throw getMatIconFailedToSanitizeLiteralError(literal);
- }
- // Security: The literal is passed in as SafeHtml, and is thus trusted.
- const trustedLiteral = trustedHTMLFromString(cleanLiteral);
- return this._addSvgIconSetConfig(namespace, new SvgIconConfig('', trustedLiteral, options));
- }
- /**
- * Defines an alias for CSS class names 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.
- *
- * If the registered font is a ligature font, then don't forget to also include the special
- * class `mat-ligature-font` to allow the usage via attribute. So register like this:
- *
- * ```ts
- * iconRegistry.registerFontClassAlias('f1', 'font1 mat-ligature-font');
- * ```
- *
- * And use like this:
- *
- * ```html
- * <mat-icon fontSet="f1" fontIcon="home"></mat-icon>
- * ```
- *
- * @param alias Alias for the font.
- * @param classNames Class names override to be used instead of the alias.
- */
- registerFontClassAlias(alias, classNames = alias) {
- this._fontCssClassesByAlias.set(alias, classNames);
- return 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.
- */
- classNameForFontAlias(alias) {
- return this._fontCssClassesByAlias.get(alias) || alias;
- }
- /**
- * Sets the CSS classes 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.
- */
- setDefaultFontSetClass(...classNames) {
- this._defaultFontSetClass = classNames;
- return this;
- }
- /**
- * Returns the CSS classes 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.
- */
- getDefaultFontSetClass() {
- 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.
- */
- getSvgIconFromUrl(safeUrl) {
- const url = this._sanitizer.sanitize(SecurityContext.RESOURCE_URL, safeUrl);
- if (!url) {
- throw getMatIconFailedToSanitizeUrlError(safeUrl);
- }
- const cachedIcon = this._cachedIconsByUrl.get(url);
- if (cachedIcon) {
- return of(cloneSvg(cachedIcon));
- }
- return this._loadSvgIconFromConfig(new SvgIconConfig(safeUrl, null)).pipe(tap(svg => this._cachedIconsByUrl.set(url, svg)), map(svg => 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.
- */
- getNamedSvgIcon(name, namespace = '') {
- const key = iconKey(namespace, name);
- let config = this._svgIconConfigs.get(key);
- // Return (copy of) cached icon if possible.
- if (config) {
- return this._getSvgFromConfig(config);
- }
- // Otherwise try to resolve the config from one of the resolver functions.
- config = this._getIconConfigFromResolvers(namespace, name);
- if (config) {
- this._svgIconConfigs.set(key, config);
- return this._getSvgFromConfig(config);
- }
- // See if we have any icon sets registered for the namespace.
- const iconSetConfigs = this._iconSetConfigs.get(namespace);
- if (iconSetConfigs) {
- return this._getSvgFromIconSetConfigs(name, iconSetConfigs);
- }
- return throwError(getMatIconNameNotFoundError(key));
- }
- ngOnDestroy() {
- this._resolvers = [];
- 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.
- */
- _getSvgFromConfig(config) {
- if (config.svgText) {
- // We already have the SVG element for this icon, return a copy.
- return of(cloneSvg(this._svgElementFromConfig(config)));
- }
- else {
- // Fetch the icon from the config's URL, cache it, and return a copy.
- return this._loadSvgIconFromConfig(config).pipe(map(svg => 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.
- */
- _getSvgFromIconSetConfigs(name, iconSetConfigs) {
- // For all the icon set SVG elements we've fetched, see if any contain an icon with the
- // requested name.
- const 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 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.
- const iconSetFetchRequests = iconSetConfigs
- .filter(iconSetConfig => !iconSetConfig.svgText)
- .map(iconSetConfig => {
- return this._loadSvgIconSetFromConfig(iconSetConfig).pipe(catchError((err) => {
- const url = this._sanitizer.sanitize(SecurityContext.RESOURCE_URL, iconSetConfig.url);
- // Swallow errors fetching individual URLs so the
- // combined Observable won't necessarily fail.
- const errorMessage = `Loading icon set URL: ${url} failed: ${err.message}`;
- this._errorHandler.handleError(new Error(errorMessage));
- return 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 forkJoin(iconSetFetchRequests).pipe(map(() => {
- const foundIcon = this._extractIconWithNameFromAnySet(name, iconSetConfigs);
- // TODO: add an ngDevMode check
- 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.
- */
- _extractIconWithNameFromAnySet(iconName, iconSetConfigs) {
- // Iterate backwards, so icon sets added later have precedence.
- for (let i = iconSetConfigs.length - 1; i >= 0; i--) {
- const config = iconSetConfigs[i];
- // Parsing the icon set's text into an SVG element can be expensive. We can avoid some of
- // the parsing by doing a quick check using `indexOf` to see if there's any chance for the
- // icon to be in the set. This won't be 100% accurate, but it should help us avoid at least
- // some of the parsing.
- if (config.svgText && config.svgText.toString().indexOf(iconName) > -1) {
- const svg = this._svgElementFromConfig(config);
- const foundIcon = this._extractSvgIconFromSet(svg, 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.
- */
- _loadSvgIconFromConfig(config) {
- return this._fetchIcon(config).pipe(tap(svgText => (config.svgText = svgText)), map(() => this._svgElementFromConfig(config)));
- }
- /**
- * Loads the content of the icon set URL specified in the
- * SvgIconConfig and attaches it to the config.
- */
- _loadSvgIconSetFromConfig(config) {
- if (config.svgText) {
- return of(null);
- }
- return this._fetchIcon(config).pipe(tap(svgText => (config.svgText = svgText)));
- }
- /**
- * 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.
- */
- _extractSvgIconFromSet(iconSet, iconName, options) {
- // Use the `id="iconName"` syntax in order to escape special
- // characters in the ID (versus using the #iconName syntax).
- const 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.
- const iconElement = 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(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
- const svg = this._svgElementFromString(trustedHTMLFromString('<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.
- */
- _svgElementFromString(str) {
- const div = this._document.createElement('DIV');
- div.innerHTML = str;
- const svg = div.querySelector('svg');
- // TODO: add an ngDevMode check
- if (!svg) {
- throw Error('<svg> tag not found');
- }
- return svg;
- }
- /**
- * Converts an element into an SVG node by cloning all of its children.
- */
- _toSvgElement(element) {
- const svg = this._svgElementFromString(trustedHTMLFromString('<svg></svg>'));
- const attributes = element.attributes;
- // Copy over all the attributes from the `symbol` to the new SVG, except the id.
- for (let i = 0; i < attributes.length; i++) {
- const { name, value } = attributes[i];
- if (name !== 'id') {
- svg.setAttribute(name, value);
- }
- }
- for (let 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.
- */
- _setSvgAttributes(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 icon. Results may be
- * cached, so future calls with the same URL may not cause another HTTP request.
- */
- _fetchIcon(iconConfig) {
- const { url: safeUrl, options } = iconConfig;
- const withCredentials = options?.withCredentials ?? false;
- if (!this._httpClient) {
- throw getMatIconNoHttpProviderError();
- }
- // TODO: add an ngDevMode check
- if (safeUrl == null) {
- throw Error(`Cannot fetch icon from URL "${safeUrl}".`);
- }
- const url = this._sanitizer.sanitize(SecurityContext.RESOURCE_URL, safeUrl);
- // TODO: add an ngDevMode check
- 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.
- const inProgressFetch = this._inProgressUrlFetches.get(url);
- if (inProgressFetch) {
- return inProgressFetch;
- }
- const req = this._httpClient.get(url, { responseType: 'text', withCredentials }).pipe(map(svg => {
- // Security: This SVG is fetched from a SafeResourceUrl, and is thus
- // trusted HTML.
- return trustedHTMLFromString(svg);
- }), finalize(() => this._inProgressUrlFetches.delete(url)), 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.
- */
- _addSvgIconConfig(namespace, iconName, config) {
- this._svgIconConfigs.set(iconKey(namespace, iconName), config);
- return 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.
- */
- _addSvgIconSetConfig(namespace, config) {
- const configNamespace = this._iconSetConfigs.get(namespace);
- if (configNamespace) {
- configNamespace.push(config);
- }
- else {
- this._iconSetConfigs.set(namespace, [config]);
- }
- return this;
- }
- /** Parses a config's text into an SVG element. */
- _svgElementFromConfig(config) {
- if (!config.svgElement) {
- const svg = this._svgElementFromString(config.svgText);
- this._setSvgAttributes(svg, config.options);
- config.svgElement = svg;
- }
- return config.svgElement;
- }
- /** Tries to create an icon config through the registered resolver functions. */
- _getIconConfigFromResolvers(namespace, name) {
- for (let i = 0; i < this._resolvers.length; i++) {
- const result = this._resolvers[i](name, namespace);
- if (result) {
- return isSafeUrlWithOptions(result)
- ? new SvgIconConfig(result.url, null, result.options)
- : new SvgIconConfig(result, null);
- }
- }
- return undefined;
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.0.0", ngImport: i0, type: MatIconRegistry, deps: [{ token: i1.HttpClient, optional: true }, { token: i2.DomSanitizer }, { token: DOCUMENT, optional: true }, { token: i0.ErrorHandler }], target: i0.ɵɵFactoryTarget.Injectable }); }
- static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.0.0", ngImport: i0, type: MatIconRegistry, providedIn: 'root' }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.0.0", ngImport: i0, type: MatIconRegistry, decorators: [{
- type: Injectable,
- args: [{ providedIn: 'root' }]
- }], ctorParameters: function () { return [{ type: i1.HttpClient, decorators: [{
- type: Optional
- }] }, { type: i2.DomSanitizer }, { type: undefined, decorators: [{
- type: Optional
- }, {
- type: Inject,
- args: [DOCUMENT]
- }] }, { type: i0.ErrorHandler }]; } });
- /** @docs-private */
- function ICON_REGISTRY_PROVIDER_FACTORY(parentRegistry, httpClient, sanitizer, errorHandler, document) {
- return parentRegistry || new MatIconRegistry(httpClient, sanitizer, document, errorHandler);
- }
- /** @docs-private */
- const ICON_REGISTRY_PROVIDER = {
- // If there is already an MatIconRegistry available, use that. Otherwise, provide a new one.
- provide: MatIconRegistry,
- deps: [
- [new Optional(), new SkipSelf(), MatIconRegistry],
- [new Optional(), HttpClient],
- DomSanitizer,
- ErrorHandler,
- [new Optional(), DOCUMENT],
- ],
- useFactory: ICON_REGISTRY_PROVIDER_FACTORY,
- };
- /** Clones an SVGElement while preserving type information. */
- function cloneSvg(svg) {
- return svg.cloneNode(true);
- }
- /** Returns the cache key to use for an icon namespace and name. */
- function iconKey(namespace, name) {
- return namespace + ':' + name;
- }
- function isSafeUrlWithOptions(value) {
- return !!(value.url && value.options);
- }
- // Boilerplate for applying mixins to MatIcon.
- /** @docs-private */
- const _MatIconBase = mixinColor(class {
- constructor(_elementRef) {
- this._elementRef = _elementRef;
- }
- });
- /** Injection token to be used to override the default options for `mat-icon`. */
- const MAT_ICON_DEFAULT_OPTIONS = new InjectionToken('MAT_ICON_DEFAULT_OPTIONS');
- /**
- * 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
- */
- const MAT_ICON_LOCATION = new InjectionToken('mat-icon-location', {
- providedIn: 'root',
- factory: MAT_ICON_LOCATION_FACTORY,
- });
- /** @docs-private */
- function MAT_ICON_LOCATION_FACTORY() {
- const _document = inject(DOCUMENT);
- const _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: () => (_location ? _location.pathname + _location.search : ''),
- };
- }
- /** SVG attributes that accept a FuncIRI (e.g. `url(<something>)`). */
- const funcIriAttributes = [
- 'clip-path',
- 'color-profile',
- 'src',
- 'cursor',
- 'fill',
- 'filter',
- 'marker',
- 'marker-start',
- 'marker-mid',
- 'marker-end',
- 'mask',
- 'stroke',
- ];
- /** Selector that can be used to find all elements that are using a `FuncIRI`. */
- const funcIriAttributeSelector = funcIriAttributes.map(attr => `[${attr}]`).join(', ');
- /** Regex that can be used to extract the id out of a FuncIRI. */
- const 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 `fontIcon` attribute or the
- * content of the `<mat-icon>` component. If you register a custom font class, don't forget to also
- * include the special class `mat-ligature-font`. It is recommended to use the attribute alternative
- * to prevent the ligature text to be selectable and to appear in search engine results.
- * 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
- * alternate font by setting the fontSet input to either the CSS class to apply to use the
- * desired font, or to an alias previously registered with MatIconRegistry.registerFontClassAlias.
- * Examples:
- * `<mat-icon fontIcon="home"></mat-icon>
- * <mat-icon>home</mat-icon>
- * <mat-icon fontSet="myfont" fontIcon="sun"></mat-icon>
- * <mat-icon fontSet="myfont">sun</mat-icon>`
- *
- * - Specify a font glyph to be included via CSS rules by setting the fontSet input to specify the
- * font, and the fontIcon input to specify the icon. Typically the fontIcon will specify a
- * CSS class which causes the glyph to be displayed via a :before selector, as in
- * https://fortawesome.github.io/Font-Awesome/examples/
- * Example:
- * `<mat-icon fontSet="fa" fontIcon="alarm"></mat-icon>`
- */
- class MatIcon extends _MatIconBase {
- /**
- * Whether the icon should be inlined, automatically sizing the icon to match the font size of
- * the element the icon is contained in.
- */
- get inline() {
- return this._inline;
- }
- set inline(inline) {
- this._inline = coerceBooleanProperty(inline);
- }
- /** Name of the icon in the SVG icon set. */
- get svgIcon() {
- return this._svgIcon;
- }
- set svgIcon(value) {
- if (value !== this._svgIcon) {
- if (value) {
- this._updateSvgIcon(value);
- }
- else if (this._svgIcon) {
- this._clearSvgElement();
- }
- this._svgIcon = value;
- }
- }
- /** Font set that the icon is a part of. */
- get fontSet() {
- return this._fontSet;
- }
- set fontSet(value) {
- const newValue = this._cleanupFontValue(value);
- if (newValue !== this._fontSet) {
- this._fontSet = newValue;
- this._updateFontIconClasses();
- }
- }
- /** Name of an icon within a font set. */
- get fontIcon() {
- return this._fontIcon;
- }
- set fontIcon(value) {
- const newValue = this._cleanupFontValue(value);
- if (newValue !== this._fontIcon) {
- this._fontIcon = newValue;
- this._updateFontIconClasses();
- }
- }
- constructor(elementRef, _iconRegistry, ariaHidden, _location, _errorHandler, defaults) {
- super(elementRef);
- this._iconRegistry = _iconRegistry;
- this._location = _location;
- this._errorHandler = _errorHandler;
- this._inline = false;
- this._previousFontSetClass = [];
- /** Subscription to the current in-progress SVG icon request. */
- this._currentIconFetch = Subscription.EMPTY;
- if (defaults) {
- if (defaults.color) {
- this.color = this.defaultColor = defaults.color;
- }
- if (defaults.fontSet) {
- this.fontSet = defaults.fontSet;
- }
- }
- // If the user has not explicitly set aria-hidden, mark the icon as hidden, as this is
- // the right thing to do for the majority of icon use-cases.
- if (!ariaHidden) {
- elementRef.nativeElement.setAttribute('aria-hidden', 'true');
- }
- }
- /**
- * Splits an svgIcon binding value into its icon set and icon name components.
- * Returns a 2-element array of [(icon set), (icon name)].
- * The separator for the two fields is ':'. If there is no separator, an empty
- * string is returned for the icon set and the entire value is returned for
- * the icon name. If the argument is falsy, returns an array of two empty strings.
- * Throws an error if the name contains two or more ':' separators.
- * Examples:
- * `'social:cake' -> ['social', 'cake']
- * 'penguin' -> ['', 'penguin']
- * null -> ['', '']
- * 'a:b:c' -> (throws Error)`
- */
- _splitIconName(iconName) {
- if (!iconName) {
- return ['', ''];
- }
- const parts = iconName.split(':');
- switch (parts.length) {
- case 1:
- return ['', parts[0]]; // Use default namespace.
- case 2:
- return parts;
- default:
- throw Error(`Invalid icon name: "${iconName}"`); // TODO: add an ngDevMode check
- }
- }
- ngOnInit() {
- // Update font classes because ngOnChanges won't be called if none of the inputs are present,
- // e.g. <mat-icon>arrow</mat-icon> In this case we need to add a CSS class for the default font.
- this._updateFontIconClasses();
- }
- ngAfterViewChecked() {
- const cachedElements = this._elementsWithExternalReferences;
- if (cachedElements && cachedElements.size) {
- const newPath = this._location.getPathname();
- // We need to check whether the URL has changed on each change detection since
- // the browser doesn't have an API that will let us react on link clicks and
- // we can't depend on the Angular router. The references need to be updated,
- // because while most browsers don't care whether the URL is correct after
- // the first render, Safari will break if the user navigates to a different
- // page and the SVG isn't re-rendered.
- if (newPath !== this._previousPath) {
- this._previousPath = newPath;
- this._prependPathToReferences(newPath);
- }
- }
- }
- ngOnDestroy() {
- this._currentIconFetch.unsubscribe();
- if (this._elementsWithExternalReferences) {
- this._elementsWithExternalReferences.clear();
- }
- }
- _usingFontIcon() {
- return !this.svgIcon;
- }
- _setSvgElement(svg) {
- this._clearSvgElement();
- // Note: we do this fix here, rather than the icon registry, because the
- // references have to point to the URL at the time that the icon was created.
- const path = this._location.getPathname();
- this._previousPath = path;
- this._cacheChildrenWithExternalReferences(svg);
- this._prependPathToReferences(path);
- this._elementRef.nativeElement.appendChild(svg);
- }
- _clearSvgElement() {
- const layoutElement = this._elementRef.nativeElement;
- let childCount = layoutElement.childNodes.length;
- if (this._elementsWithExternalReferences) {
- this._elementsWithExternalReferences.clear();
- }
- // Remove existing non-element child nodes and SVGs, and add the new SVG element. Note that
- // we can't use innerHTML, because IE will throw if the element has a data binding.
- while (childCount--) {
- const child = layoutElement.childNodes[childCount];
- // 1 corresponds to Node.ELEMENT_NODE. We remove all non-element nodes in order to get rid
- // of any loose text nodes, as well as any SVG elements in order to remove any old icons.
- if (child.nodeType !== 1 || child.nodeName.toLowerCase() === 'svg') {
- child.remove();
- }
- }
- }
- _updateFontIconClasses() {
- if (!this._usingFontIcon()) {
- return;
- }
- const elem = this._elementRef.nativeElement;
- const fontSetClasses = (this.fontSet
- ? this._iconRegistry.classNameForFontAlias(this.fontSet).split(/ +/)
- : this._iconRegistry.getDefaultFontSetClass()).filter(className => className.length > 0);
- this._previousFontSetClass.forEach(className => elem.classList.remove(className));
- fontSetClasses.forEach(className => elem.classList.add(className));
- this._previousFontSetClass = fontSetClasses;
- if (this.fontIcon !== this._previousFontIconClass &&
- !fontSetClasses.includes('mat-ligature-font')) {
- if (this._previousFontIconClass) {
- elem.classList.remove(this._previousFontIconClass);
- }
- if (this.fontIcon) {
- elem.classList.add(this.fontIcon);
- }
- this._previousFontIconClass = this.fontIcon;
- }
- }
- /**
- * Cleans up a value to be used as a fontIcon or fontSet.
- * Since the value ends up being assigned as a CSS class, we
- * have to trim the value and omit space-separated values.
- */
- _cleanupFontValue(value) {
- return typeof value === 'string' ? value.trim().split(' ')[0] : value;
- }
- /**
- * Prepends the current path to all elements that have an attribute pointing to a `FuncIRI`
- * reference. This is required because WebKit browsers require references to be prefixed with
- * the current path, if the page has a `base` tag.
- */
- _prependPathToReferences(path) {
- const elements = this._elementsWithExternalReferences;
- if (elements) {
- elements.forEach((attrs, element) => {
- attrs.forEach(attr => {
- element.setAttribute(attr.name, `url('${path}#${attr.value}')`);
- });
- });
- }
- }
- /**
- * Caches the children of an SVG element that have `url()`
- * references that we need to prefix with the current path.
- */
- _cacheChildrenWithExternalReferences(element) {
- const elementsWithFuncIri = element.querySelectorAll(funcIriAttributeSelector);
- const elements = (this._elementsWithExternalReferences =
- this._elementsWithExternalReferences || new Map());
- for (let i = 0; i < elementsWithFuncIri.length; i++) {
- funcIriAttributes.forEach(attr => {
- const elementWithReference = elementsWithFuncIri[i];
- const value = elementWithReference.getAttribute(attr);
- const match = value ? value.match(funcIriPattern) : null;
- if (match) {
- let attributes = elements.get(elementWithReference);
- if (!attributes) {
- attributes = [];
- elements.set(elementWithReference, attributes);
- }
- attributes.push({ name: attr, value: match[1] });
- }
- });
- }
- }
- /** Sets a new SVG icon with a particular name. */
- _updateSvgIcon(rawName) {
- this._svgNamespace = null;
- this._svgName = null;
- this._currentIconFetch.unsubscribe();
- if (rawName) {
- const [namespace, iconName] = this._splitIconName(rawName);
- if (namespace) {
- this._svgNamespace = namespace;
- }
- if (iconName) {
- this._svgName = iconName;
- }
- this._currentIconFetch = this._iconRegistry
- .getNamedSvgIcon(iconName, namespace)
- .pipe(take(1))
- .subscribe(svg => this._setSvgElement(svg), (err) => {
- const errorMessage = `Error retrieving icon ${namespace}:${iconName}! ${err.message}`;
- this._errorHandler.handleError(new Error(errorMessage));
- });
- }
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.0.0", ngImport: i0, type: MatIcon, deps: [{ token: i0.ElementRef }, { token: MatIconRegistry }, { token: 'aria-hidden', attribute: true }, { token: MAT_ICON_LOCATION }, { token: i0.ErrorHandler }, { token: MAT_ICON_DEFAULT_OPTIONS, optional: true }], target: i0.ɵɵFactoryTarget.Component }); }
- static { this.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "16.0.0", type: MatIcon, selector: "mat-icon", inputs: { color: "color", inline: "inline", svgIcon: "svgIcon", fontSet: "fontSet", fontIcon: "fontIcon" }, host: { attributes: { "role": "img" }, properties: { "attr.data-mat-icon-type": "_usingFontIcon() ? \"font\" : \"svg\"", "attr.data-mat-icon-name": "_svgName || fontIcon", "attr.data-mat-icon-namespace": "_svgNamespace || fontSet", "attr.fontIcon": "_usingFontIcon() ? fontIcon : null", "class.mat-icon-inline": "inline", "class.mat-icon-no-color": "color !== \"primary\" && color !== \"accent\" && color !== \"warn\"" }, classAttribute: "mat-icon notranslate" }, exportAs: ["matIcon"], usesInheritance: true, ngImport: i0, template: '<ng-content></ng-content>', isInline: true, styles: [".mat-icon{-webkit-user-select:none;user-select:none;background-repeat:no-repeat;display:inline-block;fill:currentColor;height:24px;width:24px;overflow:hidden}.mat-icon.mat-icon-inline{font-size:inherit;height:inherit;line-height:inherit;width:inherit}.mat-icon.mat-ligature-font[fontIcon]::before{content:attr(fontIcon)}[dir=rtl] .mat-icon-rtl-mirror{transform:scale(-1, 1)}.mat-form-field:not(.mat-form-field-appearance-legacy) .mat-form-field-prefix .mat-icon,.mat-form-field:not(.mat-form-field-appearance-legacy) .mat-form-field-suffix .mat-icon{display:block}.mat-form-field:not(.mat-form-field-appearance-legacy) .mat-form-field-prefix .mat-icon-button .mat-icon,.mat-form-field:not(.mat-form-field-appearance-legacy) .mat-form-field-suffix .mat-icon-button .mat-icon{margin:auto}"], changeDetection: i0.ChangeDetectionStrategy.OnPush, encapsulation: i0.ViewEncapsulation.None }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.0.0", ngImport: i0, type: MatIcon, decorators: [{
- type: Component,
- args: [{ template: '<ng-content></ng-content>', selector: 'mat-icon', exportAs: 'matIcon', inputs: ['color'], host: {
- 'role': 'img',
- 'class': 'mat-icon notranslate',
- '[attr.data-mat-icon-type]': '_usingFontIcon() ? "font" : "svg"',
- '[attr.data-mat-icon-name]': '_svgName || fontIcon',
- '[attr.data-mat-icon-namespace]': '_svgNamespace || fontSet',
- '[attr.fontIcon]': '_usingFontIcon() ? fontIcon : null',
- '[class.mat-icon-inline]': 'inline',
- '[class.mat-icon-no-color]': 'color !== "primary" && color !== "accent" && color !== "warn"',
- }, encapsulation: ViewEncapsulation.None, changeDetection: ChangeDetectionStrategy.OnPush, styles: [".mat-icon{-webkit-user-select:none;user-select:none;background-repeat:no-repeat;display:inline-block;fill:currentColor;height:24px;width:24px;overflow:hidden}.mat-icon.mat-icon-inline{font-size:inherit;height:inherit;line-height:inherit;width:inherit}.mat-icon.mat-ligature-font[fontIcon]::before{content:attr(fontIcon)}[dir=rtl] .mat-icon-rtl-mirror{transform:scale(-1, 1)}.mat-form-field:not(.mat-form-field-appearance-legacy) .mat-form-field-prefix .mat-icon,.mat-form-field:not(.mat-form-field-appearance-legacy) .mat-form-field-suffix .mat-icon{display:block}.mat-form-field:not(.mat-form-field-appearance-legacy) .mat-form-field-prefix .mat-icon-button .mat-icon,.mat-form-field:not(.mat-form-field-appearance-legacy) .mat-form-field-suffix .mat-icon-button .mat-icon{margin:auto}"] }]
- }], ctorParameters: function () { return [{ type: i0.ElementRef }, { type: MatIconRegistry }, { type: undefined, decorators: [{
- type: Attribute,
- args: ['aria-hidden']
- }] }, { type: undefined, decorators: [{
- type: Inject,
- args: [MAT_ICON_LOCATION]
- }] }, { type: i0.ErrorHandler }, { type: undefined, decorators: [{
- type: Optional
- }, {
- type: Inject,
- args: [MAT_ICON_DEFAULT_OPTIONS]
- }] }]; }, propDecorators: { inline: [{
- type: Input
- }], svgIcon: [{
- type: Input
- }], fontSet: [{
- type: Input
- }], fontIcon: [{
- type: Input
- }] } });
- class MatIconModule {
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.0.0", ngImport: i0, type: MatIconModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
- static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "16.0.0", ngImport: i0, type: MatIconModule, declarations: [MatIcon], imports: [MatCommonModule], exports: [MatIcon, MatCommonModule] }); }
- static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "16.0.0", ngImport: i0, type: MatIconModule, imports: [MatCommonModule, MatCommonModule] }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.0.0", ngImport: i0, type: MatIconModule, decorators: [{
- type: NgModule,
- args: [{
- imports: [MatCommonModule],
- exports: [MatIcon, MatCommonModule],
- declarations: [MatIcon],
- }]
- }] });
- /**
- * Generated bundle index. Do not edit.
- */
- export { ICON_REGISTRY_PROVIDER, ICON_REGISTRY_PROVIDER_FACTORY, MAT_ICON_DEFAULT_OPTIONS, MAT_ICON_LOCATION, MAT_ICON_LOCATION_FACTORY, MatIcon, MatIconModule, MatIconRegistry, getMatIconFailedToSanitizeLiteralError, getMatIconFailedToSanitizeUrlError, getMatIconNameNotFoundError, getMatIconNoHttpProviderError };
- //# sourceMappingURL=icon.mjs.map
|