Documentation
¶
Overview ¶
Package figcaption provides constructors and methods for the HTML <figcaption> element.
The <figcaption> HTML element provides a caption or legend describing the content of its parent <figure> element. Should be the first or last child of the figure. Used to add descriptive text, credits, or explanatory information to images, diagrams, code listings, or other figure content. Improves accessibility and provides context for visual or illustrative content.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TagOpen = []byte("<figcaption") TagClose = []byte("</figcaption>") )
Byte constants for HTML rendering.
Functions ¶
func New ¶
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 ¶
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>
Source Files