@dotcms/react/src/lib/components/DotEditableText/utils.d.ts

Official React Components library to render a dotCMS page.

import { IAllProps } from '@tinymce/tinymce-react';
import { DotCMSContentlet } from '../../models';
export type DOT_EDITABLE_TEXT_FORMAT = 'html' | 'text';
export type DOT_EDITABLE_TEXT_MODE = 'minimal' | 'full' | 'plain';
export interface DotEditableTextProps {
    /**
     * Represents the field name of the `contentlet` that can be edited
     *
     * @memberof DotEditableTextProps
     */
    fieldName: string;
    /**
     * Represents the format of the editor which can be `text` or `html`
     *
     * @type {DOT_EDITABLE_TEXT_FORMAT}
     * @memberof DotEditableTextProps
     */
    format?: DOT_EDITABLE_TEXT_FORMAT;
    /**
     * Represents the mode of the editor which can be `plain`, `minimal`, or `full`
     *
     * @type {DOT_EDITABLE_TEXT_MODE}
     * @memberof DotEditableTextProps
     */
    mode?: DOT_EDITABLE_TEXT_MODE;
    /**
     * Represents the `contentlet` that can be inline edited
     *
     * @type {DotCMSContentlet}
     * @memberof DotEditableTextProps
     */
    contentlet: DotCMSContentlet;
}
export declare const TINYMCE_CONFIG: {
    [key in DOT_EDITABLE_TEXT_MODE]: IAllProps['init'];
};