u

package
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 5, 2026 License: MIT Imports: 21 Imported by: 0

Documentation

Overview

Package u provides constructors and methods for the HTML <u> element.

The <u> HTML element represents a span of inline text which should be rendered in a way that indicates that it has a non-textual annotation. This is rendered by default as a single solid underline, but may be altered using CSS.

Index

Constants

This section is empty.

Variables

View Source
var (
	TagOpen  = []byte("<u")
	TagClose = []byte("</u>")
)

Byte constants for HTML rendering.

Functions

func New

func New(nodes ...node.Node) *element

New creates a new u element with the given child nodes. Example: u.New(text.Text("misspelled"))

func RawText

func RawText(content string) *element

RawText creates a new u element with raw text content. Uses text.RawText which is not HTML-escaped. Example: u.RawText("<em>annotated</em> text") Renders: <u><em>annotated</em> text</u>

func RawTextf

func RawTextf(format string, args ...any) *element

RawTextf creates a new u element with formatted raw text content. Uses text.RawTextf which is not HTML-escaped. Example: u.RawTextf("<em>%s</em>", word) Renders: <u><em>emphasis</em></u>

func Static

func Static(content string) *element

Static creates a new u element with static text content. Uses text.Static which is not HTML-escaped and is JIT-optimisable. Example: u.Static("proper noun") Renders: <u>proper noun</u>

func Text

func Text(content string) *element

Text creates a new u element with text content. Uses text.Text which HTML-escapes the output. Example: u.Text("misspelled word") Renders: <u>misspelled word</u>

func Textf

func Textf(format string, args ...any) *element

Textf creates a new u element with formatted text content. Uses text.Textf which HTML-escapes the output. Example: u.Textf("%s", word) Renders: <u>emphasis</u>

Types

type Element

type Element = element

Element is an exported alias for the private element type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL