dot

package
v0.3.0-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 7, 2026 License: MIT Imports: 115 Imported by: 0

Documentation

Overview

Package dot provides convenience wrappers for fluent HTML element constructors.

This package is designed to be used with Go's dot import feature, allowing you to write HTML generation code without package prefixes: 

import (
    . "github.com/jpl-au/fluent/dot"
    "github.com/jpl-au/fluent/html5/meta"
)

func render() node.Node {
    return Html(
        Head(
            meta.UTF8(),
            Title().Text("My Page"),
            Style().RawText("body { font-family: sans-serif; }"),
        ),
        Body(
            Div(
                H1().Text("Welcome"),
                P().Text("Hello, world!"),
            ).Class("container"),
        ),
    )
}

Function Naming

Each HTML element has a wrapper function matching its tag name:

  • Div(children ...node.Node) - creates a <div> element
  • H1(children ...node.Node) - creates an <h1> element
  • etc.

Specialised constructors (like meta.UTF8()) require importing the element package directly.

Adding Content

Use the .Text() method chain to add text content: 

P().Text("Hello, world!")
H1().Class("title").Text("Welcome")
Style().RawText("body { color: red; }")

Content methods available:

  • .Text(s) - adds escaped text content
  • .Textf(format, args...) - adds formatted escaped text
  • .Static(s) - adds static text (JIT-optimisable)
  • .RawText(s) - adds unescaped HTML content
  • .RawTextf(format, args...) - adds formatted unescaped HTML

Alternative: Package Imports

If you prefer explicit package prefixes, import element packages directly: 

import "github.com/jpl-au/fluent/html5/div"

el := div.New().Class("container").Text("Hello")

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func A 

func A(nodes ...node.Node) *a.Element

A Creates a new anchor element without any initial attributes. Example: a.New(text.Text("Click here")).Href("https://example.com") Renders: <a href="https://example.com">Click here</a>

func Abbr 

func Abbr(nodes ...node.Node) *abbr.Element

Abbr Creates a new abbreviation element without any initial attributes. Use for basic abbreviations where semantic markup is needed. Example: abbr.New() Renders: <abbr></abbr>

func Address 

func Address(nodes ...node.Node) *address.Element

Address 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 Area 

func Area() *area.Element

Area Creates a new area element without any initial attributes. Example: area.New() Renders: <area />

func Article 

func Article(nodes ...node.Node) *article.Element

Article Creates a new article element with optional child nodes Example: article.New() Renders: <article></article>

func Aside 

func Aside(nodes ...node.Node) *aside.Element

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

func Audio 

func Audio(nodes ...node.Node) *audio.Element

Audio Creates a new audio element without any initial attributes. Example: audio.New() Renders: <audio></audio>

func B 

func B(nodes ...node.Node) *b.Element

B Creates a new b element with the given child nodes. Example: b.New(text.Text("This text is important.")) Renders: <b>This text is important.</b>

func Base 

func Base() *base.Element

Base Creates a new base element without any initial attributes. Example: base.New().Href("/docs/") Renders: <base href="/docs/" />

func Bdi 

func Bdi(nodes ...node.Node) *bdi.Element

Bdi Creates a new bdi element with the given child nodes. Example: bdi.New(text.Text("username")) Renders: <bdi>username</bdi>

func Bdo 

func Bdo(nodes ...node.Node) *bdo.Element

Bdo Creates a new bdo element with child nodes. Example: bdo.New(text.Text("Hello")) Renders: <bdo>Hello</bdo>

func Blockquote 

func Blockquote(nodes ...node.Node) *blockquote.Element

Blockquote Creates a new blockquote element with the given child nodes. Example: blockquote.New(p.Text("To be or not to be.")) Renders: <blockquote><p>To be or not to be.</p></blockquote>

func Body 

func Body(nodes ...node.Node) *body.Element

Body Creates a new body element with the given child nodes. Example: body.New(p.New(text.Text("Hello, World!"))) Renders: <body><p>Hello, World!</p></body>

func Br 

func Br() *br.Element

