Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

vue3-summernote-editor

rafwell1.3kSEE LICENSE IN LICENSE1.0.2

A vuejs 3 component for Summernote library

vue3, summernote, wysiwyg

readme

Vue3 Summernote Editor

A VueJs 3 component for use Summernote WYSIWYG

Install

// npm install
npm install vue3-summernote-editor --save

You must be have jQuery at window.$ and install summernote by yourself.

Use as component

  1. import as global component. ` javascript // import SummernoteEditor import SummernoteEditor from 'vue3-summernote-editor';

const vueApp = createApp({}); vueApp.component('SummernoteEditor', SummernoteEditor);


2. import into a single component.
``` javascript
// import SummernoteEditor
import SummernoteEditor from 'vue3-summernote-editor';

<template>
  <SummernoteEditor
      v-model="myValue"
      @update:modelValue="summernoteChange($event)"
      @summernoteImageLinkInsert="summernoteImageLinkInsert"
    />
</template>
<script>
export default {
    // declare SummernoteEditor
    components: {SummernoteEditor},
    data() {
        return {
            myValue: '',
        }
    },
    methods: {
       summernoteChange(newValue) {
          console.log("summernoteChange", newValue);
       },
        summernoteImageLinkInsert(...args) {
          console.log("summernoteImageLinkInsert()", args);
       },
    }
}
</script>

Options

  • options: option[]
    • configurable settings, see Summernote options
    • you can define a global options on a window.SUMMERNOTE_DEFAULT_CONFIGS

Events

  • update:modelValue
    • triggered when summernote value change
  • summernote bare events
    • summernote events will be triggered in camelCase
    • "summernote.change": "summernoteChange"
    • "summernote.image.link.insert": "summernoteImageLinkInsert"