0.1.4 • Published 4 years ago

vuerd-plugin-summernote v0.1.4

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

vuerd-plugin-summernote

vuerd-core plugin summernote

npm version Build Status

Document

Storybook
Live Demo

Install

$ yarn add vuerd-core
$ yarn add vuerd-plugin-summernote
or
$ npm install vuerd-core
$ npm install vuerd-plugin-summernote

Usage

// main.js or main.ts
import Vue from 'vue';
import VuerdCore from 'vuerd-core';
import Summernote from 'vuerd-plugin-summernote';
import 'vuerd-core/dist/vuerd-core.css';
import 'vuerd-plugin-summernote/dist/vuerd-plugin-summernote.css';

VuerdCore.use(
  Summernote,
/*
  {
    imageUpload(files, callback) {
      // upload
      callback("URL");
    }
  }
*/
);

Vue.use(VuerdCore);
<vuerd-core />

CDN Quick Start

<!DOCTYPE html>
<html>
<head>
  <title>vuerd-core demo</title>
  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/vuerd-core/dist/vuerd-core.css">
  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/vuerd-plugin-summernote/dist/vuerd-plugin-summernote.css">
</head>
<body>
  <div id="app">
    <vuerd-core />
  </div>
  <script src="https://cdn.jsdelivr.net/npm/vue"></script>
  <script src="https://cdn.jsdelivr.net/npm/vuerd-core/dist/vuerd-core.umd.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/vuerd-plugin-summernote/dist/vuerd-plugin-summernote.umd.min.js"></script>
  <script>
    const VuerdCore = window['vuerd-core'].default
    const Summernote = window['vuerd-plugin-summernote'].default
    VuerdCore.use(Summernote)
    Vue.use(VuerdCore)
    new Vue({
      el: '#app'
    })
  </script>
</body>
</html>

Option interface

export interface Option {
  imageUpload?: (files: File[], callback: (url: string) => void) => void;
  scope?: string[] | RegExp[];
  exclude?: string[] | RegExp[];
  editorOption?: EditorOption;
}

export interface EditorOption {
  tabsize?: number;
  toolbar?: [string, Toolbar[]][] | boolean;
}

export type Toolbar =
  | "style"
  | "bold"
  | "underline"
  | "clear"
  | "fontname"
  | "color"
  | "ul"
  | "ol"
  | "paragraph"
  | "table"
  | "link"
  | "picture"
  | "video"
  | "fullscreen"
  | "codeview"
  | "help";

Option

NameTypeDefaultDescribe
imageUploadfunctionbase64image upload
scopeString | RegExp"rich"file designation(string extension)
excludeString | RegExpexception file designation(string extension)
editorOptionEditorOptiondefault optionsummernote option

default EditorOption

editorOption = {
    tabsize: 2,
    toolbar: [
        ["style", ["style"]],
        ["font", ["bold", "underline", "clear"]],
        ["fontname", ["fontname"]],
        ["color", ["color"]],
        ["para", ["ul", "ol", "paragraph"]],
        ["table", ["table"]],
        ["insert", ["link", "picture", "video"]],
        ["view", ["fullscreen", "codeview", "help"]]
    ]
};

License

MIT