| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464 |
- import { _AbstractConstructor } from '@angular/material/core';
- import { AfterViewChecked } from '@angular/core';
- import { BooleanInput } from '@angular/cdk/coercion';
- import { CanColor } from '@angular/material/core';
- import { _Constructor } from '@angular/material/core';
- import { DomSanitizer } from '@angular/platform-browser';
- import { ElementRef } from '@angular/core';
- import { ErrorHandler } from '@angular/core';
- import { HttpClient } from '@angular/common/http';
- import * as i0 from '@angular/core';
- import * as i2 from '@angular/material/core';
- import { InjectionToken } from '@angular/core';
- import { Observable } from 'rxjs';
- import { OnDestroy } from '@angular/core';
- import { OnInit } from '@angular/core';
- import { Optional } from '@angular/core';
- import { SafeHtml } from '@angular/platform-browser';
- import { SafeResourceUrl } from '@angular/platform-browser';
- import { ThemePalette } from '@angular/material/core';
- /**
- * 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 declare function getMatIconFailedToSanitizeLiteralError(literal: SafeHtml): Error;
- /**
- * 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 declare function getMatIconFailedToSanitizeUrlError(url: SafeResourceUrl): Error;
- /**
- * 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 declare function getMatIconNameNotFoundError(iconName: string): Error;
- /**
- * Returns an exception to be thrown when the consumer attempts to use
- * `<mat-icon>` without including @angular/common/http.
- * @docs-private
- */
- export declare function getMatIconNoHttpProviderError(): Error;
- declare namespace i1 {
- export {
- MAT_ICON_LOCATION_FACTORY,
- MatIconDefaultOptions,
- MAT_ICON_DEFAULT_OPTIONS,
- MAT_ICON_LOCATION,
- MatIconLocation,
- MatIcon
- }
- }
- /** @docs-private */
- export declare const ICON_REGISTRY_PROVIDER: {
- provide: typeof MatIconRegistry;
- deps: (Optional[] | typeof DomSanitizer | typeof ErrorHandler)[];
- useFactory: typeof ICON_REGISTRY_PROVIDER_FACTORY;
- };
- /** @docs-private */
- export declare function ICON_REGISTRY_PROVIDER_FACTORY(parentRegistry: MatIconRegistry, httpClient: HttpClient, sanitizer: DomSanitizer, errorHandler: ErrorHandler, document?: any): MatIconRegistry;
- /** Options that can be used to configure how an icon or the icons in an icon set are presented. */
- export declare 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 declare type IconResolver = (name: string, namespace: string) => SafeResourceUrl | SafeResourceUrlWithIconOptions | null;
- /** Injection token to be used to override the default options for `mat-icon`. */
- export declare const MAT_ICON_DEFAULT_OPTIONS: InjectionToken<MatIconDefaultOptions>;
- /**
- * 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
- */
- export declare const MAT_ICON_LOCATION: InjectionToken<MatIconLocation>;
- /** @docs-private */
- export declare function MAT_ICON_LOCATION_FACTORY(): MatIconLocation;
- /**
- * 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>`
- */
- export declare class MatIcon extends _MatIconBase implements OnInit, AfterViewChecked, CanColor, OnDestroy {
- private _iconRegistry;
- private _location;
- private readonly _errorHandler;
- /**
- * 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(): boolean;
- set inline(inline: BooleanInput);
- private _inline;
- /** Name of the icon in the SVG icon set. */
- get svgIcon(): string;
- set svgIcon(value: string);
- private _svgIcon;
- /** Font set that the icon is a part of. */
- get fontSet(): string;
- set fontSet(value: string);
- private _fontSet;
- /** Name of an icon within a font set. */
- get fontIcon(): string;
- set fontIcon(value: string);
- private _fontIcon;
- private _previousFontSetClass;
- private _previousFontIconClass;
- _svgName: string | null;
- _svgNamespace: string | null;
- /** Keeps track of the current page path. */
- private _previousPath?;
- /** Keeps track of the elements and attributes that we've prefixed with the current path. */
- private _elementsWithExternalReferences?;
- /** Subscription to the current in-progress SVG icon request. */
- private _currentIconFetch;
- constructor(elementRef: ElementRef<HTMLElement>, _iconRegistry: MatIconRegistry, ariaHidden: string, _location: MatIconLocation, _errorHandler: ErrorHandler, defaults?: MatIconDefaultOptions);
- /**
- * 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)`
- */
- private _splitIconName;
- ngOnInit(): void;
- ngAfterViewChecked(): void;
- ngOnDestroy(): void;
- _usingFontIcon(): boolean;
- private _setSvgElement;
- private _clearSvgElement;
- private _updateFontIconClasses;
- /**
- * 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.
- */
- private _cleanupFontValue;
- /**
- * 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.
- */
- private _prependPathToReferences;
- /**
- * Caches the children of an SVG element that have `url()`
- * references that we need to prefix with the current path.
- */
- private _cacheChildrenWithExternalReferences;
- /** Sets a new SVG icon with a particular name. */
- private _updateSvgIcon;
- static ɵfac: i0.ɵɵFactoryDeclaration<MatIcon, [null, null, { attribute: "aria-hidden"; }, null, null, { optional: true; }]>;
- static ɵcmp: i0.ɵɵComponentDeclaration<MatIcon, "mat-icon", ["matIcon"], { "color": { "alias": "color"; "required": false; }; "inline": { "alias": "inline"; "required": false; }; "svgIcon": { "alias": "svgIcon"; "required": false; }; "fontSet": { "alias": "fontSet"; "required": false; }; "fontIcon": { "alias": "fontIcon"; "required": false; }; }, {}, never, ["*"], false, never>;
- }
- /** @docs-private */
- declare const _MatIconBase: _Constructor<CanColor> & _AbstractConstructor<CanColor> & {
- new (_elementRef: ElementRef): {
- _elementRef: ElementRef;
- };
- };
- /** Default options for `mat-icon`. */
- export declare interface MatIconDefaultOptions {
- /** Default color of the icon. */
- color?: ThemePalette;
- /** Font set that the icon is a part of. */
- fontSet?: string;
- }
- /**
- * Stubbed out location for `MatIcon`.
- * @docs-private
- */
- export declare interface MatIconLocation {
- getPathname: () => string;
- }
- export declare class MatIconModule {
- static ɵfac: i0.ɵɵFactoryDeclaration<MatIconModule, never>;
- static ɵmod: i0.ɵɵNgModuleDeclaration<MatIconModule, [typeof i1.MatIcon], [typeof i2.MatCommonModule], [typeof i1.MatIcon, typeof i2.MatCommonModule]>;
- static ɵinj: i0.ɵɵInjectorDeclaration<MatIconModule>;
- }
- /**
- * 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.
- */
- export declare class MatIconRegistry implements OnDestroy {
- private _httpClient;
- private _sanitizer;
- private readonly _errorHandler;
- private _document;
- /**
- * URLs and cached SVG elements for individual icons. Keys are of the format "[namespace]:[icon]".
- */
- private _svgIconConfigs;
- /**
- * SvgIconConfig objects and cached SVG elements for icon sets, keyed by namespace.
- * Multiple icon sets can be registered under the same namespace.
- */
- private _iconSetConfigs;
- /** Cache for icons loaded by direct URLs. */
- private _cachedIconsByUrl;
- /** In-progress icon fetches. Used to coalesce multiple requests to the same URL. */
- private _inProgressUrlFetches;
- /** Map from font identifiers to their CSS class names. Used for icon fonts. */
- private _fontCssClassesByAlias;
- /** Registered icon resolver functions. */
- private _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
- */
- private _defaultFontSetClass;
- constructor(_httpClient: HttpClient, _sanitizer: DomSanitizer, document: any, _errorHandler: ErrorHandler);
- /**
- * 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;
- /**
- * 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;
- /**
- * 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;
- /**
- * 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;
- /**
- * 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;
- /**
- * Registers an icon set by URL in the default namespace.
- * @param url
- */
- addSvgIconSet(url: SafeResourceUrl, options?: IconOptions): this;
- /**
- * 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;
- /**
- * 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;
- /**
- * 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;
- /**
- * 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): 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;
- /**
- * 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;
- /**
- * 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[];
- /**
- * 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>;
- /**
- * 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>;
- ngOnDestroy(): void;
- /**
- * Returns the cached icon for a SvgIconConfig if available, or fetches it from its URL if not.
- */
- private _getSvgFromConfig;
- /**
- * 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;
- /**
- * 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;
- /**
- * Loads the content of the icon URL specified in the SvgIconConfig and creates an SVG element
- * from it.
- */
- private _loadSvgIconFromConfig;
- /**
- * Loads the content of the icon set URL specified in the
- * SvgIconConfig and attaches it to the config.
- */
- private _loadSvgIconSetFromConfig;
- /**
- * 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;
- /**
- * Creates a DOM element from the given SVG string.
- */
- private _svgElementFromString;
- /**
- * Converts an element into an SVG node by cloning all of its children.
- */
- private _toSvgElement;
- /**
- * Sets the default attributes for an SVG element to be used as an icon.
- */
- private _setSvgAttributes;
- /**
- * 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;
- /**
- * 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;
- /**
- * 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;
- /** Parses a config's text into an SVG element. */
- private _svgElementFromConfig;
- /** Tries to create an icon config through the registered resolver functions. */
- private _getIconConfigFromResolvers;
- static ɵfac: i0.ɵɵFactoryDeclaration<MatIconRegistry, [{ optional: true; }, null, { optional: true; }, null]>;
- static ɵprov: i0.ɵɵInjectableDeclaration<MatIconRegistry>;
- }
- /** Object that specifies a URL from which to fetch an icon and the options to use for it. */
- export declare interface SafeResourceUrlWithIconOptions {
- url: SafeResourceUrl;
- options: IconOptions;
- }
- export { }
|