A fully open source & end-to-end encrypted note taking alternative to Evernote.
TypeScript asp-net-coredotnet-coreelectronfosshacktoberfestnote-managmentnote-takingnote-taking-appnotebooknotesnotes-appopen-sourceopensourceprivacyproductivityreactreact-nativereactjsself-hosted
/*
This file is part of the Notesnook project (https://notesnook.com/)
Copyright (C) 2023 Streetwriters (Private) Limited
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/*---------------------------------------------------------
* Author: Benjamin R. Bray
* License: MIT (see LICENSE in project root for details)
*--------------------------------------------------------*/
// prosemirror imports
import { Node as ProseNode } from "prosemirror-model";
import {
Plugin as ProsePlugin,
PluginKey,
PluginSpec
} from "prosemirror-state";
import { MathView } from "./math-node-view.js";
import { EditorView } from "prosemirror-view";
import { KatexRenderer } from "./renderers/katex.js";
////////////////////////////////////////////////////////////
export interface IMathPluginState {
macros: { [cmd: string]: string };
/** A list of currently active `NodeView`s, in insertion order. */
activeNodeViews: MathView[];
/**
* Used to determine whether to place the cursor in the front- or back-most
* position when expanding a math node, without overriding the default arrow
* key behavior.
*/
prevCursorPos: number;
}
// uniquely identifies the prosemirror-math plugin
const MATH_PLUGIN_KEY = new PluginKey<IMathPluginState>("prosemirror-math");
/**
* Returns a function suitable for passing as a field in `EditorProps.nodeViews`.
* @param inline TRUE for block math, FALSE for inline math.
* @see https://prosemirror.net/docs/ref/#view.EditorProps.nodeViews
*/
export function createMathView(inline: boolean) {
return (
node: ProseNode,
view: EditorView,
getPos: boolean | (() => number | undefined)
): MathView => {
/** @todo is this necessary?
* Docs says that for any function proprs, the current plugin instance
* will be bound to `this`. However, the typings don't reflect this.
*/
const pluginState = MATH_PLUGIN_KEY.getState(view.state);
if (!pluginState) {
throw new Error("no math plugin!");
}
const nodeViews = pluginState.activeNodeViews;
// set up NodeView
const nodeView = new MathView(
node,
view,
getPos as () => number,
{
className: inline ? "math-inline" : "math-block",
renderer: inline ? KatexRenderer.inline : KatexRenderer.block,
tagName: inline ? "span" : "div"
},
MATH_PLUGIN_KEY
);
nodeViews.push(nodeView);
return nodeView;
};
}
const mathPluginSpec: PluginSpec<IMathPluginState> = {
key: MATH_PLUGIN_KEY,
state: {
init() {
return {
macros: {},
activeNodeViews: [],
prevCursorPos: 0
};
},
apply(_tr, value, oldState, newState) {
// produce updated state field for this plugin
const newPos = newState.selection.from;
const oldPos = oldState.selection.from;
return {
// these values are left unchanged
activeNodeViews: value.activeNodeViews,
macros: value.macros,
// update with the second-most recent cursor pos
prevCursorPos: oldPos !== newPos ? oldPos : value.prevCursorPos
};
}
/** @todo (8/21/20) implement serialization for math plugin */
// toJSON(value) { },
// fromJSON(config, value, state){ return {}; }
},
props: {
nodeViews: {
mathInline: createMathView(true),
mathBlock: createMathView(false)
}
}
};
export const mathPlugin = new ProsePlugin(mathPluginSpec);