react-mde/lib/definitions/commands/command.d.ts

React Markdown Editor

import * as React from "react";
import { L18n, TextApi, TextState } from "..";
import { HandleKeyCommand } from "../types";
export declare type GetIcon = (iconName: string) => React.ReactNode;
export interface ExecuteOptions {
    initialState: TextState;
    textApi: TextApi;
    context?: CommandContext;
    l18n?: L18n;
}
export interface Command {
    buttonComponentClass?: React.ComponentClass | string;
    icon?: (getIconFromProvider: GetIcon) => React.ReactNode;
    buttonProps?: any;
    execute: (options: ExecuteOptions) => void | Promise<void>;
    /**
     * On every key-down, "handleKeyCommand", if defined, will be executed for every command.
     * The first "HandleKeyCommand" that returns true will cause the command to be executed.
     * "HandleKeyCommand" for subsequent commands will not be executed after the first one returns true.
     */
    handleKeyCommand?: HandleKeyCommand;
}
export interface CommandContext {
    type: string;
}
export interface PasteCommandContext extends CommandContext {
    type: "paste";
    event: React.ClipboardEvent | React.DragEvent | React.ChangeEvent;
    pasteOptions: PasteOptions;
}
export declare type ToolbarCommands = string[][];
export declare type CommandMap = Record<string, Command>;
export interface PasteOptions {
    /**
     * Generator function to save images pasted.
     * This generator should 1) Yield the image URL. 2) Return true if the save was successful or false, otherwise
     */
    saveImage: SaveImageHandler;
    /**
     * Command to execute on paste command
     */
    command?: string;
    /**
     * The accept attribute specifies a filter for what file types the user can pick from the file input dialog box.
     */
    accept?: string;
    /**
     * When present, it specifies that the user is allowed to enter more than one value in the file input dialog box.
     * By default is set to true
     */
    multiple?: boolean;
}
export declare type SaveImageHandler = (data: ArrayBuffer, file: Blob) => AsyncGenerator<string, boolean>;