Documentation of Mouse Interaction is very incomplete, somehow confusing, and lacks examples

Ouverte
  • Quelque chose ne va pas ?
#209 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
javascript, jquery
Domaine
documentation

Piste de recherche

Commencez par la page de l’API d’interaction avec la souris à l’adresse http://api.jqueryui.com/mouse/ et examinez les entrées _mouseCapture, _mouseStart, _mouseDrag et _mouseStop ainsi que leurs exemples existants. Le travail sera considéré comme terminé lorsque la manière dont les auteurs de widgets implémentent ces hooks sera clarifiée, que les arguments des événements seront documentés et que les exemples limités à des appels seront remplacés par des exemples d’implémentation utiles ou par une section de démonstration liée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

http://api.jqueryui.com/mouse/

This part of the documentation needs serious improvement, and/or a corresponding dedicated section in Demos, which does not exist.

  1. (this applies to several methods but I take _mouseStart() as an example)

_mouseStart()Returns: jQuery (plugin only)

The extending widget should implement a _mouseStart() method to handle the beginning of an interaction

=> Explain how the widget author is supposed to implement this method. Because the obvious apparent meaning is that you are expected to implement it in this way:

$.widget("my.widget.name", {
  //....
  //....
  _mouseStart: function() {
    //my definition of the method. e.g.:
    alert("Mouse interaction starting");
    return this;
  }
});

but that's not the case, as this way the method won't ever be called.

The same applies to all the other methods of this part of the api (_mouseCapture, _mouseStop, _mouseDrag...)

  1. The following can be seen in the documentation of most of these methods:

This method will receive the mouse event associated with the start of the interaction.

  • This method does not accept any arguments.

There's an apparent contraddiction there.

  1. Code examples. The current code examples are completely useless. Most (or all) examples are like this:

Code examples:
Invoke the _mouseStart method:

$( ".selector" ).mouse( "_mouseStart" );

That or no example at all is the same. A useful example would be an example implementation of the method, rather than an example of calling it which is something you wouldn't usually do.

Langage dominant
HTML
Étoiles
73
Forks
75
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de jquery/api.jqueryui.com

Toutes les issues de jquery/api.jqueryui.com

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.