anki/ts/editor/index.ts

615 lines
17 KiB
TypeScript
Raw Normal View History

2019-02-05 04:59:03 +01:00
/* Copyright: Ankitects Pty Ltd and contributors
* License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html */
2021-01-30 17:54:07 +01:00
import { filterHTML } from "./filterHtml";
import { nodeIsElement, nodeIsInline } from "./helpers";
2021-01-31 14:15:03 +01:00
import { bridgeCommand } from "./lib";
2021-01-30 17:54:07 +01:00
let currentField: EditingArea | null = null;
2021-01-29 00:43:45 +01:00
let changeTimer: number | null = null;
let currentNoteId: number | null = null;
2021-01-30 18:32:36 +01:00
declare global {
interface String {
format(...args: string[]): string;
}
interface Selection {
modify(s: string, t: string, u: string): void;
addRange(r: Range): void;
removeAllRanges(): void;
getRangeAt(n: number): Range;
}
}
2019-12-18 04:53:31 +01:00
/* kept for compatibility with add-ons */
2021-01-30 18:32:36 +01:00
String.prototype.format = function (...args: string[]): string {
return this.replace(/\{\d+\}/g, (m: string): void => {
const match = m.match(/\d+/);
return match ? args[match[0]] : "";
});
};
2021-01-30 17:54:07 +01:00
export function setFGButton(col: string): void {
document.getElementById("forecolor").style.backgroundColor = col;
2017-07-28 08:48:49 +02:00
}
2021-01-30 17:54:07 +01:00
export function saveNow(keepFocus: boolean): void {
if (!currentField) {
return;
}
clearChangeTimer();
if (keepFocus) {
saveField("key");
} else {
// triggers onBlur, which saves
currentField.blurEditable();
}
2017-07-28 08:48:49 +02:00
}
function triggerKeyTimer(): void {
clearChangeTimer();
2020-06-24 13:54:38 +02:00
changeTimer = setTimeout(function () {
updateButtonState();
saveField("key");
}, 600);
}
function onKey(evt: KeyboardEvent): void {
// esc clears focus, allowing dialog to close
if (evt.code === "Escape") {
currentField.blurEditable();
return;
}
2021-01-14 13:32:30 +01:00
// prefer <br> instead of <div></div>
if (evt.code === "Enter" && !inListItem()) {
2021-01-14 13:32:30 +01:00
evt.preventDefault();
document.execCommand("insertLineBreak");
}
2021-01-28 18:37:38 +01:00
// // fix Ctrl+right/left handling in RTL fields
if (currentField.isRightToLeft()) {
const selection = currentField.getSelection();
const granularity = evt.ctrlKey ? "word" : "character";
const alter = evt.shiftKey ? "extend" : "move";
switch (evt.code) {
case "ArrowRight":
selection.modify(alter, "right", granularity);
evt.preventDefault();
return;
case "ArrowLeft":
selection.modify(alter, "left", granularity);
evt.preventDefault();
return;
}
}
triggerKeyTimer();
2017-07-28 08:48:49 +02:00
}
function onKeyUp(evt: KeyboardEvent): void {
// Avoid div element on remove
if (evt.code === "Enter" || evt.code === "Backspace") {
const anchor = currentField.getSelection().anchorNode;
if (
nodeIsElement(anchor) &&
anchor.tagName === "DIV" &&
!(anchor instanceof EditingArea) &&
anchor.childElementCount === 1 &&
anchor.children[0].tagName === "BR"
) {
anchor.replaceWith(anchor.children[0]);
}
}
}
function inListItem(): boolean {
2021-01-28 17:43:56 +01:00
const anchor = currentField.getSelection().anchorNode;
let inList = false;
let n = nodeIsElement(anchor) ? anchor : anchor.parentElement;
while (n) {
inList = inList || window.getComputedStyle(n).display == "list-item";
n = n.parentElement;
}
return inList;
}
2021-01-30 17:54:07 +01:00
export function insertNewline(): void {
if (!inPreEnvironment()) {
setFormat("insertText", "\n");
return;
}
// in some cases inserting a newline will not show any changes,
// as a trailing newline at the end of a block does not render
// differently. so in such cases we note the height has not
// changed and insert an extra newline.
const r = currentField.getSelection().getRangeAt(0);
if (!r.collapsed) {
// delete any currently selected text first, making
// sure the delete is undoable
setFormat("delete");
}
const oldHeight = currentField.clientHeight;
setFormat("inserthtml", "\n");
2017-07-28 08:48:49 +02:00
if (currentField.clientHeight === oldHeight) {
setFormat("inserthtml", "\n");
}
}
// is the cursor in an environment that respects whitespace?
function inPreEnvironment(): boolean {
const anchor = currentField.getSelection().anchorNode;
const n = nodeIsElement(anchor) ? anchor : anchor.parentElement;
return window.getComputedStyle(n).whiteSpace.startsWith("pre");
}
function onInput(): void {
// make sure IME changes get saved
triggerKeyTimer();
2017-07-28 08:48:49 +02:00
}
function updateButtonState(): void {
const buts = ["bold", "italic", "underline", "superscript", "subscript"];
for (const name of buts) {
const elem = document.querySelector(`#${name}`) as HTMLElement;
elem.classList.toggle("highlighted", document.queryCommandState(name));
}
// fixme: forecolor
2019-12-18 07:12:39 +01:00
// 'col': document.queryCommandValue("forecolor")
2017-07-28 08:48:49 +02:00
}
2021-01-30 17:54:07 +01:00
export function toggleEditorButton(buttonid: string): void {
const button = $(buttonid)[0];
button.classList.toggle("highlighted");
2017-07-28 08:48:49 +02:00
}
2021-01-30 17:54:07 +01:00
export function setFormat(cmd: string, arg?: any, nosave: boolean = false): void {
document.execCommand(cmd, false, arg);
if (!nosave) {
2019-12-18 07:12:39 +01:00
saveField("key");
updateButtonState();
}
2017-07-28 08:48:49 +02:00
}
function clearChangeTimer(): void {
if (changeTimer) {
clearTimeout(changeTimer);
changeTimer = null;
}
2017-07-28 08:48:49 +02:00
}
function onFocus(evt: FocusEvent): void {
const elem = evt.currentTarget as EditingArea;
if (currentField === elem) {
// anki window refocused; current element unchanged
return;
}
elem.focusEditable();
currentField = elem;
2021-01-31 14:15:03 +01:00
bridgeCommand(`focus:${currentField.ord}`);
enableButtons();
// do this twice so that there's no flicker on newer versions
caretToEnd();
// scroll if bottom of element off the screen
function pos(elem: HTMLElement): number {
let cur = 0;
do {
cur += elem.offsetTop;
elem = elem.offsetParent as HTMLElement;
} while (elem);
return cur;
}
const y = pos(elem);
2019-12-18 07:12:39 +01:00
if (
window.pageYOffset + window.innerHeight < y + elem.offsetHeight ||
window.pageYOffset > y
) {
window.scroll(0, y + elem.offsetHeight - window.innerHeight);
}
}
2021-01-30 17:54:07 +01:00
export function focusField(n: number): void {
const field = getEditorField(n);
if (field) {
field.editingArea.focusEditable();
}
}
2021-01-30 17:54:07 +01:00
export function focusIfField(x: number, y: number): boolean {
const elements = document.elementsFromPoint(x, y);
for (let i = 0; i < elements.length; i++) {
let elem = elements[i] as EditingArea;
if (elem instanceof EditingArea) {
elem.focusEditable();
// the focus event may not fire if the window is not active, so make sure
// the current field is set
currentField = elem;
return true;
}
}
return false;
}
function onPaste(): void {
2021-01-31 14:15:03 +01:00
bridgeCommand("paste");
window.event.preventDefault();
}
function caretToEnd(): void {
2021-01-29 00:43:45 +01:00
const range = document.createRange();
range.selectNodeContents(currentField.editable);
2021-01-29 00:43:45 +01:00
range.collapse(false);
const selection = currentField.getSelection();
selection.removeAllRanges();
selection.addRange(range);
2017-07-28 08:48:49 +02:00
}
function onBlur(): void {
if (!currentField) {
return;
}
if (document.activeElement === currentField) {
// other widget or window focused; current field unchanged
saveField("key");
} else {
saveField("blur");
currentField = null;
disableButtons();
}
2017-07-28 08:48:49 +02:00
}
function containsInlineContent(field: Element): boolean {
if (field.childNodes.length === 0) {
// for now, for all practical purposes, empty fields are in block mode
return false;
}
for (const child of field.children) {
if (!nodeIsInline(child)) {
return false;
}
}
return true;
}
function saveField(type: "blur" | "key"): void {
clearChangeTimer();
if (!currentField) {
// no field has been focused yet
return;
}
2021-01-31 14:15:03 +01:00
bridgeCommand(
`${type}:${currentField.ord}:${currentNoteId}:${currentField.fieldHTML}`
);
2017-07-28 08:48:49 +02:00
}
function wrappedExceptForWhitespace(text: string, front: string, back: string): string {
const match = text.match(/^(\s*)([^]*?)(\s*)$/);
return match[1] + front + match[2] + back + match[3];
2017-07-28 08:48:49 +02:00
}
2021-01-30 17:54:07 +01:00
export function preventButtonFocus(): void {
for (const element of document.querySelectorAll("button.linkb")) {
element.addEventListener("mousedown", (evt: Event) => {
evt.preventDefault();
});
}
}
function disableButtons(): void {
$("button.linkb:not(.perm)").prop("disabled", true);
2017-07-28 08:48:49 +02:00
}
function enableButtons(): void {
$("button.linkb").prop("disabled", false);
2017-07-28 08:48:49 +02:00
}
// disable the buttons if a field is not currently focused
function maybeDisableButtons(): void {
if (document.activeElement instanceof EditingArea) {
enableButtons();
} else {
disableButtons();
}
2017-07-28 08:48:49 +02:00
}
2021-01-30 17:54:07 +01:00
export function wrap(front: string, back: string): void {
wrapInternal(front, back, false);
}
/* currently unused */
function wrapIntoText(front: string, back: string): void {
wrapInternal(front, back, true);
}
function wrapInternal(front: string, back: string, plainText: boolean): void {
const s = currentField.getSelection();
let r = s.getRangeAt(0);
const content = r.cloneContents();
const span = document.createElement("span");
span.appendChild(content);
if (plainText) {
const new_ = wrappedExceptForWhitespace(span.innerText, front, back);
setFormat("inserttext", new_);
} else {
const new_ = wrappedExceptForWhitespace(span.innerHTML, front, back);
setFormat("inserthtml", new_);
}
if (!span.innerHTML) {
// run with an empty selection; move cursor back past postfix
r = s.getRangeAt(0);
r.setStart(r.startContainer, r.startOffset - back.length);
r.collapse(true);
s.removeAllRanges();
s.addRange(r);
}
2017-07-28 08:48:49 +02:00
}
function onCutOrCopy(): boolean {
2021-01-31 14:15:03 +01:00
bridgeCommand("cutOrCopy");
return true;
}
class Editable extends HTMLElement {
set fieldHTML(content: string) {
this.innerHTML = content;
if (containsInlineContent(this)) {
this.appendChild(document.createElement("br"));
}
}
get fieldHTML(): string {
return containsInlineContent(this) && this.innerHTML.endsWith("<br>")
? this.innerHTML.slice(0, -4) // trim trailing <br>
: this.innerHTML;
}
2021-01-29 20:13:02 +01:00
connectedCallback() {
this.setAttribute("contenteditable", "");
}
}
customElements.define("anki-editable", Editable);
class EditingArea extends HTMLDivElement {
editable: Editable;
baseStyle: HTMLStyleElement;
constructor() {
super();
this.attachShadow({ mode: "open" });
this.className = "field";
const rootStyle = document.createElement("link");
rootStyle.setAttribute("rel", "stylesheet");
rootStyle.setAttribute("href", "./_anki/css/editable.css");
this.shadowRoot.appendChild(rootStyle);
this.baseStyle = document.createElement("style");
this.baseStyle.setAttribute("rel", "stylesheet");
this.shadowRoot.appendChild(this.baseStyle);
this.editable = document.createElement("anki-editable") as Editable;
this.shadowRoot.appendChild(this.editable);
}
get ord(): number {
return Number(this.getAttribute("ord"));
}
2021-01-29 20:13:02 +01:00
set fieldHTML(content: string) {
this.editable.fieldHTML = content;
2021-01-29 20:13:02 +01:00
}
get fieldHTML(): string {
return this.editable.fieldHTML;
2021-01-29 20:13:02 +01:00
}
connectedCallback(): void {
this.addEventListener("keydown", onKey);
this.addEventListener("keyup", onKeyUp);
this.addEventListener("input", onInput);
this.addEventListener("focus", onFocus);
this.addEventListener("blur", onBlur);
this.addEventListener("paste", onPaste);
this.addEventListener("copy", onCutOrCopy);
this.addEventListener("oncut", onCutOrCopy);
const baseStyleSheet = this.baseStyle.sheet as CSSStyleSheet;
baseStyleSheet.insertRule("anki-editable {}", 0);
}
disconnectedCallback(): void {
this.removeEventListener("keydown", onKey);
this.removeEventListener("keyup", onKeyUp);
this.removeEventListener("input", onInput);
this.removeEventListener("focus", onFocus);
this.removeEventListener("blur", onBlur);
this.removeEventListener("paste", onPaste);
this.removeEventListener("copy", onCutOrCopy);
this.removeEventListener("oncut", onCutOrCopy);
}
initialize(color: string, content: string): void {
this.setBaseColor(color);
this.editable.fieldHTML = content;
}
setBaseColor(color: string): void {
const styleSheet = this.baseStyle.sheet as CSSStyleSheet;
const firstRule = styleSheet.cssRules[0] as CSSStyleRule;
firstRule.style.color = color;
}
2021-01-28 18:37:38 +01:00
setBaseStyling(fontFamily: string, fontSize: string, direction: string): void {
const styleSheet = this.baseStyle.sheet as CSSStyleSheet;
const firstRule = styleSheet.cssRules[0] as CSSStyleRule;
firstRule.style.fontFamily = fontFamily;
firstRule.style.fontSize = fontSize;
firstRule.style.direction = direction;
}
2021-01-28 18:37:38 +01:00
isRightToLeft(): boolean {
return this.editable.style.direction === "rtl";
2021-01-28 18:37:38 +01:00
}
2021-01-30 18:32:36 +01:00
getSelection(): Selection {
return this.shadowRoot.getSelection();
2021-01-28 17:43:56 +01:00
}
focusEditable(): void {
this.editable.focus();
}
blurEditable(): void {
this.editable.blur();
}
}
customElements.define("anki-editing-area", EditingArea, { extends: "div" });
class EditorField extends HTMLDivElement {
labelContainer: HTMLDivElement;
label: HTMLSpanElement;
editingArea: EditingArea;
constructor() {
super();
this.labelContainer = document.createElement("div");
this.labelContainer.className = "fname";
this.appendChild(this.labelContainer);
this.label = document.createElement("span");
this.label.className = "fieldname";
this.labelContainer.appendChild(this.label);
this.editingArea = document.createElement("div", {
is: "anki-editing-area",
}) as EditingArea;
this.appendChild(this.editingArea);
}
static get observedAttributes(): string[] {
return ["ord"];
}
2021-01-29 20:13:02 +01:00
set ord(n: number) {
this.setAttribute("ord", String(n));
}
attributeChangedCallback(name: string, _oldValue: string, newValue: string): void {
switch (name) {
case "ord":
this.editingArea.setAttribute("ord", newValue);
}
}
initialize(label: string, color: string, content: string): void {
this.label.innerText = label;
this.editingArea.initialize(color, content);
}
2021-01-28 18:37:38 +01:00
setBaseStyling(fontFamily: string, fontSize: string, direction: string): void {
this.editingArea.setBaseStyling(fontFamily, fontSize, direction);
2021-01-28 18:37:38 +01:00
}
}
customElements.define("anki-editor-field", EditorField, { extends: "div" });
function adjustFieldAmount(amount: number): void {
const fieldsContainer = document.getElementById("fields");
while (fieldsContainer.childElementCount < amount) {
const newField = document.createElement("div", {
is: "anki-editor-field",
}) as EditorField;
newField.ord = fieldsContainer.childElementCount;
fieldsContainer.appendChild(newField);
}
while (fieldsContainer.childElementCount > amount) {
fieldsContainer.removeChild(fieldsContainer.lastElementChild);
}
}
function getEditorField(n: number): EditorField | null {
const fields = document.getElementById("fields").children;
return (fields[n] as EditorField) ?? null;
}
function forEditorField<T>(
values: T[],
func: (field: EditorField, value: T) => void
): void {
const fields = document.getElementById("fields").children;
for (let i = 0; i < fields.length; i++) {
const field = fields[i] as EditorField;
func(field, values[i]);
2021-01-28 18:37:38 +01:00
}
}
2021-01-30 17:54:07 +01:00
export function setFields(fields: [string, string][]): void {
// webengine will include the variable after enter+backspace
// if we don't convert it to a literal colour
const color = window
.getComputedStyle(document.documentElement)
.getPropertyValue("--text-fg");
adjustFieldAmount(fields.length);
forEditorField(fields, (field, [name, fieldContent]) =>
field.initialize(name, color, fieldContent)
);
maybeDisableButtons();
2017-07-28 08:48:49 +02:00
}
2021-01-30 17:54:07 +01:00
export function setBackgrounds(cols: ("dupe" | "")[]) {
forEditorField(cols, (field, value) =>
field.editingArea.classList.toggle("dupe", value === "dupe")
);
document
.querySelector("#dupes")
.classList.toggle("is-inactive", !cols.includes("dupe"));
}
2021-01-30 17:54:07 +01:00
export function setFonts(fonts: [string, number, boolean][]): void {
forEditorField(fonts, (field, [fontFamily, fontSize, isRtl]) => {
2021-01-28 18:37:38 +01:00
field.setBaseStyling(fontFamily, `${fontSize}px`, isRtl ? "rtl" : "ltr");
});
}
2021-01-30 17:54:07 +01:00
export function setNoteId(id: number): void {
currentNoteId = id;
}
2021-01-30 17:54:07 +01:00
export let pasteHTML = function (
2021-01-19 01:08:15 +01:00
html: string,
internal: boolean,
extendedMode: boolean
): void {
html = filterHTML(html, internal, extendedMode);
if (html !== "") {
setFormat("inserthtml", html);
}
};