Ticket #2340 (closed bug: fixed)

Opened 3 years ago

Last modified 8 months ago

[UI] Dispatched Events

Reported by: scott.gonzalez Owned by: scott.gonzalez
Priority: blocker Milestone: 1.5.1
Component: ui.core Version: 1.5
Keywords: ui event Cc:

Description

There are currently three models being used for dispatching events in the UI plugins.

accordion: 

$(el).triggerHandler('<action>.ui-<plugin>', [ui], callback);

dialog, draggable, droppable, resizable, selectable, slider, sortable 

$(el).triggerHandler('<plugin><action>', [e, ui], callback);

tabs: 

$(el).triggerHandler('<action>.ui-<plugin>', [ui]);

The accordion and tabs models are both missing the event object in the data parameter. The tabs model is also missing the callback.

However, it is unclear which event naming convention should be used. The more widely used "<plugin><action>" convention seems more likely to avoid collisions with other event names. However, the "<action>.ui-<plugin>" convention provides the convenience of having user-defined events be cleaned up if the plugin's destroy method is called.

Change History

Changed 3 years ago by joern

Unless you actually need to provide a custom event object - for whatever reason - there is no point in passing one in.

Passing in the callback has now obvious drawbacks, that should be easy to fix for tabs.

Not sure about the namespace though.

Changed 3 years ago by scott.gonzalez

You're right about not needing to pass in the event object. I forgot that the parameters passed to the event handler will still be (event, ui) regardless of whether the plugin passes an event object in the data. My concern was only that the user would have different parameters to work with depending on the plugin (apparently I didn't think it through far enough).

Changed 3 years ago by paul

Yes, we should definitely make sure we have one convention for naming the custom events. From a semantical view, I would prefer <plugin><action>.

However, I right now tend to go with the dot, since it feels more like it was intended.

Changed 3 years ago by paul

  • status changed from new to assigned

Changed 3 years ago by scott.gonzalez

Recent thoughts on why <plugin><action> might be better than <action>.ui-<plugin>:

1) Event names may overlap with real events. For instance, "slidechange" would become "change.ui-slider" which could end up being triggered from some other change event.

2) If someone develops widgets that rely on jQuery UI plugins, they may want to hook into the events and use their own namespace (to make cleanup easier). This will only be possible if the triggered events are not namespaced.

Changed 2 years ago by paul

  • owner changed from paul to scott.gonzalez
  • status changed from assigned to new

Scott, I vote for <plugin><action>. I've assigned it to you - could you work on this later on in every plugin?

Changed 2 years ago by scott.gonzalez

  • status changed from new to assigned

Accordion is fixed in [4912].

Changed 2 years ago by scott.gonzalez

Tabs updated in [4956] - Thanks Klaus.

Changed 2 years ago by scott.gonzalez

  • status changed from assigned to closed
  • resolution set to fixed

datepicker currently has no events

Changed 2 years ago by anonymous

  • milestone 1.2.4 deleted

Milestone 1.2.4 deleted

Changed 2 years ago by scott.gonzalez

  • priority changed from major to critical
  • status changed from closed to reopened
  • version changed from 1.2.3 to 1.5b4
  • resolution fixed deleted
  • milestone set to 1.5.1

Not all plugins pass the ui parameter as the second parameter in the callback.

Changed 2 years ago by rdworth

  • priority changed from critical to blocker

Changed 2 years ago by scott.gonzalez

  • status changed from reopened to closed
  • resolution set to fixed

Fixed in [342].

Tabs should be reviewed to see if there are meaningful events that can be passed instead of null. Accordion should be reviewed to determine if a fake event should be passed instead of null.

Changed 2 years ago by rdworth

  • version changed from 1.5b4 to 1.5
Note: See TracTickets for help on using tickets.