https://github.com/grapesjs/style-gradient
Add gradient input to the Style Manager in GrapesJS
https://github.com/grapesjs/style-gradient
Last synced: about 1 year ago
JSON representation
Add gradient input to the Style Manager in GrapesJS
- Host: GitHub
- URL: https://github.com/grapesjs/style-gradient
- Owner: GrapesJS
- License: bsd-3-clause
- Created: 2017-11-07T00:27:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-07T14:39:31.000Z (over 2 years ago)
- Last Synced: 2025-06-11T18:29:48.292Z (about 1 year ago)
- Language: TypeScript
- Size: 399 KB
- Stars: 19
- Watchers: 4
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GrapesJS Style Gradient
This plugins adds a new `gradient` property to the GrapesJS's StyleManager by using [Grapick](https://github.com/artf/grapick)
> Requires GrapesJS v0.20.1 or higher
[Demo](https://codepen.io/artf/full/bYwdQG/)
## Summary
* Plugin name: `grapesjs-style-gradient`
* Style type: `gradient` (the gradient picker input)
* Built-in Style property: `background-image` (composite type with gradient picker and direction/type selectors)
## Options
| Option | Description | Default |
|-|-|-
| `grapickOpts` | [Grapick options](https://github.com/artf/grapick#configurations). | `{}` |
| `colorPicker` | Custom color picker, check [Grapick's repo](https://github.com/artf/grapick#add-custom-color-picker) to get more about it. | `undefined` |
| `selectEdgeStops` | Select, by default, the edge color stops of the gradient picker. | `true` |
| `styleType` | The id to assign for the gradient picker type. | `'gradient'` |
| `builtInType` | Built-in property name to use for the composite type with the gradient picker and direction/type selectors. | `'background-image'` |
## Download
* CDN
* `https://unpkg.com/grapesjs-style-gradient`
* NPM
* `npm i grapesjs-style-gradient`
* GIT
* `git clone https://github.com/GrapesJS/style-gradient.git`
## Usage
Directly in the browser.
```html
const editor = grapesjs.init({
container : '#gjs',
// ...
plugins: ['grapesjs-style-gradient'],
pluginsOpts: {
'grapesjs-style-gradient': {}
}
});
```
Modern javascript
```js
import grapesjs from 'grapesjs';
import plugin from 'grapesjs-style-gradient';
const editor = grapesjs.init({
container : '#gjs',
// ...
plugins: [plugin],
pluginsOpts: {
[plugin]: { /* options */ }
}
});
// Usage via API
// Add gradient picker as a single input
editor.StyleManager.addProperty('decorations', {
type: 'gradient', // <- new type
name: 'Gradient',
property: 'background-image',
defaults: 'none'
full: true,
});
// Add the new background-image bulti-in type
editor.StyleManager.addProperty('decorations', {
extend: 'background-image', // <- extend the built-in type
name: 'Gradient Background',
});
```
## Development
Clone the repository
```sh
$ git clone https://github.com/GrapesJS/style-gradient.git
$ cd style-gradient
```
Install dependencies
```sh
$ npm i
```
Start the dev server
```sh
$ npm start
```
## License
BSD 3-Clause