A jquery plugin used to parse css color string and convent it to other color formats. It support rgb, rgba, hex, hsl, hsla.
- Main files
- Quick start
- Requirements
- Usage
- Examples
- Options
- Methods
- No conflict
- Browser support
- Contributing
- Development
- Changelog
- Copyright and license
dist/
├── jquery-asColor.js
├── jquery-asColor.es.js
└── jquery-asColor.min.js
Several quick start options are available:
- Development - unminified
- Production - minified
bower install jquery-asColor --save
npm install jquery-asColor --save
yarn add jquery-asColor
If you want build from source:
git clone git@github.com:amazingSurge/jquery-asColor.git
cd jquery-asColor
npm install
npm install -g gulp-cli babel-cli
gulp build
Done!
jquery-asColor
requires the latest version of jQuery
.
<script src="/path/to/jquery.js"></script>
<script src="/path/to/jquery-asColor.js"></script>
All you need to do is call the plugin on the element:
jQuery(function($) {
var color = $.asColor('rgba(255, 255, 255, 1)', {
format: 'rgba',
shortenHex: false,
hexUseName: false,
reduceAlpha: false,
nameDegradation: 'HEX',
invalidValue: '',
zeroAlphaAsTransparent: true
});
var string = color.toString(), // rgba(255, 255, 255, 1)
hex = color.toHEX(), // #ffffff
rgb = color.toRGB(), // rgb(255, 255, 255)
hsl = color.toHSL(), // hsl(0, 0%, 100%)
hsla = color.toHSLA(), // hsla(0, 0%, 100%, 1)
name = color.toNAME(); // white
color.val('#000');
color.format('hsla');
color.alpha(0.5);
var value = color.val(); // hsla(0, 0%, 0%, 0.5)
});
There are some example usages that you can look at to get started. They can be found in the examples folder.
jquery-asColor
can accept an options object to alter the way it behaves. You can see the default options by call $.asColor.setDefaults()
. The structure of an options object is as follows:
{
format: false,
shortenHex: false,
hexUseName: false,
reduceAlpha: false,
alphaConvert: { // or false will disable convert
'RGB': 'RGBA',
'HSL': 'HSLA',
'HEX': 'RGBA',
'NAMESPACE': 'RGBA',
},
nameDegradation: 'HEX',
invalidValue: '',
zeroAlphaAsTransparent: true
}
Methods are called on asColor instances through the asColor method itself. You can also save the instances to variable for further use.
Return the color string.
color.toString();
Get the color format or set the color format.
color.format();
color.format('rgb');
Set or get the color value.
// get the val
color.val();
// set the val
color.val('rgb(66, 50, 50)');
Set the color.
color.set({
r: 255,
g: 255,
b: 255,
a: 0.5
});
Get the color.
var rgb = color.get();
Get alpha.
var alpha = color.alpha();
Check color is valid.
color.isValid();
Convent to rgb color.
color.toRGB();
Convent to rgba color.
color.toRGBA();
Convent to hex color.
color.toHEX();
Convent to hsl color.
color.toHSL();
Convent to hsla color.
color.toHSLA();
If you have to use other plugin with the same namespace, just call the $.asColor.noConflict
method to revert to it.
<script src="other-plugin.js"></script>
<script src="jquery-asColor.js"></script>
<script>
$.asColor.noConflict();
// Code that uses other plugin's "$().asColor" can follow here.
</script>
Tested on all major browsers.
Latest ✓ | Latest ✓ | Latest ✓ | Latest ✓ | 9-11 ✓ | Latest ✓ |
As a jQuery plugin, you also need to see the jQuery Browser Support.
Anyone and everyone is welcome to contribute. Please take a moment to
review the guidelines for contributing. Make sure you're using the latest version of jquery-asColor
before submitting an issue. There are several ways to help out:
- Bug reports
- Feature requests
- Pull requests
- Write test cases for open bug issues
- Contribute to the documentation
jquery-asColor
is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:
npm install -g gulp
npm install -g babel-cli
npm install
Then you can generate new distributable files from the sources, using:
gulp build
More gulp tasks can be found here.
To see the list of recent changes, see Releases section.
Copyright (C) 2016 amazingSurge.
Licensed under the LGPL license.