README

GrapesJS Style Filter

Add filter type input to the Style Manager in GrapesJS

GrapesJS

Requires GrapesJS v0.14.40 or higher

Summary

Plugin name: grapesjs-style-filter
StyleManager types
- filter

Options

| Option | Description | Default | |-|-|- | inputFilterType | Extend the filter type input, eg. { name: 'Filter type', defaults: 'blur', ... } | {} | | inputFilterStrength | Extend the default filter strength input, eg. { name: 'Blur', defaults: 50, ... } | {} | | filterStrengthChange | Customize the filter strength input when it should be updated. The option is a function, which receive the current object type and returns a new one | type => type |

Download

CDN
- https://unpkg.com/grapesjs-style-filter
NPM
- npm i grapesjs-style-filter
GIT
- git clone https://github.com/artf/grapesjs-style-filter.git

Usage

Directly in the browser

<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet"/>
<script src="https://unpkg.com/grapesjs"></script>
<script src="path/to/grapesjs-style-filter.min.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var filterInput = {
    name: 'Filter',
    property: 'filter',
    type: 'filter', // <- the new type
    full: 1,
  };

  var editor = grapesjs.init({
      container : '#gjs',
      // ...
      plugins: ['grapesjs-style-filter'],
      pluginsOpts: {
        'grapesjs-style-filter': { /* options */ }
      },
      // Use the type on init
      styleManager: {
        // ...
        sectors: [
          // ...
          {
            name: 'Extra',
            buildProps: ['filter', 'opacity', ...],
            properties: [ filterInput ],
          }
      },
  });

  // or add it to the StyleManager via API
  editor.StyleManager.addProperty('Extra', filterInput);
</script>

Modern javascript

import grapesjs from 'grapesjs';
import styleFilter from 'grapesjs-style-filter';

const editor = grapesjs.init({
  container : '#gjs',
  // ...
  plugins: [styleFilter],
  pluginsOpts: {
    [styleFilter]: { /* options */ }
  }
  // or
  plugins: [
    editor => styleFilter(editor, { /* options */ }),
  ],
});
// Same StyleManager usage

Development

Clone the repository

$ git clone https://github.com/artf/grapesjs-style-filter.git
$ cd grapesjs-style-filter

Install dependencies

$ npm i

Start the dev server

$ npm start

License

BSD 3-Clause

Usage no npm install needed!