figcaption

package
v0.3.0 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("<figcaption")
	TagClose = []byte("</figcaption>")
)

Byte constants for HTML rendering.

Functions

func New

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

New Creates a new figcaption element with child nodes. Example: figcaption.New(text.Text("An elephant at sunset")) Renders: <figcaption>An elephant at sunset</figcaption>

func RawText

func RawText(str string) *element

RawText Creates a new figcaption element with raw text content. Uses text.RawText which is not HTML-escaped. Example: figcaption.RawText("Photo by <cite>Jane Doe</cite>") Renders: <figcaption>Photo by <cite>Jane Doe</cite></figcaption>

func RawTextf

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

RawTextf Creates a new figcaption element with formatted raw text content. Uses text.RawTextf which is not HTML-escaped. Example: figcaption.RawTextf("Photo by <cite>%s</cite>", photographer) Renders: <figcaption>Photo by <cite>Ansel Adams</cite></figcaption>

func Static

func Static(str string) *element

Static Creates a new figcaption element with static text content. Uses text.Static which is not HTML-escaped and is JIT-optimisable. Example: figcaption.Static("Figure 1: Architecture diagram") Renders: <figcaption>Figure 1: Architecture diagram</figcaption>

func Text

func Text(str string) *element

Text Creates a new figcaption element with text content. Uses text.Text which HTML-escapes the output. Example: figcaption.Text("An elephant at sunset") Renders: <figcaption>An elephant at sunset</figcaption>

func Textf

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

Textf Creates a new figcaption element with formatted text content. Uses text.Textf which HTML-escapes the output. Example: figcaption.Textf("Figure %d: %s", num, "Architecture") Renders: <figcaption>Figure 1: Architecture</figcaption>

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