zx-editor

Version:

ZxEditor is a HTML5 rich text editor

2 lines • 18.3 kB

HTML

<!DOCTYPE HTML><html><head><meta charset="UTF-8"><meta content="text/html; charset=utf-8" http-equiv="Content-Type"><title>参数 Options · zx-editor v3.x.x</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="description" content=""><meta name="generator" content="GitBook 3.2.3"><meta name="author" content="Capricorncd"><link rel="stylesheet" href="gitbook/style.css"><link rel="stylesheet" href="gitbook/gitbook-plugin-back-to-top-button/plugin.css"><link rel="stylesheet" href="gitbook/gitbook-plugin-chapter-fold/chapter-fold.css"><link rel="stylesheet" href="gitbook/gitbook-plugin-expandable-chapters-small/expandable-chapters-small.css"><link rel="stylesheet" href="gitbook/gitbook-plugin-flexible-alerts/style.css"><link rel="stylesheet" href="gitbook/gitbook-plugin-insert-logo/plugin.css"><link rel="stylesheet" href="gitbook/gitbook-plugin-search-pro/search.css"><link rel="stylesheet" href="gitbook/gitbook-plugin-tbfed-pagefooter/footer.css"><link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css"><link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css"><meta name="HandheldFriendly" content="true"><meta name="viewport" content="width=device-width,initial-scale=1,user-scalable=no"><meta name="apple-mobile-web-app-capable" content="yes"><meta name="apple-mobile-web-app-status-bar-style" content="black"><link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png"><link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon"><link rel="next" href="options.html"><link rel="prev" href="./"></head><body><div class="book"><div class="book-summary"><div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div><nav role="navigation"><ul class="summary"><li class="header">zx-editor</li><li class="chapter" data-level="1.1" data-path="./"><a href="./">version 3.x.x</a></li><li class="chapter active" data-level="1.2" data-path="options.html"><a href="options.html">参数 Options</a><ul class="articles"><li class="chapter" data-level="1.2.1" data-path="options.html"><a href="options.html#editable">editable</a></li><li class="chapter" data-level="1.2.2" data-path="options.html"><a href="options.html#placeholder">placeholder</a></li><li class="chapter" data-level="1.2.3" data-path="options.html"><a href="options.html#placeholdercolor">placeholderColor</a></li><li class="chapter" data-level="1.2.4" data-path="options.html"><a href="options.html#lineheight">lineHeight</a></li><li class="chapter" data-level="1.2.5" data-path="options.html"><a href="options.html#paragraphtailspacing">paragraphTailSpacing</a></li><li class="chapter" data-level="1.2.6" data-path="options.html"><a href="options.html#cursorcolor">cursorColor</a></li><li class="chapter" data-level="1.2.7" data-path="options.html"><a href="options.html#offsettop">offsetTop</a></li><li class="chapter" data-level="1.2.8" data-path="options.html"><a href="options.html#speed">speed</a></li><li class="chapter" data-level="1.2.9" data-path="options.html"><a href="options.html#toolbarbeenfixed">toolbarBeenFixed</a></li><li class="chapter" data-level="1.2.10" data-path="options.html"><a href="options.html#toolbarheight">toolbarHeight</a></li><li class="chapter" data-level="1.2.11" data-path="options.html"><a href="options.html#toolbarbtns">toolbarBtns</a></li><li class="chapter" data-level="1.2.12" data-path="options.html"><a href="options.html#customPictureHandler">customPictureHandler</a></li><li class="chapter" data-level="1.2.13" data-path="options.html"><a href="options.html#imagemaxwidth">imageMaxWidth</a></li><li class="chapter" data-level="1.2.14" data-path="options.html"><a href="options.html#imagemaxsize">imageMaxSize</a></li><li class="chapter" data-level="1.2.15" data-path="options.html"><a href="options.html#imagesectiontemp">imageSectionTemp</a></li><li class="chapter" data-level="1.2.16" data-path="options.html"><a href="options.html#ignoregif">ignoreGif</a></li><li class="chapter" data-level="1.2.17" data-path="options.html"><a href="options.html#forceimageresize">forceImageResize</a></li><li class="chapter" data-level="1.2.18" data-path="options.html"><a href="options.html#textstylecolors">textStyleColors</a></li><li class="chapter" data-level="1.2.19" data-path="options.html"><a href="options.html#textstyletitle">textStyleTitle</a></li><li class="chapter" data-level="1.2.20" data-path="options.html"><a href="options.html#textStyleheadLeftbtntext">textStyleHeadLeftBtnText</a></li><li class="chapter" data-level="1.2.21" data-path="options.html"><a href="options.html#textstyleheadalign">textStyleHeadAlign</a></li><li class="chapter" data-level="1.2.22" data-path="options.html"><a href="options.html#maincolor">mainColor</a></li><li class="chapter" data-level="1.2.23" data-path="options.html"><a href="options.html#bordercolor">borderColor</a></li></ul></li><li class="chapter" data-level="1.3" data-path="propertys.html"><a href="propertys.html">属性 Property</a><ul class="articles"><li class="chapter" data-level="1.3.1" data-path="propertys.html"><a href="propertys.html#expansionpanel">ExpansionPanel</a></li></ul></li><li class="chapter" data-level="1.4" data-path="methods.html"><a href="methods.html">方法 Methods</a><ul class="articles"><li class="chapter" data-level="1.4.1" data-path="methods.html"><a href="methods.html#$">ZxQuery:$</a></li><li class="chapter" data-level="1.4.2" data-path="methods.html"><a href="methods.html#gethtml">getHtml</a></li><li class="chapter" data-level="1.4.3" data-path="methods.html"><a href="methods.html#sethtml">setHtml</a></li></ul></li><li class="divider"></li><li><a href="https://github.com/capricorncd/zx-editor" target="blank" class="gitbook-link">Github</a></li></ul></nav></div><div class="book-body"><div class="body-inner"><div class="book-header" role="navigation"><h1><i class="fa fa-circle-o-notch fa-spin"></i> <a href=".">参数 Options</a></h1></div><div class="page-wrapper" tabindex="-1" role="main"><div class="page-inner"><div id="book-search-results"><div class="search-noresults"><section class="normal markdown-section"><h1 id="options-初始化参数">Options 初始化参数</h1><pre><code class="lang-javascript"><span class="hljs-keyword">const</span> zxEditor = <span class="hljs-keyword">new</span> ZxEditor(selector, options) </code></pre><blockquote><p>[!TIP|label:selector]</p><p><code>id</code> 、<code>className</code> 选择器，或 <code>DOM元素</code>。</p></blockquote><h3 id="editable">editable</h3><p>类型：<code>boolean</code></p><p>默认：<code>true</code></p><p>说明：内容是否可以被编辑。</p><h3 id="placeholder">placeholder</h3><p>类型：<code>string</code></p><p>默认：<code>Enter...</code></p><p>说明：编辑器内容为空时，显示的提示文字。</p><h3 id="placeholdercolor">placeholderColor</h3><p>类型：<code>string</code></p><p>默认：<code>#ccc</code></p><p>说明：placeholder文字颜色。</p><h3 id="lineheight">lineHeight</h3><p>类型：<code>number/string</code></p><p>默认：<code>1.5</code></p><p>说明：正文内容行高。</p><h3 id="paragraphtailspacing">paragraphTailSpacing</h3><p>类型：<code>string</code></p><p>默认：<code>10px</code></p><p>说明：段落尾部间距。</p><p>paragraph tail spacing, default 10px</p><h3 id="cursorcolor">cursorColor</h3><p>类型：<code>string</code></p><p>默认：<code>#333</code></p><p>说明：光标颜色(不一定兼容所有浏览器)。</p><h3 id="offsettop">offsetTop</h3><p>类型：<code>number</code></p><p>默认:<code>30</code></p><p>说明：输入内容时，光标位置距顶部距离。</p><h3 id="speed">speed</h3><p>类型：<code>number</code></p><p>默认：<code>0</code></p><p>说明：位置检测，输入可视区域元素移动速度，单位毫秒(ms)。</p><h3 id="toolbarbeenfixed">toolbarBeenFixed</h3><p>类型：<code>boolean</code></p><p>默认：<code>true</code></p><p>说明：底部工具栏是否始终固定。</p><h3 id="toolbarheight">toolbarHeight</h3><p>类型：<code>number</code></p><p>默认：<code>50</code></p><p>说明：底部工具栏高度。</p><h3 id="toolbarbtns">toolbarBtns</h3><p>类型：<code>array</code></p><p>默认：<code>['select-picture', 'text-style']</code></p><p>说明：底部工具栏显示图标及顺序。</p><h3 id="custompicturehandler">customPictureHandler</h3><p>类型：<code>boolean</code></p><p>默认：<code>false</code></p><p>说明：自定义图片处理，即不使用默认插入图片逻辑。</p><h3 id="imagemaxwidth">imageMaxWidth</h3><p>类型：<code>number</code></p><p>默认：<code>750</code></p><p>说明：正文中插入图片的最大宽度，大于该尺寸的图片将被等比缩放至宽度为设置值。单位 <code>px</code>。</p><h3 id="imagemaxsize">imageMaxSize</h3><p>类型：<code>number</code></p><p>默认：<code>20480</code></p><p>说明：正文中插入图片的最大文件大小，默认20480Kib（20M），单位 <code>Kib</code>。</p><h3 id="imagesectiontemp">imageSectionTemp</h3><p>类型：<code>string</code></p><p>默认：<code><section class="child-is-picture"><img src="{url}"></section></code></p><p>说明：正文中插入图片元素html模板，<code>{url}</code>字符串会被替换成图片base64数据，或url地址。</p><h3 id="ignoregif">ignoreGif</h3><p>类型：<code>boolean</code></p><p>默认：<code>true</code></p><p>说明：插入图片为gif，不做转换和裁剪等处理。注意，gif等比缩放或裁剪过程中只会取其第一帧，所以处理后的gif无动态效果。</p><h3 id="forceimageresize">forceImageResize</h3><p>类型：<code>boolean</code></p><p>默认：<code>false</code></p><p>说明：原图片尺寸小于目标尺寸时，强制缩放或裁剪图片。</p><p>Force the width/height of the picture, even if the width/height of the picture is smaller than the target width/height</p><h3 id="textstylecolors">textStyleColors</h3><p>类型：<code>array</code></p><p>默认：<code>['#333', '#d0d0d0', '#ff583d', '#fdaa25', '#44c67b', '#14b2e0', '#b065e2']</code></p><p>说明：文字样式扩展面板，可选颜色值列表。</p><blockquote><p>[!WARNING|style:flat|label:提示]</p><p>为空数组时，不显示颜色栏。</p></blockquote><h3 id="textstyletitle">textStyleTitle</h3><p>类型：<code>string</code></p><p>默认：<code>Set Style</code></p><p>说明：文字样式扩展面板，标题。</p><h3 id="textstyleheadleftbtntext">textStyleHeadLeftBtnText</h3><p>类型：<code>string</code></p><p>默认：<code>Clear style</code></p><p>说明：文字样式扩展面板，标题栏左侧按钮文字内容。</p><h3 id="textstyleheadalign">textStyleHeadAlign</h3><p>类型：<code>string</code></p><p>默认：<code>center</code></p><p>说明：文字样式扩展面板，标题栏对齐方式。可选值 <code>left/center/right</code>。</p><h3 id="maincolor">mainColor</h3><p>类型：<code>string</code></p><p>默认：<code>#00c1b7</code></p><p>说明：编辑器主题色。</p><h3 id="bordercolor">borderColor</h3><p>类型：<code>string</code></p><p>默认：<code>#ddd</code></p><p>说明：边框颜色。</p><footer class="page-footer"><span class="copyright">© 2019 Capricorncd.</span><span class="footer-modification">该文件修订时间： 2020-02-29 10:34:15</span></footer></section></div><div class="search-results"><div class="has-results"><h1 class="search-results-title"><span class="search-results-count"></span> results matching "<span class="search-query"></span>"</h1><ul class="search-results-list"></ul></div><div class="no-results"><h1 class="search-results-title">No results matching "<span class="search-query"></span>"</h1></div></div></div></div></div></div><a href="./" class="navigation navigation-prev" aria-label="Previous page: version 3.x.x"><i class="fa fa-angle-left"></i> </a><a href="options.html#editable" class="navigation navigation-next" aria-label="Next page: editable"><i class="fa fa-angle-right"></i></a></div><script>var gitbook=gitbook||[];gitbook.push(function(){gitbook.page.hasChanged({page:{title:"参数 Options",level:"1.2",depth:1,next:{title:"editable",level:"1.2.1",depth:2,anchor:"#editable",path:"options.md",ref:"options.md#editable",articles:[]},previous:{title:"version 3.x.x",level:"1.1",depth:1,path:"README.md",ref:"README.md",articles:[]},dir:"ltr"},config:{plugins:["-sharing","-lunr","-search","back-to-top-button","chapter-fold","expandable-chapters-small","flexible-alerts","insert-logo","search-pro","tbfed-pagefooter"],styles:{website:"styles/website.css",pdf:"styles/pdf.css",epub:"styles/epub.css",mobi:"styles/mobi.css",ebook:"styles/ebook.css",print:"styles/print.css"},pluginsConfig:{"tbfed-pagefooter":{copyright:"&copy 2019 Capricorncd",modify_label:"该文件修订时间：",modify_format:"YYYY-MM-DD HH:mm:ss"},"chapter-fold":{},"search-pro":{},code:{copyButtons:!1},fontsettings:{theme:"white",family:"sans",size:2},highlight:{},"back-to-top-button":{},"expandable-chapters-small":{},"flexible-alerts":{style:"callout",note:{label:"Note",icon:"fa fa-info-circle",className:"info"},tip:{label:"Tip",icon:"fa fa-lightbulb-o",className:"tip"},warning:{label:"Warning",icon:"fa fa-exclamation-triangle",className:"warning"},danger:{label:"Attention",icon:"fa fa-ban",className:"danger"}},"theme-default":{styles:{website:"styles/website.css",pdf:"styles/pdf.css",epub:"styles/epub.css",mobi:"styles/mobi.css",ebook:"styles/ebook.css",print:"styles/print.css"},showLevel:!1},"insert-logo":{url:"./logo.png",style:"background: none; max-height: 50px; min-height: 30px"}},theme:"default",author:"Capricorncd",pdf:{pageNumbers:!0,fontSize:12,fontFamily:"Arial",paperSize:"a4",chapterMark:"pagebreak",pageBreaksBefore:"/",margin:{right:62,left:62,top:56,bottom:56}},structure:{langs:"LANGS.md",readme:"README.md",glossary:"GLOSSARY.md",summary:"SUMMARY.md"},variables:{},title:"zx-editor v3.x.x",gitbook:"*"},file:{path:"options.md",mtime:"2020-02-29T02:34:15.382Z",type:"markdown"},gitbook:{version:"3.2.3",time:"2020-10-25T08:04:23.548Z"},basePath:".",book:{language:""}})})</script></div><script src="gitbook/gitbook.js"></script><script src="gitbook/theme.js"></script><script src="gitbook/gitbook-plugin-back-to-top-button/plugin.js"></script><script src="gitbook/gitbook-plugin-chapter-fold/chapter-fold.js"></script><script src="gitbook/gitbook-plugin-expandable-chapters-small/expandable-chapters-small.js"></script><script src="gitbook/gitbook-plugin-flexible-alerts/plugin.js"></script><script src="gitbook/gitbook-plugin-insert-logo/plugin.js"></script><script src="gitbook/gitbook-plugin-search-pro/jquery.mark.min.js"></script><script src="gitbook/gitbook-plugin-search-pro/search.js"></script><script src="gitbook/gitbook-plugin-fontsettings/buttons.js"></script></body></html>