wysimark-lite 0.16.2 → 0.17.0

package/README.md

@@ -15,6 +15,10 @@ https://takeshy.github.io/wysimark-lite
 
 ### As React Component
 
+```bash
+npm install wysimark-lite
+```
+
 ```tsx
 import { Editable, useEditor } from "wysimark-lite";
 import React from "react";

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as slate from 'slate';
-import { Descendant, Editor, Element as Element$1, BaseEditor, NodeEntry, BaseRange, Location, Path, BaseText } from 'slate';
+import { Descendant, Editor, Element as Element$1, BaseEditor, NodeEntry, BaseRange, Location, Path, Text, BaseText } from 'slate';
 import { HistoryEditor } from 'slate-history';
 import { ReactEditor, Editable as Editable$1 } from 'slate-react';
 import { SetReturnType, SetOptional, UnionToIntersection, Simplify } from 'type-fest';
@@ -16,6 +16,14 @@ type WysimarkEditor = {
             markdown: string;
             children: Descendant[];
         };
+        /**
+         * Whether the editor is in Raw mode
+         */
+        isRawMode?: boolean;
+        /**
+         * Function to toggle Raw mode
+         */
+        toggleRawMode?: () => void;
     };
     /**
      * Public methods for the wysimark editor.
@@ -725,6 +733,10 @@ type BlockQuoteEditor = {
         indent: () => void;
         outdent: () => void;
         isActive: () => boolean;
+        increaseDepth: () => void;
+        decreaseDepth: () => void;
+        canIncreaseDepth: () => boolean;
+        canDecreaseDepth: () => boolean;
     };
 };
 type BlockQuoteElement = {
@@ -737,9 +749,50 @@ type BlockQuotePluginCustomTypes = {
     Element: BlockQuoteElement;
 };
 
+declare function createCodeBlockMethods(editor: Editor): {
+    createCodeBlock: (args_0: {
+        language: BuiltInLanguage;
+    }) => void;
+    setCodeBlockLanguage: (language: BuiltInLanguage, options?: {
+        at?: BetterAt | undefined;
+    } | undefined) => boolean;
+};
+
+type CodeBlockMethods = ReturnType<typeof createCodeBlockMethods>;
+type BuiltInLanguage = "text" | "html" | "svg" | "markup" | "css" | "javascript" | "js" | "java" | "c" | "clike";
+type CodeBlockEditor = {
+    codeBlock: CodeBlockMethods;
+};
+/**
+ * The code block element is the root element of a code block.
+ */
+type CodeBlockElement = {
+    type: "code-block";
+    /**
+     * The language of the code block. Can accept any string because Markdown can
+     * accept any string; however, the built-in Prism languages are defined in:
+     * `BuiltInLanguage`
+     */
+    language: string;
+    children: CodeBlockLineElement[];
+};
+type CodeBlockLineElement = {
+    type: "code-block-line";
+    children: Text[];
+};
+type CodeBlockPluginCustomTypes = {
+    Name: "code-block";
+    Editor: CodeBlockEditor;
+    Element: CodeBlockElement | CodeBlockLineElement;
+    Text: {
+        text: string;
+        prismToken?: string;
+    };
+};
+
 declare function createTableMethods(editor: Editor): {
     getTableInfo: (args_0?: {
-        at?: ImageBlockElement | ParagraphElement | OrderedListItemElement | UnorderedListItemElement | TaskListItemElement | HorizontalRuleElement | TableElement | TableRowElement | TableCellElement | TableContentElement | BlockQuoteElement | HeadingElement | AnchorElement | slate.Location | null | undefined;
+        at?: ImageBlockElement | ParagraphElement | OrderedListItemElement | UnorderedListItemElement | TaskListItemElement | HorizontalRuleElement | TableElement | TableRowElement | TableCellElement | TableContentElement | CodeBlockElement | CodeBlockLineElement | BlockQuoteElement | HeadingElement | AnchorElement | slate.Location | null | undefined;
     } | undefined) => TableInfo | undefined;
     insertTable: (args_0: number, args_1: number, args_2?: {
         at?: slate.Location | null | undefined;
@@ -800,7 +853,7 @@ declare function createMarksMethods(editor: Editor): {
     removeMarks: (args_0?: {
         at?: slate.Location | null | undefined;
     } | undefined) => void;
-    toggleMark: (args_0: "bold" | "strike" | "text" | "code" | "italic" | "underline", args_1?: "bold" | "strike" | "text" | "code" | "italic" | "underline" | undefined, args_2?: {
+    toggleMark: (args_0: "bold" | "strike" | "text" | "prismToken" | "code" | "italic" | "underline", args_1?: "bold" | "strike" | "text" | "prismToken" | "code" | "italic" | "underline" | undefined, args_2?: {
         at?: slate.Location | null | undefined;
     } | undefined) => void;
     toggleBold: () => void;
@@ -846,8 +899,8 @@ type CurriedConvertElements = <T extends Element$1 = Element$1>(matchForToggle:
 
 declare function createConvertElementMethods(editor: Editor): {
     convertElementTypes: string[];
-    addConvertElementType: (type: "anchor" | "heading" | "block-quote" | "table" | "horizontal-rule" | "paragraph" | "image-block" | "ordered-list-item" | "unordered-list-item" | "task-list-item" | "table-row" | "table-cell" | "table-content" | ("anchor" | "heading" | "block-quote" | "table" | "horizontal-rule" | "paragraph" | "image-block" | "ordered-list-item" | "unordered-list-item" | "task-list-item" | "table-row" | "table-cell" | "table-content")[]) => void;
-    isConvertibleElement: (element: ImageBlockElement | ParagraphElement | OrderedListItemElement | UnorderedListItemElement | TaskListItemElement | HorizontalRuleElement | TableElement | TableRowElement | TableCellElement | TableContentElement | BlockQuoteElement | HeadingElement | AnchorElement) => boolean;
+    addConvertElementType: (type: "anchor" | "heading" | "block-quote" | "table" | "horizontal-rule" | "code-block" | "paragraph" | "image-block" | "ordered-list-item" | "unordered-list-item" | "task-list-item" | "table-row" | "table-cell" | "table-content" | "code-block-line" | ("anchor" | "heading" | "block-quote" | "table" | "horizontal-rule" | "code-block" | "paragraph" | "image-block" | "ordered-list-item" | "unordered-list-item" | "task-list-item" | "table-row" | "table-cell" | "table-content" | "code-block-line")[]) => void;
+    isConvertibleElement: (element: ImageBlockElement | ParagraphElement | OrderedListItemElement | UnorderedListItemElement | TaskListItemElement | HorizontalRuleElement | TableElement | TableRowElement | TableCellElement | TableContentElement | CodeBlockElement | CodeBlockLineElement | BlockQuoteElement | HeadingElement | AnchorElement) => boolean;
     convertElements: CurriedConvertElements;
 };
 
@@ -872,7 +925,7 @@ type PasteMarkdownPluginCustomTypes = {
     Editor: PasteMarkdownEditor;
 };
 
-declare const plugins: (TypedPlugin<PasteMarkdownPluginCustomTypes> | TypedPlugin<ConvertElementPluginCustomTypes> | TypedPlugin<AnchorPluginCustomTypes> | TypedPlugin<HeadingPluginCustomTypes> | TypedPlugin<MarksPluginCustomTypes> | TypedPlugin<InlineCodePluginCustomTypes> | TypedPlugin<BlockQuotePluginCustomTypes> | TypedPlugin<TablePluginCustomTypes> | TypedPlugin<HorizontalRulePluginCustomTypes> | TypedPlugin<{
+declare const plugins: (TypedPlugin<PasteMarkdownPluginCustomTypes> | TypedPlugin<ConvertElementPluginCustomTypes> | TypedPlugin<AnchorPluginCustomTypes> | TypedPlugin<HeadingPluginCustomTypes> | TypedPlugin<MarksPluginCustomTypes> | TypedPlugin<InlineCodePluginCustomTypes> | TypedPlugin<BlockQuotePluginCustomTypes> | TypedPlugin<CodeBlockPluginCustomTypes> | TypedPlugin<TablePluginCustomTypes> | TypedPlugin<HorizontalRulePluginCustomTypes> | TypedPlugin<{
     Name: "trailing-block";
     Editor: {
         allowTrailingBlock: true;