iron-doc-viewer icon indicating copy to clipboard operation
iron-doc-viewer copied to clipboard

Surface the automatic events from notify properties more clearly

Open rictic opened this issue 10 years ago • 3 comments

Currently we add a little text annotation on notifyproperties. This is useful for power users who've used Polymer for a while, but I often see folks that want to listen for the automatically generated events but don't know what notify implies.

It'd be helpful for them if we added a tooltip or similar on the notify annotation and had a way to show auto generated events for users curious about them.

rictic avatar Aug 24 '15 20:08 rictic

+1 It would be super clear for auto generated events to be explicitly listed under the "Events" section of each element's API doc.

jmstriegel avatar Aug 24 '15 20:08 jmstriegel

We're already saying something like Default: false – readOnly – notifies for these properties, maybe it could be notifies foo-changed instead?

notwaldorf avatar Jan 28 '16 22:01 notwaldorf

I'm with @jmstriegel on this... People look in the Events section for events. The current system works fine for people who know the conventions, but for everyone else, it's just one more unnecessary mystery.

If there's no technical limitation, I'd go with adding them to Events and adding a "Hide generated events" button.

arthurevans avatar Apr 11 '16 20:04 arthurevans