aside

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 aside provides constructors and methods for the HTML <aside> element.

The <aside> HTML element represents a portion of a document whose content is only indirectly related to the document's main content. Asides are frequently presented as sidebars or call-out boxes. Common uses include related articles, glossaries, author bios, pull quotes, advertisements, or navigation groups. Content within an aside should be tangentially related to the surrounding content but able to stand alone.

Index

Constants

This section is empty.

Variables

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

Byte constants for HTML rendering.

Functions

func New

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

New creates a new aside element with the given child nodes. Example: aside.New() Renders: <aside></aside>

func RawText

func RawText(str string) *element

RawText creates a new aside element with raw text content. Uses text.RawText which is not HTML-escaped. Example: aside.RawText("<blockquote>A pull quote</blockquote>") Renders: <aside><blockquote>A pull quote</blockquote></aside>

func RawTextf

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

RawTextf creates a new aside element with formatted raw text content. Uses text.RawTextf which is not HTML-escaped. Example: aside.RawTextf("<p>By %s</p>", name) Renders: <aside><p>By Mary</p></aside>

func Static

func Static(str string) *element

Static creates a new aside element with static text content. Uses text.Static which is not HTML-escaped and is JIT-optimisable. Example: aside.Static("Did you know?") Renders: <aside>Did you know?</aside>

func Text

func Text(str string) *element

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

func Textf

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

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

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