jQuery asGradient
A jquery plugin used to manipulate css image gradient. You can add a new color stop. Change the position of color stop. Or remove a color stop. In the end, it can output a formated standard css gradient string.
Table of contents
- Main files
- Quick start
- Requirements
- Usage
- Examples
- Options
- Methods
- No conflict
- Browser support
- Contributing
- Development
- Changelog
- Copyright and license
Main files
dist/
├── jquery-asGradient.js
├── jquery-asGradient.es.js
└── jquery-asGradient.min.js
Quick start
Several quick start options are available:
Download the latest build
- Development - unminified
- Production - minified
Install From Bower
bower install jquery-asGradient --save
Install From Npm
npm install jquery-asGradient --save
Install From Yarn
yarn add jquery-asGradient
Build From Source
If you want build from source:
git clone git@github.com:amazingSurge/jquery-asGradient.gitcd jquery-asGradientnpm installnpm install -g gulp-cli babel-cligulp build
Done!
Requirements
jquery-asGradient
requires the latest version of jQuery
and jQuery-asColor
.
Usage
Including files:
Initialization
All you need to do is call the plugin on the element:
var gradient = 'linear-gradient(to rgba(0, 0, 0, 1), rgba(255, 255, 255, 1))' cleanPosition: true color: format: 'rgba' ;
Examples
There are some example usages that you can look at to get started. They can be found in the examples folder.
Options
jquery-asGradient
can accept an options object to alter the way it behaves. You can see the default options by call $.asGradient.setDefaults()
. The structure of an options object is as follows:
{
prefixes: ['-webkit-', '-moz-', '-ms-', '-o-'],
forceStandard: true,
angleUseKeyword: true,
emptyString: '',
degradationFormat: false,
cleanPosition: true,
color: {
format: false, // rgb, rgba, hsl, hsla, hex
hexUseName: false,
reduceAlpha: true,
shortenHex: true,
zeroAlphaAsTransparent: false,
invalidValue: {
r: 0,
g: 0,
b: 0,
a: 1
}
}
}
Methods
var gradient = 'linear-gradient(to bottom, yellow, blue)'; gradient;
toString()
Get gradient string.
// Get standard string.gradient; // Get string by prefix.gradient;
fromString()
Set values from gradient string.
gradient;
getPrefixedStrings()
Get prefixed strings array.
gradient;
val()
Get or set gradient string.
// get gradient stringgradient; // set gradient stringgradient;
angle()
Get or set angle.
// get gradient anglegradient; // set gradient anglegradient;
append(color, position)
Append a new color stop.
gradient;
insert(color, position, index)
Insert a color stop to index
gradient;
getCurrent()
Get current color stop.
var stop = gradient;
setCurrentById(id)
Set current color stop by id.
gradient;
getById(id)
Get color stop by index.
var stop = gradient;
removeById(id)
Remove color stop by id.
gradient;
get(index)
Get color stop by index.
var stop = gradient;
remove(index)
Remove color stop by index.
gradient;
empty()
Empty color stops.
gradient;
reset()
Reset gradient.
gradient;
No conflict
If you have to use other plugin with the same namespace, just call the $.asGradient.noConflict
method to revert to it.
Browser support
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.
Contributing
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-asGradient
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
Development
jquery-asGradient
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 gulpnpm install -g babel-clinpm install
Then you can generate new distributable files from the sources, using:
gulp build
More gulp tasks can be found here.
Changelog
To see the list of recent changes, see Releases section.
Copyright and license
Copyright (C) 2016 amazingSurge.
Licensed under the LGPL license.