Prefix event should be documented on website

[frediana]

Hi,

The following widgets have an event prefix diferrent than the widget's name. This seems undocumented on the website and in my opinion should be.

ui/jquery.ui.draggable.js: widgetEventPrefix: "drag",
ui/jquery.ui.droppable.js: widgetEventPrefix: "drop",
ui/jquery.ui.resizable.js: widgetEventPrefix: "resize",
ui/jquery.ui.slider.js: widgetEventPrefix: "slide",
ui/jquery.ui.sortable.js: widgetEventPrefix: "sort",
ui/jquery.ui.spinner.js: widgetEventPrefix: "spin",

For example for the slider, how a user knows he have to bind on 'slidestop' event instead of 'sliderstop'.
Some other widgets doesn't use this widgetEventPrefix and widget's name is used as a prefix, this is confusing to me.

So maybe would be a good to have 'event prefix' section on each widget doc (on the event section)?

Just an idea..

[scottgonzalez]

We shouldn't document the prefix separately, the events need to include the event name.

[frediana]

OK so I could I present this, does the following structure would suits to you?

stop( event, ui )

Event name: slidestop

Triggered after the user slides a handle.

• event
  Type: Event
• ui
  Type: Object

[scottgonzalez]

Yeah, that looks good to me. I'm always nervous that people will be confused by the two names, but this is almost exactly what we had on the old site, and I don't remember getting complaints about that.

[scottgonzalez]

I just landed an implementation of this. This will go out with the next site deployment. In the meantime, you can see it by going to http://stage.api.jqueryui.com/