入门
获取 Summernote
安装
基础API
i18n 支持
集成
深入研究
初始化选项
自定义工具栏、弹出窗口
块引号断开级别
自定义样式
自定义字体名称
自定义字体大小单位
自定义行高
自定义占位符
对话框
禁用拖放
禁用快捷键
禁用 TAB
代码视图的 XSS 保护
基础API
字体样式 API
段落 API
插入 API
范围和选择 API
回调
自定义按钮
自定义图标
模块系统
模块
实例
空气模式
带 Bootswatch 的主题
多个编辑器
点击编辑
在线代码编辑器视图
自定义 SVG 图标
提示
插件
安装 - summernote文档 - 笔下光年
网站首页
安装
### 安装需要 HTML5 doctype Bootstrap 使用某些需要 HTML5 doctype 的 HTML 元素和 CSS 属性。 请在您所有项目的开头加入 `<!DOCTYPE html>`。 ```html <!DOCTYPE html> <html lang="en"> ... </html> ``` ### 包含 js/css 如果你使用的是 Boostrap 3 或 4 版本的 Summernote,Summernote 会使用 jQuery 和 Bootstrap 这两个开源库;如果你使用的是 Lite 版本的 Summernote,则只使用 jQuery。在 HTML 页面的头部包含以下代码。 ```html <!-- include libraries(jQuery, bootstrap) --> <link href="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css" rel="stylesheet"> <script src="https://code.jquery.com/jquery-3.5.1.min.js"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script> <!-- include summernote css/js --> <link href="https://cdn.jsdelivr.net/npm/summernote@0.8.18/dist/summernote.min.css" rel="stylesheet"> <script src="https://cdn.jsdelivr.net/npm/summernote@0.8.18/dist/summernote.min.js"></script> ``` 如果下载的 summernote 文件夹不同,请不要忘记更改文件路径。 不过,你也可以在页面头部加入样式表,并在页面底部加入 Javascript,但要在结尾的 `body` 标签之前加入。 > **Fontawesome依赖性** 在 0.8.0 版之后,你不必再使用 fontawesome 来显示 Summernote 的图标了。但你仍然可以使用 fontawesome 来显示自定义图标。更多详情,请访问自定义按钮部分。v0.8.18 之后,你可以用自定义图标覆盖 summernote 图标。更多详情,请访问自定义图标部分。 ### 嵌入 Summernote 可在有表单或无表单的情况下使用。 要在不带 `form` 的情况下使用,我们建议在正文中使用一个 `div`;然后在页面中需要呈现 Summernote 编辑器的地方使用该元素。 ```html <div id="summernote">Hello Summernote</div> ``` 在 `form` 中使用的方法与上述基本相同,但我们建议在 `form` 中使用 `textarea` 元素而不是 `div`,其中应包含 `name` 属性,这样当表单提交时,你就可以使用该名称在后台处理编辑器数据。此外,如果在 `form` 中使用 Summernote,请设置 `method="post"` 属性,以便将较大尺寸的编辑器内容解析到后台,否则数据可能无法解析或被截断。 ```html <form method="post"> <textarea id="summernote" name="editordata"></textarea> </form> ``` ### 运行 summernote 文件准备就绪后,运行下面的脚本! ```javascript $(document).ready(function() { $('#summernote').summernote(); }); ``` 如果在文档末尾包含 Javascript,则尤其需要使用 `$(document).ready` 函数。 ### 简单示例 您也可以测试运行示例。将以下代码另存为 `index.html`,然后用浏览器打开。 ```html <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Summernote</title> <link href="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css" rel="stylesheet"> <script src="https://code.jquery.com/jquery-3.5.1.min.js"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script> <link href="https://cdn.jsdelivr.net/npm/summernote@0.8.18/dist/summernote.min.css" rel="stylesheet"> <script src="https://cdn.jsdelivr.net/npm/summernote@0.8.18/dist/summernote.min.js"></script> </head> <body> <div id="summernote"><p>Hello Summernote</p></div> <script> $(document).ready(function() { $('#summernote').summernote(); }); </script> </body> </html> ``` ### 用于 Bootstrap 4 你还可以使用 `summernote-bs4.js` 和 `summernote-bs4.css` 在 Bootstrap 4 中使用 Summernote。 ```html <html lang="en"> <head> <meta charset="UTF-8"> <title>Summernote with Bootstrap 4</title> <script src="https://code.jquery.com/jquery-3.5.1.min.js" crossorigin="anonymous"></script> <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh" crossorigin="anonymous"> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js" integrity="sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6" crossorigin="anonymous"></script> <link href="https://cdn.jsdelivr.net/npm/summernote@0.8.18/dist/summernote-bs4.min.css" rel="stylesheet"> <script src="https://cdn.jsdelivr.net/npm/summernote@0.8.18/dist/summernote-bs4.min.js"></script> </head> <body> <div id="summernote"></div> <script> $('#summernote').summernote({ placeholder: 'Hello Bootstrap 4', tabsize: 2, height: 100 }); </script> </body> </html> ``` ### 用于 Bootstrap 5 你还可以使用 `summernote-bs5.js` 和 `summernote-bs5.css` 将 Summernote 与 Bootstrap 5 结合使用。 ```html <html lang="en"> <head> <meta charset="UTF-8"> <title>Summernote with Bootstrap 5</title> <!-- include libraries(jQuery, bootstrap) --> <script type="text/javascript" src="//code.jquery.com/jquery-3.6.0.min.js"></script> <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" /> <script type="text/javascript" src="cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js"></script> <!-- include summernote css/js--> <link href="summernote-bs5.css" rel="stylesheet"> <script src="summernote-bs5.js"></script> </head> <body> <div id="summernote"></div> <script> $('#summernote').summernote({ placeholder: 'Hello Bootstrap 5', tabsize: 2, height: 100 }); </script> </body> </html> Without Bootstr ``` ### 无 Bootstrap(精简版) 使用 `summernote-lite.js` 和 `summernote-lite. css`,你可以在不使用 Bootstrap 的情况下使用 Summernote。 ```html <html lang="en"> <head> <meta charset="UTF-8"> <title>without bootstrap</title> <script src="https://code.jquery.com/jquery-3.4.1.slim.min.js" integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n" crossorigin="anonymous"></script> <link href="https://cdn.jsdelivr.net/npm/summernote@0.8.18/dist/summernote-lite.min.css" rel="stylesheet"> <script src="https://cdn.jsdelivr.net/npm/summernote@0.8.18/dist/summernote-lite.min.js"></script> </head> <body> <div id="summernote"></div> <script> $('#summernote').summernote({ placeholder: 'Hello stand alone ui', tabsize: 2, height: 120, toolbar: [ ['style', ['style']], ['font', ['bold', 'underline', 'clear']], ['color', ['color']], ['para', ['ul', 'ol', 'paragraph']], ['table', ['table']], ['insert', ['link', 'picture', 'video']], ['view', ['fullscreen', 'codeview', 'help']] ] }); </script> </body> </html> ```
上一篇:
获取 Summernote
下一篇:
基础API