summernote
Advanced tools
Summernote is a JavaScript library that provides a WYSIWYG (What You See Is What You Get) editor. It allows users to create and edit content with a rich text editor that includes various formatting options, image and video embedding, and more.
Basic Text Formatting
This code initializes Summernote on a textarea element, enabling basic text formatting options like bold, italic, underline, and more.
<script>
$(document).ready(function() {
$('#summernote').summernote();
});
</script>
<textarea id="summernote"></textarea>Image Upload
This code demonstrates how to handle image uploads in Summernote by providing a custom callback function for the onImageUpload event.
<script>
$(document).ready(function() {
$('#summernote').summernote({
callbacks: {
onImageUpload: function(files) {
// Custom image upload logic
}
}
});
});
</script>
<textarea id="summernote"></textarea>Video Embedding
Summernote allows users to embed videos directly into the editor. This is done through the toolbar options available in the initialized editor.
<script>
$(document).ready(function() {
$('#summernote').summernote();
});
</script>
<textarea id="summernote"></textarea>Custom Toolbar
This code shows how to customize the toolbar in Summernote by specifying the buttons and their groups.
<script>
$(document).ready(function() {
$('#summernote').summernote({
toolbar: [
['style', ['bold', 'italic', 'underline', 'clear']],
['font', ['strikethrough', 'superscript', 'subscript']],
['fontsize', ['fontsize']],
['color', ['color']],
['para', ['ul', 'ol', 'paragraph']],
['height', ['height']]
]
});
});
</script>
<textarea id="summernote"></textarea>TinyMCE is another popular WYSIWYG editor that offers a wide range of features similar to Summernote. It provides extensive customization options, plugins, and a robust API for developers.
CKEditor is a highly versatile WYSIWYG editor that supports rich text editing, image and media embedding, and various plugins. It is known for its flexibility and extensive documentation.
Quill is a modern WYSIWYG editor that is lightweight and highly customizable. It offers a modular architecture, making it easy to extend and customize according to specific needs.
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
Summernote has a few special features:
Summernote is built on jQuery.
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>
div tagThen place a div tag somewhere in the body tag. This element will be replaced with the summernote editor.
<div id="summernote">Hello Summernote</div>
Finally, initialize Summernote with the following JavaScript:
$(document).ready(function() {
$('#summernote').summernote();
});
For more examples, please visit to homepage.
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.
See the CONTRIBUTING.md for details on how to contribute to Summernote.
Thanks go to these incredible people:
Is your company using Summernote? Ask your boss to support us. It will help us dedicate more time to maintain this project and to make it even better for all our users. Also, your company logo will show up on here and on our website: -) [Become a sponsor]
Please be our Backers.
v0.9.1
FAQs
Super simple WYSIWYG editor
We found that summernote demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
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.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.