jquery / jquery/api.jquerymobile.com

Bad documentation for virtualized events

Open
#100 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
55
Forks
57
PR merge metrics
No merged PRs in 30d

Description

I am looking at the documentation for the vclick event handler and I am confused.

  • It says it simulates the "onclick" handler for mobile devices. Should it say "click" instead of "onclick"? In any case, why would I want to do that? I am using click handlers and they seem to work fine on the devices I tested them on.
  • It mentions something about "missing mouse event triggers". What does that mean? Are there devices that don't trigger mouse events for taps?
  • The source for the example binds an event to "vclick" that shows a message saying "vmouseup fired.", although when I try the example, it says "vclick fired.". That may simply be a typo.
  • The "vclick fired." text comes up twice every time I click. At least that is what happened when I tried it in Chrome and Firefox for OS X.

I think it is unclear as to what advantages "vclick" may have over "click" or "onclick".

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 vclick event handler documentation and its linked example. Check the onclick versus click wording, the explanation of missing mouse event triggers, the vmouseup example text, and the duplicate firing report; done means the page accurately explains vclick's purpose and corrects confirmed errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, jquery
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.