address

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

The <address>: The Contact Address element indicates that the enclosed HTML provides contact information for a person or people, or for an organization. The contact information can take whatever form is appropriate for the context, and may include any type of contact information that is needed, such as a physical address, URL, email address, phone number, social media handle, geographic coordinates, and so forth.

Index

Constants

This section is empty.

Variables

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

Byte constants for HTML rendering.

Functions

func New

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

New creates a new address element without any initial attributes. Use for basic contact information where semantic markup is needed. Example: address.New() Renders: <address></address>

func RawText

func RawText(str string) *element

RawText creates a new address element with raw text content. Uses text.RawText which is not HTML-escaped. Example: address.RawText("Contact us at <em>info@example.com</em>") Renders: <address>Contact us at <em>info@example.com</em></address>

func RawTextf

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

RawTextf creates a new address element with formatted raw text content. Uses text.RawTextf which is not HTML-escaped. Example: address.RawTextf("<a href=\"mailto:%s\">%s</a>", email, email) Renders: <address><a href="mailto:mary@example.com">mary@example.com</a></address>

func Static

func Static(str string) *element

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

func Text

func Text(str string) *element

Text creates a new address element with text content. Uses text.Text which HTML-escapes the output. Example: address.Text("Contact us at info@example.com") Renders: <address>Contact us at info@example.com</address>

func Textf

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

Textf creates a new address element with formatted text content. Uses text.Textf which HTML-escapes the output. Example: address.Textf("Contact %s at %s", name, email) Renders: <address>Contact Mary at mary@example.com</address>

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