casesandberg/react-color

document the onChangeComplete delay and make it configurable

Open

#516 opened on Jun 11, 2018

View on GitHub
 (7 comments) (4 reactions) (0 assignees)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

Contributor guide

Tech stack
reactjavascript
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactJavaScriptUnderstanding of debounce
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.