mirror of
https://github.com/codex-team/editor.js
synced 2024-06-26 09:20:07 +02:00
21cac86e42
* i18n first steps * i18n internal, toolbox, api for tools * namespaced api * tn, t * tn in block tunes * join toolbox and inlineTools under toolNames * translations * make enum toolTypes * Update block.ts * Update src/components/core.ts Co-Authored-By: George Berezhnoy <gohabereg@users.noreply.github.com> * add more types * rm tn * export i18n types * upd bundle * fix tabulation * Add type-safe namespaces * upd * Improve example * Update toolbox.ts * improve examplle * upd * fix typo * Add comments for complex types Co-authored-by: George Berezhnoy <gohabereg@users.noreply.github.com> Co-authored-by: Georgy Berezhnoy <gohabereg@gmail.com>
82 lines
1.6 KiB
TypeScript
82 lines
1.6 KiB
TypeScript
import {ToolConstructable, ToolSettings} from '../tools';
|
|
import {LogLevels, OutputData, API} from '../index';
|
|
import {SanitizerConfig} from './sanitizer-config';
|
|
import {I18nConfig} from './i18n-config';
|
|
|
|
export interface EditorConfig {
|
|
/**
|
|
* Element where Editor will be append
|
|
* @deprecated property will be removed in next major release, use holder instead
|
|
*/
|
|
holderId?: string | HTMLElement;
|
|
|
|
/**
|
|
* Element where Editor will be append
|
|
*/
|
|
holder?: string | HTMLElement;
|
|
|
|
/**
|
|
* If true, set caret at the first Block after Editor is ready
|
|
*/
|
|
autofocus?: boolean;
|
|
|
|
/**
|
|
* This Tool will be used as default
|
|
* Name should be equal to one of Tool`s keys of passed tools
|
|
* If not specified, Paragraph Tool will be used
|
|
*/
|
|
initialBlock?: string;
|
|
|
|
/**
|
|
* First Block placeholder
|
|
*/
|
|
placeholder?: string|false;
|
|
|
|
/**
|
|
* Define default sanitizer configuration
|
|
* @see {@link sanitizer}
|
|
*/
|
|
sanitizer?: SanitizerConfig;
|
|
|
|
/**
|
|
* If true, toolbar won't be shown
|
|
*/
|
|
hideToolbar?: boolean;
|
|
|
|
/**
|
|
* Map of Tools to use
|
|
*/
|
|
tools?: {[toolName: string]: ToolConstructable|ToolSettings};
|
|
|
|
/**
|
|
* Data to render on Editor start
|
|
*/
|
|
data?: OutputData;
|
|
|
|
/**
|
|
* Height of Editor's bottom area that allows to set focus on the last Block
|
|
*/
|
|
minHeight?: number;
|
|
|
|
/**
|
|
* Editors log level (how many logs you want to see)
|
|
*/
|
|
logLevel?: LogLevels;
|
|
|
|
/**
|
|
* Internalization config
|
|
*/
|
|
i18n?: I18nConfig;
|
|
|
|
/**
|
|
* Fires when Editor is ready to work
|
|
*/
|
|
onReady?(): void;
|
|
|
|
/**
|
|
* Fires when something changed in DOM
|
|
* @param {API} api - editor.js api
|
|
*/
|
|
onChange?(api: API): void;
|
|
}
|