@angular/platform-browser

constructor

constructor(providersAlreadyPresent: boolean);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<
    BrowserModule,
    [{ optional: true; skipSelf: true }]
>;

property ɵinj

static ɵinj: i0.ɵɵInjectorDeclaration<BrowserModule>;

property ɵmod

static ɵmod: i0.ɵɵNgModuleDeclaration<BrowserModule, never, never, [any, any]>;

method withServerTransition

static withServerTransition: (params: {
    appId: string;
}) => ModuleWithProviders<BrowserModule>;

• Configures a browser-based app to transition from a server-rendered app, if one is present on the page.

  Parameter params

  An object containing an identifier for the app to transition. The ID must match between the client and server versions of the app.

  Returns

  The reconfigured BrowserModule to import into the app's root AppModule.

  Deprecated

  Use APP_ID instead to set the application ID.

method all

static all: () => Predicate<DebugNode>;

• Match all nodes.

  ### Example

method css

static css: (selector: string) => Predicate<DebugElement>;

• Match elements by the given CSS selector.

  ### Example

method directive

static directive: (type: Type<any>) => Predicate<DebugNode>;

• Match nodes that have the given directive present.

  ### Example

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<DomSanitizer, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<DomSanitizer>;

method bypassSecurityTrustHtml

abstract bypassSecurityTrustHtml: (value: string) => SafeHtml;

• Bypass security and trust the given value to be safe HTML. Only use this when the bound HTML is unsafe (e.g. contains <script> tags) and the code should be executed. The sanitizer will leave safe HTML intact, so in most situations this method should not be used.

  **WARNING:** calling this method with untrusted user data exposes your application to XSS security risks!

method bypassSecurityTrustResourceUrl

abstract bypassSecurityTrustResourceUrl: (value: string) => SafeResourceUrl;

• Bypass security and trust the given value to be a safe resource URL, i.e. a location that may be used to load executable code from, like <script src>, or <iframe src>.

  **WARNING:** calling this method with untrusted user data exposes your application to XSS security risks!

method bypassSecurityTrustScript

abstract bypassSecurityTrustScript: (value: string) => SafeScript;

• Bypass security and trust the given value to be safe JavaScript.

  **WARNING:** calling this method with untrusted user data exposes your application to XSS security risks!

method bypassSecurityTrustStyle

abstract bypassSecurityTrustStyle: (value: string) => SafeStyle;

• Bypass security and trust the given value to be safe style value (CSS).

  **WARNING:** calling this method with untrusted user data exposes your application to XSS security risks!

method bypassSecurityTrustUrl

abstract bypassSecurityTrustUrl: (value: string) => SafeUrl;

• Bypass security and trust the given value to be a safe style URL, i.e. a value that can be used in hyperlinks or <img src>.

  **WARNING:** calling this method with untrusted user data exposes your application to XSS security risks!

method sanitize

abstract sanitize: (
    context: SecurityContext,
    value: SafeValue | string | null
) => string | null;

• Gets a safe value from either a known safe value or a value with unknown safety.

  If the given value is already a SafeValue, this method returns the unwrapped value. If the security context is HTML and the given value is a plain string, this method sanitizes the string, removing any potentially unsafe content. For any other security context, this method throws an error if provided with a plain string.

constructor

constructor(plugins: EventManagerPlugin[], _zone: NgZone);

• Initializes an instance of the event-manager service.

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<EventManager, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<EventManager>;

method addEventListener

addEventListener: (
    element: HTMLElement,
    eventName: string,
    handler: Function
) => Function;

• Registers a handler for a specific element and event.

  Parameter element

  The HTML element to receive event notifications.

  Parameter eventName

  The name of the event to listen for.

  Parameter handler

  A function to call when the notification occurs. Receives the event object as an argument.

  Returns

  A callback function that can be used to remove the handler.

method getZone

getZone: () => NgZone;

• Retrieves the compilation zone in which event listeners are registered.

property events

events: string[];

