@instructure/canvas-rce/es/rce/types.d.ts

A component wrapping Canvas's usage of Tinymce

import tinymce from 'tinymce';
import type { Editor } from 'tinymce';
export interface RCEWrapperInterface {
    id: string;
    tinymce?: typeof tinymce;
    mceInstance?: () => any;
    insertCode?: (code: string) => void;
    replaceCode?: (code: string) => void;
    getContentSelection?: () => string;
    getContent?: () => string;
}
export type { RCEWrapperProps } from './RCEWrapperProps';
export type AlertVariant = 'info' | 'warning' | 'error' | 'success';
export type AlertMessage = {
    id: number;
    text: string;
    variant: AlertVariant;
};
export type RCETrayProps = {
    canUploadFiles: boolean;
    contextId: string;
    contextType: string;
    host?: string;
    jwt?: string;
    containingContext?: {
        contextType: string;
        contextId: string;
        userId: string;
    };
    filesTabDisabled?: boolean;
    refreshToken?: () => void;
    source?: {
        fetchImages: () => void;
    };
    themeUrl?: string;
};
/**
 * Subset of TinyMCE used by the ExternalTools dialog. Used to document the subset of the API that we use so
 * it's easier to test.
 */
export interface ExternalToolsEditor {
    id: string;
    selection?: {
        getContent(): string;
    };
    getContent(): string;
    focus(): void;
    editorContainer: HTMLElement;
    $: Editor['$'];
    ui: Editor['ui'];
}
export interface ExternalToolData {
    id: string | number;
    on_by_default?: boolean | null;
    favorite?: boolean | null;
}
declare global {
    interface Document {
        fullscreenElement?: HTMLElement | null;
        webkitExitFullscreen(): Promise<void>;
        webkitFullscreenElement?: HTMLElement | null;
        webkitFullscreenEnabled?: boolean;
    }
    interface HTMLDivElement {
        webkitRequestFullscreen(): Promise<void>;
    }
}
export type InitInstanceCallback = (ed: Editor) => void;
export type ToolbarPropType = {
    name: string;
    items: string[];
};
export type HeightType = number | string;
export interface MenuItem {
    title?: string;
    items: string;
}
export type MenuPropType = Record<string, MenuItem>;
export type EditorOptions = {
    editorOptions?: (tinyMCE: typeof tinymce) => EditorOptions;
    height?: HeightType;
    init_instance_callback?: InitInstanceCallback;
    language?: string;
    menu?: MenuPropType;
    name?: string;
    mirroredAttrs?: Record<string, string>;
    plugins?: string[];
    readonly?: boolean;
    selector?: string;
    textareaId?: string;
    toolbar?: ToolbarPropType[];
};
export type NormalizedEditorOptions = Omit<EditorOptions, 'editorOptions'> & {
    editorOptions: Record<string, unknown>;
    tinymce: typeof tinymce;
};