Chartbreaker
    Preparing search index...

    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?: null | string | URL): void;
        replaceState(data: any, unused: string, url?: null | string | URL): void;
    }
    Index

    Properties

    length scrollRestoration state

    Methods

    back forward go pushState replaceState

    Properties

    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.

    MDN Reference

    Methods

    • 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.

      MDN Reference

      Returns void

    • The go() method of the History interface loads a specific page from the session history.

      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: null | string | URL

      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.

      MDN Reference

      Parameters

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

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods