Skip to main content

NavigateEvent

The NavigateEvent interface of the Navigation API is the event object for the navigate event, which fires when any type of navigation is initiated (this includes usage of History API features like History.go()). NavigateEvent provides access to information about that navigation, and allows developers to intercept and control the navigation handling.

MDN Reference

Extends​

Methods​

composedPath()​

composedPath(): EventTarget[];

The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.

MDN Reference

Returns​

EventTarget[]

Inherited from​

Event.composedPath

initEvent()​

initEvent(
   type, 
   bubbles?, 
   cancelable?
): void;

The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

Parameters​

ParameterType
typestring
bubbles?boolean
cancelable?boolean

Returns​

void

Deprecated​

MDN Reference

Inherited from​

Event.initEvent

intercept()​

intercept(options?): void;

The intercept() method of the NavigateEvent interface intercepts this navigation, turning it into a same-document navigation to the destination URL.

MDN Reference

Parameters​

ParameterType
options?NavigationInterceptOptions

Returns​

void

preventDefault()​

preventDefault(): void;

The preventDefault() method of the Event interface tells the user agent that the event is being explicitly handled, so its default action, such as page scrolling, link navigation, or pasting text, should not be taken.

MDN Reference

Returns​

void

Inherited from​

Event.preventDefault

scroll()​

scroll(): void;

The scroll() method of the NavigateEvent interface can be called to manually trigger the browser-driven scrolling behavior that occurs in response to the navigation, if you want it to happen before the navigation handling has completed.

MDN Reference

Returns​

void

stopImmediatePropagation()​

stopImmediatePropagation(): void;

The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.

MDN Reference

Returns​

void

Inherited from​

Event.stopImmediatePropagation

stopPropagation()​

stopPropagation(): void;

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see stopImmediatePropagation().

MDN Reference

Returns​

void

Inherited from​

Event.stopPropagation

Properties​

AT_TARGET​

readonly AT_TARGET: 2;

Inherited from​

Event.AT_TARGET

bubbles​

readonly bubbles: boolean;

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

MDN Reference

Inherited from​

Event.bubbles

BUBBLING_PHASE​

readonly BUBBLING_PHASE: 3;

Inherited from​

Event.BUBBLING_PHASE

cancelable​

readonly cancelable: boolean;

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

MDN Reference

Inherited from​

Event.cancelable

cancelBubble​

cancelBubble: boolean;

The cancelBubble property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.

Deprecated​

MDN Reference

Inherited from​

Event.cancelBubble

canIntercept​

readonly canIntercept: boolean;

The canIntercept read-only property of the NavigateEvent interface returns true if the navigation can be intercepted and have its URL rewritten, or false otherwise

MDN Reference

CAPTURING_PHASE​

readonly CAPTURING_PHASE: 1;

Inherited from​

Event.CAPTURING_PHASE

composed​

readonly composed: boolean;

The read-only composed property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.

MDN Reference

Inherited from​

Event.composed

currentTarget​

readonly currentTarget: EventTarget | null;

The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

MDN Reference

Inherited from​

Event.currentTarget

defaultPrevented​

readonly defaultPrevented: boolean;

The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.

MDN Reference

Inherited from​

Event.defaultPrevented

destination​

readonly destination: NavigationDestination;

The destination read-only property of the NavigateEvent interface returns a NavigationDestination object representing the destination being navigated to.

MDN Reference

downloadRequest​

readonly downloadRequest: string | null;

The downloadRequest read-only property of the NavigateEvent interface returns the filename of the file requested for download, in the case of a download navigation (e.g., an <a> or <area> element with a download attribute), or null otherwise.

MDN Reference

eventPhase​

readonly eventPhase: number;

The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.

MDN Reference

Inherited from​

Event.eventPhase

formData​

readonly formData: FormData | null;

The formData read-only property of the NavigateEvent interface returns the FormData object representing the submitted data in the case of a POST form submission, or null otherwise.

MDN Reference

hashChange​

readonly hashChange: boolean;

The hashChange read-only property of the NavigateEvent interface returns true if the navigation is a fragment navigation (i.e., to a fragment identifier in the same document), or false otherwise.

MDN Reference

hasUAVisualTransition​

readonly hasUAVisualTransition: boolean;

The hasUAVisualTransition read-only property of the NavigateEvent interface returns true if the user agent performed a visual transition for this navigation before dispatching this event, or false otherwise.

MDN Reference

info​

readonly info: any;

The info read-only property of the NavigateEvent interface returns the info data value passed by the initiating navigation operation (e.g., Navigation.back(), or Navigation.navigate()), or undefined if no info data was passed.

MDN Reference

isTrusted​

readonly isTrusted: boolean;

The isTrusted read-only property of the Event interface is a boolean value that is true when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via EventTarget.dispatchEvent(). The only exception is the click event, which initializes the isTrusted property to false in user agents.

MDN Reference

Inherited from​

Event.isTrusted

readonly navigationType: NavigationType;

The navigationType read-only property of the NavigateEvent interface returns the type of the navigation — push, reload, replace, or traverse.

MDN Reference

NONE​

readonly NONE: 0;

Inherited from​

Event.NONE

returnValue​

returnValue: boolean;

The Event property returnValue indicates whether the default action for this event has been prevented or not.

Deprecated​

MDN Reference

Inherited from​

Event.returnValue

signal​

readonly signal: AbortSignal;

The signal read-only property of the NavigateEvent interface returns an AbortSignal, which will become aborted if the navigation is cancelled (e.g., by the user pressing the browser's "Stop" button, or another navigation starting and thus cancelling the ongoing one).

MDN Reference

sourceElement​

readonly sourceElement: Element | null;

The sourceElement read-only property of the NavigateEvent interface returns an Element object representing the initiating element, in cases where the navigation was initiated by an element.

MDN Reference

srcElement​

readonly srcElement: EventTarget | null;

The deprecated Event.srcElement is an alias for the Event.target property. Use Event.target instead.

Deprecated​

MDN Reference

Inherited from​

Event.srcElement

target​

readonly target: EventTarget | null;

The read-only target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.

MDN Reference

Inherited from​

Event.target

timeStamp​

readonly timeStamp: number;

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

MDN Reference

Inherited from​

Event.timeStamp

type​

readonly type: string;

The type read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.

MDN Reference

Inherited from​

Event.type

userInitiated​

readonly userInitiated: boolean;

The userInitiated read-only property of the NavigateEvent interface returns true if the navigation was initiated by the user (e.g., by clicking a link, submitting a form, or pressing the browser's "Back"/"Forward" buttons), or false otherwise.

MDN Reference