Documentation ¶
Overview ¶
Package goquery implements features similar to jQuery, including the chainable syntax, to manipulate and query an HTML document.
It brings a syntax and a set of features similar to jQuery to the Go language. It is based on Go's net/html package and the CSS Selector library cascadia. Since the net/html parser returns nodes, and not a full-featured DOM tree, jQuery's stateful manipulation functions (like height(), css(), detach()) have been left off.
Also, because the net/html parser requires UTF-8 encoding, so does goquery: it is the caller's responsibility to ensure that the source document provides UTF-8 encoded HTML. See the repository's wiki for various options on how to do this.
Syntax-wise, it is as close as possible to jQuery, with the same method names when possible, and that warm and fuzzy chainable interface. jQuery being the ultra-popular library that it is, writing a similar HTML-manipulating library was better to follow its API than to start anew (in the same spirit as Go's fmt package), even though some of its methods are less than intuitive (looking at you, index()...).
It is hosted on GitHub, along with additional documentation in the README.md file: https://github.com/puerkitobio/goquery
Please note that because of the net/html dependency, goquery requires Go1.1+.
The various methods are split into files based on the category of behavior. The three dots (...) indicate that various "overloads" are available.
* array.go : array-like positional manipulation of the selection.
- Eq()
- First()
- Get()
- Index...()
- Last()
- Slice()
* expand.go : methods that expand or augment the selection's set.
- Add...()
- AndSelf()
- Union(), which is an alias for AddSelection()
* filter.go : filtering methods, that reduce the selection's set.
- End()
- Filter...()
- Has...()
- Intersection(), which is an alias of FilterSelection()
- Not...()
* iteration.go : methods to loop over the selection's nodes.
- Each()
- EachWithBreak()
- Map()
* manipulation.go : methods for modifying the document
- After...()
- Append...()
- Before...()
- Clone()
- Empty()
- Prepend...()
- Remove...()
- ReplaceWith...()
- Unwrap()
- Wrap...()
- WrapAll...()
- WrapInner...()
* property.go : methods that inspect and get the node's properties values.
- Attr*(), RemoveAttr(), SetAttr()
- AddClass(), HasClass(), RemoveClass(), ToggleClass()
- Html()
- Length()
- Size(), which is an alias for Length()
- Text()
* query.go : methods that query, or reflect, a node's identity.
- Contains()
- Is...()
* traversal.go : methods to traverse the HTML document tree.
- Children...()
- Contents()
- Find...()
- Next...()
- Parent[s]...()
- Prev...()
- Siblings...()
* type.go : definition of the types exposed by goquery.
- Document
- Selection
- Matcher
* utilities.go : definition of helper functions (and not methods on a *Selection) that are not part of jQuery, but are useful to goquery.
- NodeName
- OuterHtml
Example ¶
This example scrapes the reviews shown on the home page of metalsucks.net.
package main import ( "fmt" "log" "github.com/PuerkitoBio/goquery" ) func main() { // Load the HTML document doc, err := goquery.NewDocument("http://metalsucks.net") if err != nil { log.Fatal(err) } // Find the review items doc.Find(".sidebar-reviews article .content-block").Each(func(i int, s *goquery.Selection) { // For each item found, get the band and title band := s.Find("a").Text() title := s.Find("i").Text() fmt.Printf("Review %d: %s - %s\n", i, band, title) }) // To see the output of the Example while running the test suite (go test), simply // remove the leading "x" before Output on the next line. This will cause the // example to fail (all the "real" tests should pass). // xOutput: voluntarily fail the Example output. }
Output:
Index ¶
- func NodeName(s *Selection) string
- func OuterHtml(s *Selection) (string, error)
- type Document
- type Matcher
- type Selection
- func (s *Selection) Add(selector string) *Selection
- func (s *Selection) AddClass(class ...string) *Selection
- func (s *Selection) AddMatcher(m Matcher) *Selection
- func (s *Selection) AddNodes(nodes ...*html.Node) *Selection
- func (s *Selection) AddSelection(sel *Selection) *Selection
- func (s *Selection) After(selector string) *Selection
- func (s *Selection) AfterHtml(html string) *Selection
- func (s *Selection) AfterMatcher(m Matcher) *Selection
- func (s *Selection) AfterNodes(ns ...*html.Node) *Selection
- func (s *Selection) AfterSelection(sel *Selection) *Selection
- func (s *Selection) AndSelf() *Selection
- func (s *Selection) Append(selector string) *Selection
- func (s *Selection) AppendHtml(html string) *Selection
- func (s *Selection) AppendMatcher(m Matcher) *Selection
- func (s *Selection) AppendNodes(ns ...*html.Node) *Selection
- func (s *Selection) AppendSelection(sel *Selection) *Selection
- func (s *Selection) Attr(attrName string) (val string, exists bool)
- func (s *Selection) AttrOr(attrName, defaultValue string) string
- func (s *Selection) Before(selector string) *Selection
- func (s *Selection) BeforeHtml(html string) *Selection
- func (s *Selection) BeforeMatcher(m Matcher) *Selection
- func (s *Selection) BeforeNodes(ns ...*html.Node) *Selection
- func (s *Selection) BeforeSelection(sel *Selection) *Selection
- func (s *Selection) Children() *Selection
- func (s *Selection) ChildrenFiltered(selector string) *Selection
- func (s *Selection) ChildrenMatcher(m Matcher) *Selection
- func (s *Selection) Clone() *Selection
- func (s *Selection) Closest(selector string) *Selection
- func (s *Selection) ClosestMatcher(m Matcher) *Selection
- func (s *Selection) ClosestNodes(nodes ...*html.Node) *Selection
- func (s *Selection) ClosestSelection(sel *Selection) *Selection
- func (s *Selection) Contains(n *html.Node) bool
- func (s *Selection) Contents() *Selection
- func (s *Selection) ContentsFiltered(selector string) *Selection
- func (s *Selection) ContentsMatcher(m Matcher) *Selection
- func (s *Selection) Each(f func(int, *Selection)) *Selection
- func (s *Selection) EachWithBreak(f func(int, *Selection) bool) *Selection
- func (s *Selection) Empty() *Selection
- func (s *Selection) End() *Selection
- func (s *Selection) Eq(index int) *Selection
- func (s *Selection) Filter(selector string) *Selection
- func (s *Selection) FilterFunction(f func(int, *Selection) bool) *Selection
- func (s *Selection) FilterMatcher(m Matcher) *Selection
- func (s *Selection) FilterNodes(nodes ...*html.Node) *Selection
- func (s *Selection) FilterSelection(sel *Selection) *Selection
- func (s *Selection) Find(selector string) *Selection
- func (s *Selection) FindMatcher(m Matcher) *Selection
- func (s *Selection) FindNodes(nodes ...*html.Node) *Selection
- func (s *Selection) FindSelection(sel *Selection) *Selection
- func (s *Selection) First() *Selection
- func (s *Selection) Get(index int) *html.Node
- func (s *Selection) Has(selector string) *Selection
- func (s *Selection) HasClass(class string) bool
- func (s *Selection) HasMatcher(m Matcher) *Selection
- func (s *Selection) HasNodes(nodes ...*html.Node) *Selection
- func (s *Selection) HasSelection(sel *Selection) *Selection
- func (s *Selection) Html() (ret string, e error)
- func (s *Selection) Index() int
- func (s *Selection) IndexMatcher(m Matcher) int
- func (s *Selection) IndexOfNode(node *html.Node) int
- func (s *Selection) IndexOfSelection(sel *Selection) int
- func (s *Selection) IndexSelector(selector string) int
- func (s *Selection) Intersection(sel *Selection) *Selection
- func (s *Selection) Is(selector string) bool
- func (s *Selection) IsFunction(f func(int, *Selection) bool) bool
- func (s *Selection) IsMatcher(m Matcher) bool
- func (s *Selection) IsNodes(nodes ...*html.Node) bool
- func (s *Selection) IsSelection(sel *Selection) bool
- func (s *Selection) Last() *Selection
- func (s *Selection) Length() int
- func (s *Selection) Map(f func(int, *Selection) string) (result []string)
- func (s *Selection) Next() *Selection
- func (s *Selection) NextAll() *Selection
- func (s *Selection) NextAllFiltered(selector string) *Selection
- func (s *Selection) NextAllMatcher(m Matcher) *Selection
- func (s *Selection) NextFiltered(selector string) *Selection
- func (s *Selection) NextFilteredUntil(filterSelector, untilSelector string) *Selection
- func (s *Selection) NextFilteredUntilMatcher(filter, until Matcher) *Selection
- func (s *Selection) NextFilteredUntilNodes(filterSelector string, nodes ...*html.Node) *Selection
- func (s *Selection) NextFilteredUntilSelection(filterSelector string, sel *Selection) *Selection
- func (s *Selection) NextMatcher(m Matcher) *Selection
- func (s *Selection) NextMatcherUntilNodes(filter Matcher, nodes ...*html.Node) *Selection
- func (s *Selection) NextMatcherUntilSelection(filter Matcher, sel *Selection) *Selection
- func (s *Selection) NextUntil(selector string) *Selection
- func (s *Selection) NextUntilMatcher(m Matcher) *Selection
- func (s *Selection) NextUntilNodes(nodes ...*html.Node) *Selection
- func (s *Selection) NextUntilSelection(sel *Selection) *Selection
- func (s *Selection) Not(selector string) *Selection
- func (s *Selection) NotFunction(f func(int, *Selection) bool) *Selection
- func (s *Selection) NotMatcher(m Matcher) *Selection
- func (s *Selection) NotNodes(nodes ...*html.Node) *Selection
- func (s *Selection) NotSelection(sel *Selection) *Selection
- func (s *Selection) Parent() *Selection
- func (s *Selection) ParentFiltered(selector string) *Selection
- func (s *Selection) ParentMatcher(m Matcher) *Selection
- func (s *Selection) Parents() *Selection
- func (s *Selection) ParentsFiltered(selector string) *Selection
- func (s *Selection) ParentsFilteredUntil(filterSelector, untilSelector string) *Selection
- func (s *Selection) ParentsFilteredUntilMatcher(filter, until Matcher) *Selection
- func (s *Selection) ParentsFilteredUntilNodes(filterSelector string, nodes ...*html.Node) *Selection
- func (s *Selection) ParentsFilteredUntilSelection(filterSelector string, sel *Selection) *Selection
- func (s *Selection) ParentsMatcher(m Matcher) *Selection
- func (s *Selection) ParentsMatcherUntilNodes(filter Matcher, nodes ...*html.Node) *Selection
- func (s *Selection) ParentsMatcherUntilSelection(filter Matcher, sel *Selection) *Selection
- func (s *Selection) ParentsUntil(selector string) *Selection
- func (s *Selection) ParentsUntilMatcher(m Matcher) *Selection
- func (s *Selection) ParentsUntilNodes(nodes ...*html.Node) *Selection
- func (s *Selection) ParentsUntilSelection(sel *Selection) *Selection
- func (s *Selection) Prepend(selector string) *Selection
- func (s *Selection) PrependHtml(html string) *Selection
- func (s *Selection) PrependMatcher(m Matcher) *Selection
- func (s *Selection) PrependNodes(ns ...*html.Node) *Selection
- func (s *Selection) PrependSelection(sel *Selection) *Selection
- func (s *Selection) Prev() *Selection
- func (s *Selection) PrevAll() *Selection
- func (s *Selection) PrevAllFiltered(selector string) *Selection
- func (s *Selection) PrevAllMatcher(m Matcher) *Selection
- func (s *Selection) PrevFiltered(selector string) *Selection
- func (s *Selection) PrevFilteredUntil(filterSelector, untilSelector string) *Selection
- func (s *Selection) PrevFilteredUntilMatcher(filter, until Matcher) *Selection
- func (s *Selection) PrevFilteredUntilNodes(filterSelector string, nodes ...*html.Node) *Selection
- func (s *Selection) PrevFilteredUntilSelection(filterSelector string, sel *Selection) *Selection
- func (s *Selection) PrevMatcher(m Matcher) *Selection
- func (s *Selection) PrevMatcherUntilNodes(filter Matcher, nodes ...*html.Node) *Selection
- func (s *Selection) PrevMatcherUntilSelection(filter Matcher, sel *Selection) *Selection
- func (s *Selection) PrevUntil(selector string) *Selection
- func (s *Selection) PrevUntilMatcher(m Matcher) *Selection
- func (s *Selection) PrevUntilNodes(nodes ...*html.Node) *Selection
- func (s *Selection) PrevUntilSelection(sel *Selection) *Selection
- func (s *Selection) Remove() *Selection
- func (s *Selection) RemoveAttr(attrName string) *Selection
- func (s *Selection) RemoveClass(class ...string) *Selection
- func (s *Selection) RemoveFiltered(selector string) *Selection
- func (s *Selection) RemoveMatcher(m Matcher) *Selection
- func (s *Selection) ReplaceWith(selector string) *Selection
- func (s *Selection) ReplaceWithHtml(html string) *Selection
- func (s *Selection) ReplaceWithMatcher(m Matcher) *Selection
- func (s *Selection) ReplaceWithNodes(ns ...*html.Node) *Selection
- func (s *Selection) ReplaceWithSelection(sel *Selection) *Selection
- func (s *Selection) SetAttr(attrName, val string) *Selection
- func (s *Selection) Siblings() *Selection
- func (s *Selection) SiblingsFiltered(selector string) *Selection
- func (s *Selection) SiblingsMatcher(m Matcher) *Selection
- func (s *Selection) Size() int
- func (s *Selection) Slice(start, end int) *Selection
- func (s *Selection) Text() string
- func (s *Selection) ToggleClass(class ...string) *Selection
- func (s *Selection) Union(sel *Selection) *Selection
- func (s *Selection) Unwrap() *Selection
- func (s *Selection) Wrap(selector string) *Selection
- func (s *Selection) WrapAll(selector string) *Selection
- func (s *Selection) WrapAllHtml(html string) *Selection
- func (s *Selection) WrapAllMatcher(m Matcher) *Selection
- func (s *Selection) WrapAllNode(n *html.Node) *Selection
- func (s *Selection) WrapAllSelection(sel *Selection) *Selection
- func (s *Selection) WrapHtml(html string) *Selection
- func (s *Selection) WrapInner(selector string) *Selection
- func (s *Selection) WrapInnerHtml(html string) *Selection
- func (s *Selection) WrapInnerMatcher(m Matcher) *Selection
- func (s *Selection) WrapInnerNode(n *html.Node) *Selection
- func (s *Selection) WrapInnerSelection(sel *Selection) *Selection
- func (s *Selection) WrapMatcher(m Matcher) *Selection
- func (s *Selection) WrapNode(n *html.Node) *Selection
- func (s *Selection) WrapSelection(sel *Selection) *Selection
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NodeName ¶ added in v1.0.0
NodeName returns the node name of the first element in the selection. It tries to behave in a similar way as the DOM's nodeName property (https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeName).
Go's net/html package defines the following node types, listed with the corresponding returned value from this function:
ErrorNode : #error TextNode : #text DocumentNode : #document ElementNode : the element's tag name CommentNode : #comment DoctypeNode : the name of the document type
func OuterHtml ¶ added in v1.0.0
OuterHtml returns the outer HTML rendering of the first item in the selection - that is, the HTML including the first element's tag and attributes.
Unlike InnerHtml, this is a function and not a method on the Selection, because this is not a jQuery method (in javascript-land, this is a property provided by the DOM).
Types ¶
type Document ¶
Document represents an HTML document to be manipulated. Unlike jQuery, which is loaded as part of a DOM document, and thus acts upon its containing document, GoQuery doesn't know which HTML document to act upon. So it needs to be told, and that's what the Document class is for. It holds the root document node to manipulate, and can make selections on this document.
func CloneDocument ¶ added in v1.0.0
CloneDocument creates a deep-clone of a document.
func NewDocument ¶
NewDocument is a Document constructor that takes a string URL as argument. It loads the specified document, parses it, and stores the root Document node, ready to be manipulated.
func NewDocumentFromNode ¶
NewDocumentFromNode is a Document constructor that takes a root html Node as argument.
func NewDocumentFromReader ¶ added in v0.3.2
NewDocumentFromReader returns a Document from a generic reader. It returns an error as second value if the reader's data cannot be parsed as html. It does *not* check if the reader is also an io.Closer, so the provided reader is never closed by this call, it is the responsibility of the caller to close it if required.
func NewDocumentFromResponse ¶ added in v0.3.1
NewDocumentFromResponse is another Document constructor that takes an http response as argument. It loads the specified response's document, parses it, and stores the root Document node, ready to be manipulated. The response's body is closed on return.
type Matcher ¶ added in v1.0.0
type Matcher interface { Match(*html.Node) bool MatchAll(*html.Node) []*html.Node Filter([]*html.Node) []*html.Node }
Matcher is an interface that defines the methods to match HTML nodes against a compiled selector string. Cascadia's Selector implements this interface.
type Selection ¶
Selection represents a collection of nodes matching some criteria. The initial Selection can be created by using Document.Find, and then manipulated using the jQuery-like chainable syntax and methods.
func (*Selection) Add ¶
Add adds the selector string's matching nodes to those in the current selection and returns a new Selection object. The selector string is run in the context of the document of the current Selection object.
func (*Selection) AddClass ¶ added in v1.0.0
AddClass adds the given class(es) to each element in the set of matched elements. Multiple class names can be specified, separated by a space or via multiple arguments.
func (*Selection) AddMatcher ¶ added in v1.0.0
AddMatcher adds the matcher's matching nodes to those in the current selection and returns a new Selection object. The matcher is run in the context of the document of the current Selection object.
func (*Selection) AddNodes ¶
AddNodes adds the specified nodes to those in the current selection and returns a new Selection object.
func (*Selection) AddSelection ¶
AddSelection adds the specified Selection object's nodes to those in the current selection and returns a new Selection object.
func (*Selection) After ¶ added in v1.0.0
After applies the selector from the root document and inserts the matched elements after the elements in the set of matched elements.
If one of the matched elements in the selection is not currently in the document, it's impossible to insert nodes after it, so it will be ignored.
This follows the same rules as Selection.Append.
func (*Selection) AfterHtml ¶ added in v1.0.0
AfterHtml parses the html and inserts it after the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) AfterMatcher ¶ added in v1.0.0
AfterMatcher applies the matcher from the root document and inserts the matched elements after the elements in the set of matched elements.
If one of the matched elements in the selection is not currently in the document, it's impossible to insert nodes after it, so it will be ignored.
This follows the same rules as Selection.Append.
func (*Selection) AfterNodes ¶ added in v1.0.0
AfterNodes inserts the nodes after each element in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) AfterSelection ¶ added in v1.0.0
AfterSelection inserts the elements in the selection after each element in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) AndSelf ¶
AndSelf adds the previous set of elements on the stack to the current set. It returns a new Selection object containing the current Selection combined with the previous one.
func (*Selection) Append ¶ added in v1.0.0
Append appends the elements specified by the selector to the end of each element in the set of matched elements, following those rules:
1) The selector is applied to the root document.
2) Elements that are part of the document will be moved to the new location.
3) If there are multiple locations to append to, cloned nodes will be appended to all target locations except the last one, which will be moved as noted in (2).
func (*Selection) AppendHtml ¶ added in v1.0.0
AppendHtml parses the html and appends it to the set of matched elements.
func (*Selection) AppendMatcher ¶ added in v1.0.0
AppendMatcher appends the elements specified by the matcher to the end of each element in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) AppendNodes ¶ added in v1.0.0
AppendNodes appends the specified nodes to each node in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) AppendSelection ¶ added in v1.0.0
AppendSelection appends the elements in the selection to the end of each element in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) Attr ¶
Attr gets the specified attribute's value for the first element in the Selection. To get the value for each element individually, use a looping construct such as Each or Map method.
func (*Selection) AttrOr ¶ added in v1.0.0
AttrOr works like Attr but returns default value if attribute is not present.
func (*Selection) Before ¶ added in v1.0.0
Before inserts the matched elements before each element in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) BeforeHtml ¶ added in v1.0.0
BeforeHtml parses the html and inserts it before the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) BeforeMatcher ¶ added in v1.0.0
BeforeMatcher inserts the matched elements before each element in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) BeforeNodes ¶ added in v1.0.0
BeforeNodes inserts the nodes before each element in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) BeforeSelection ¶ added in v1.0.0
BeforeSelection inserts the elements in the selection before each element in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) Children ¶
Children gets the child elements of each element in the Selection. It returns a new Selection object containing these elements.
func (*Selection) ChildrenFiltered ¶
ChildrenFiltered gets the child elements of each element in the Selection, filtered by the specified selector. It returns a new Selection object containing these elements.
func (*Selection) ChildrenMatcher ¶ added in v1.0.0
ChildrenMatcher gets the child elements of each element in the Selection, filtered by the specified matcher. It returns a new Selection object containing these elements.
func (*Selection) Clone ¶ added in v1.0.0
Clone creates a deep copy of the set of matched nodes. The new nodes will not be attached to the document.
func (*Selection) Closest ¶ added in v0.2.0
Closest gets the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.
func (*Selection) ClosestMatcher ¶ added in v1.0.0
ClosestMatcher gets the first element that matches the matcher by testing the element itself and traversing up through its ancestors in the DOM tree.
func (*Selection) ClosestNodes ¶ added in v0.2.0
ClosestNodes gets the first element that matches one of the nodes by testing the element itself and traversing up through its ancestors in the DOM tree.
func (*Selection) ClosestSelection ¶ added in v0.2.0
ClosestSelection gets the first element that matches one of the nodes in the Selection by testing the element itself and traversing up through its ancestors in the DOM tree.
func (*Selection) Contains ¶
Contains returns true if the specified Node is within, at any depth, one of the nodes in the Selection object. It is NOT inclusive, to behave like jQuery's implementation, and unlike Javascript's .contains, so if the contained node is itself in the selection, it returns false.
func (*Selection) Contents ¶
Contents gets the children of each element in the Selection, including text and comment nodes. It returns a new Selection object containing these elements.
func (*Selection) ContentsFiltered ¶
ContentsFiltered gets the children of each element in the Selection, filtered by the specified selector. It returns a new Selection object containing these elements. Since selectors only act on Element nodes, this function is an alias to ChildrenFiltered unless the selector is empty, in which case it is an alias to Contents.
func (*Selection) ContentsMatcher ¶ added in v1.0.0
ContentsMatcher gets the children of each element in the Selection, filtered by the specified matcher. It returns a new Selection object containing these elements. Since matchers only act on Element nodes, this function is an alias to ChildrenMatcher.
func (*Selection) Each ¶
Each iterates over a Selection object, executing a function for each matched element. It returns the current Selection object. The function f is called for each element in the selection with the index of the element in that selection starting at 0, and a *Selection that contains only that element.
func (*Selection) EachWithBreak ¶ added in v0.3.0
EachWithBreak iterates over a Selection object, executing a function for each matched element. It is identical to Each except that it is possible to break out of the loop by returning false in the callback function. It returns the current Selection object.
func (*Selection) Empty ¶ added in v1.0.0
Empty removes all children nodes from the set of matched elements. It returns the children nodes in a new Selection.
func (*Selection) End ¶
End ends the most recent filtering operation in the current chain and returns the set of matched elements to its previous state.
func (*Selection) Eq ¶
Eq reduces the set of matched elements to the one at the specified index. If a negative index is given, it counts backwards starting at the end of the set. It returns a new Selection object, and an empty Selection object if the index is invalid.
func (*Selection) Filter ¶
Filter reduces the set of matched elements to those that match the selector string. It returns a new Selection object for this subset of matching elements.
func (*Selection) FilterFunction ¶
FilterFunction reduces the set of matched elements to those that pass the function's test. It returns a new Selection object for this subset of elements.
func (*Selection) FilterMatcher ¶ added in v1.0.0
FilterMatcher reduces the set of matched elements to those that match the given matcher. It returns a new Selection object for this subset of matching elements.
func (*Selection) FilterNodes ¶
FilterNodes reduces the set of matched elements to those that match the specified nodes. It returns a new Selection object for this subset of elements.
func (*Selection) FilterSelection ¶
FilterSelection reduces the set of matched elements to those that match a node in the specified Selection object. It returns a new Selection object for this subset of elements.
func (*Selection) Find ¶
Find gets the descendants of each element in the current set of matched elements, filtered by a selector. It returns a new Selection object containing these matched elements.
func (*Selection) FindMatcher ¶ added in v1.0.0
FindMatcher gets the descendants of each element in the current set of matched elements, filtered by the matcher. It returns a new Selection object containing these matched elements.
func (*Selection) FindNodes ¶
FindNodes gets the descendants of each element in the current Selection, filtered by some nodes. It returns a new Selection object containing these matched elements.
func (*Selection) FindSelection ¶
FindSelection gets the descendants of each element in the current Selection, filtered by a Selection. It returns a new Selection object containing these matched elements.
func (*Selection) First ¶
First reduces the set of matched elements to the first in the set. It returns a new Selection object, and an empty Selection object if the the selection is empty.
func (*Selection) Get ¶
Get retrieves the underlying node at the specified index. Get without parameter is not implemented, since the node array is available on the Selection object.
func (*Selection) Has ¶
Has reduces the set of matched elements to those that have a descendant that matches the selector. It returns a new Selection object with the matching elements.
func (*Selection) HasClass ¶
HasClass determines whether any of the matched elements are assigned the given class.
func (*Selection) HasMatcher ¶ added in v1.0.0
HasMatcher reduces the set of matched elements to those that have a descendant that matches the matcher. It returns a new Selection object with the matching elements.
func (*Selection) HasNodes ¶
HasNodes reduces the set of matched elements to those that have a descendant that matches one of the nodes. It returns a new Selection object with the matching elements.
func (*Selection) HasSelection ¶
HasSelection reduces the set of matched elements to those that have a descendant that matches one of the nodes of the specified Selection object. It returns a new Selection object with the matching elements.
func (*Selection) Html ¶
Html gets the HTML contents of the first element in the set of matched elements. It includes text and comment nodes.
func (*Selection) Index ¶
Index returns the position of the first element within the Selection object relative to its sibling elements.
func (*Selection) IndexMatcher ¶ added in v1.0.0
IndexMatcher returns the position of the first element within the Selection object relative to the elements matched by the matcher, or -1 if not found.
func (*Selection) IndexOfNode ¶
IndexOfNode returns the position of the specified node within the Selection object, or -1 if not found.
func (*Selection) IndexOfSelection ¶
IndexOfSelection returns the position of the first node in the specified Selection object within this Selection object, or -1 if not found.
func (*Selection) IndexSelector ¶
IndexSelector returns the position of the first element within the Selection object relative to the elements matched by the selector, or -1 if not found.
func (*Selection) Intersection ¶
Intersection is an alias for FilterSelection.
func (*Selection) Is ¶
Is checks the current matched set of elements against a selector and returns true if at least one of these elements matches.
func (*Selection) IsFunction ¶
IsFunction checks the current matched set of elements against a predicate and returns true if at least one of these elements matches.
func (*Selection) IsMatcher ¶ added in v1.0.0
IsMatcher checks the current matched set of elements against a matcher and returns true if at least one of these elements matches.
func (*Selection) IsNodes ¶
IsNodes checks the current matched set of elements against the specified nodes and returns true if at least one of these elements matches.
func (*Selection) IsSelection ¶
IsSelection checks the current matched set of elements against a Selection object and returns true if at least one of these elements matches.
func (*Selection) Last ¶
Last reduces the set of matched elements to the last in the set. It returns a new Selection object, and an empty Selection object if the selection is empty.
func (*Selection) Map ¶
Map passes each element in the current matched set through a function, producing a slice of string holding the returned values. The function f is called for each element in the selection with the index of the element in that selection starting at 0, and a *Selection that contains only that element.
func (*Selection) Next ¶
Next gets the immediately following sibling of each element in the Selection. It returns a new Selection object containing the matched elements.
func (*Selection) NextAll ¶
NextAll gets all the following siblings of each element in the Selection. It returns a new Selection object containing the matched elements.
func (*Selection) NextAllFiltered ¶
NextAllFiltered gets all the following siblings of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.
func (*Selection) NextAllMatcher ¶ added in v1.0.0
NextAllMatcher gets all the following siblings of each element in the Selection filtered by a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) NextFiltered ¶
NextFiltered gets the immediately following sibling of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.
func (*Selection) NextFilteredUntil ¶
NextFilteredUntil is like NextUntil, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.
func (*Selection) NextFilteredUntilMatcher ¶ added in v1.0.0
NextFilteredUntilMatcher is like NextUntilMatcher, with the option to filter the results based on a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) NextFilteredUntilNodes ¶
NextFilteredUntilNodes is like NextUntilNodes, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.
func (*Selection) NextFilteredUntilSelection ¶
NextFilteredUntilSelection is like NextUntilSelection, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.
func (*Selection) NextMatcher ¶ added in v1.0.0
NextMatcher gets the immediately following sibling of each element in the Selection filtered by a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) NextMatcherUntilNodes ¶ added in v1.0.0
NextMatcherUntilNodes is like NextUntilNodes, with the option to filter the results based on a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) NextMatcherUntilSelection ¶ added in v1.0.0
NextMatcherUntilSelection is like NextUntilSelection, with the option to filter the results based on a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) NextUntil ¶
NextUntil gets all following siblings of each element up to but not including the element matched by the selector. It returns a new Selection object containing the matched elements.
func (*Selection) NextUntilMatcher ¶ added in v1.0.0
NextUntilMatcher gets all following siblings of each element up to but not including the element matched by the matcher. It returns a new Selection object containing the matched elements.
func (*Selection) NextUntilNodes ¶
NextUntilNodes gets all following siblings of each element up to but not including the element matched by the nodes. It returns a new Selection object containing the matched elements.
func (*Selection) NextUntilSelection ¶
NextUntilSelection gets all following siblings of each element up to but not including the element matched by the Selection. It returns a new Selection object containing the matched elements.
func (*Selection) Not ¶
Not removes elements from the Selection that match the selector string. It returns a new Selection object with the matching elements removed.
func (*Selection) NotFunction ¶
NotFunction removes elements from the Selection that pass the function's test. It returns a new Selection object with the matching elements removed.
func (*Selection) NotMatcher ¶ added in v1.0.0
NotMatcher removes elements from the Selection that match the given matcher. It returns a new Selection object with the matching elements removed.
func (*Selection) NotNodes ¶
NotNodes removes elements from the Selection that match the specified nodes. It returns a new Selection object with the matching elements removed.
func (*Selection) NotSelection ¶
NotSelection removes elements from the Selection that match a node in the specified Selection object. It returns a new Selection object with the matching elements removed.
func (*Selection) Parent ¶
Parent gets the parent of each element in the Selection. It returns a new Selection object containing the matched elements.
func (*Selection) ParentFiltered ¶
ParentFiltered gets the parent of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.
func (*Selection) ParentMatcher ¶ added in v1.0.0
ParentMatcher gets the parent of each element in the Selection filtered by a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) Parents ¶
Parents gets the ancestors of each element in the current Selection. It returns a new Selection object with the matched elements.
func (*Selection) ParentsFiltered ¶
ParentsFiltered gets the ancestors of each element in the current Selection. It returns a new Selection object with the matched elements.
func (*Selection) ParentsFilteredUntil ¶
ParentsFilteredUntil is like ParentsUntil, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.
func (*Selection) ParentsFilteredUntilMatcher ¶ added in v1.0.0
ParentsFilteredUntilMatcher is like ParentsUntilMatcher, with the option to filter the results based on a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) ParentsFilteredUntilNodes ¶
func (s *Selection) ParentsFilteredUntilNodes(filterSelector string, nodes ...*html.Node) *Selection
ParentsFilteredUntilNodes is like ParentsUntilNodes, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.
func (*Selection) ParentsFilteredUntilSelection ¶
ParentsFilteredUntilSelection is like ParentsUntilSelection, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.
func (*Selection) ParentsMatcher ¶ added in v1.0.0
ParentsMatcher gets the ancestors of each element in the current Selection. It returns a new Selection object with the matched elements.
func (*Selection) ParentsMatcherUntilNodes ¶ added in v1.0.0
ParentsMatcherUntilNodes is like ParentsUntilNodes, with the option to filter the results based on a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) ParentsMatcherUntilSelection ¶ added in v1.0.0
ParentsMatcherUntilSelection is like ParentsUntilSelection, with the option to filter the results based on a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) ParentsUntil ¶
ParentsUntil gets the ancestors of each element in the Selection, up to but not including the element matched by the selector. It returns a new Selection object containing the matched elements.
func (*Selection) ParentsUntilMatcher ¶ added in v1.0.0
ParentsUntilMatcher gets the ancestors of each element in the Selection, up to but not including the element matched by the matcher. It returns a new Selection object containing the matched elements.
func (*Selection) ParentsUntilNodes ¶
ParentsUntilNodes gets the ancestors of each element in the Selection, up to but not including the specified nodes. It returns a new Selection object containing the matched elements.
func (*Selection) ParentsUntilSelection ¶
ParentsUntilSelection gets the ancestors of each element in the Selection, up to but not including the elements in the specified Selection. It returns a new Selection object containing the matched elements.
func (*Selection) Prepend ¶ added in v1.0.0
Prepend prepends the elements specified by the selector to each element in the set of matched elements, following the same rules as Append.
func (*Selection) PrependHtml ¶ added in v1.0.0
PrependHtml parses the html and prepends it to the set of matched elements.
func (*Selection) PrependMatcher ¶ added in v1.0.0
PrependMatcher prepends the elements specified by the matcher to each element in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) PrependNodes ¶ added in v1.0.0
PrependNodes prepends the specified nodes to each node in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) PrependSelection ¶ added in v1.0.0
PrependSelection prepends the elements in the selection to each element in the set of matched elements.
This follows the same rules as Selection.Append.
func (*Selection) Prev ¶
Prev gets the immediately preceding sibling of each element in the Selection. It returns a new Selection object containing the matched elements.
func (*Selection) PrevAll ¶
PrevAll gets all the preceding siblings of each element in the Selection. It returns a new Selection object containing the matched elements.
func (*Selection) PrevAllFiltered ¶
PrevAllFiltered gets all the preceding siblings of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.
func (*Selection) PrevAllMatcher ¶ added in v1.0.0
PrevAllMatcher gets all the preceding siblings of each element in the Selection filtered by a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) PrevFiltered ¶
PrevFiltered gets the immediately preceding sibling of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.
func (*Selection) PrevFilteredUntil ¶
PrevFilteredUntil is like PrevUntil, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.
func (*Selection) PrevFilteredUntilMatcher ¶ added in v1.0.0
PrevFilteredUntilMatcher is like PrevUntilMatcher, with the option to filter the results based on a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) PrevFilteredUntilNodes ¶
PrevFilteredUntilNodes is like PrevUntilNodes, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.
func (*Selection) PrevFilteredUntilSelection ¶
PrevFilteredUntilSelection is like PrevUntilSelection, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.
func (*Selection) PrevMatcher ¶ added in v1.0.0
PrevMatcher gets the immediately preceding sibling of each element in the Selection filtered by a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) PrevMatcherUntilNodes ¶ added in v1.0.0
PrevMatcherUntilNodes is like PrevUntilNodes, with the option to filter the results based on a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) PrevMatcherUntilSelection ¶ added in v1.0.0
PrevMatcherUntilSelection is like PrevUntilSelection, with the option to filter the results based on a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) PrevUntil ¶
PrevUntil gets all preceding siblings of each element up to but not including the element matched by the selector. It returns a new Selection object containing the matched elements.
func (*Selection) PrevUntilMatcher ¶ added in v1.0.0
PrevUntilMatcher gets all preceding siblings of each element up to but not including the element matched by the matcher. It returns a new Selection object containing the matched elements.
func (*Selection) PrevUntilNodes ¶
PrevUntilNodes gets all preceding siblings of each element up to but not including the element matched by the nodes. It returns a new Selection object containing the matched elements.
func (*Selection) PrevUntilSelection ¶
PrevUntilSelection gets all preceding siblings of each element up to but not including the element matched by the Selection. It returns a new Selection object containing the matched elements.
func (*Selection) Remove ¶ added in v1.0.0
Remove removes the set of matched elements from the document. It returns the same selection, now consisting of nodes not in the document.
func (*Selection) RemoveAttr ¶ added in v1.0.0
RemoveAttr removes the named attribute from each element in the set of matched elements.
func (*Selection) RemoveClass ¶ added in v1.0.0
RemoveClass removes the given class(es) from each element in the set of matched elements. Multiple class names can be specified, separated by a space or via multiple arguments. If no class name is provided, all classes are removed.
func (*Selection) RemoveFiltered ¶ added in v1.0.0
RemoveFiltered removes the set of matched elements by selector. It returns the Selection of removed nodes.
func (*Selection) RemoveMatcher ¶ added in v1.0.0
RemoveMatcher removes the set of matched elements. It returns the Selection of removed nodes.
func (*Selection) ReplaceWith ¶ added in v1.0.0
ReplaceWith replaces each element in the set of matched elements with the nodes matched by the given selector. It returns the removed elements.
This follows the same rules as Selection.Append.
func (*Selection) ReplaceWithHtml ¶ added in v1.0.0
ReplaceWithHtml replaces each element in the set of matched elements with the parsed HTML. It returns the removed elements.
This follows the same rules as Selection.Append.
func (*Selection) ReplaceWithMatcher ¶ added in v1.0.0
ReplaceWithMatcher replaces each element in the set of matched elements with the nodes matched by the given Matcher. It returns the removed elements.
This follows the same rules as Selection.Append.
func (*Selection) ReplaceWithNodes ¶ added in v1.0.0
ReplaceWithNodes replaces each element in the set of matched elements with the given nodes. It returns the removed elements.
This follows the same rules as Selection.Append.
func (*Selection) ReplaceWithSelection ¶ added in v1.0.0
ReplaceWithSelection replaces each element in the set of matched elements with the nodes from the given Selection. It returns the removed elements.
This follows the same rules as Selection.Append.
func (*Selection) SetAttr ¶ added in v1.0.0
SetAttr sets the given attribute on each element in the set of matched elements.
func (*Selection) Siblings ¶
Siblings gets the siblings of each element in the Selection. It returns a new Selection object containing the matched elements.
func (*Selection) SiblingsFiltered ¶
SiblingsFiltered gets the siblings of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.
func (*Selection) SiblingsMatcher ¶ added in v1.0.0
SiblingsMatcher gets the siblings of each element in the Selection filtered by a matcher. It returns a new Selection object containing the matched elements.
func (*Selection) Slice ¶
Slice reduces the set of matched elements to a subset specified by a range of indices.
func (*Selection) Text ¶
Text gets the combined text contents of each element in the set of matched elements, including their descendants.
func (*Selection) ToggleClass ¶ added in v1.0.0
ToggleClass adds or removes the given class(es) for each element in the set of matched elements. Multiple class names can be specified, separated by a space or via multiple arguments.
func (*Selection) Unwrap ¶ added in v1.0.0
Unwrap removes the parents of the set of matched elements, leaving the matched elements (and their siblings, if any) in their place. It returns the original selection.
func (*Selection) Wrap ¶ added in v1.0.0
Wrap wraps each element in the set of matched elements inside the first element matched by the given selector. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapAll ¶ added in v1.0.0
WrapAll wraps a single HTML structure, matched by the given selector, around all elements in the set of matched elements. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapAllHtml ¶ added in v1.0.0
WrapAllHtml wraps the given HTML structure around all elements in the set of matched elements. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapAllMatcher ¶ added in v1.0.0
WrapAllMatcher wraps a single HTML structure, matched by the given Matcher, around all elements in the set of matched elements. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapAllNode ¶ added in v1.0.0
WrapAllNode wraps the given node around the first element in the Selection, making all other nodes in the Selection children of the given node. The node is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapAllSelection ¶ added in v1.0.0
WrapAllSelection wraps a single HTML structure, the first node of the given Selection, around all elements in the set of matched elements. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapHtml ¶ added in v1.0.0
WrapHtml wraps each element in the set of matched elements inside the inner- most child of the given HTML.
It returns the original set of elements.
func (*Selection) WrapInner ¶ added in v1.0.0
WrapInner wraps an HTML structure, matched by the given selector, around the content of element in the set of matched elements. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapInnerHtml ¶ added in v1.0.0
WrapInnerHtml wraps an HTML structure, matched by the given selector, around the content of element in the set of matched elements. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapInnerMatcher ¶ added in v1.0.0
WrapInnerMatcher wraps an HTML structure, matched by the given selector, around the content of element in the set of matched elements. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapInnerNode ¶ added in v1.0.0
WrapInnerNode wraps an HTML structure, matched by the given selector, around the content of element in the set of matched elements. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapInnerSelection ¶ added in v1.0.0
WrapInnerSelection wraps an HTML structure, matched by the given selector, around the content of element in the set of matched elements. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapMatcher ¶ added in v1.0.0
WrapMatcher wraps each element in the set of matched elements inside the first element matched by the given matcher. The matched child is cloned before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapNode ¶ added in v1.0.0
WrapNode wraps each element in the set of matched elements inside the inner- most child of the given node. The given node is copied before being inserted into the document.
It returns the original set of elements.
func (*Selection) WrapSelection ¶ added in v1.0.0
WrapSelection wraps each element in the set of matched elements inside the first element in the given Selection. The element is cloned before being inserted into the document.
It returns the original set of elements.