Join us online - 19th of November
Save your spot

Interface History

The History interface of the History API allows manipulation of the browser session history, that is the pages visited in the tab or frame that the current page is loaded in.

MDN Reference

interface History {
    length: number;
    scrollRestoration: ScrollRestoration;
    state: any;
    back(): void;
    forward(): void;
    go(delta?: number): void;
    pushState(data: any, unused: string, url?: string | URL | null): void;
    replaceState(data: any, unused: string, url?: string | URL | null): void;
}
Index
length scrollRestoration state
back forward go pushState replaceState
length: number

The length read-only property of the History interface returns an integer representing the number of entries in the session history, including the currently loaded page.

MDN Reference

scrollRestoration: ScrollRestoration

The scrollRestoration property of the History interface allows web applications to explicitly set default scroll restoration behavior on history navigation.

MDN Reference

state: any

The state read-only property of the History interface returns a value representing the state at the top of the history stack. This is a way to look at the state without having to wait for a popstate event.

MDN Reference

  • The back() method of the History interface causes the browser to move back one page in the session history.

    MDN Reference

    Returns void

  • The forward() method of the History interface causes the browser to move forward one page in the session history. It has the same effect as calling history.go(1).

    MDN Reference

    Returns void

  • The go() method of the History interface loads a specific page from the session history. You can use it to move forwards and backwards through the history depending on the value of a parameter.

    MDN Reference

    Parameters

    • Optionaldelta: number

    Returns void

  • The pushState() method of the History interface adds an entry to the browser's session history stack.

    MDN Reference

    Parameters

    • data: any
    • unused: string
    • Optionalurl: string | URL | null

    Returns void

  • The replaceState() method of the History interface modifies the current history entry, replacing it with the state object and URL passed in the method parameters. This method is particularly useful when you want to update the state object or URL of the current history entry in response to some user action.

    MDN Reference

    Parameters

    • data: any
    • unused: string
    • Optionalurl: string | URL | null

    Returns void

Was this helpful?