Br Creates a new br element without any initial attributes. Example: br.New() Renders: <br />

func Button 

func Button(nodes ...node.Node) *button.Element

Button Creates a new button element with the given child nodes. Example: button.New(text.Text("Click Me")) Renders: <button>Click Me</button>

func Canvas 

func Canvas(nodes ...node.Node) *canvas.Element

Canvas Creates a new canvas element with child nodes for fallback content. Example: canvas.New(text.Text("Your browser does not support canvas.")) Renders: <canvas>Your browser does not support canvas.</canvas>

func Caption 

func Caption(nodes ...node.Node) *caption.Element

Caption Creates a new caption element with the given child nodes. Example: caption.New(text.Text("My Table Caption")) Renders: <caption>My Table Caption</caption>

func Cite 

func Cite(nodes ...node.Node) *cite.Element

Cite Creates a new cite element with the given child nodes. Example: cite.New(text.Text("Nineteen Eighty-Four")) Renders: <cite>Nineteen Eighty-Four</cite>

func Code 

func Code(nodes ...node.Node) *code.Element

Code Creates a new code element with the given child nodes. Example: code.New(text.Text("console.log('Hello, World!');")) Renders: <code>console.log('Hello, World!');</code>

func Col 

func Col() *col.Element

Col Creates a new col element without any initial attributes. Example: col.New() Renders: <col />

func Colgroup 

func Colgroup(nodes ...node.Node) *colgroup.Element

Colgroup Creates a new colgroup element with the given child nodes (typically <col> elements). Example: colgroup.New(col.New(), col.Span(2)) Renders: <colgroup><col /><col span="2" /></colgroup>

func Data 

func Data(nodes ...node.Node) *data.Element

Data Creates a new data element with the given child nodes. Example: data.New(text.Text("Mini Ketchup")) Renders: <data>Mini Ketchup</data>

func Datalist 

func Datalist(nodes ...node.Node) *datalist.Element

Datalist Creates a new datalist element with child nodes (typically <option> elements). Example: datalist.New(option.New().Value("Chocolate"), option.New().Value("Vanilla")) Renders: <datalist><option value="Chocolate"><option value="Vanilla"></datalist>

func Dd 

func Dd(nodes ...node.Node) *dd.Element

Dd Creates a new dd element with child nodes. Example: dd.New(text.Text("A large feline inhabiting Bodmin Moor.")) Renders: <dd>A large feline inhabiting Bodmin Moor.</dd>

func Del 

func Del(nodes ...node.Node) *del.Element

Del Creates a new del element with optional child nodes. Example: del.New() Renders: <del></del>

func Details 

func Details(nodes ...node.Node) *details.Element

Details Creates a new details element with the given child nodes. Example: details.New(summary.Text("Details"), p.Text("Hidden content")) Renders: <details><summary>Details</summary><p>Hidden content</p></details>

func Dfn 

func Dfn(nodes ...node.Node) *dfn.Element

Dfn Creates a new dfn element with the given child nodes. Example: dfn.New(text.Text("validator")) Renders: <dfn>validator</dfn>

func Dialog 

func Dialog(nodes ...node.Node) *dialog.Element

Dialog Creates a new dialog element with the given child nodes. Example: dialog.New(p.Text("Greetings, one and all!")) Renders: <dialog><p>Greetings, one and all!</p></dialog>

func Div 

func Div(nodes ...node.Node) *div.Element

Div Creates a new div element with child nodes. Example: div.New(p.New(text.Text("Any kind of content here."))) Renders: <div><p>Any kind of content here.</p></div>

func Dl 

func Dl(nodes ...node.Node) *dl.Element

Dl Creates a new dl element with the given child nodes (typically <dt> and <dd> elements). Example: dl.New(dt.New(text.Text("Term")), dd.New(text.Text("Description"))) Renders: <dl><dt>Term</dt><dd>Description</dd></dl> 

func Dropdown(nodes ...node.Node) *dropdown.Element

Dropdown Creates a new select element with option and optgroup child elements. Example: dropdown.New(option.Option("Red", "red"), option.Option("Blue", "blue")) Renders: <select><option value="red">Red</option><option value="blue">Blue</option></select>

