i

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

The <i>: The Idiomatic Text element represents a range of text that is set off from the normal text for some reason, such as idiomatic text, technical terms, taxonomical designations, among others. Historically, these have been presented using italicized type, which is the original source of the <i> naming of this element.

Index

Constants

This section is empty.

Variables

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

Byte constants for HTML rendering.

Functions

func New

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

New creates a new italic element with optional child nodes. Example: i.New() Renders: <i></i>

func RawText

func RawText(str string) *element

RawText creates a new i element with raw text content. Uses text.RawText which is not HTML-escaped. Example: i.RawText("<cite>The Origin of Species</cite>") Renders: <i><cite>The Origin of Species</cite></i>

func RawTextf

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

RawTextf creates a new i element with formatted raw text content. Uses text.RawTextf which is not HTML-escaped. Example: i.RawTextf("<cite>%s</cite>", headline) Renders: <i><cite>Breaking News</cite></i>

func Static

func Static(str string) *element

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

func Text

func Text(str string) *element

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

func Textf

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

Textf creates a new i element with formatted text content. Uses text.Textf which HTML-escapes the output. Example: i.Textf("%s sapiens", genus) Renders: <i>Homo sapiens</i>

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