Class: Browser::History

Inherits:
Object show all
Includes:
NativeCachedWrapper
Defined in:
opal/browser/history.rb

Overview

History allows manipulation of the session history.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from NativeCachedWrapper

#restricted?, #set_native_reference

Instance Attribute Details

#current ⇒ String (readonly)

Returns the current item.

Returns:

  • (String) —

    the current item


53
54
55
 
# File 'opal/browser/history.rb', line 53

def current
  $window.location.full_path
end

#length ⇒ Integer (readonly)

Returns how many items are in the history.

Returns:

  • (Integer) —

    how many items are in the history


19
 
# File 'opal/browser/history.rb', line 19

alias_native :length

Class Method Details

.supported? ⇒ Boolean

Check if HTML5 history is supported.

Returns:

  • (Boolean)
[View source]

11
12
13
 
# File 'opal/browser/history.rb', line 11

def self.supported?
  Browser.supports? 'History'
end

Instance Method Details

#back(number = 1) ⇒ Object

Go back in the history.

Parameters:

  • number (Integer) (defaults to: 1) —

    how many items to go back

[View source]

24
25
26
 
# File 'opal/browser/history.rb', line 24

def back(number = 1)
  `#@native.go(-number)`
end

#forward(number = 1) ⇒ Object

Go forward in the history.

Parameters:

  • number (Integer) (defaults to: 1) —

    how many items to go forward

[View source]

31
32
33
 
# File 'opal/browser/history.rb', line 31

def forward(number = 1)
  `#@native.go(number)`
end

#push(item, data = nil) ⇒ Object

Push an item in the history.

Parameters:

  • item (String) —

    the item to push in the history

  • data (Object) (defaults to: nil) —

    additional state to push

[View source]

39
40
41
 
# File 'opal/browser/history.rb', line 39

def push(item, data = nil)
  `#@native.pushState(#{data.to_n}, null, item)`
end

#replace(item, data = nil) ⇒ Object

Replace the current history item with another.

Parameters:

  • item (String) —

    the item to replace with

  • data (Object) (defaults to: nil) —

    additional state to replace

[View source]

47
48
49
 
# File 'opal/browser/history.rb', line 47

def replace(item, data = nil)
  `#@native.replaceState(#{data.to_n}, null, item)`
end

#state ⇒ Object

Raises:

  • (NotImplementedError)
[View source]

60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'opal/browser/history.rb', line 60

def state
  %x{
    var state = #@native.state;

    if (state == null) {
      return nil;
    }
    else {
      return state;
    }
  }
end