rme 0.3.0-beta.2 → 0.3.0-beta.20

package/dist/index.d.ts

@@ -19,6 +19,47 @@ import * as styled_components_dist_types from 'styled-components/dist/types';
 
 type LoadLanguage = (lang: string) => Promise<LanguageSupport> | LanguageSupport | void;
 
+type ClipboardReadFunction = typeof clipboardRead;
+declare function clipboardRead(): Promise<{
+    html: string;
+    text: string;
+}>;
+
+interface CommandKeymapOptions {
+    /**
+     * Override default keyboard shortcuts
+     * @example
+     * { toggleStrong: 'mod-shift-b', toggleEmphasis: 'ctrl-i' }
+     */
+    overrideShortcutMap?: Partial<Record<CommandName, string>>;
+    /**
+     * Disable all built-in shortcuts
+     * @default false
+     */
+    disableAllBuildInShortcuts?: boolean;
+    clipboardReadFunction?: ClipboardReadFunction;
+}
+type CommandName = keyof typeof defaultCommandShortcutMap;
+declare const defaultCommandShortcutMap: {
+    readonly copy: "mod-c";
+    readonly paste: "mod-v";
+    readonly undo: "mod-z";
+    readonly redo: "mod-shift-z";
+    readonly cut: "mod-x";
+    readonly toggleH1: "mod-1";
+    readonly toggleH2: "mod-2";
+    readonly toggleH3: "mod-3";
+    readonly toggleH4: "mod-4";
+    readonly toggleH5: "mod-5";
+    readonly toggleH6: "mod-6";
+    readonly toggleStrong: "mod-b";
+    readonly toggleEmphasis: "mod-i";
+    readonly toggleCodeText: "mod-e";
+    readonly toggleDelete: "mod-shift-s";
+    readonly insertLink: "mod-k";
+    readonly insertImage: "mod-alt-i";
+};
+
 type CustomCopyFunction = (code: string) => Promise<boolean> | boolean;
 
 declare const changeTheme: (theme: CreateThemeOptions) => void;
@@ -44,6 +85,10 @@ type CreateCodemirrorOptions = {
          */
         customCopyFunction?: CustomCopyFunction;
     };
+    /**
+     * Command keymap options for customizing keyboard shortcuts
+     */
+    commandKeymapOptions?: CommandKeymapOptions;
 };
 declare class MfCodemirrorView {
     private readonly view;
@@ -231,6 +276,18 @@ type EditorContext = ReactFrameworkOutput<Remirror.Extensions>;
 type CreateSourceCodeManagerOptions = {
     language?: string;
     onCodemirrorViewLoad: (cm: MfCodemirrorView) => void;
+    /**
+     * Override default keyboard shortcuts
+     * @example
+     * { toggleStrong: 'mod-shift-b', toggleEmphasis: 'ctrl-i' }
+     */
+    overrideShortcutMap?: Partial<Record<CommandName, string>>;
+    /**
+     * Disable all built-in shortcuts
+     * @default false
+     */
+    disableAllBuildInShortcuts?: boolean;
+    clipboardReadFunction?: ClipboardReadFunction;
 };
 declare function createSourceCodeManager(options?: CreateSourceCodeManagerOptions): RemirrorManager$1<any>;
 declare const createSourceCodeDelegate: (options?: CreateSourceCodeManagerOptions) => EditorDelegate<any>;
@@ -250,6 +307,10 @@ interface AIOptions {
     }) => Promise<string | null>;
 }
 
+type CodemirrorOptions = {
+    lineWrapping?: boolean;
+};
+
 type MarkdownItToken = string;
 declare enum ParserRuleType {
     text = 1,
@@ -385,10 +446,12 @@ type ExtensionsOptions = {
     disableAllBuildInShortcuts?: boolean;
     handleViewImgSrcUrl?: (src: string) => Promise<string>;
     imageHostingHandler?: (src: string) => Promise<string>;
-    imageCopyHandler?: (src: string) => Promise<string>;
+    imagePasteHandler?: (src: string) => Promise<string>;
     ai?: AIOptions;
     customCopyFunction?: CustomCopyFunction;
     overrideShortcutMap?: Record<string, string>;
+    clipboardReadFunction?: ClipboardReadFunction;
+    codemirrorOptions?: CodemirrorOptions;
 };
 declare function extensions(options: ExtensionsOptions): any[];
 
@@ -495,6 +558,7 @@ declare const darkTheme: {
         contextMenuBgColorHover: string;
         slashMenuBorderColor: string;
         editorToolbarBgColor: string;
+        selectionMatchBgColor: string;
         lineHeightBase: string;
         titleBarHeight: string;
         titleBarControlBtnWidth: string;
@@ -562,6 +626,7 @@ declare const lightTheme: {
         contextMenuBgColorHover: string;
         slashMenuBorderColor: string;
         editorToolbarBgColor: string;
+        selectionMatchBgColor: string;
         lineHeightBase: string;
         titleBarHeight: string;
         titleBarControlBtnWidth: string;