jonathantreffler / quill-mathlive-blot

A Blot/Extension for Quill.js to embed editable formulas with mathLive.

Quill-mathLive-blot

A Blot/Extension for Quill.js to embed editable formulas with mathLive.

Installation:

npm install quill-mathlive-blot

Usage:

• import Quill

import mathLiveBlot from "quill-mathlive-blot";

// MathLive options can be modified before the initialisation.
// If changed later it only applies to mathLive Instances created after the change.
mathLiveBlot.options.virtualKeyboardMode = "off";

var quill = new Quill('#editor-container', {
	modules: {
		toolbar: {
			container: [
				['bold', 'italic', 'underline'],
				['mathLive']
			],
			handlers: {
				'mathLive': insert,
			}
		}
	},
	placeholder: '',
	theme: 'snow'
});

mathLiveBlot.register(Quill);

// This function gets called by the quill toolbar handler.
// It can also be called programmatically.
function insert() {
	let selection = quill.getSelection();
	// In this example a mathLive instance will start with the content "x"
	quill.insertEmbed(selection.index, "mathLive", "x");
}

Configuration:

Options can be set through the mathLiveBlot.options variable.

The default values are:

smartMode: true,
virtualKeyboardMode: "manual",
virtualKeyboardLayout: "qwertz",
virtualKeyboardTheme: "material",
virtualKeyboards: "all",
inlineShortcuts: {
	"minus": "-",
	"-": "-",
	"plus": "+",
	"/": "\\frac",
	"super 1": "^1",
	"super 2": "^2",
	"super 3": "^3",
	"super 4": "^4",
	"super 5": "^5",
	"super 6": "^6",
	"super 7": "^7",
	"super 8": "^8",
	"super 9": "^8",
},

Demo

quill-mathlive-blot's Issues

Documentation or instructions to integrate it with quill

Can I get the Documentation or a set of instructions so that I can use this library to integrate it with Quill

Thank you,
Kiran

Dependabot couldn't find a package.json for this project

Dependabot couldn't find a package.json for this project.

Dependabot requires a package.json to evaluate your project's current JavaScript dependencies. It had expected to find one at the path: /package.json.

If this isn't a JavaScript project, or if it is a library, you may wish to disable updates for it from within Dependabot.

View the update logs.

Add Stylelint