-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Hexashades | ||
|
||
 | ||
 | ||
 | ||
|
||
Hexashades helps you generate a range of shades and tints for any specified RGB Hex color code. | ||
|
||
> Currently, it only supports RGB Hex codes. More input formats will be allowed in the future. | ||
## Installation | ||
|
||
**NPM** | ||
|
||
```sh | ||
npm install hexashades --save | ||
``` | ||
|
||
Or load using a `<script>` tag from a CDN | ||
|
||
```html | ||
<script src="https://cdn.jsdelivr.net/npm/hexashades/"></script> | ||
``` | ||
|
||
## Usage | ||
|
||
```js | ||
// Import Hexashades & initialize. | ||
import { Colors } from "hexashades"; | ||
const color = new Colors(); | ||
|
||
// Generate tints & shades. | ||
const tintsAndShades = color.createColors("663399", 10, false); | ||
``` | ||
|
||
## API | ||
|
||
### createColors(color, percentage, prefix) | ||
|
||
Returns an array of tints & shades for the given color with a given percentage of increments. | ||
|
||
Throws an error if no/invalid inputs are given. | ||
|
||
- `@param {string} color` - a valid RGB hex code without # | ||
- `@param {number} percentage` - a valid percentage value between 0 and 100 | ||
- `@param {boolean} prefix` - (Optional) true/false. Whether the output should include # | ||
- `@return {Array<string>}` - array with hex codes | ||
|
||
## License | ||
|
||
MIT © arjunkdot |