Document the behavior for camelCased plugins/events in the widget factory #182

Closed
FagnerMartinsBrack opened this Issue Oct 25, 2013 · 5 comments

Comments

Projects
None yet
3 participants

http://jsfiddle.net/UmacR/

It wasn't clear the behavior of camel cased events according to the jquery ui widget API documentation.
Of course it would be pretty crazy if jquery UI did not handled in some way (greatPluginexecuteEvent), but the current behavior to lowercase everything is not mentioned in the docs and is not as intuitive as you think it is.
To avoid looking into source I had to create a JSFiddle to check the behavior.

This is an information so simple that could be presented like:

Events

...For most widgets, when the events are triggered, the names are prefixed with the widget name and all converted to lowercase...

or something like that.

The given example in the page do not imply the current behavior, since both sides are built using a single word

By the way I assume this is supported and not just some implementation detail, looking for confirmation though.

Member

tjvantoll commented Oct 27, 2013

Yeah this is intentionally done and seems like a good idea to document.

Owner

jzaefferer commented Jan 21, 2014

@tjvantoll could you work on documenting this?

@tjvantoll tjvantoll added a commit to tjvantoll/api.jqueryui.com that referenced this issue Jan 22, 2014

@tjvantoll tjvantoll jQuery.widget: Document that widget event names are lowercased
Fixes gh-182
7838b9e
Member

tjvantoll commented Jan 22, 2014

Yes, I suppose a simple mention of the intent will do the trick.

tjvantoll closed this in 0f8f481 Jan 31, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment