casesandberg/react-color

document the onChangeComplete delay and make it configurable

Open

#516 ouverte le 11 juin 2018

Voir sur GitHub
 (7 commentaires) (4 réactions) (0 assignés)JavaScript (11 679 stars) (946 forks)batch import
enhancementhelp wanted

Description

I couldn't find any explanation in the documentation as to what onChangeComplete actually does. The code reveals that it is a hardcoded debounce with 100ms.

I suggest:

  1. Document the behavior
  2. Make the 100ms configurable

Guide contributeur

Stack technique
reactjavascript
Domaine
frontend
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
ReactJavaScriptUnderstanding of debounce
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
The issue points to src/components/common/ColorWrap.js line 30 where a hardcoded 100ms debounce is used. To implement, add a new prop (e.g., `onChangeCompleteDelay`) to accept a custom delay, defaulting to 100ms, and update the documentation accordingly. Check the comments for any maintainer feedback on naming or behavior.