JavaScripting

The definitive source of the best
JavaScript libraries, frameworks, and plugins.


  • ×

    Summernote

    Super simple WYSIWYG editor
    Filed under 

    • 🔾86%Overall
    • 8,281
    • 1.4 days
    • 🕩1725
    • 👥13

    Summernote

    Super simple WYSIWYG Editor.

    Build Status npm version Coverage Status

    Sauce Test Status

    Summernote

    Summernote is a JavaScript library that helps you create WYSIWYG editors online.

    Home page: https://summernote.org

    Why Summernote?

    Summernote has a few special features:

    • Paste images from clipboard
    • Saves images directly in the content of the field using base64 encoding, so you don't need to implement image handling at all
    • Simple UI
    • Interactive WYSIWYG editing
    • Handy integration with server
    • Supports Bootstrap 3 and 4 integrities
    • Lots of plugins and connectors provided together

    Installation and dependencies

    Summernote is built on jQuery.

    1. Include JS/CSS

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

    <!-- include libraries(jQuery, bootstrap) -->
    <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script> 
    <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/css/bootstrap.min.css" />
    <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
    
    <!-- include summernote css/js-->
    <link href="summernote.css" rel="stylesheet">
    <script src="summernote.js"></script>
    

    2. Target a element

    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. Summernote it!

    Finally, run this script after the DOM is ready:

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

    For more examples, please visit to homepage.

    API

    code - 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

    https://github.com/summernote/summernote/blob/develop/CONTRIBUTING.md

    Contacts

    License

    Summernote may be freely distributed under the MIT license.

    Show All