@kui-shell/core/mdist/models/CommentaryResponse.d.ts

An Electron-based shell for cloud-native development

import { Entity } from './entity';
import { KResponse } from './command';
import REPL from './repl';
export type CommentaryResponse = {
    apiVersion: 'kui-shell/v1';
    kind: 'CommentaryResponse';
    props: {
        /** Content rendered inside the CardTitle */
        title?: string;
        /** Source filepath */
        filepath?: string;
        /** Markdown source */
        children: string;
        /** Show header text indicating what we are doing (e.g. Editing Markdown) [Default: true] */
        header?: boolean;
        /** Open in edit mode [Default: only if children.length === 0 */
        edit?: boolean;
        /** Show a preview while editing [Default: true] */
        preview?: boolean;
        /** Send edits to this channel (implies --no-header and --no-preview and --edit) */
        send?: string;
        /** Consume edits from this channel (implies --no-header and --no-edit and --preview) */
        receive?: string;
        /** Replace all existing content in this tab */
        replace?: boolean;
        /** CodeBlock responses */
        codeBlockResponses?: {
            status: 'done' | 'error';
            response: KResponse;
        }[];
        /** Prefix for image URLs */
        baseUrl?: string;
        /** Support for pymdownx.snippets */
        snippetBasePath?: string;
        /** [Optional] REPL controller, but required if you want your Card
         * to have functional kuiexec?command=... links via Markdown */
        repl?: REPL;
        /** [Optional] If true, the source specified by `filepath` does not utilize extended markdown, such as tabs and tips */
        simple?: boolean;
    };
};
export declare function isCommentaryResponse(entity: Entity): entity is CommentaryResponse;
export declare function maybeKuiLink(link: string): string;