Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show combined element attributes & properties #125

Open
samuelli opened this issue May 11, 2017 · 2 comments
Open

Show combined element attributes & properties #125

samuelli opened this issue May 11, 2017 · 2 comments

Comments

@samuelli
Copy link
Contributor

samuelli commented May 11, 2017

Currently only properties are shown. This is fine for Polymer use cases, where all attributes are propagated as properties. However, analyzer supports vanilla custom elements, for which attributes are properties are distinct.

Attributes are picked up by analyzer. Sample source of observedAttributes.
https://github.com/samuelli/progress-bar/blob/ab8acaa186da2377a20b3e5f6f3b0501a8921dcc/progress-bar.html#L90
But iron-doc-element does not display the attribute: https://www.webcomponents.org/element/samuelli/progress-bar/v2.0.0

I propose that we show a list as follows:


Attributes & properties

attribute-property (HTML attribute) This is an attribute which is also a property
attributeProperty (JS property)

my-attribute (HTML attribute) This is just an attribute not found in properties

myProperty (JS property) This is just a property not found in attributes


The "HTML attribute" and "JS property" could just be shortened to "HTML" and "JS" and could be displayed as little tags like MDN does.
image
image

We have seen related requests to show separate attribute/property annotations:

Another related issue previously was annotations were too subtle & we could utilise the same tag concept:
webcomponents/webcomponents.org#796

@samuelli
Copy link
Contributor Author

New related user report: webcomponents/webcomponents.org#965

@arthurevans
Copy link
Contributor

Would love to see HTML attr. names for props that have associated attributes. That's often a source of confusion. And there are some Polymer elements that use vanilla attributes. +100!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants