dom

Documentation

Overview

Package dom provides APIs for interacting with the DOM.

Index

• Variables
• func DefaultQueryString() string
• func ExpandArgs(args []js.Value, target ...*js.Value)
• func FromJSON(s string) js.Value
• func Log(format string, objs ...interface{})
• func LogDebug(format string, objs ...interface{})
• func LogError(format string, objs ...interface{})
• func ObjectKeys(val js.Value) ([]string, error)
• func SetTimeout(timeout time.Duration, callback func())
• func SingleArg(args []js.Value) js.Value
• func ToJSON(val js.Value) string
• type DOM
  • func New(doc js.Value) *DOM
  • func (d *DOM) AppendChild(parent, child js.Value, populate func(child js.Value))
  • func (d *DOM) Close(o js.Value)
  • func (d *DOM) DoClick(o js.Value)
  • func (d *DOM) GetElement(id string) js.Value
  • func (d *DOM) GetElementsByTag(tag string) []js.Value
  • func (d *DOM) NewElement(tag string) js.Value
  • func (d *DOM) NewText(text string) js.Value
  • func (d *DOM) OnClick(o js.Value, callback func(evt Event))
  • func (d *DOM) OnDOMContentLoaded(callback func())
  • func (d *DOM) RemoveChildren(p js.Value)
  • func (d *DOM) RemoveEventListeners(o js.Value) js.Value
  • func (d *DOM) SetValue(o js.Value, value string)
  • func (d *DOM) ShowModal(o js.Value)
  • func (d *DOM) TextContent(o js.Value) string
  • func (d *DOM) Value(o js.Value) string
• type Event
• type URLSearchParams
  • func NewURLSearchParams(queryString string) *URLSearchParams
  • func (u *URLSearchParams) Has(param string) bool

Variables

var (
	// Doc is the default 'document' object.  This should be used for regular
	// code. See NewDocForTesting() for a Document object that can be used in
	// unit tests.
	Doc = js.Global().Get("document")

	// Console is the default 'console' object for the browser.
	Console = js.Global().Get("console")

	// Object refers to Javascript's Object class.
	Object = js.Global().Get("Object")

	// JSON refers to Javascript's JSON class.
	JSON = js.Global().Get("JSON")
)

Functions

func DefaultQueryString

func DefaultQueryString() string

DefaultQueryString returns the query string used to request the current document. This is likely not available during unit tests, but is available in normal operation.

func ExpandArgs

func ExpandArgs(args []js.Value, target ...*js.Value)

ExpandArgs unpacks function arguments to target values.

func FromJSON

func FromJSON(s string) js.Value

FromJSON converts the supplied JSON string to a Javascript value.

func Log

func Log(format string, objs ...interface{})

Log logs general information to the Javascript Console.

func LogDebug

func LogDebug(format string, objs ...interface{})

LogDebug logs a debug message to the Javascript Console.

func LogError

func LogError(format string, objs ...interface{})

LogError logs an error to the Javascript Console.

func ObjectKeys

func ObjectKeys(val js.Value) ([]string, error)

ObjectKeys returns the keys for a given object.

func SetTimeout

func SetTimeout(timeout time.Duration, callback func())

SetTimeout registers a callback to be invoked when the timeout has expired.

func SingleArg

func SingleArg(args []js.Value) js.Value

SingleArg unpacks a single function argument and returns it.

func ToJSON

func ToJSON(val js.Value) string

ToJSON converts the supplied value to a JSON string.

Types

type DOM

type DOM struct {
	// contains filtered or unexported fields
}

DOM provides an API for interacting with the DOM for a Document.

func New

func New(doc js.Value) *DOM

New returns a DOM instance for interacting with the specified Document object.

func (*DOM) AppendChild

func (d *DOM) AppendChild(parent, child js.Value, populate func(child js.Value))

AppendChild adds the child object. If non-nil, the populate() function is invoked on the child to initialize it.

func (*DOM) Close

func (d *DOM) Close(o js.Value)

Close closes the specified dialog.

func (*DOM) DoClick

func (d *DOM) DoClick(o js.Value)

DoClick simulates a click. Any callback registered by OnClick() will be invoked.

func (*DOM) GetElement

func (d *DOM) GetElement(id string) js.Value

GetElement returns the element with the specified ID.

func (*DOM) GetElementsByTag

func (d *DOM) GetElementsByTag(tag string) []js.Value

GetElementsByTag returns the elements with the speciied tag.

func (*DOM) NewElement

func (d *DOM) NewElement(tag string) js.Value

NewElement returns a new element with the specified tag (e.g., 'tr', 'td').

func (*DOM) NewText

func (d *DOM) NewText(text string) js.Value

NewText returns a new text element with the specified text.

func (*DOM) OnClick

func (d *DOM) OnClick(o js.Value, callback func(evt Event))

OnClick registers a callback to be invoked when the specified object is clicked.

func (*DOM) OnDOMContentLoaded

func (d *DOM) OnDOMContentLoaded(callback func())

OnDOMContentLoaded registers a callback to be invoked when the DOM has finished loading.

func (*DOM) RemoveChildren

func (d *DOM) RemoveChildren(p js.Value)

RemoveChildren removes all children of the specified node.

func (*DOM) RemoveEventListeners

func (d *DOM) RemoveEventListeners(o js.Value) js.Value

RemoveEventListeners removes all event listeners from an object and its children. This is accomplished by cloning the object, which has the side effect of *not* cloning the event listeners. The newly-created object is returned.

func (*DOM) SetValue

func (d *DOM) SetValue(o js.Value, value string)

SetValue sets the of the object.

func (*DOM) ShowModal

func (d *DOM) ShowModal(o js.Value)

ShowModal shows the specified dialog as a modal dialog.

func (*DOM) TextContent

func (d *DOM) TextContent(o js.Value) string

TextContent returns the text content of the specified object (and its children).

func (*DOM) Value

func (d *DOM) Value(o js.Value) string

Value returns the value of an object as a string.

type Event

type Event struct {
	js.Value
}

Event provides an API for interacting with events.

type URLSearchParams

type URLSearchParams struct {
	// contains filtered or unexported fields
}

URLSearchParams is a thin wrapper around the URLSearchParams API. See https://url.spec.whatwg.org/#urlsearchparams.

func NewURLSearchParams

func NewURLSearchParams(queryString string) *URLSearchParams

NewURLSearchParams returns a URLSearchParams for the specified query string.

func (*URLSearchParams) Has

func (u *URLSearchParams) Has(param string) bool

Has indicates if the query string contains the specified parameter.