• A set of supported event names for gestures to be used in Angular. Angular supports all built-in recognizers, as listed in [HammerJS documentation](https://hammerjs.github.io/).

property options

options?: {
    cssProps?: any;
    domEvents?: boolean;
    enable?: boolean | ((manager: any) => boolean);
    preset?: any[];
    touchAction?: string;
    recognizers?: any[];
    inputClass?: any;
    inputTarget?: EventTarget;
};

• Properties whose default values can be overridden for a given event. Different sets of properties apply to different events. For information about which properties are supported for which events, and their allowed and default values, see [HammerJS documentation](https://hammerjs.github.io/).

property overrides

overrides: { [key: string]: Object };

• Maps gesture event names to a set of configuration options that specify overrides to the default values for specific properties.

  The key is a supported event name to be configured, and the options object contains a set of properties, with override values to be applied to the named recognizer event. For example, to disable recognition of the rotate event, specify {"rotate": {"enable": false}}.

  Properties that are not present take the HammerJS default values. For information about which properties are supported for which events, and their allowed and default values, see [HammerJS documentation](https://hammerjs.github.io/).

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<HammerGestureConfig, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<HammerGestureConfig>;

method buildHammer

buildHammer: (element: HTMLElement) => HammerInstance;

• Creates a [HammerJS Manager](https://hammerjs.github.io/api/#hammermanager) and attaches it to a given HTML element.

  Parameter element

  The element that will recognize gestures.

  Returns

  A HammerJS event-manager object.

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<HammerModule, never>;

property ɵinj

static ɵinj: i0.ɵɵInjectorDeclaration<HammerModule>;

property ɵmod

static ɵmod: i0.ɵɵNgModuleDeclaration<HammerModule, never, never, never>;

constructor

constructor(_doc: any);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Meta, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Meta>;

method addTag

addTag: (tag: MetaDefinition, forceCreation?: boolean) => HTMLMetaElement | null;

• Retrieves or creates a specific <meta> tag element in the current HTML document. In searching for an existing tag, Angular attempts to match the name or property attribute values in the provided tag definition, and verifies that all other attribute values are equal. If an existing element is found, it is returned and is not modified in any way.

  Parameter tag

  The definition of a <meta> element to match or create.

  Parameter forceCreation

  True to create a new element without checking whether one already exists.

  Returns

  The existing element with the same attributes and values if found, the new element if no match is found, or null if the tag parameter is not defined.

method addTags

addTags: (tags: MetaDefinition[], forceCreation?: boolean) => HTMLMetaElement[];

• Retrieves or creates a set of <meta> tag elements in the current HTML document. In searching for an existing tag, Angular attempts to match the name or property attribute values in the provided tag definition, and verifies that all other attribute values are equal.

  Parameter tags

  An array of tag definitions to match or create.

  Parameter forceCreation

  True to create new elements without checking whether they already exist.

  Returns

  The matching elements if found, or the new elements.

method getTag

getTag: (attrSelector: string) => HTMLMetaElement | null;

• Retrieves a <meta> tag element in the current HTML document.

  Parameter attrSelector

  The tag attribute and value to match against, in the format "tag_attribute='value string'".

  Returns

  The matching element, if any.

method getTags

getTags: (attrSelector: string) => HTMLMetaElement[];

• Retrieves a set of <meta> tag elements in the current HTML document.

  Parameter attrSelector

  The tag attribute and value to match against, in the format "tag_attribute='value string'".

  Returns

  The matching elements, if any.

method removeTag

removeTag: (attrSelector: string) => void;

• Removes an existing <meta> tag element from the current HTML document.

  Parameter attrSelector

  A tag attribute and value to match against, to identify an existing tag. A string in the format "tag_attribute=value string".

method removeTagElement

removeTagElement: (meta: HTMLMetaElement) => void;

• Removes an existing <meta> tag element from the current HTML document.

  Parameter meta

  The tag definition to match against to identify an existing tag.

method updateTag

updateTag: (tag: MetaDefinition, selector?: string) => HTMLMetaElement | null;

• Modifies an existing <meta> tag element in the current HTML document.

  Parameter tag

  The tag description with which to replace the existing tag content.

  Parameter selector

  A tag attribute and value to match against, to identify an existing tag. A string in the format "tag_attribute=value string". If not supplied, matches a tag with the same name or property attribute value as the replacement tag. The modified element.

method createElement

createElement: (tagName: string, doc?: Document) => HTMLElement;

method createHtmlDocument

createHtmlDocument: () => Document;

method dispatchEvent

dispatchEvent: (el: Node, evt: any) => void;

method getBaseHref

getBaseHref: (doc: Document) => string | null;

method getCookie

getCookie: (name: string) => string | null;

method getDefaultDocument

getDefaultDocument: () => Document;

method getGlobalEventTarget

getGlobalEventTarget: (doc: Document, target: string) => EventTarget | null;

• Deprecated

  No longer being used in Ivy code. To be removed in version 14.

method getUserAgent

getUserAgent: () => string;

method isElementNode

isElementNode: (node: Node) => boolean;

method isShadowRoot

isShadowRoot: (node: any) => boolean;

method makeCurrent

static makeCurrent: () => void;

method onAndCancel

onAndCancel: (el: Node, evt: any, listener: any) => Function;

method remove

remove: (node: Node) => void;

method resetBaseElement

resetBaseElement: () => void;

method addToWindow

addToWindow: (registry: TestabilityRegistry) => void;

method findTestabilityInTree

findTestabilityInTree: (
    registry: TestabilityRegistry,
    elem: any,
    findInAncestors: boolean
) => Testability | null;

constructor

constructor(doc: any);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<ɵDomEventsPlugin, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<ɵDomEventsPlugin>;

method addEventListener

addEventListener: (
    element: HTMLElement,
    eventName: string,
    handler: Function
) => Function;

method removeEventListener

removeEventListener: (
    target: any,
    eventName: string,
    callback: Function
) => void;

method supports

supports: (eventName: string) => boolean;

constructor

constructor(
    eventManager: EventManager,
    sharedStylesHost: ɵSharedStylesHost,
    appId: string,
    removeStylesOnCompDestroy: boolean,
    doc: Document,
    platformId: Object,
    ngZone: NgZone,
    nonce?: string
);

property ngZone

readonly ngZone: NgZone;

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<ɵDomRendererFactory2, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<ɵDomRendererFactory2>;

property platformId

readonly platformId: Object;

method createRenderer

createRenderer: (element: any, type: RendererType2 | null) => Renderer2;

method ngOnDestroy

ngOnDestroy: () => void;

constructor

constructor(_doc: any);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<ɵDomSanitizerImpl, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<ɵDomSanitizerImpl>;

method bypassSecurityTrustHtml

bypassSecurityTrustHtml: (value: string) => SafeHtml;

method bypassSecurityTrustResourceUrl

bypassSecurityTrustResourceUrl: (value: string) => SafeResourceUrl;

method bypassSecurityTrustScript

bypassSecurityTrustScript: (value: string) => SafeScript;

method bypassSecurityTrustStyle

bypassSecurityTrustStyle: (value: string) => SafeStyle;

method bypassSecurityTrustUrl

bypassSecurityTrustUrl: (value: string) => SafeUrl;

method sanitize

sanitize: (
    ctx: SecurityContext,
    value: SafeValue | string | null
) => string | null;

constructor

constructor(
    doc: any,
    _config: HammerGestureConfig,
    console: ɵConsole,
    loader?: HammerLoader
);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<
    ɵHammerGesturesPlugin,
    [null, null, null, { optional: true }]
>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<ɵHammerGesturesPlugin>;

method addEventListener

addEventListener: (
    element: HTMLElement,
    eventName: string,
    handler: Function
) => Function;

method isCustomEvent

isCustomEvent: (eventName: string) => boolean;

method supports

supports: (eventName: string) => boolean;

constructor

constructor(doc: any);

• Initializes an instance of the browser plug-in.

  Parameter doc

  The document in which key events will be detected.

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<ɵKeyEventsPlugin, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<ɵKeyEventsPlugin>;

method addEventListener

addEventListener: (
    element: HTMLElement,
    eventName: string,
    handler: Function
) => Function;

• Registers a handler for a specific element and key event.

  Parameter element

  The HTML element to receive event notifications.

  Parameter eventName

  The name of the key event to listen for.

  Parameter handler

  A function to call when the notification occurs. Receives the event object as an argument.

  Returns

  The key event that was registered.

method eventCallback

static eventCallback: (
    fullKey: string,
    handler: Function,
    zone: NgZone
) => Function;

• Configures a handler callback for a key event.

  Parameter fullKey

  The event name that combines all simultaneous keystrokes.

  Parameter handler

  The function that responds to the key event.

  Parameter zone

  The zone in which the event occurred.

  Returns

  A callback function.

method matchEventFullKeyCode

static matchEventFullKeyCode: (
    event: KeyboardEvent,
    fullKeyCode: string
) => boolean;

• Determines whether the actual keys pressed match the configured key code string. The fullKeyCode event is normalized in the parseEventName method when the event is attached to the DOM during the addEventListener call. This is unseen by the end user and is normalized for internal consistency and parsing.

  Parameter event

  The keyboard event.

  Parameter fullKeyCode

  The normalized user defined expected key event string

  Returns

  boolean.

method parseEventName

static parseEventName: (
    eventName: string
) => { fullKey: string; domEventName: string } | null;

• Parses the user provided full keyboard event definition and normalizes it for later internal use. It ensures the string is all lowercase, converts special characters to a standard spelling, and orders all the values consistently.

  Parameter eventName

  The name of the key event to listen for.

  Returns

  an object with the full, normalized string, and the dom event name or null in the case when the event doesn't match a keyboard event.

method supports

supports: (eventName: string) => boolean;

• Reports whether a named key event is supported.

  Parameter eventName

  The event name to query. True if the named key event is supported.

constructor

constructor(doc: Document, appId: string, nonce?: string, platformId?: {});

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<
    ɵSharedStylesHost,
    [null, null, { optional: true }, null]
>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<ɵSharedStylesHost>;

property platformId

readonly platformId: {};

method addHost

addHost: (hostNode: Node) => void;

method addStyles

addStyles: (styles: string[]) => void;

method ngOnDestroy

ngOnDestroy: () => void;

method removeHost

removeHost: (hostNode: Node) => void;

method removeStyles

removeStyles: (styles: string[]) => void;

constructor

constructor(_doc: any);

property ɵfac

static ɵfac: i0.ɵɵFactoryDeclaration<Title, never>;

property ɵprov

static ɵprov: i0.ɵɵInjectableDeclaration<Title>;

method getTitle

getTitle: () => string;

• Get the title of the current HTML document.

method setTitle

setTitle: (newTitle: string) => void;

• Set the title of the current HTML document.

  Parameter newTitle

property ɵkind

ɵkind: FeatureKind;

property ɵproviders

ɵproviders: Provider[];

member NoDomReuseFeature

NoDomReuseFeature = 0

member NoHttpTransferCache

NoHttpTransferCache = 1