Contents

module Browser

# Allows manipulation of a location, usually from {Window} and {DOM::Document}.
#
# @see https://developer.mozilla.org/en-US/docs/Web/API/Location
class Location
  include Native

  # Change the location.
  #
  # @param url [String, #to_s] the URL to go to
  def assign(url)
    `#@native.assign(#{url.to_s})`
  end

  # Replace the current URL.
  #
  # @param url [String, #to_s] the URL to go to
  def replace(url)
    `#@native.replace(#{url.to_s})`
  end

  # Reload the page.
  #
  # @param force [Boolean] whether to force the reload
  def reload(force = false)
    `#@native.reload(force)`
  end

  # Convert the location to a string.
  def to_s
    `#@native.toString()`
  end

  # @!attribute fragment
  # @return [String] the hash fragment of the location URI
  alias_native :fragment, :hash
  alias_native :fragment=, :hash=

  # @!attribute host
  # @return [String] the host part of the location URI
  alias_native :host
  alias_native :host=

  # @!attribute uri
  # @return [String] the whole location URI
  alias_native :uri, :href
  alias_native :uri=, :href=

  # @!attribute path
  # @return [String] the path part of the location URI
  alias_native :path, :pathname
  alias_native :path=, :pathname=

  # @!attribute port
  # @return [Integer] the port part of the location URI
  alias_native :port
  alias_native :port=

  # @!attribute scheme
  # @return [String] the scheme part of the location URI
  alias_native :scheme, :protocol
  alias_native :scheme=, :protocol=

  # @!attribute query
  # @return [String] the query part of the location URI
  alias_native :query, :search
  alias_native :query=, :search=
end

class Window
  # @!attribute [r] location
  # @return [Location] the location for the window
  def location
    Location.new(`#@native.location`) if `#@native.location`
  end
end

class DOM::Document < DOM::Element
  # @!attribute [r] location
  # @return [Location] the location for the document
  def location
    Location.new(`#@native.location`) if `#@native.location`
  end
end

end

Version data entries

3 entries across 3 versions & 2 rubygems

Version	Path
diamonds-0.1.5	lib/diamonds/opal/browser/location.rb
opal-browser-0.2.0	opal/browser/location.rb
opal-browser-0.2.0.beta1	opal/browser/location.rb