https://github.com/omegion/horul-editor
Block styled editor based on Editor.js
https://github.com/omegion/horul-editor
editor editorjs open-source vue-editor vuejs
Last synced: about 2 months ago
JSON representation
Block styled editor based on Editor.js
- Host: GitHub
- URL: https://github.com/omegion/horul-editor
- Owner: omegion
- License: mit
- Created: 2019-09-02T12:00:14.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T02:56:04.000Z (over 2 years ago)
- Last Synced: 2024-04-17T18:10:22.527Z (about 2 years ago)
- Topics: editor, editorjs, open-source, vue-editor, vuejs
- Language: Vue
- Homepage:
- Size: 3.99 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# horul-editor
horul-editor is editorjs wrapper component.
Please see this first. https://editorjs.io/
## Supported Plugins
- [Header](https://github.com/editor-js/header)
- [List](https://github.com/editor-js/list)
- [Image](https://github.com/editor-js/image)
- [InlineCode](https://github.com/editor-js/inline-code)
- [Embed](https://github.com/editor-js/embed)
- [Quote](https://github.com/editor-js/quote)
- [Marker](https://github.com/editor-js/marker)
- [Code](https://github.com/editor-js/code)
- [Link](https://github.com/editor-js/link)
- [Delimiter](https://github.com/editor-js/delimiter)
- [Raw](https://github.com/editor-js/raw)
- [Table](https://github.com/editor-js/table)
- [Warning](https://github.com/editor-js/warning)
- [Paragraph](https://github.com/editor-js/paragraph)
- [Checklist](https://github.com/editor-js/checklist)
- [Personality](https://github.com/editor-js/personality)
## Installation
```bash
npm install --save horul-editor
# or Yarn
yarn add horul-editor
```
## Usage
```js
// In main.js
// ...
import Editor from 'horul-editor'
Vue.use(Editor)
// ...
```
```js
// In component
// ...
import { Editor } from 'horul-editor'
export default {
components: {
Editor,
}
}
// ...
```
```Vue
```
---
```js
// on Nuxt.js
// in nuxt.config.js
plugins: [
{
src: '~/plugins/vue-editor.js', ssr: false
}
],
// in ~/plugins/vue-editor.js
import Vue from 'vue'
import Editor from 'horul-editor'
Vue.use(Editor)
// in your page
```
### Other props:
- customTools - Object with name (key) and class of a custom tool (value)