JavaScripting

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


  • ×

    A lightweight HTML and BBCode WYSIWYG editor
    Filed under 

    • 🔾41%Overall
    • 465
    • 8.4 days
    • 🕩153
    • 👥10

    SCEditor v2.1.2

    Build Status Dependency Status SemVer License

    A lightweight WYSIWYG BBCode and XHTML editor.

    SCEditor preview

    For more information visit sceditor.com

    Usage

    Include the SCEditor JavaScript:

    <link rel="stylesheet" href="minified/themes/default.min.css" />
    <script src="minified/sceditor.min.js"></script>
    <script src="minified/formats/bbcode.js"></script>
    <script src="minified/formats/xhtml.js"></script>
    

    Then to convert a textarea into SCEditor, simply do:

    var textarea = document.getElementById('id-of-textarea');
    
    sceditor.create(textarea, {
        format: 'xhtml',
        style: 'minified/themes/content/default.min.css'
    });
    

    or for a BBCode WYSIWYG editor do:

    var textarea = document.getElementById('id-of-textarea');
    
    sceditor.create(textarea, {
        format: 'bbcode',
        style: 'minified/themes/content/default.min.css'
    });
    

    Finally, to get the contents of the editor:

    var textarea = document.getElementById("id-of-textarea");
    
    sceditor.instance(textarea).val();
    

    Options

    For a full list of options, see the options documentation.

    Building and testing

    You will need Grunt installed to run the build/tests. To install Grunt run:

    npm install -g grunt-cli
    

    Next, to install the SCEditor dev dependencies run:

    npm install
    

    That's it! You can now build and test SCEditor with the following commands:

    # Minify the JS and convert the LESS to CSS
    grunt build
    
    # Run the linter, unit tests and coverage
    grunt test
    
    # Creates the final distributable ZIP file
    grunt release
    

    You can also run the dev server to test changes without having to do a full build by running:

    npm run dev
    

    and then going to http://localhost:9000/tests/

    Contribute

    Any contributions and/or pull requests would be welcome.

    Themes, translations, bug reports, bug fixes and donations are greatly appreciated.

    If you would like to make a donation you can via PayPal or via Flattr

    License

    SCEditor is licensed under the MIT license:

    Copyright (C) 2011 - 2017 Sam Clarke and contributors – sceditor.com

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Credits

    Nomicons: The Full Monty Emoticons by: Oscar Gruno, aka Nominell v. 2.0 -> oscargruno@mac.com Andy Fedosjeenko, aka Nightwolf -> bobo@animevanguard.com

    Icons by: Mark James (http://www.famfamfam.com/lab/icons/silk/) Licensed under the Creative Commons CC-BY license.

    Show All