Module Window.HistorySource

Browser history.

Sourcemodule Scroll_restoration : sig ... end

The scroll restoration enum.

Sourcetype t

The type for History objects. See Window.history to get one.

Sourceval length : t -> int

length h is the number of elements in history including the currently loaded page.

Sourceval scroll_restoration : t -> Scroll_restoration.t

scroll_restoration h is the scroll restoration behaviour of h.

Sourceval set_scroll_restoration : t -> Scroll_restoration.t -> unit

set_scroll_restoration h r sets the scroll_restoration of h to r.

Moving in history

Sourceval back : t -> unit

back h goes back in history.

Sourceval forward : t -> unit

forward h goes forward in history.

Sourceval go : t -> int -> unit

go delta goes forward or backward in history by delta steps. 0 reloads the current page.

Making history

Warning. This may become typed in the future. Note that the specifiation mandates state values to be serializable.

Sourcetype state = Jv.t

The type for history state.

Sourceval state : t -> Jv.t

state h is the state at the top of the history stack. Warning. This can be Jv.null

Sourceval push_state : ?state:state -> ?title:Jstr.t -> ?uri:Uri.t -> t -> unit

push_state h ~state ~title ~uri h pushes state state with title title and URI uri (if any). Any of these can be omitted.

Warning. The title argument seems to be ignored by browsers. Use Document.set_title to change the title.

Sourceval replace_state : ?state:state -> ?title:Jstr.t -> ?uri:Uri.t -> t -> unit

replace_state h ~state ~title ~uri replaces state state with title title and URI uri (if any). Any of these can be omitted.

Warning. The title argument seems to be ignored by browsers. Use Document.set_title to change the title.

Events

Sourcemodule Ev : sig ... end

History events.