@ckeditor/ckeditor5-ui
Version:
The UI framework and standard UI library of CKEditor 5.
59 lines (58 loc) • 1.68 kB
TypeScript
/**
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/
/**
* @module ui/editorui/editoruiview
*/
import View from '../view.js';
import BodyCollection from './bodycollection.js';
import type EditableUIView from '../editableui/editableuiview.js';
import type { Locale, LocaleTranslate } from '@ckeditor/ckeditor5-utils';
import '../../theme/components/editorui/editorui.css';
import type MenuBarView from '../menubar/menubarview.js';
import type ToolbarView from '../toolbar/toolbarview.js';
/**
* The editor UI view class. Base class for the editor main views.
*/
export default abstract class EditorUIView extends View {
/**
* Collection of the child views, detached from the DOM
* structure of the editor, like panels, icons etc.
*/
readonly body: BodyCollection;
locale: Locale;
t: LocaleTranslate;
abstract get editable(): EditableUIView;
/**
* Menu bar view instance. Initialized by default in:
*
* * balloon editor;
* * decoupled editor;
* * multiroot editor.
*/
menuBarView?: MenuBarView;
/**
* Toolbar view instance. Initialized by default in:
*
* * classic editor;
* * decoupled editor;
* * inline editor;
* * multiroot editor.
*/
toolbar?: ToolbarView;
/**
* Creates an instance of the editor UI view class.
*
* @param locale The locale instance.
*/
constructor(locale: Locale);
/**
* @inheritDoc
*/
render(): void;
/**
* @inheritDoc
*/
destroy(): void;
}