Socket
Socket
Sign inDemoInstall

summernote

Package Overview
Dependencies
Maintainers
0
Versions
41
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

summernote

Super simple WYSIWYG editor


Version published
Weekly downloads
103K
decreased by-3.16%
Maintainers
0
Weekly downloads
 
Created
Source

Summernote

Build Status npm version Coverage Status

Summernote is a JavaScript library that helps you create WYSIWYG editors with a simple and easy-to-use interface. Summernote is licensed under MIT and maintained by the community.

Homepage: https://summernote.org

Why Summernote?

Summernote has a few special features:

  • Simple and User-friendly: Providing a simple and intuitive interface that allows users
  • Easy to install: Just include the JS/CSS files on your HTML and create a div tag to get started.
  • Compatible with Bootstrap: Bootstrap 3, 4, and 5.
  • Rich ecosystem: A wide array of plugins and connectors are available, enhancing functionality and integration options.
  • Easy image handling: Images are automatically embedded in the content using base64 encoding, eliminating the need for separate image management

How to Use

Summernote is built on jQuery.

How to install

1. Include JS/CSS

Include the following code in the <head> tag of your HTML:

<!-- 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>
2. Place a div tag

Then place a div tag somewhere in the body tag. This element will be replaced with the summernote editor.

<div id="summernote">Hello Summernote</div>
3. Initialize Summernote

Finally, initialize Summernote with the following JavaScript:

$(document).ready(function() {
  $('#summernote').summernote();
});

For more examples, please visit to homepage.

API

Summernote provides a set of API. For example, you can use the following code to get the HTML source code underlying the text in the editor:

var html = $('#summernote').summernote('code');

For more detail about API, please refer to document.

Warning - code injection The code view allows the user to enter script contents. Make sure to filter/sanitize the HTML on the server. Otherwise, an attacker can inject arbitrary JavaScript code into clients.

For contributing

See the CONTRIBUTING.md for details on how to contribute to Summernote.

Contributors ✨

Thanks go to these incredible people:

contributors

Contacts

Keywords

FAQs

Package last updated on 28 Sep 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc