Skip to content

Latest commit

 

History

History
212 lines (167 loc) · 7.58 KB

SpEditor.md

File metadata and controls

212 lines (167 loc) · 7.58 KB

SpEditor

SpEditor is a HTML5 rich text editor in smartphone browsers, and it's extends Editor.

import { SpEditor } from 'sp-editor'
import 'sp-editor/css'

const spEditor = new SpEditor({
  // container: document.querySelector('#app'),
  // or
  container: '#app',
})

Methods

More methods please see Editor methods documentation.

addToolbarButton(params, index)

Add a custom button to toolbar.

// Add a button named 'custom-button-name' for toolbar.
editor.addToolbarButton({
  name: 'custom-button-name',
})

// when the button is clicked
editor.on('toolbarButtonOnClick', (name) => {
  if (name === 'custom-button-name') {
    // do something ...
  }
})
Param Types Required Description
params ButtonOptions yes ButtonOptions
index number no New button insertion index.
  • @returns void

destroy()

destroy events

  • @returns void

handleImageFile(files)

Image files handler.

Param Types Required Description
files FileList/File[]/Blob[]/null yes Image files.

Types

ButtonOptions

button options, use by add button to toolbar

Prop Types Required Description
name string yes button name, returned when button is clicked
className string no class='name'
innerHtml string/HTMLElement/Node no inner html, Element or Node
style CSSProperties no style
Source Code 
interface ButtonOptions {
  // button name, returned when button is clicked
  name: string
  // class='name'
  className?: string
  // inner html, Element or Node
  innerHtml?: string | HTMLElement | Node
  // style
  style?: CSSProperties
}

SpEditorOptions

extends EditorOptions, StylePanelOptions and ToolbarOptions

Prop Types Required Description
container string/HTMLElement no container that Editor parent HTMLElement
editable boolean no The contenteditable global attribute is an enumerated attribute indicating if the element should be editable by the user. If so, the browser modifies its widget to allow editing. default true.
placeholder string no 编辑器内容为空是的提示内容，default 请在此输入内容..
placeholderColor string no placeholder color, default #999
lineHeight string/number no 编辑器内容行高，default 1.5
minHeight string/number no min height, default 50vh
paddingBottom string/number no Set paddingBottom to avoid being obscured by toolbar or style panel, default 50vh
childNodeName string no Editor's child node name, default section
allowedNodeNames string[] no 允许使用的编辑器子元素节点名称， default ['SECTION', 'H1', 'H2', 'H3', 'H4', 'H5', 'BLOCKQUOTE', 'UL', 'OL'] allowed Node names
paragraphTailSpacing string/number no paragraph tail spacing, default 10px
caretColor string no 光标颜色
textColor string no 编辑器文本默认颜色 default color of editor text, default #333333
customPasteHandler (e: ClipboardEvent) => void no 自定义用户粘贴处理函数
styles CSSProperties no 编辑器自定义样式
insertTextToNewParagraph boolean no Insert text to new paragraph, only textNode is valid. default false
textStyleColors string[] no colors array of style panel, default ['#333333', '#d0d0d0', '#ff583d', '#fdaa25', '#44c67b', '#14b2e0', '#b065e2'].
textStyleTitle string no title of style panel, default Set Style.
textStyleHeadLeftBtnText string no text of button that style panel's left, default Clear.
toolbarBeenFixed boolean no Has the toolbar been fixed. default true
toolbarHeight number/string no toolbar height. default 50px
toolbarButtons string[] no buttons name, and order. default ['choose-picture', 'text-style']. Button click events can be listener editor.on('toolbarButtonOnClick, ('button-name') => { ... })
customPictureHandler () => void no image options customize Picture Handler
imageMaxWidth number no image max width, default 750
ignoreGif boolean no GIF pictures are not processed, default true.
forceImageResize boolean no Force the width/height of the picture, even if the width/height of the picture is smaller than the target width/height. default false.
chooseFileMultiple boolean no When the multiple Boolean attribute is specified, the file input allows the user to select more than one file. default true.
chooseFileAccept string no mimeType, for example image/jpeg, default image/*
Source Code 
interface SpEditorOptions extends EditorOptions, StylePanelOptions, ToolbarOptions {
  // image options
  // customize Picture Handler
  customPictureHandler?: () => void
  // image max width, default `750`
  imageMaxWidth?: number
  // GIF pictures are not processed, default `true`.
  ignoreGif?: boolean
  // Force the width/height of the picture, even if the width/height of the picture
  // is smaller than the target width/height. default `false`.
  forceImageResize?: boolean
  // When the `multiple` Boolean attribute is specified, the file input allows the user to select more than one file. default `true`.
  chooseFileMultiple?: boolean
  // mimeType, for example `image/jpeg`, default `image/*`
  chooseFileAccept?: string
}

StylePanelOptions

Prop Types Required Description
textStyleColors string[] no colors array of style panel, default ['#333333', '#d0d0d0', '#ff583d', '#fdaa25', '#44c67b', '#14b2e0', '#b065e2'].
textStyleTitle string no title of style panel, default Set Style.
textStyleHeadLeftBtnText string no text of button that style panel's left, default Clear.
Source Code 
interface StylePanelOptions {
  // colors array of style panel, default `['#333333', '#d0d0d0', '#ff583d', '#fdaa25', '#44c67b', '#14b2e0', '#b065e2']`.
  textStyleColors?: string[]
  // title of style panel, default `Set Style`.
  textStyleTitle?: string
  // text of button that style panel's left, default `Clear`.
  textStyleHeadLeftBtnText?: string
}

ToolbarOptions

toolbar options

Prop Types Required Description
toolbarBeenFixed boolean no Has the toolbar been fixed. default true
toolbarHeight number/string no toolbar height. default 50px
toolbarButtons string[] no buttons name, and order. default ['choose-picture', 'text-style']. Button click events can be listener editor.on('toolbarButtonOnClick, ('button-name') => { ... })
Source Code 
interface ToolbarOptions {
  // Has the toolbar been fixed. default `true`
  toolbarBeenFixed?: boolean
  // toolbar height. default `50px`
  toolbarHeight?: number | string
  // buttons name, and order. default `['choose-picture', 'text-style']`.
  // Button click events can be listener `editor.on('toolbarButtonOnClick, ('button-name') => { ... })`
  toolbarButtons?: string[]
}

Other Docs

Docs Description Url
Editor class Editor documentation, main module of SpEditor. /docs/Editor.md
EventEmitter class EventEmitter documentation. /docs/EventEmitter.md
SpEditor class SpEditor documentation. /docs/SpEditor.md
nodejs-helpers nodejs-helpers documentation. /docs/nodejs-helpers.md
Others Other documentations. /docs

License

MIT License © 2018-Present Capricorncd.