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

Abierto
  • ¿Algo no está bien?
#209 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript, jquery
Área
documentation

Línea de trabajo

Comienza con la página de la API de interacción del ratón en http://api.jqueryui.com/mouse/ y revisa las entradas de _mouseCapture, _mouseStart, _mouseDrag y _mouseStop y sus ejemplos existentes. Se considera terminado cuando se aclare cómo implementan estos hooks los autores de widgets, se documenten los argumentos de los eventos y los ejemplos que solo muestran invocaciones se sustituyan por ejemplos de implementación útiles o por una sección de demos enlazada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
HTML
Estrellas
73
Forks
75
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de jquery/api.jqueryui.com

Todos los issues de jquery/api.jqueryui.com

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.