Struct TextOptions

utilities.go:61–79

TextOptions controls the behaviour of the Text function.

// TextOptions controls the behaviour of the Text function.
type TextOptions struct {
	// Separator is inserted between the contents of the text nodes that are
	// included in the result. It defaults to the empty string, which
	// concatenates the text nodes without any separator.
	Separator string

	// Trim, when true, removes leading and trailing whitespace from the
	// content of each text node and omits text nodes that are empty once
	// trimmed. This is useful to discard the insignificant whitespace that
	// comes from the indentation of the source HTML.
	Trim bool

	// Keep, when non-nil, is called for each text node encountered while
	// traversing the selection. The content of the text node is included in
	// the result only if Keep returns true. It can be used, for example, to
	// drop the text of <script> and <style> elements by inspecting the node's
	// parent. When Keep is nil, every text node is included (subject to Trim).
	Keep func(node *html.Node) bool
}

// Text returns the combined text contents of the nodes in the selection,
// including their descendants, in document order. It is a package-level