АПИ редактора

Инициализация

interface EditorConfig {
    // Configuration for the editor items
    items: Array<Record<string, any>>;
    // Automatically apply changes to the data object
    autoSave?: boolean;
    // Define the current active batch for the editor
    activeBatch?: string;
    // Configuration for the top toolbar
    topBar?: {
        // Array of items for the toolbar
        items: Array<Record<string, any>>;
    };
    // Configuration for the bottom toolbar
    bottomBar?: {
        // Array of items for the toolbar
        items: Array<Record<string, any>>;
    };
    // Additional CSS class for the editor's box
    css?: string;
    // Initial values for the editor fields
    values?: Record<string, any>;
    // Placement of the editor (inline, modal, sidebar)
    placement?: "inline" | "modal" | "sidebar";
    // Set the editor to readonly mode
    readonly?: boolean;
    // Define layout for the editor
    layout?: "columns" | "default";
    // Function to handle action events
    onaction?: (ev: OnActionResult) => void;
    // Function to handle change events
    onchange?: (ev: OnChangeResult) => void;
    // Function to handle save events
    onsave?: (ev: OnSaveResult) => void;
    // Function to handle validation events
    onvalidation?: (ev: OnValidationResult) => void;
}

Свойства

activeBatch	Необязательный. Управляет тем, какой пакет полей ввода в данный момент активен в редакторе
autoSave	Необязательный. Управляет автоматическим сохранением данных в редакторе
bottomBar	Необязательный. Управляет конфигурацией нижней панели инструментов в редакторе
css	Необязательный. Определяет CSS-класс для контейнера редактора
focus	Опционально. Управляет тем, должен ли виджет редактора автоматически получать фокус при рендеринге
hotkeys	Опционально. Позволяет задавать пользовательские горячие клавиши для действий Editor
items	Опционально. Определяет компоненты, которые будут отрисованы в Editor
layout	Опционально. Управляет расположением компонентов редактора
placement	Необязательный. Управляет размещением компонентов редактора
readonly	Опционально. Управляет режимом только для чтения в редакторе
topBar	Необязательный. Управляет конфигурацией верхней панели инструментов в редакторе
values	Необязательный. Определяет начальные значения для полей редактора

События

action	Срабатывает при изменении в любом поле редактора
change	Срабатывает при изменении любого поля редактора
save	Срабатывает, когда пользователь запрашивает сохранение данных в редакторе
validation	Срабатывает по завершении процесса валидации

Вспомогательные инструменты

---

• registerEditorItem - регистрация внешних элементов управления как элементов редактора

Дополнительные ресурсы

• Посетите Руководство по возможностям, чтобы узнать больше о функциональности виджета.
• Изучите примеры для наглядной демонстрации доступных возможностей.