Opened 7 years ago

Closed 7 years ago

#8751 closed feature (notabug)

Poor docs regarding "events"

Reported by: collindo Owned by:
Priority: minor Milestone: 1.10.0
Component: ui.core Version: 1.9.1
Keywords: Cc:
Blocked by: Blocking:

Description

Looking specifically at sortable, but probably this affects all widgets.

You have very little documentation on "Events" in api.jqueryui.com. I can't find ANY examples as how to use them as an option, or as an event. I can't find an example anywhere on the internet that shows them being used as events.

I propose:

  • Include examples of how to use them
  • if they are able to be used as events:
    • include examples of how to use them as events
  • if they are not able to be used as events:
    • move them to the options list and call them "callbacks", not "events". They have nothing to do with DOM events so the language is confusing.

I apologize for my shortness, but this was extremely frustrating.

If this affects all widgets, then maybe it would be better to just change the "Events" heading above the events list into a link to some general documentation about how to use jqueryui "events".

Change History (1)

comment:1 Changed 7 years ago by Scott González

Resolution: notabug
Status: newclosed

We're working on this, but I'm closing as notabug because this is not the correct place for documentation bugs/features. In the future, please use http://github.com/jquery/api.jqueryui.com/issues.

Note: See TracTickets for help on using tickets.