Qix-/color

Docs don't give examples of all supported constructor arguments

Open

#181 opened on May 6, 2020

View on GitHub
 (1 comment) (2 reactions) (0 assignees)JavaScript (4,637 stars) (316 forks)batch import
documentationhelp wantedpr welcome

Description

The docs give examples of various forms of Color.rgb() with 3 arguments, but never give an example of specifying an alpha value in the constructor. They do give the example Color('#7743CE').alpha(0.5) but nothing like Color.rgb([0x77, 0x43, 0xCE, 0.5]).

Also, there are no examples of construction from non-RGB color spaces. Color.hsl(200,80,70) works but is never mentioned.

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
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
basic JavaScriptfamiliarity with Color library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Add documentation examples for Color.rgb() with alpha and Color.hsl() usage. Look at the main documentation file (likely README.md or docs/) and insert examples after existing rgb() examples. The issue mentions no example of Color.rgb([0x77, 0x43, 0xCE, 0.5]) and no mention of Color.hsl(200,80,70). Ensure the new examples are consistent with existing style.