about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authorMarkus Wüstenberg2024-06-06 12:43:15 +0200
committerGitHub2024-06-06 12:43:15 +0200
commit81b2d6a9e39ff8859400bfa806cb3e712049615c (patch)
treed986529c8f6cb462f61a1057f48f93230938a933 /README.md
parentd944acd39fd6c987ea3cdd57c2cec525e918425e (diff)
parent0b85f722038e0cc6cc7b66b7d0a704d845b614db (diff)
downloadgomponents-81b2d6a9e39ff8859400bfa806cb3e712049615c.tar.lz
gomponents-81b2d6a9e39ff8859400bfa806cb3e712049615c.tar.zst
gomponents-81b2d6a9e39ff8859400bfa806cb3e712049615c.zip
Deprecate DataAttr, StyleAttr, TitleAttr, FormEl (#174)
This change addresses #170 by deprecating some HTML helpers in favor of
using one of the styles as a main one, selected based on what I think is
the main use case.

- For `Data`, it's the attribute. I don't see much use of the `<data>`
element in the wild.
- For `Style`, it's the attribute. The `style` attribute is everywhere,
the `<style>` element is perhaps less so (but not much). This was the
hardest one to decide.
- For `Title`, it's the attribute. The `<title>` element only shows up
once per document.
- For `Form`, it's the element. I haven't seen much use of the `form`
attribute in the wild.

I know this is arguably not a "consistent" approach, but I think it
makes for a much nicer API, simply because the most-used option will not
be a suffixed version.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.md b/README.md
index ca84c7f..bef2fbf 100644
--- a/README.md
+++ b/README.md
@@ -146,9 +146,10 @@ 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,
-respectively, to be able to co-exist in the same package in Go:
+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`/`DataAttr`)
-- `form` (`FormEl`/`FormAttr`)
-- `style` (`StyleEl`/`StyleAttr`)
-- `title` (`TitleEl`/`TitleAttr`)
+- `data` (`DataEl`/`Data`, `DataAttr` also exists)
+- `form` (`Form`/`FormAttr`, `FormEl` also exists)
+- `style` (`StyleEl`/`Style`, `StyleAttr` also exists)
+- `title` (`TitleEl`/`Title`, `TitleAttr` also exists)