func Dt 

func Dt(nodes ...node.Node) *dt.Element

Dt Creates a new dt element with the given child nodes. Example: dt.New(text.Text("Term")) Renders: <dt>Term</dt>

func Em 

func Em(nodes ...node.Node) *em.Element

Em Creates a new em element with the given child nodes. Example: em.New(text.Text("now")) Renders: <em>now</em>

func Embed 

func Embed() *embed.Element

Embed Creates a new embed element without any initial attributes. Example: embed.New() Renders: <embed />

func Fieldset 

func Fieldset(nodes ...node.Node) *fieldset.Element

Fieldset Creates a new fieldset element with child nodes. Example: fieldset.New(legend.Text("Personal details"), input.Text("name", "")) Renders: <fieldset><legend>Personal details</legend><input name="name" type="text" /></fieldset>

func Figcaption 

func Figcaption(nodes ...node.Node) *figcaption.Element

Figcaption 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 Figure 

func Figure(nodes ...node.Node) *figure.Element

Figure Creates a new figure element with the given child nodes. Example: figure.New(img.New().Src("elephant.jpg"), figcaption.New(text.Text("An elephant at sunset"))) Renders: <figure><img src="elephant.jpg" /><figcaption>An elephant at sunset</figcaption></figure> 

func Footer(nodes ...node.Node) *footer.Element

Footer Creates a new footer element with the given child nodes. Example: footer.New(p.New(text.Text("Copyright 2023 My Website"))) Renders: <footer><p>Copyright 2023 My Website</p></footer>

func Form 

func Form(nodes ...node.Node) *form.Element

Form Creates a new form element with child nodes. Example: form.New(input.Text("name", ""), button.Submit("Send")) Renders: <form><input name="name" type="text" /><button type="submit">Send</button></form>

func H1 

func H1(nodes ...node.Node) *h1.Element

H1 Creates a new h1 element with the given child nodes. Example: h1.New(text.Text("Page Title")) Renders: <h1>Page Title</h1>

func H2 

func H2(nodes ...node.Node) *h2.Element

H2 Creates a new h2 element with the given child nodes. Example: h2.New(text.Text("Section Title")) Renders: <h2>Section Title</h2>

func H3 

func H3(nodes ...node.Node) *h3.Element

H3 Creates a new h3 element with the given child nodes. Example: h3.New(text.Text("Subsection Title")) Renders: <h3>Subsection Title</h3>

func H4 

func H4(nodes ...node.Node) *h4.Element

H4 Creates a new h4 element with the given child nodes. Example: h4.New(text.Text("Detailed Point")) Renders: <h4>Detailed Point</h4>

func H5 

func H5(nodes ...node.Node) *h5.Element

H5 Creates a new h5 element with the given child nodes. Example: h5.New(text.Text("Sub-point")) Renders: <h5>Sub-point</h5>

func H6 

func H6(nodes ...node.Node) *h6.Element

H6 Creates a new h6 element with the given child nodes. Example: h6.New(text.Text("Footnote Title")) Renders: <h6>Footnote Title</h6> 

func Head(nodes ...node.Node) *head.Element

Head Creates a new head element with the given child nodes (metadata content). Example: head.New(title.New(text.Text("My Page")), meta.Charset("UTF-8")) Renders: <head><title>My Page</title><meta charset="UTF-8" /></head> 

func Header(nodes ...node.Node) *header.Element

Header Creates a new header element with the given child nodes. Example: header.New(h1.Text("Welcome"), p.Text("A brief introduction")) Renders: <header><h1>Welcome</h1><p>A brief introduction</p></header>

func Hgroup 

func Hgroup(nodes ...node.Node) *hgroup.Element

Hgroup Creates a new hgroup element with child nodes (typically a heading and subtitle paragraphs). Example: hgroup.New(h1.Text("Main Title"), p.Text("A subtitle")) Renders: <hgroup><h1>Main Title</h1><p>A subtitle</p></hgroup>

func Hr 

func Hr() *hr.Element

