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 (946 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (11,679 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Examine the debounce implementation in ColorWrap.js, add a configurable delay option to the component, and update the documentation to explain the onChangeComplete behavior.
Tech stack
javascriptreact
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85