Giter Club home page Giter Club logo

medium-editor-list's Introduction

MediumEditor List

It is simple list extension with "Add new paragraph" option for MediumEditor.

Install

You can install manually or either by using npm:

npm install medium-editor-list

Demo page

medium-editor-list.

Usage

<!DOCTYPE html>
<html>
    <head>
        <title>MediumEditor List</title>
        <meta charset="UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <link rel="stylesheet" href="<path_to_medium-editor>/dist/css/medium-editor.min.css" type="text/css" media="screen" charset="utf-8">
        <style>
            body, p, div {
                margin: 0;
                padding: 0;
            }
            #editor{ width: 100%; height: 100vh; }
        </style>
    </head>
    <body>
        <div id="editor"></div>
        <script src="<path_to_medium-editor>/dist/js/medium-editor.js" type="text/javascript"></script>
        <script src="<path_to_medium-editor_list>/build/medium-editor-list.js" type="text/javascript"></script>
        <script>
            var editor = new MediumEditor(document.getElementById('editor'), {
                toolbar: {
                    buttons: ['bold', 'italic', 'underline', 'list-extension']
                },
                extensions: {
                    'list-extension': new MediumEditorList()
                },
                mediumEditorList: {
                    newParagraphTemplate: '<li>...</li>',
                    buttonTemplate: '<b>List</b>',
                    addParagraphTemplate: 'Add new paragraph',
                    isEditable: true
                }
            });
        </script>
    </body>
</html>

Options

Options to customize medium-editor-list are passed as the argument of the MediumEditor options. Example:

            var editor = new MediumEditor(document.getElementById('editor'), {
                toolbar: {
                    buttons: ['bold', 'italic', 'underline', 'list-extension']
                },
                extensions: {
                    'list-extension': new MediumEditorList()
                },
                mediumEditorList: {
                    newParagraphTemplate: '<li>...</li>',
                    buttonTemplate: '<b>List</b>',
                    addParagraphTemplate: 'Add new paragraph',
                    isEditable: true
                }
            });
  • newParagraphTemplate - template for new paragraph adding by "Add new Paragraph" button
  • buttonTemplate - toolbar button template
  • addParagraphTemplate - "Add new Paragraph" button template
  • isEditable - if this flag is set to false Add new Paragraph button will not be display.

How to run example page?

Clone repository and:

 npm install
 gulp

License

https://github.com/mkawczynski07/medium-editor-list/blob/master/LICENSE.md

medium-editor-list's People

Contributors

armadilov avatar josefromsanjose avatar mkawczynski07 avatar sirmarbug avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.