Hr Creates a new hr element without any initial attributes. Example: hr.New() Renders: <hr />

func Html 

func Html(nodes ...node.Node) *html.Element

Html Creates a complete HTML5 document with DOCTYPE declaration Example: html.New() Renders: <!DOCTYPE html><html></html>

func I 

func I(nodes ...node.Node) *i.Element

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

func Iframe 

func Iframe(nodes ...node.Node) *iframe.Element

Iframe Creates a new iframe element with optional fallback content. Example: iframe.New().Src("/page.html") Renders: <iframe src="/page.html"></iframe>

func Imagemap 

func Imagemap(nodes ...node.Node) *imagemap.Element

Imagemap Creates a new map element with optional child nodes (typically area elements). Example: imagemap.New(area.Rect(0, 0, 100, 50, "/page1")) Renders: <map><area shape="rect" coords="0,0,100,50" href="/page1" /></map>

func Img 

func Img() *img.Element

Img Creates a new img element without any initial attributes. Example: img.New().Src("photo.jpg").Alt("A beautiful sunset") Renders: <img src="photo.jpg" alt="A beautiful sunset" />

func Input 

func Input() *input.Element

Input Creates a new input element without any initial attributes. Example: input.New().Type(inputtype.Text).Name("username") Renders: <input name="username" type="text" />

func Ins 

func Ins(nodes ...node.Node) *ins.Element

Ins Creates a new ins element with optional child nodes. Example: ins.New() Renders: <ins></ins>

func Kbd 

func Kbd(nodes ...node.Node) *kbd.Element

Kbd Creates a new kbd element with optional child nodes. Example: kbd.New() Renders: <kbd></kbd>

func Label 

func Label(nodes ...node.Node) *label.Element

Label Creates a new label element with child nodes. Example: label.New() Renders: <label></label>

func Legend 

func Legend(nodes ...node.Node) *legend.Element

Legend Creates a new legend element with optional child nodes. Example: legend.New() Renders: <legend></legend>

func Li 

func Li(nodes ...node.Node) *li.Element

Li Creates a new list item element with optional child nodes. Example: li.New() Renders: <li></li> 

func Link() *link.Element

Link Creates a new link element without any initial attributes. Example: link.New() Renders: <link />

func Mark 

func Mark(nodes ...node.Node) *mark.Element

Mark Creates a new mark element with the given child nodes. Example: mark.New(text.Text("highlighted text")) Renders: <mark>highlighted text</mark>

func Math 

func Math(nodes ...node.Node) *math.Element

Math Creates a new math element with optional child nodes. Example: math.New() Renders: <math></math> 

func Menu(nodes ...node.Node) *menu.Element

Menu Creates a new menu element with child li elements. Example: menu.New(li.Text("Cut"), li.Text("Copy"), li.Text("Paste")) Renders: <menu><li>Cut</li><li>Copy</li><li>Paste</li></menu>

func Meta 

func Meta() *meta.Element

Meta Creates a new meta element without any initial attributes. Example: meta.New() Renders: <meta />

func Meter 

func Meter(nodes ...node.Node) *meter.Element

Meter Creates a new meter element with optional child nodes Example: meter.New() Renders: <meter></meter> 

func Nav(nodes ...node.Node) *nav.Element

Nav Creates a new nav element with optional child nodes Example: nav.New() Renders: <nav></nav>

func Noscript 

func Noscript(nodes ...node.Node) *noscript.Element

Noscript Creates a new noscript element with optional child nodes Example: noscript.New() Renders: <noscript></noscript>

func Object 

func Object(nodes ...node.Node) *object.Element

Object Creates a new object element with optional child nodes Example: object.New() Renders: <object></object>

func Ol 

func Ol(nodes ...node.Node) *ol.Element

Ol Creates a new ordered list element with optional child nodes (typically li elements) Example: ol.New() Renders: <ol></ol>

func Optgroup 

func Optgroup(nodes ...node.Node) *optgroup.Element

