BookStack Code Mirror - bookstack/blob - resources/js/wysiwyg/ui/defaults/button-definitions.ts

   1 import {EditorButtonDefinition} from "../framework/buttons";
   2 import {
   3     $createNodeSelection,
   4     $createParagraphNode, $getRoot, $getSelection, $insertNodes,
   5     $isParagraphNode, $setSelection,
   6     BaseSelection, ElementNode, FORMAT_TEXT_COMMAND,
   7     LexicalNode,
   8     REDO_COMMAND, TextFormatType,
   9     UNDO_COMMAND
  10 } from "lexical";
  11 import {
  12     getNodeFromSelection,
  13     selectionContainsNodeType,
  14     selectionContainsTextFormat,
  15     toggleSelectionBlockNodeType
  16 } from "../../helpers";
  17 import {$createCalloutNode, $isCalloutNodeOfCategory, CalloutCategory} from "../../nodes/callout";
  18 import {
  19     $createHeadingNode,
  20     $createQuoteNode,
  21     $isHeadingNode,
  22     $isQuoteNode,
  23     HeadingNode,
  24     HeadingTagType
  25 } from "@lexical/rich-text";
  26 import {$isLinkNode, $toggleLink, LinkNode} from "@lexical/link";
  27 import {EditorUiContext} from "../framework/core";
  28 import {$isImageNode, ImageNode} from "../../nodes/image";
  29 import {$createDetailsNode, $isDetailsNode} from "../../nodes/details";
  30 import {$insertNodeToNearestRoot} from "@lexical/utils";
  31 import {getEditorContentAsHtml} from "../../actions";
  32
  33 export const undo: EditorButtonDefinition = {
  34     label: 'Undo',
  35     action(context: EditorUiContext) {
  36         context.editor.dispatchCommand(UNDO_COMMAND, undefined);
  37     },
  38     isActive(selection: BaseSelection|null): boolean {
  39         return false;
  40     }
  41 }
  42
  43 export const redo: EditorButtonDefinition = {
  44     label: 'Redo',
  45     action(context: EditorUiContext) {
  46         context.editor.dispatchCommand(REDO_COMMAND, undefined);
  47     },
  48     isActive(selection: BaseSelection|null): boolean {
  49         return false;
  50     }
  51 }
  52
  53 function buildCalloutButton(category: CalloutCategory, name: string): EditorButtonDefinition {
  54     return {
  55         label: `${name} Callout`,
  56         action(context: EditorUiContext) {
  57             toggleSelectionBlockNodeType(
  58                 context.editor,
  59                 (node) => $isCalloutNodeOfCategory(node, category),
  60                 () => $createCalloutNode(category),
  61             )
  62         },
  63         isActive(selection: BaseSelection|null): boolean {
  64             return selectionContainsNodeType(selection, (node) => $isCalloutNodeOfCategory(node, category));
  65         }
  66     };
  67 }
  68
  69 export const infoCallout: EditorButtonDefinition = buildCalloutButton('info', 'Info');
  70 export const dangerCallout: EditorButtonDefinition = buildCalloutButton('danger', 'Danger');
  71 export const warningCallout: EditorButtonDefinition = buildCalloutButton('warning', 'Warning');
  72 export const successCallout: EditorButtonDefinition = buildCalloutButton('success', 'Success');
  73
  74 const isHeaderNodeOfTag = (node: LexicalNode | null | undefined, tag: HeadingTagType) => {
  75       return $isHeadingNode(node) && (node as HeadingNode).getTag() === tag;
  76 };
  77
  78 function buildHeaderButton(tag: HeadingTagType, name: string): EditorButtonDefinition {
  79     return {
  80         label: name,
  81         action(context: EditorUiContext) {
  82             toggleSelectionBlockNodeType(
  83                 context.editor,
  84                 (node) => isHeaderNodeOfTag(node, tag),
  85                 () => $createHeadingNode(tag),
  86             )
  87         },
  88         isActive(selection: BaseSelection|null): boolean {
  89             return selectionContainsNodeType(selection, (node) => isHeaderNodeOfTag(node, tag));
  90         }
  91     };
  92 }
  93
  94 export const h2: EditorButtonDefinition = buildHeaderButton('h2', 'Large Header');
  95 export const h3: EditorButtonDefinition = buildHeaderButton('h3', 'Medium Header');
  96 export const h4: EditorButtonDefinition = buildHeaderButton('h4', 'Small Header');
  97 export const h5: EditorButtonDefinition = buildHeaderButton('h5', 'Tiny Header');
  98
  99 export const blockquote: EditorButtonDefinition = {
 100     label: 'Blockquote',
 101     action(context: EditorUiContext) {
 102         toggleSelectionBlockNodeType(context.editor, $isQuoteNode, $createQuoteNode);
 103     },
 104     isActive(selection: BaseSelection|null): boolean {
 105         return selectionContainsNodeType(selection, $isQuoteNode);
 106     }
 107 };
 108
 109 export const paragraph: EditorButtonDefinition = {
 110     label: 'Paragraph',
 111     action(context: EditorUiContext) {
 112         toggleSelectionBlockNodeType(context.editor, $isParagraphNode, $createParagraphNode);
 113     },
 114     isActive(selection: BaseSelection|null): boolean {
 115         return selectionContainsNodeType(selection, $isParagraphNode);
 116     }
 117 }
 118
 119 function buildFormatButton(label: string, format: TextFormatType): EditorButtonDefinition {
 120     return {
 121         label: label,
 122         action(context: EditorUiContext) {
 123             context.editor.dispatchCommand(FORMAT_TEXT_COMMAND, format);
 124         },
 125         isActive(selection: BaseSelection|null): boolean {
 126             return selectionContainsTextFormat(selection, format);
 127         }
 128     };
 129 }
 130
 131 export const bold: EditorButtonDefinition = buildFormatButton('Bold', 'bold');
 132 export const italic: EditorButtonDefinition = buildFormatButton('Italic', 'italic');
 133 export const underline: EditorButtonDefinition = buildFormatButton('Underline', 'underline');
 134 // Todo - Text color
 135 // Todo - Highlight color
 136 export const strikethrough: EditorButtonDefinition = buildFormatButton('Strikethrough', 'strikethrough');
 137 export const superscript: EditorButtonDefinition = buildFormatButton('Superscript', 'superscript');
 138 export const subscript: EditorButtonDefinition = buildFormatButton('Subscript', 'subscript');
 139 export const code: EditorButtonDefinition = buildFormatButton('Inline Code', 'code');
 140 // Todo - Clear formatting
 141
 142
 143 export const link: EditorButtonDefinition = {
 144     label: 'Insert/edit link',
 145     action(context: EditorUiContext) {
 146         const linkModal = context.manager.createModal('link');
 147         context.editor.getEditorState().read(() => {
 148             const selection = $getSelection();
 149             const selectedLink = getNodeFromSelection(selection, $isLinkNode) as LinkNode|null;
 150
 151             let formDefaults = {};
 152             if (selectedLink) {
 153                 formDefaults = {
 154                     url: selectedLink.getURL(),
 155                     text: selectedLink.getTextContent(),
 156                     title: selectedLink.getTitle(),
 157                     target: selectedLink.getTarget(),
 158                 }
 159
 160                 context.editor.update(() => {
 161                     const selection = $createNodeSelection();
 162                     selection.add(selectedLink.getKey());
 163                     $setSelection(selection);
 164                 });
 165             }
 166
 167             linkModal.show(formDefaults);
 168         });
 169     },
 170     isActive(selection: BaseSelection|null): boolean {
 171         return selectionContainsNodeType(selection, $isLinkNode);
 172     }
 173 };
 174
 175 export const image: EditorButtonDefinition = {
 176     label: 'Insert/Edit Image',
 177     action(context: EditorUiContext) {
 178         const imageModal = context.manager.createModal('image');
 179         const selection = context.lastSelection;
 180         const selectedImage = getNodeFromSelection(selection, $isImageNode) as ImageNode|null;
 181
 182         context.editor.getEditorState().read(() => {
 183             let formDefaults = {};
 184             if (selectedImage) {
 185                 formDefaults = {
 186                     src: selectedImage.getSrc(),
 187                     alt: selectedImage.getAltText(),
 188                     height: selectedImage.getHeight(),
 189                     width: selectedImage.getWidth(),
 190                 }
 191
 192                 context.editor.update(() => {
 193                     const selection = $createNodeSelection();
 194                     selection.add(selectedImage.getKey());
 195                     $setSelection(selection);
 196                 });
 197             }
 198
 199             imageModal.show(formDefaults);
 200         });
 201     },
 202     isActive(selection: BaseSelection|null): boolean {
 203         return selectionContainsNodeType(selection, $isImageNode);
 204     }
 205 };
 206
 207 export const details: EditorButtonDefinition = {
 208     label: 'Insert collapsible block',
 209     action(context: EditorUiContext) {
 210         context.editor.update(() => {
 211             const selection = $getSelection();
 212             const detailsNode = $createDetailsNode();
 213             const selectionNodes = selection?.getNodes() || [];
 214             const topLevels = selectionNodes.map(n => n.getTopLevelElement())
 215                 .filter(n => n !== null) as ElementNode[];
 216             const uniqueTopLevels = [...new Set(topLevels)];
 217
 218             if (uniqueTopLevels.length > 0) {
 219                 uniqueTopLevels[0].insertAfter(detailsNode);
 220             } else {
 221                 $getRoot().append(detailsNode);
 222             }
 223
 224             for (const node of uniqueTopLevels) {
 225                 detailsNode.append(node);
 226             }
 227         });
 228     },
 229     isActive(selection: BaseSelection|null): boolean {
 230         return selectionContainsNodeType(selection, $isDetailsNode);
 231     }
 232 }
 233
 234 export const source: EditorButtonDefinition = {
 235     label: 'Source code',
 236     async action(context: EditorUiContext) {
 237         const modal = context.manager.createModal('source');
 238         const source = await getEditorContentAsHtml(context.editor);
 239         modal.show({source});
 240     },
 241     isActive() {
 242         return false;
 243     }
 244 };