NgDocIconRegistry

Loads SVG icons and keeps them for the lifetime of the application.

Every URL is requested once and shared by all icons that show it, whether or not the application registers HTTP interceptors. A failed request is logged and remembered: reading the icon again does not send a new request, only retry() does. A response that is not SVG markup counts as a failure: dev servers answer a missing file with the application's index.html, which must not be rendered as an icon.

Decorators: @Service

DeclarationTypeScript

@Service()
export class NgDocIconRegistry { … }

Members

Methods

(…): Signal<string | null>

Returns the SVG markup stored at url, loading it on the first call.

Signature

get(url: string, httpClient?: HttpClient | undefined): Signal<string | null>;

Parameters

Name	Type	Description
url	`string`	URL of the SVG file.
httpClient	`HttpClient \| undefined`	Client for the request; defaults to the root `HttpClient`.

Returns

Signal<string | null> -

A signal with the markup: null while it loads, '' when the request failed.

(…): void

Requests url again if its last request failed. Does nothing for an icon that has loaded or is loading.

Signature

retry(url: string, httpClient?: HttpClient | undefined): void;

Parameters

Name	Type	Description
url	`string`	URL of the SVG file.
httpClient	`HttpClient \| undefined`	Client for the request; defaults to the root `HttpClient`.

Returns

void

Symbol

Kind: Class
Decorators: @Service
Scope: @ng-doc/ui-kit

Edit this page