769 lines
27 KiB
TypeScript
769 lines
27 KiB
TypeScript
/**
|
|
* @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.dev/license
|
|
*/
|
|
|
|
import {DOCUMENT} from '@angular/common';
|
|
import {HttpClient, HttpErrorResponse} from '@angular/common/http';
|
|
import {
|
|
ErrorHandler,
|
|
Inject,
|
|
Injectable,
|
|
InjectionToken,
|
|
OnDestroy,
|
|
Optional,
|
|
SecurityContext,
|
|
SkipSelf,
|
|
} from '@angular/core';
|
|
import {DomSanitizer, SafeHtml, SafeResourceUrl} from '@angular/platform-browser';
|
|
import {forkJoin, Observable, of as observableOf, throwError as observableThrow} from 'rxjs';
|
|
import {catchError, finalize, map, share, tap} from 'rxjs/operators';
|
|
import {TrustedHTML, trustedHTMLFromString} from './trusted-types';
|
|
|
|
/**
|
|
* Returns an exception to be thrown in the case when attempting to
|
|
* load an icon with a name that cannot be found.
|
|
* @docs-private
|
|
*/
|
|
export function getMatIconNameNotFoundError(iconName: string): Error {
|
|
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
|
|
*/
|
|
export function getMatIconNoHttpProviderError(): Error {
|
|
return Error(
|
|
'Could not find HttpClient for use with Angular Material icons. ' +
|
|
'Please add provideHttpClient() to your providers.',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Returns an exception to be thrown when a URL couldn't be sanitized.
|
|
* @param url URL that was attempted to be sanitized.
|
|
* @docs-private
|
|
*/
|
|
export function getMatIconFailedToSanitizeUrlError(url: SafeResourceUrl): Error {
|
|
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
|
|
*/
|
|
export function getMatIconFailedToSanitizeLiteralError(literal: SafeHtml): Error {
|
|
return Error(
|
|
`The literal provided to MatIconRegistry was not trusted as safe HTML by ` +
|
|
`Angular's DomSanitizer. Attempted literal was "${literal}".`,
|
|
);
|
|
}
|
|
|
|
/** Options that can be used to configure how an icon or the icons in an icon set are presented. */
|
|
export interface IconOptions {
|
|
/** View box to set on the icon. */
|
|
viewBox?: string;
|
|
|
|
/** Whether or not to fetch the icon or icon set using HTTP credentials. */
|
|
withCredentials?: boolean;
|
|
}
|
|
|
|
/**
|
|
* Function that will be invoked by the icon registry when trying to resolve the
|
|
* URL from which to fetch an icon. The returned URL will be used to make a request for the icon.
|
|
*/
|
|
export type IconResolver = (
|
|
name: string,
|
|
namespace: string,
|
|
) => SafeResourceUrl | SafeResourceUrlWithIconOptions | null;
|
|
|
|
/** Object that specifies a URL from which to fetch an icon and the options to use for it. */
|
|
export interface SafeResourceUrlWithIconOptions {
|
|
url: SafeResourceUrl;
|
|
options: IconOptions;
|
|
}
|
|
|
|
/**
|
|
* Configuration for an icon, including the URL and possibly the cached SVG element.
|
|
* @docs-private
|
|
*/
|
|
class SvgIconConfig {
|
|
svgElement: SVGElement | null;
|
|
|
|
constructor(
|
|
public url: SafeResourceUrl,
|
|
public svgText: TrustedHTML | null,
|
|
public options?: IconOptions,
|
|
) {}
|
|
}
|
|
|
|
/** Icon configuration whose content has already been loaded. */
|
|
type LoadedSvgIconConfig = SvgIconConfig & {svgText: TrustedHTML};
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
@Injectable({providedIn: 'root'})
|
|
export class MatIconRegistry implements OnDestroy {
|
|
private _document: Document;
|
|
|
|
/**
|
|
* URLs and cached SVG elements for individual icons. Keys are of the format "[namespace]:[icon]".
|
|
*/
|
|
private _svgIconConfigs = new Map<string, SvgIconConfig>();
|
|
|
|
/**
|
|
* SvgIconConfig objects and cached SVG elements for icon sets, keyed by namespace.
|
|
* Multiple icon sets can be registered under the same namespace.
|
|
*/
|
|
private _iconSetConfigs = new Map<string, SvgIconConfig[]>();
|
|
|
|
/** Cache for icons loaded by direct URLs. */
|
|
private _cachedIconsByUrl = new Map<string, SVGElement>();
|
|
|
|
/** In-progress icon fetches. Used to coalesce multiple requests to the same URL. */
|
|
private _inProgressUrlFetches = new Map<string, Observable<TrustedHTML>>();
|
|
|
|
/** Map from font identifiers to their CSS class names. Used for icon fonts. */
|
|
private _fontCssClassesByAlias = new Map<string, string>();
|
|
|
|
/** Registered icon resolver functions. */
|
|
private _resolvers: IconResolver[] = [];
|
|
|
|
/**
|
|
* 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 https://google.github.io/material-design-icons/#icon-font-for-the-web
|
|
*/
|
|
private _defaultFontSetClass = ['material-icons', 'mat-ligature-font'];
|
|
|
|
constructor(
|
|
@Optional() private _httpClient: HttpClient,
|
|
private _sanitizer: DomSanitizer,
|
|
@Optional() @Inject(DOCUMENT) document: any,
|
|
private readonly _errorHandler: ErrorHandler,
|
|
) {
|
|
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: string, url: SafeResourceUrl, options?: IconOptions): this {
|
|
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: string, literal: SafeHtml, options?: IconOptions): this {
|
|
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: string,
|
|
iconName: string,
|
|
url: SafeResourceUrl,
|
|
options?: IconOptions,
|
|
): this {
|
|
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: IconResolver): this {
|
|
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: string,
|
|
iconName: string,
|
|
literal: SafeHtml,
|
|
options?: IconOptions,
|
|
): this {
|
|
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: SafeResourceUrl, options?: IconOptions): this {
|
|
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: SafeHtml, options?: IconOptions): this {
|
|
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: string, url: SafeResourceUrl, options?: IconOptions): this {
|
|
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: string,
|
|
literal: SafeHtml,
|
|
options?: IconOptions,
|
|
): this {
|
|
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: string, classNames: string = alias): this {
|
|
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: string): string {
|
|
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: string[]): this {
|
|
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(): string[] {
|
|
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: SafeResourceUrl): Observable<SVGElement> {
|
|
const url = this._sanitizer.sanitize(SecurityContext.RESOURCE_URL, safeUrl);
|
|
|
|
if (!url) {
|
|
throw getMatIconFailedToSanitizeUrlError(safeUrl);
|
|
}
|
|
|
|
const cachedIcon = this._cachedIconsByUrl.get(url);
|
|
|
|
if (cachedIcon) {
|
|
return observableOf(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: string, namespace: string = ''): Observable<SVGElement> {
|
|
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 observableThrow(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.
|
|
*/
|
|
private _getSvgFromConfig(config: SvgIconConfig): Observable<SVGElement> {
|
|
if (config.svgText) {
|
|
// We already have the SVG element for this icon, return a copy.
|
|
return observableOf(cloneSvg(this._svgElementFromConfig(config as LoadedSvgIconConfig)));
|
|
} 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.
|
|
*/
|
|
private _getSvgFromIconSetConfigs(
|
|
name: string,
|
|
iconSetConfigs: SvgIconConfig[],
|
|
): Observable<SVGElement> {
|
|
// 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 observableOf(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: Observable<TrustedHTML | null>[] = iconSetConfigs
|
|
.filter(iconSetConfig => !iconSetConfig.svgText)
|
|
.map(iconSetConfig => {
|
|
return this._loadSvgIconSetFromConfig(iconSetConfig).pipe(
|
|
catchError((err: HttpErrorResponse) => {
|
|
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 observableOf(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.
|
|
*/
|
|
private _extractIconWithNameFromAnySet(
|
|
iconName: string,
|
|
iconSetConfigs: SvgIconConfig[],
|
|
): SVGElement | null {
|
|
// 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 as LoadedSvgIconConfig);
|
|
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.
|
|
*/
|
|
private _loadSvgIconFromConfig(config: SvgIconConfig): Observable<SVGElement> {
|
|
return this._fetchIcon(config).pipe(
|
|
tap(svgText => (config.svgText = svgText)),
|
|
map(() => this._svgElementFromConfig(config as LoadedSvgIconConfig)),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Loads the content of the icon set URL specified in the
|
|
* SvgIconConfig and attaches it to the config.
|
|
*/
|
|
private _loadSvgIconSetFromConfig(config: SvgIconConfig): Observable<TrustedHTML | null> {
|
|
if (config.svgText) {
|
|
return observableOf(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.
|
|
*/
|
|
private _extractSvgIconFromSet(
|
|
iconSet: SVGElement,
|
|
iconName: string,
|
|
options?: IconOptions,
|
|
): SVGElement | null {
|
|
// 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) as Element;
|
|
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 as SVGElement, 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.
|
|
*/
|
|
private _svgElementFromString(str: TrustedHTML): SVGElement {
|
|
const div = this._document.createElement('DIV');
|
|
div.innerHTML = str as unknown as string;
|
|
const svg = div.querySelector('svg') as SVGElement;
|
|
|
|
// 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.
|
|
*/
|
|
private _toSvgElement(element: Element): SVGElement {
|
|
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.
|
|
*/
|
|
private _setSvgAttributes(svg: SVGElement, options?: IconOptions): SVGElement {
|
|
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.
|
|
*/
|
|
private _fetchIcon(iconConfig: SvgIconConfig): Observable<TrustedHTML> {
|
|
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.
|
|
*/
|
|
private _addSvgIconConfig(namespace: string, iconName: string, config: SvgIconConfig): this {
|
|
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.
|
|
*/
|
|
private _addSvgIconSetConfig(namespace: string, config: SvgIconConfig): this {
|
|
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. */
|
|
private _svgElementFromConfig(config: LoadedSvgIconConfig): SVGElement {
|
|
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. */
|
|
private _getIconConfigFromResolvers(namespace: string, name: string): SvgIconConfig | undefined {
|
|
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;
|
|
}
|
|
}
|
|
|
|
/** @docs-private */
|
|
export function ICON_REGISTRY_PROVIDER_FACTORY(
|
|
parentRegistry: MatIconRegistry,
|
|
httpClient: HttpClient,
|
|
sanitizer: DomSanitizer,
|
|
errorHandler: ErrorHandler,
|
|
document?: any,
|
|
) {
|
|
return parentRegistry || new MatIconRegistry(httpClient, sanitizer, document, errorHandler);
|
|
}
|
|
|
|
/** @docs-private */
|
|
export 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 as InjectionToken<any>],
|
|
],
|
|
useFactory: ICON_REGISTRY_PROVIDER_FACTORY,
|
|
};
|
|
|
|
/** Clones an SVGElement while preserving type information. */
|
|
function cloneSvg(svg: SVGElement): SVGElement {
|
|
return svg.cloneNode(true) as SVGElement;
|
|
}
|
|
|
|
/** Returns the cache key to use for an icon namespace and name. */
|
|
function iconKey(namespace: string, name: string) {
|
|
return namespace + ':' + name;
|
|
}
|
|
|
|
function isSafeUrlWithOptions(value: any): value is SafeResourceUrlWithIconOptions {
|
|
return !!(value.url && value.options);
|
|
}
|