hztianxu-draft-js-plugins
Version:
A Plugin Architecture on top of Draft.JS
59 lines (41 loc) • 3.44 kB
Markdown
# DraftJS Sticker Plugin
[](https://www.youtube.com/watch?v=9auOCbH5Ns4)
*This is a plugin for the `draft-js-plugins-editor`.*
This plugin allows you to add stickers to your editor!
Usage:
```js
import createStickerPlugin from 'draft-js-sticker-plugin';
const stickerPlugin = createStickerPlugin({ stickers });
const { StickerSelect } = stickerPlugin;
```
## Importing the default styles
The plugin ships with a default styling available at this location in the installed package:
`node_modules/draft-js-sticker-plugin/lib/plugin.css`.
### Webpack Usage
Follow the steps below to import the css file by using Webpack's `style-loader` and `css-loader`.
1. Install Webpack loaders: `npm install style-loader css-loader --save-dev`
2. Add the below section to Webpack config (if your Webpack already has loaders array, simply add the below loader object(`{test:foo, loaders:bar[]}`) as an item in the array).
```js
module: {
loaders: [{
test: /\.css$/,
loaders: [
'style', 'css'
]
}]
}
```
3. Add the below import line to your component to tell Webpack to inject style to your component.
```js
import 'draft-js-sticker-plugin/lib/plugin.css';
```
4. Restart Webpack.
### Browserify Usage
TODO: PR welcome
## Exported functions
| Props | Description
| -----------------------------------------------|------------:|
| add(editorState: Object, stickerId: any) | add a Sticker ContentBlock after the current Selection|
| remove(editorState: Object, blockKey: String) | removes a Sticker ContentBlock|
| Sticker | the default Sticker Component |
| StickerSelect | a basic StickerSelector |