\n\n## How to use\n\n> Use version 2.* for Vue 2\n>\n> Use version 3.* for Vue 3\n\nInstall **Jodit Vue**:\n\n```\nnpm install jodit-vue --save\n// or with Yarn\nyarn add jodit-vue\n```\n\n## Import and use it\n\nSince this component is just a wrapper, you need to include the `css` of the **Jodit Editor** on your app for it to work properly, if you're using `vue-cli` to create your app, or another build system you can import it directly or add a `link` tag with the `css` file provided by the **Jodit Editor** package.\n\n```js\nimport 'jodit/build/jodit.min.css'\nimport Vue from 'vue'\nimport JoditVue from 'jodit-vue'\n\nVue.use(JoditVue)\n```\n\nInstead of using `Vue.use(JoditVue)` you can use the component locally\n\n```vue\n\n
\n \n
\n\n\n\n```\n\nYou can check and test it on **[Codesanbox](https://codesandbox.io/s/jv0l1r86wv)** too.\n\n## Using without a build system\n\nIf you don't use a build system on your app, you can also use Jodit Vue without problems, check and test it on this **[JsFiddle](https://jsfiddle.net/6ch2gn0t/)**.\n\n## Component Properties\n\nIf you pass only the `v-model` for the component, it will load all the editor features, if you want to customize it, you can do it with its properties that are listed below, but all of them are not required, just if you want to customize your editor that you will need them:\n\n| Property | Type | Default Value | Description |\n| :--------------: | :-----: | :-----------: | :-------------------------------------------------------------------------------------------------------------------: |\n| buttons | Array | `null` | The buttons that you want to show on toolbar, if this is not provided, all the buttons will be shown |\n| extraButtons | Array | `null` | If you need to create and display custom buttons you can pass an array with your custom buttons to this property |\n| config | Object | `{}` | The config object that has all the other configurations for the editor |\n| plugins | Array | `[]` | If you need to create custom plugins you can pass array of plugins to this property |\n\n#### Buttons property\n\nWhen providing the buttons to show on the editor you will need to provide an array with the buttons that you want to show. The button names can be found **[here](https://xdsoft.net/jodit/play.html)**. You can also pass a `|` to put a divider between the buttons.\n\n```vue\n\n
\n \n
\n\n\n\n```\n\n#### Extra Buttons property\n\nIf you need to create custom buttons to the editor, you can create them and provide the component with an array\n\n```vue\n\n
\n \n
\n\n\n\n```\n\nTo create custom buttons, check the **[Jodit Editor Docs](https://xdsoft.net/jodit/doc/)**\n\n#### Config property\n\nThis config allows you to pass all the other configurations found **[here](https://xdsoft.net/jodit/doc/options/)** to customize your editor\n\n#### Plugins property\nPlugins property allows you to pass array of plugin objects with name and callback which will be initialized when Jodit is initialized. Plugins are initialized globally and it will added to all instances of Jodit editor.\nFor example:\n```vue\n\n
\n \n
\n\n\n\n```\nTo add plugins Jodit Vue uses `Jodit.plugins.add` API.\nCheck Jodit [documentation](https://github.com/xdan/jodit#create-plugin) and [examples](https://xdsoft.net/jodit/examples/plugin/custom_plugin.html) how to implement plugins.\n\n## Credits ✨\n\n- [Wendell Adriel](https://github.com/WendellAdriel)\n- [All Contributors](https://github.com/WendellAdriel/jodit-vue/contributors)\n","readmeFilename":"README.md"}
![\"Version\"](\"https://img.shields.io/npm/v/jodit-vue.svg?style=flat-square\")
\n![\"Downloads\"](\"https://img.shields.io/npm/dm/jodit-vue.svg?style=flat-square\")
\n![\"License\"](\"https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square\")
\n