caption

package
v0.3.0-rc1 Latest Latest
Warning

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

Go to latest
Published: Apr 7, 2026 License: MIT Imports: 21 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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

Byte constants for HTML rendering.

Functions

func New

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

New Creates a new caption element with the given child nodes. Example: caption.New(text.Text("My Table Caption")) Renders: <caption>My Table Caption</caption>

func RawText

func RawText(str string) *element

RawText Creates a new caption element with raw text content. Uses text.RawText which is not HTML-escaped. Example: caption.RawText("User Accounts") Renders: <caption>User Accounts</caption>

func RawTextf

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

RawTextf Creates a new caption element with formatted raw text content. Uses text.RawTextf which is not HTML-escaped. Example: caption.RawTextf("%s Revenue", "Monthly") Renders: <caption>Monthly Revenue</caption>

func Static

func Static(str string) *element

Static Creates a new caption element with static text content. Uses text.Static which is not HTML-escaped and is JIT-optimisable. Example: caption.Static("Monthly Revenue") Renders: <caption>Monthly Revenue</caption>

func Text

func Text(str string) *element

Text Creates a new caption element with text content. Uses text.Text which HTML-escapes the output. Example: caption.Text("User Accounts") Renders: <caption>User Accounts</caption>

func Textf

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

Textf Creates a new caption element with formatted text content. Uses text.Textf which HTML-escapes the output. Example: caption.Textf("%s Accounts", "User") Renders: <caption>User Accounts</caption>

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