Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sircamp/supercolor
A simple library for color management inside your projects
https://github.com/sircamp/supercolor
Last synced: 1 day ago
JSON representation
A simple library for color management inside your projects
- Host: GitHub
- URL: https://github.com/sircamp/supercolor
- Owner: sirCamp
- License: mit
- Created: 2015-07-17T08:50:45.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-08-07T15:23:48.000Z (over 9 years ago)
- Last Synced: 2023-10-27T14:44:59.547Z (about 1 year ago)
- Language: JavaScript
- Size: 180 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://david-dm.org/sircamp/supercolor)
[](https://david-dm.org/sircamp/supercolor#info=devDependencies)
# SupercolorJS
A simple library for color management inside your projects.
With this library you can create, delete and manage your color palettes, get random color, get all colors between a range of two colors, get and generate random palette or get radom color from palette, generate random palette, convert color from Hex to RGB and viceversa.
N.B this is a standalone library write with pure JavaScript Object using prototype
## USAGE
#### CREATE OBJECT
var options is a optional paramters, if you want you can create object anyway without options
```javascript
var options = {
customColors: ["#FBC02D", "#FFEB3B","#FFF9C4","#FFEB3B","#FFFFFF"]
};
var color = new Color(options);
```
#### convertFomRGBToHex
with this method you can convert an rgb color into hexadecimal color
```javascript
var r = 255;
var g = 255;
var b = 255;
color.convertFromRGBtoHex(r,g,b); //return #FFFFFF
```
#### convertFromHextoRGB
with this method you can convert an hexadecimal color into rgb color.
This method return an array with 3 pieces of hexadecimal color
```javascript
var string = "#FFFFFF" ;
color.convertFromHextoRGB(string); //return 255,255,255
```
#### getRangeOfHexColors
with this method you can obtain an array full of hexadecimal colors that are between to and from.
```javascript
var from = "#A2A2A2";
var to = "#FFFFFF" ;
color.getRangeOfHexColors(from,to);
```
#### getRangeOfRGBColors
with this method you can obtain an array full of RGB colors that are between to and from.
```javascript
var from = [205,205,205];
var to = [255,255,255];
color.getRangeOfRGBColors(from,to);
```
#### getStarterColors
with this method you can obtain an array full of hex colors that are the standard color of library
```javascript
color.getStarterColors();
```
#### getCustomColors
This method returns an array of colors that you have setted.
```javascript
color.getStarterColors();
```
#### setCustomColors
This method allow you to set a custom color array
```javascript
color.setCustomColors(colors);
```
#### getPalette
This returns all palettes of colors that you have set
```javascript
var palettes = [];
palettes = color.getPalette();
```
#### addPalette
This method allows you to add a new palette of colors to your project
```javascript
var palette = {
name: "YellowPalette",
colors: ["#FBC02D", "#FFEB3B","#FFF9C4","#FFEB3B","#FFFFFF"]
};
color.addPalette(palette);
```
#### removePaletteByIndex
This method allows you to remove a pelette by index obtained by *getPalette()* result
```javascript
var indexOfPaletteToRemove = 2;
color.removePaletteByIndex(indexOfPaletteToRemove);
```
#### removePaletteByName
This method allows you to remove a pelette by its name
```javascript
var nameOfPaletteToRemove = "YellowPalette";
color.removePaletteByName(nameOfPalette);
```
#### getPaletteByIndex
This method allows you to get a pelette by index obtained by *getPalette()* result
```javascript
var indexOfPaletteToGet = 2;
color.getPaletteByIndex(indexOfPaletteToRemove);
```
#### getPaletteByName
This method allows you to get a pelette by its name
```javascript
var nameOfPaletteToGet = "YellowPalette";
color.getPaletteByName(nameOfPalette);
```
#### getRandomStarterColor
This method returns a random color from a presetted array of colors owened by this library
```javascript
color.getRandomStarterColor();
```
#### getRandomCustomColor
This method returns a random color from a custom array of colors setted by you
```javascript
color.getRandomCustomColor();
```
#### getRandomPalette
This method returns a random palette of colors
```javascript
color.getRandomPalette();
```
#### getRandomColorFromPaletteIndex
This method returns a random color from a palette selected by index obtained by *getPalette()* result
```javascript
color.getRandomColorFromPaletteIndex();
```
#### getRandomColorFromPaletteName
This method returns a random color from a palette selected by its name
```javascript
color.getRandomColorFromPaletteName();
```
#### getRandomColorFromRandomPalette
This method returns a random color from a random palette
```javascript
color.getRandomColorFromRandomPalette();
```
#### getRandomColor
This method returns a random generated color (Hexadecimal format)
```javascript
//This is a static function
Color.getRandomColor();
```
#### generateRandomPalette
This method returns a random generated palette of colors
```javascript
//This is a static function
Color.generateRandomPalette();
```