Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Fandom-OSS/quill-blot-formatter

A module for Quill that allows editor elements to be resized, repositioned, etc.
https://github.com/Fandom-OSS/quill-blot-formatter

quill quilljs

Last synced: about 1 month ago
JSON representation

A module for Quill that allows editor elements to be resized, repositioned, etc.

Awesome Lists containing this project

README 

        
# Quill Blot Formatter



A [quill](https://quilljs.com/) module to format document [blots](https://github.com/quilljs/parchment#blots). Heavily inspired by [quill-image-resize-module](https://github.com/kensnyder/quill-image-resize-module). Out of the box supports resizing and realigning images and iframe videos, but can be easily extended using [`BlotSpec`](#blotspec) and [`Action`](#action).



## Demo

[demo](https://codesandbox.io/s/4wnwllnnl9)



## Installation

Using `yarn`:

```

yarn add quill-blot-formatter

```



Using `npm`:

```

npm install --save quill-blot-formatter

```



## Usage

### As Module

```js

import Quill from 'quill';



// from the index, which exports a lot of useful modules

import BlotFormatter from 'quill-blot-formatter';



// or, from each individual module

import BlotFormatter from 'quill-blot-formatter/dist/BlotFormatter';



Quill.register('modules/blotFormatter', BlotFormatter);



const quill = new Quill(..., {

  modules: {

    ...

    blotFormatter: {

      // see config options below

    }

  }

});

```



### Script Tag

`quill-blot-formatter.min.js` is provided which exports the same modules as `index.js` under the global `QuillBlotFormatter`.



```html



  Quill.register('modules/blotFormatter', QuillBlotFormatter.default);

  const quill = new Quill(..., {

      modules: {

          ...

          blotFormatter: {

            // see config options below

          }

      }

    }

  });



```



## BlotSpec

The [`BlotSpec`](https://github.com/Fandom-OSS/quill-blot-formatter/blob/master/src/specs/BlotSpec.js) classes define how `BlotFormatter` interacts with blots. They take the `BlotFormatter` as a constructor arg and have the following functions:



### `init(): void`

Called after all specs have been constructed. Use this to bind to quill events to determine when to activate a specific spec.



### `getActions(): Class[]`

The [`actions`](#action) that are allowed on this blot. The default is `[AlignAction, ResizeAction, DeleteAction]`.



### `getTargetElement(): ?HTMLElement`

When the spec is active this should return the element that is to be formatter



### `getOverlayElement(): ?HTMLElement`

When the spec is active this should return the element to display the formatting overlay. This defaults to `return getTargetElement()` since they will typically be the same element.



### `setSelection(): void`

After the spec is activated this should set the quill selection using [`setSelection`](https://quilljs.com/docs/api/#setselection). Defaults to `quill.setSelection(null)`.



### `onHide(): void`

Called when the spec is deactivated by the user clicking away from the blot. Use this to clean up any state in the spec during activation.



### Notes

Each spec should call `this.formatter.show(this);` to request activation. See [`specs/`](https://github.com/Fandom-OSS/quill-blot-formatter/tree/master/src/specs) for the built-in specs.



## Action

The [`Action`](https://github.com/Fandom-OSS/quill-blot-formatter/blob/master/src/actions/Action.js) classes define the actions available to a blot once its spec is activated. They take the `BlotFormatter` as a constructor arg and have the following functions:



### `onCreate(): void`

Called immediately after the action is created. Use this to bind quill events and create elements to attach to the overlay.



### `onUpdate(): void`

Called when the formatter has changed something on the blot. Use this to update any internal state.



### `onDestroy(): void`

Called when the formatter is hidden by the user.



See [`actions/`](https://github.com/Fandom-OSS/quill-blot-formatter/tree/master/src/actions) for the existing actions.



## Options

Using quill module options it's easy to disable existing specs, actions, or to override any of the styles provided by this module. For example: if you wanted to remove resizing, support only images, and change the overlay border the following config would work:



```js

import Quill from 'quill';



// from main module

import BlotFormatter, { AlignAction, DeleteAction, ImageSpec } from 'quill-blot-formatter'



// or, from individual modules

import BlotFormatter from 'quill-blot-formatter/dist/BlotFormatter';

import AlignAction from 'quill-blot-formatter/dist/actions/align/AlignAction';

import DeleteAction from 'quill-blot-formatter/dist/actions/DeleteAction';

import ImageSpec from 'quill-blot-formatter/dist/specs/ImageSpec';



Quill.register('modules/blotFormatter', BlotFormatter);



class CustomImageSpec extends ImageSpec {

    getActions() {

        return [AlignAction, DeleteAction];

    }

}



const quill = new Quill(..., {

  modules: {

    ...

    blotFormatter: {

      specs: [

        CustomImageSpec,

      ],

      overlay: {

        style: {

          border: '2px solid red',

        }

      }

    }

  }

});

```



### Notes

- For all supported options as well as the default see [`Options`](https://github.com/Fandom-OSS/quill-blot-formatter/blob/master/src/Options.js).

- object properties are merged, but array properties override the defaults.

- To completely disable styles (`overlay.style`, `resize.handleStyle`, etc) set those to `null`