Grapesjs Style Bg
Full-stack background style property type for GrapesJS, with the possibility to add images, colors, and gradients.
Requires GrapesJS v0.16.3 or higher
Summary
- Plugin name:
grapesjs-style-bg - Style Manager properties
bgThe main background typecolor-linearLike a simple color picker but with the output compatible withbackground-image
Options
| Option | Description | Default |
|---|---|---|
styleGradientOpts |
Options for the grapesjs-style-gradient plugin |
{} |
propExtender |
Extend single style property definition of the plugin. You can this, for example, to change the defauld gradient picker color | prop => prop |
typeProps |
Use this function to change/add/extend inner style properties of each background type. For example, you can replace the Position select type (of the image bg type) with some other kind of type or options |
(result, type) => result |
Download
- CDN
https://unpkg.com/grapesjs-style-bg
- NPM
npm i grapesjs-style-bg
- GIT
git clone https://github.com/artf/grapesjs-style-bg.git
Usage
Directly in the browser (remember to include the Grapick CSS)
<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet"/>
<link href="https://unpkg.com/grapick/dist/grapick.min.css" rel="stylesheet">
<script src="https://unpkg.com/grapesjs"></script>
<script src="path/to/grapesjs-style-bg.min.js"></script>
<div id="gjs"></div>
<script type="text/javascript">
var editor = grapesjs.init({
container: '#gjs',
// ...
plugins: ['grapesjs-style-bg'],
pluginsOpts: {
'grapesjs-style-bg': { /* options */ }
}
});
</script>Modern javascript
import grapesjs from 'grapesjs';
import plugin from 'grapesjs-style-bg';
import 'grapesjs/dist/css/grapes.min.css';
import 'grapick/dist/grapick.min.css';
const editor = grapesjs.init({
container : '#gjs',
// ...
plugins: [plugin],
pluginsOpts: {
[plugin]: { /* options */ }
}
// or
plugins: [
editor => plugin(editor, { /* options */ }),
],
});Development
Clone the repository
$ git clone https://github.com/artf/grapesjs-style-bg.git
$ cd grapesjs-style-bgInstall dependencies
$ npm iStart the dev server
$ npm startBuild the source
$ npm run buildLicense
MIT
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent