Skip to content

Commit 6ef05ef

Browse files
keithamusmuan
andauthored
docs: drop note on "branding" in naming conventions
Co-authored-by: Mu-An 慕安 <me@muanchiou.com>
1 parent 461f8f0 commit 6ef05ef

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/_guide/conventions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class UserListElement extends HTMLElement {}
1616

1717
### The best class-names are two word descriptions
1818

19-
Custom elements are required to have a `-` inside the tag name. Catalyst's `@controller` will derive the tag name from the class name - and so as such the class name needs to have at least two capital letters, or to put it another way, it needs to consist of two words. It might be tempting to "brand" your component or otherwise add some kind of name space as one of the words - for example `paper-dropdown` or `iron-image`. We believe it's best to avoid branding your elements like this, and instead use this as an opportunity to describe what it does in two words. Some examples:
19+
Custom elements are required to have a `-` inside the tag name. Catalyst's `@controller` will derive the tag name from the class name - and so as such the class name needs to have at least two capital letters, or to put it another way, it needs to consist of two words. The element name should describe what it does succinctly in two words. Some examples:
2020

2121
- `theme-picker` (`class ThemePickerElement`)
2222
- `markdown-toolbar` (`class MarkdownToolbarElement`)

0 commit comments

Comments
 (0)