Optgroup Creates a new optgroup element with child option elements. Example: optgroup.New(option.Option("red", "Red"), option.Option("blue", "Blue")).Label("Colours") Renders: <optgroup label="Colours"><option value="red">Red</option><option value="blue">Blue</option></optgroup>

func Option 

func Option(nodes ...node.Node) *option.Element

Option Creates a new option element with optional child nodes Example: option.New() Renders: <option></option>

func Output 

func Output(nodes ...node.Node) *output.Element

Output Creates a new output element with optional child nodes Example: output.New() Renders: <output></output>

func P 

func P(nodes ...node.Node) *p.Element

P Creates a new paragraph element with optional child nodes Example: p.New(text.Text("Hello")) Renders: <p>Hello</p>

func Picture 

func Picture(nodes ...node.Node) *picture.Element

Picture Creates a new picture element with source and img child elements. Example: picture.New(source.ImageWebP("photo.webp"), img.Src("photo.jpg")) Renders: <picture><source srcset="photo.webp" type="image/webp"><img src="photo.jpg"></picture>

func Pre 

func Pre(nodes ...node.Node) *pre.Element

Pre Creates a new pre element with the given child nodes Example: pre.New(text.Text("Code")) Renders: <pre>Code</pre>

func Primary 

func Primary(nodes ...node.Node) *primary.Element

Primary Creates a new main element with optional child nodes Example: primary.New() Renders: <main></main>

func Progress 

func Progress(nodes ...node.Node) *progress.Element

Progress Creates a new progress element with optional child nodes for fallback content. Example: progress.New() Renders: <progress></progress>

func Q 

func Q(nodes ...node.Node) *q.Element

Q Creates a new q element with optional child nodes. Example: q.New(text.Text("To be or not to be")) Renders: <q>To be or not to be</q>

func Rp 

func Rp(nodes ...node.Node) *rp.Element

