Giter Club home page Giter Club logo

codemirror-widgets's Introduction

codemirror-widgets

Utility to easily write interactive widgets for CodeMirror.

Installation

$ npm install codemirror-widgets

Usage

Example, replace LaTeX math ($$ ... $$) by a preview using KaTeX

var widgets = require('codemirror-widgets');
var katex = require('katex');

// Create a type of widget
var WidgetMath = widgets.createType({
    mixins: [
        widgets.mixins.re(/\$\$([^$]+)\$\$/g, function(match) {
            return {
                props: {
                    text: match[1]
                }
            };
        }),
        widgets.mixins.editDelimit('$$', '$$')
    ],

    createElement: function(widget) {
        // Create the spam to replace the formula
        var span = document.createElement('span');

        // Render the formula using katex
        katex.render(widget.props.text, span)

        return span;
    }
});


// Create a widgets manager connected to an editor
var manager = widgets.createManager(editor);

// Connect a type of widget to the manager
manager.enable(WidgetLink);

Mixins

Some prebuilt mixins make it event easier to create awesome widgets:

re

Find occurrence using a Regex:

var widgetMath = widgets.createType({
    mixins: [
        widgets.mixins.re(/\$\$([^$]+)\$\$/g, function(match) {
            return {
                props: {
                    text: match[1]
                }
            };
        })
    ],

    ...
});
menu

Bind a menu with multiple actions to your widgets. The menu will show up on click (like on Gmail).

var widgetLink = widgets.createType({
    mixins: [
        widgets.mixins.menu({
            entries: [
                {
                    label: 'Open',
                    click: function(widget) {
                        window.open(widget.props.href, '_blank')
                    }
                }
            ]
        })
    ],

    ...
});
editParagraph

Helper to update a paragraph when user is typing

var widgetLink = widgets.createType({
    mixins: [
        widgets.mixins.editParagraph()
    ],

    ...
});

codemirror-widgets's People

Contributors

samypesse avatar

Watchers

 avatar  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.