jquery / jquery/api.jqueryui.com

Document order of events and their default handlers

Open
#206 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
73
Forks
74
PR merge metrics
No merged PRs in 30d

Description

I would like to see the flow or order of events, and what each handler takes care of, documented.

I might for instance add a remove: function(e, ui) { e.preventDefault(); } to a Sortable’s options, and then not understand why that makes the stop/update events not fire when an item is dropped in a connected Sortable. In this case, it would be helpful to both know the order of events, and what remove’s handler normally takes care of, enabling me to recreate the parts of it I want, leaving the parts I don’t want behind (like messing up an item’s helper).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the jQuery UI Sortable API documentation and trace the remove, stop, and update events for connected Sortables. Document the event order and explain what each default handler takes care of, using the described preventDefault case to verify that the result answers the reported confusion.

Written by the indexing model from the issue text.

Assessment

Tech stack
jquery
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.