Skip to content

Commit

Permalink
Add LabelEl (#180)
Browse files Browse the repository at this point in the history
For consistency with the other name clashes. Also, adjust the readme.

I know it's a bit weird to add a pre-deprecated function, but know it's
the same as the other functions.
  • Loading branch information
markuswustenberg authored Jun 25, 2024
1 parent 1c0ceb4 commit a79e6d9
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,11 +145,12 @@ For more complete examples, see [the examples directory](examples/).

### What's up with the specially named elements and attributes?

Unfortunately, there are four main name clashes in HTML elements and attributes, so they need an `El` or `Attr` suffix,
Unfortunately, there are five main name clashes in HTML elements and attributes, so they need an `El` or `Attr` suffix,
to be able to co-exist in the same package in Go. I've chosen one or the other based on what I think is the common usage.
In either case, the less-used variant also exists in the codebase:

- `data` (`DataEl`/`Data`, `DataAttr` also exists)
- `form` (`Form`/`FormAttr`, `FormEl` also exists)
- `label` (`Label`/`LabelAttr`, `LabelEl` also exists)
- `style` (`StyleEl`/`Style`, `StyleAttr` also exists)
- `title` (`TitleEl`/`Title`, `TitleAttr` also exists)
5 changes: 5 additions & 0 deletions html/elements.go
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,11 @@ func Label(children ...g.Node) g.Node {
return g.El("label", children...)
}

// Deprecated: Use [Label] instead.
func LabelEl(children ...g.Node) g.Node {
return g.El("label", children...)
}

func Legend(children ...g.Node) g.Node {
return g.El("legend", children...)
}
Expand Down
1 change: 1 addition & 0 deletions html/elements_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ func TestSimpleElements(t *testing.T) {
{Name: "ins", Func: Ins},
{Name: "kbd", Func: Kbd},
{Name: "label", Func: Label},
{Name: "label", Func: LabelEl},
{Name: "legend", Func: Legend},
{Name: "li", Func: Li},
{Name: "main", Func: Main},
Expand Down

0 comments on commit a79e6d9

Please sign in to comment.