dom

README

https://pkg.go.dev/github.com/HalCanary/facility/dom

Documentation

Overview

Copyright 2022 Hal Canary Use of this program is governed by the file LICENSE.

This is a lightweight wrapper around x/net/html, providing some extra functionality.

Index

• Constants
• func ExtractText(root *Node) string
• func GetAttribute(node *Node, key string) string
• func RenderHTML(root *Node, w io.Writer) error
• func RenderHTMLExperimental(root *Node, w io.Writer) error
• func RenderXHTMLDoc(root *Node, w io.Writer) error
• func TextBytes(root *Node) int
• type Attr
• type Attribute
• type Node
  • func AddAttribute(node *Node, k, v string) *Node
  • func Append(node *Node, children ...*Node) *Node
  • func Comment(data string) *Node
  • func Elem(tag string, children ...*Node) *Node
  • func Element(tag string, attributes Attr, children ...*Node) *Node
  • func FindNodeByAttribute(node *Node, key, value string) *Node
  • func FindNodeById(node *Node, id string) *Node
  • func FindNodeByTag(node *Node, tag string) *Node
  • func FindNodeByTagAndAttrib(root *Node, tag, key, value string) *Node
  • func FindNodeByTagAndAttribRe(root *Node, tag, key string, value *regexp.Regexp) *Node
  • func FindNodesByTagAndAttrib(root *Node, tag, key, value string) []*Node
  • func FindNodesByTagAndAttribRe(root *Node, tag, key string, value *regexp.Regexp) []*Node
  • func Parse(source io.Reader) (*Node, error)
  • func ParseFragment(source io.Reader, context *Node) ([]*Node, error)
  • func RawHtml(data string) *Node
  • func Remove(node *Node) *Node
  • func Text(data string) *Node

Constants

const (
	ElementNode = html.ElementNode
	TextNode    = html.TextNode
)

Functions

func ExtractText

func ExtractText(root *Node) string

Extract and combine all Text Nodes under given node.

func GetAttribute

func GetAttribute(node *Node, key string) string

Find the matching attributes, ignoring namespace.

func RenderHTML

func RenderHTML(root *Node, w io.Writer) error

Generates HTML5 doc.

func RenderHTMLExperimental

func RenderHTMLExperimental(root *Node, w io.Writer) error

Generates HTML5 doc.

func RenderXHTMLDoc

func RenderXHTMLDoc(root *Node, w io.Writer) error

Generates XHTML1 doc.

func TextBytes

func TextBytes(root *Node) int

Return the approximate number of bytes that `ExtractText` would return.

Types

type Attr

type Attr = map[string]string

type Attribute

type Attribute = html.Attribute

type Node

type Node = html.Node

func AddAttribute

func AddAttribute(node *Node, k, v string) *Node

Add an attribute to an element node, returning the node.

func Append

func Append(node *Node, children ...*Node) *Node

Append children to the node, returning the node.

func Comment

func Comment(data string) *Node

Return a HTML comment with the given data.

func Elem

func Elem(tag string, children ...*Node) *Node

Return an element with the given children.

func Element

func Element(tag string, attributes Attr, children ...*Node) *Node

Return an element with given attributes and children.

func FindNodeByAttribute

func FindNodeByAttribute(node *Node, key, value string) *Node

Return the first matching node with key attribude set to value.

func FindNodeById

func FindNodeById(node *Node, id string) *Node

Return the first matching node with `id` attribude set to id.

func FindNodeByTag

func FindNodeByTag(node *Node, tag string) *Node

Return the first matching node

func FindNodeByTagAndAttrib

func FindNodeByTagAndAttrib(root *Node, tag, key, value string) *Node

Return the first matching node. If tag is "", match key="value". If key is "", match on tag.

func FindNodeByTagAndAttribRe

func FindNodeByTagAndAttribRe(root *Node, tag, key string, value *regexp.Regexp) *Node

Return the first matching node. If tag is "", match key="value". If key is "", match on tag.

func FindNodesByTagAndAttrib

func FindNodesByTagAndAttrib(root *Node, tag, key, value string) []*Node

Return all matching nodes. If tag is "", match key="value". If key is "", match on tag.

func FindNodesByTagAndAttribRe

func FindNodesByTagAndAttribRe(root *Node, tag, key string, value *regexp.Regexp) []*Node

func Parse

func Parse(source io.Reader) (*Node, error)

Wrapper for html.Parse.

func ParseFragment

func ParseFragment(source io.Reader, context *Node) ([]*Node, error)

Wrapper for html.ParseFragment.

func RawHtml

func RawHtml(data string) *Node

Return a Node with the given raw html.

func Remove

func Remove(node *Node) *Node

Remove a node from its parent.

func Text

func Text(data string) *Node

Return a HTML node with the given text.