Rp Creates a new rp element with optional child nodes. Example: rp.New(text.Text("(")) Renders: <rp>(</rp>

func Rt 

func Rt(nodes ...node.Node) *rt.Element

Rt Creates a new rt element with optional child nodes Example: rt.New(text.Text("kan")) Renders: <rt>kan</rt>

func Ruby 

func Ruby(nodes ...node.Node) *ruby.Element

Ruby Creates a new ruby element with optional child nodes Example: ruby.New(text.Text("漢字")) Renders: <ruby>漢字</ruby>

func S 

func S(nodes ...node.Node) *s.Element

S Creates a new s element with optional child nodes. Examples: s.New() renders <s></s> s.New(text.Text("Old price: $100")) renders <s>Old price: $100</s>

func Samp 

func Samp(nodes ...node.Node) *samp.Element

Samp Creates a new samp element with optional child nodes Example: samp.New(text.Text("Output")) Renders: <samp>Output</samp>

func Script 

func Script(nodes ...node.Node) *script.Element

Script Creates a new script element without any initial attributes Example: script.New() Renders: <script></script> 

func Search(nodes ...node.Node) *search.Element

Search Creates a new search element with optional child nodes Example: search.New() Renders: <search></search>

func Section 

func Section(nodes ...node.Node) *section.Element

Section Creates a new section element with optional child nodes Example: section.New() Renders: <section></section>

func Slot 

func Slot(nodes ...node.Node) *slot.Element

Slot Creates a new slot element with optional child nodes. Example: slot.New() Renders: <slot></slot>

func Small 

func Small(nodes ...node.Node) *small.Element

Small Creates a new small element with the given child nodes. Example: small.New(text.Text("© 2024 Company Name")) Renders: <small>© 2024 Company Name</small>

func Source 

func Source() *source.Element

Source Creates a new source element without any initial attributes. Example: source.New().Src("image.webp").Type("image/webp") Renders: <source src="image.webp" type="image/webp" />

func Span 

func Span(nodes ...node.Node) *span.Element

Span Creates a new span element with optional child nodes. Example: span.New() Renders: <span></span>

func Strong 

func Strong(nodes ...node.Node) *strong.Element

Strong Creates a new strong element with optional child nodes. Example: strong.New() Renders: <strong></strong>

func Style 

func Style(nodes ...node.Node) *style.Element

Style Creates a new style element without any initial attributes. Example: style.New() Renders: <style></style>

func Sub 

func Sub(nodes ...node.Node) *sub.Element

Sub Creates a new sub element with the given child nodes. Example: sub.New(text.Text("2")) Renders: <sub>2</sub>

func Summary 

func Summary(nodes ...node.Node) *summary.Element

Summary Creates a new summary element with optional child nodes. Example: summary.New() Renders: <summary></summary>

func Sup 

func Sup(nodes ...node.Node) *sup.Element

Sup Creates a new sup element with the given child nodes. Example: sup.New(text.Text("2")) Renders: <sup>2</sup>

func Svg 

func Svg(nodes ...node.Node) *svg.Element

Svg Creates a new svg element with child SVG elements. Example: svg.New().Width("100").Height("100").ViewBox("0 0 100 100") Renders: <svg width="100" height="100" viewBox="0 0 100 100"></svg>

func Table 

func Table(nodes ...node.Node) *table.Element

Table Creates a new table element with optional child nodes (typically thead, tbody, tfoot, tr elements). Example: table.New() Renders: <table></table>

func Tbody 

func Tbody(nodes ...node.Node) *tbody.Element

Tbody Creates a new tbody element with child tr elements. Example: tbody.New(tr.New(td.Text("cell"))) Renders: <tbody><tr><td>cell</td></tr></tbody>

func Td 

func Td(nodes ...node.Node) *td.Element

Td Creates a new table data cell element with optional child nodes. Example: td.New() Renders: <td></td>

func Template 

func Template(nodes ...node.Node) *template.Element

Template Creates a new template element with child nodes. Content is not rendered directly but can be instantiated at runtime using JavaScript. Example: template.New() Renders: <template></template>

func Textarea 

func Textarea(nodes ...node.Node) *textarea.Element

Textarea Creates a new textarea element with optional child nodes Example: textarea.New() Renders: <textarea></textarea>

func Tfoot 

func Tfoot(nodes ...node.Node) *tfoot.Element

Tfoot Creates a new tfoot element with child tr elements. Example: tfoot.New(tr.New(td.Text("Total"), td.Text("100"))) Renders: <tfoot><tr><td>Total</td><td>100</td></tr></tfoot>

func Th 

func Th(nodes ...node.Node) *th.Element

Th Creates a new th element with optional child nodes. Example: th.New() Renders: <th></th>

func Thead 

func Thead(nodes ...node.Node) *thead.Element

Thead Creates a new thead element with child tr elements. Example: thead.New(tr.New(th.Text("Name"), th.Text("Age"))) Renders: <thead><tr><th>Name</th><th>Age</th></tr></thead>

func Time 

func Time(nodes ...node.Node) *time.Element

Time Creates a new time element with optional child nodes Example: time.New() Renders: <time></time>

func Title 

func Title(nodes ...node.Node) *title.Element

Title Creates a new title element with text content Example: title.New() Renders: <title></title>

func Tr 

func Tr(nodes ...node.Node) *tr.Element

Tr Creates a new table row element with optional child nodes (typically td or th elements). Example: tr.New() Renders: <tr></tr>

func Track 

func Track() *track.Element

Track Creates a new track element without any initial attributes. Example: track.New() Renders: <track />

func U 

func U(nodes ...node.Node) *u.Element

U Creates a new u element with the given child nodes. Example: u.New(text.Text("misspelled"))

func Ul 

func Ul(nodes ...node.Node) *ul.Element

Ul Creates a new unordered list element with optional child nodes (typically li elements). Example: ul.New() Renders: <ul></ul>

func Variable 

func Variable(nodes ...node.Node) *variable.Element

Variable Creates a new var element with optional child nodes. Example: variable.New() Renders: <var></var>

func Video 

func Video(nodes ...node.Node) *video.Element

Video Creates a new video element with optional child nodes Example: video.New() Renders: <video></video>

func Wbr 

func Wbr() *wbr.Element

Wbr Creates a new wbr element without any initial attributes. Example: wbr.New() Renders: <wbr />

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.