core/go-html
8
0
Fork 0
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity Actions

docs(html): align public API docs with AX principles
Some checks are pending
Security Scan / security (push) Waiting to run
Details
Test / test (push) Waiting to run
Details

Browse source 
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
Virgil 2026-04-03 18:53:50 +00:00
parent 7b95c1fc74
commit 1958cc79b1
3 changed files with 17 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
codegen/codegen.go
View file

@ -56,7 +56,7 @@ var wcTemplate = template.Must(template.New("wc").Parse(`class {{.ClassName}} ex
}
}`))
// GenerateClass produces a JS class definition for a custom element.
// codegen/codegen.go: GenerateClass produces a JS class definition for a custom element.
//
// cls, err := GenerateClass("nav-bar", "H")
func GenerateClass(tag, slot string) (string, error) {
@ -77,14 +77,14 @@ func GenerateClass(tag, slot string) (string, error) {
return b.String(), nil
}
// GenerateRegistration produces the customElements.define() call.
// codegen/codegen.go: GenerateRegistration produces the customElements.define() call.
//
// js := GenerateRegistration("nav-bar", "NavBar")
func GenerateRegistration(tag, className string) string {
return fmt.Sprintf(`customElements.define("%s", %s);`, tag, className)
}
// TagToClassName converts a kebab-case tag to PascalCase class name.
// codegen/codegen.go: TagToClassName converts a kebab-case tag to PascalCase class name.
//
// className := TagToClassName("nav-bar") // NavBar
func TagToClassName(tag string) string {
@ -98,7 +98,7 @@ func TagToClassName(tag string) string {
return b.String()
}
// GenerateBundle produces all WC class definitions and registrations
// codegen/codegen.go: GenerateBundle produces all WC class definitions and registrations
// for a set of HLCRF slot assignments.
//
// js, err := GenerateBundle(map[string]string{"H":"nav-bar", "C":"main-content"})
@ -118,7 +118,7 @@ func GenerateBundle(slots map[string]string) (string, error) {
return b.String(), nil
}
// GenerateTypeDefinitions produces a TypeScript declaration file for the
// codegen/codegen.go: GenerateTypeDefinitions produces a TypeScript declaration file for the
// generated custom elements.
//
// dts, err := GenerateTypeDefinitions(map[string]string{"H":"nav-bar"})

15
layout.go
View file

@ -71,31 +71,36 @@ func ValidateLayoutVariant(variant string) error {
return &layoutVariantError{variant: variant, invalidSlots: invalidSlots}
}
// H appends nodes to the Header slot.
// layout.go: H appends nodes to the Header slot.
// Example: NewLayout("HCF").H(Raw("head")).
func (l *Layout) H(nodes ...Node) *Layout {
l.slots['H'] = append(l.slots['H'], nodes...)
return l
}
// L appends nodes to the Left aside slot.
// layout.go: L appends nodes to the Left aside slot.
// Example: NewLayout("HLCRF").L(Raw("nav")).
func (l *Layout) L(nodes ...Node) *Layout {
l.slots['L'] = append(l.slots['L'], nodes...)
return l
}
// C appends nodes to the Content (main) slot.
// layout.go: C appends nodes to the Content (main) slot.
// Example: NewLayout("C").C(Raw("body")).
func (l *Layout) C(nodes ...Node) *Layout {
l.slots['C'] = append(l.slots['C'], nodes...)
return l
}
// R appends nodes to the Right aside slot.
// layout.go: R appends nodes to the Right aside slot.
// Example: NewLayout("HLCRF").R(Raw("aside")).
func (l *Layout) R(nodes ...Node) *Layout {
l.slots['R'] = append(l.slots['R'], nodes...)
return l
}
// F appends nodes to the Footer slot.
// layout.go: F appends nodes to the Footer slot.
// Example: NewLayout("HCF").F(Raw("foot")).
func (l *Layout) F(nodes ...Node) *Layout {
l.slots['F'] = append(l.slots['F'], nodes...)
return l

3
node.go
View file

@ -267,8 +267,9 @@ func Alt(n Node, text string) Node {
return Attr(n, "alt", text)
}
// node.go: AltText sets the alt attribute on an element node.
// node.go: AltText is a compatibility alias for Alt.
// Example: AltText(El("img"), "Product screenshot").
// Prefer Alt for new call sites so the canonical image helper stays predictable.
func AltText(n Node, text string) Node {
return Alt(n, text)
}