Trilium Frontend API
    Preparing search index...

    Interface NavigationHistoryEntry

    The NavigationHistoryEntry interface of the Navigation API represents a single navigation history entry.

    MDN Reference

    interface NavigationHistoryEntry {
        id: string;
        index: number;
        key: string;
        ondispose: (this: NavigationHistoryEntry, ev: Event) => any;
        sameDocument: boolean;
        url: string;
        addEventListener<K extends "dispose">(
            type: K,
            listener: (
                this: NavigationHistoryEntry,
                ev: NavigationHistoryEntryEventMap[K],
            ) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        getState(): any;
        removeEventListener<K extends "dispose">(
            type: K,
            listener: (
                this: NavigationHistoryEntry,
                ev: NavigationHistoryEntryEventMap[K],
            ) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
    }

    Hierarchy

    • EventTarget
      • NavigationHistoryEntry
    Index

    Properties

    id index key ondispose sameDocument url

    Methods

    addEventListener dispatchEvent getState removeEventListener

    Properties

    id: string

    The id read-only property of the NavigationHistoryEntry interface returns the id of the history entry, or an empty string if current document is not fully active. This is a unique, UA-generated value that always represents a specific history entry, useful to correlate it with an external resource such as a storage cache.

    MDN Reference

    index: number

    The index read-only property of the NavigationHistoryEntry interface returns the index of the history entry in the history entries list (that is, the list returned by Navigation.entries()), or -1 if the entry does not appear in the list or if current document is not fully active.

    MDN Reference

    key: string

    The key read-only property of the NavigationHistoryEntry interface returns the key of the history entry, or an empty string if current document is not fully active. This is a unique, UA-generated value that represents the history entry's slot in the entries list. It is used to navigate that particular slot via Navigation.traverseTo(). The key will be reused by other entries that replace the entry in the list (that is, if the NavigateEvent.navigationType is replace).

    MDN Reference

    ondispose: (this: NavigationHistoryEntry, ev: Event) => any

    MDN Reference

    sameDocument: boolean

    The sameDocument read-only property of the NavigationHistoryEntry interface returns true if this history entry is for the same document as the current Document value and current document is fully active, or false otherwise.

    MDN Reference

    url: string

    The url read-only property of the NavigationHistoryEntry interface returns the absolute URL of this history entry. If the entry corresponds to a different Document than the current one (like sameDocument property is false), and that Document was fetched with a Referrer-Policy header set to no-referrer or origin, the property returns null. If current document is not fully active, it returns an empty string.

    MDN Reference

    Methods

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The getState() method of the NavigationHistoryEntry interface returns a clone of the developer-supplied state associated with this history entry.

      MDN Reference

      Returns any

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Type Parameters

      • K extends "dispose"

      Parameters

      Returns void

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

      MDN Reference

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods