@ckeditor/ckeditor5-ui
Advanced tools
@ckeditor/ckeditor5-ui - npm Package Compare versions
Comparing version 37.0.0-alpha.0 to 37.0.0-alpha.1
| { | ||
| "name": "@ckeditor/ckeditor5-ui", | ||
| "version": "37.0.0-alpha.0", | ||
| "version": "37.0.0-alpha.1", | ||
| "description": "The UI framework and standard UI library of CKEditor 5.", | ||
@@ -14,25 +14,25 @@ "keywords": [ | ||
| "dependencies": { | ||
| "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-core": "^37.0.0-alpha.1", | ||
| "lodash-es": "^4.17.15" | ||
| }, | ||
| "devDependencies": { | ||
| "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-editor-balloon": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-essentials": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-font": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-find-and-replace": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-heading": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-link": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-list": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-mention": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-horizontal-line": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-table": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.0", | ||
| "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-editor-balloon": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-essentials": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-font": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-find-and-replace": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-heading": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-image": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-link": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-list": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-mention": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-horizontal-line": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-table": "^37.0.0-alpha.1", | ||
| "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.1", | ||
| "typescript": "^4.8.4", | ||
@@ -64,3 +64,3 @@ "webpack": "^5.58.1", | ||
| "scripts": { | ||
| "build": "tsc -p ./tsconfig.release.json", | ||
| "build": "tsc -p ./tsconfig.json", | ||
| "postversion": "npm run build" | ||
@@ -67,0 +67,0 @@ }, |
@@ -13,3 +13,3 @@ /** | ||
| * fires the `submit` event on a view instead. Such a custom event can be then used by any | ||
| * {@link module:utils/dom/emittermixin~Emitter emitter}, e.g. to serialize the form data. | ||
| * {@link module:utils/dom/emittermixin~DomEmitter emitter}, e.g. to serialize the form data. | ||
| * | ||
@@ -51,5 +51,5 @@ * ```ts | ||
| /** | ||
| * Fired by {@link ~submitHandler} helper. | ||
| * Fired by {@link module:ui/bindings/submithandler~submitHandler} helper. | ||
| * | ||
| * @eventName submit | ||
| * @eventName module:ui/view~View#submit | ||
| */ | ||
@@ -56,0 +56,0 @@ export type SubmitHandlerEvent = { |
@@ -9,3 +9,3 @@ /** | ||
| * fires the `submit` event on a view instead. Such a custom event can be then used by any | ||
| * {@link module:utils/dom/emittermixin~Emitter emitter}, e.g. to serialize the form data. | ||
| * {@link module:utils/dom/emittermixin~DomEmitter emitter}, e.g. to serialize the form data. | ||
| * | ||
@@ -12,0 +12,0 @@ * ```ts |
@@ -146,6 +146,6 @@ /** | ||
| /** | ||
| * Fired when the button view is clicked. It won't be fired when the button {@link #isEnabled} | ||
| * Fired when the button view is clicked. It won't be fired when the button {@link module:ui/button/button~Button#isEnabled} | ||
| * is `false`. | ||
| * | ||
| * @eventName execute | ||
| * @eventName ~Button#execute | ||
| */ | ||
@@ -152,0 +152,0 @@ export type ButtonExecuteEvent = { |
@@ -6,3 +6,3 @@ /** | ||
| /** | ||
| * @module ui/colorgrid/colorgrid | ||
| * @module ui/colorgrid/colorgridview | ||
| */ | ||
@@ -16,3 +16,3 @@ import View from '../view'; | ||
| /** | ||
| * A grid of {@link module:ui/colorgrid/colortile~ColorTileView color tiles}. | ||
| * A grid of {@link module:ui/colorgrid/colortileview~ColorTileView color tiles}. | ||
| */ | ||
@@ -43,3 +43,3 @@ export default class ColorGridView extends View implements DropdownPanelFocusable { | ||
| /** | ||
| * Creates an instance of a color grid containing {@link module:ui/colorgrid/colortile~ColorTileView tiles}. | ||
| * Creates an instance of a color grid containing {@link module:ui/colorgrid/colortileview~ColorTileView tiles}. | ||
| * | ||
@@ -50,3 +50,3 @@ * @fires execute | ||
| * @param options.colorDefinitions Array with definitions | ||
| * required to create the {@link module:ui/colorgrid/colortile~ColorTileView tiles}. | ||
| * required to create the {@link module:ui/colorgrid/colortileview~ColorTileView tiles}. | ||
| * @param options.columns A number of columns to display the tiles. | ||
@@ -76,3 +76,3 @@ */ | ||
| /** | ||
| * A color definition used to create a {@link module:ui/colorgrid/colortile~ColorTileView}. | ||
| * A color definition used to create a {@link module:ui/colorgrid/colortileview~ColorTileView}. | ||
| * | ||
@@ -92,11 +92,11 @@ * ```json | ||
| * String representing a color. | ||
| * It is used as value of background-color style in {@link module:ui/colorgrid/colortile~ColorTileView}. | ||
| * It is used as value of background-color style in {@link module:ui/colorgrid/colortileview~ColorTileView}. | ||
| */ | ||
| color: string; | ||
| /** | ||
| * String used as label for {@link module:ui/colorgrid/colortile~ColorTileView}. | ||
| * String used as label for {@link module:ui/colorgrid/colortileview~ColorTileView}. | ||
| */ | ||
| label: string; | ||
| /** | ||
| * Additional options passed to create a {@link module:ui/colorgrid/colortile~ColorTileView}. | ||
| * Additional options passed to create a {@link module:ui/colorgrid/colortileview~ColorTileView}. | ||
| */ | ||
@@ -106,3 +106,3 @@ options: { | ||
| * A flag that indicates if special a CSS class should be added | ||
| * to {@link module:ui/colorgrid/colortile~ColorTileView}, which renders a border around it. | ||
| * to {@link module:ui/colorgrid/colortileview~ColorTileView}, which renders a border around it. | ||
| */ | ||
@@ -115,3 +115,3 @@ hasBorder: boolean; | ||
| * | ||
| * @eventName execute | ||
| * @eventName ~ColorGridView#execute | ||
| * @param data Additional information about the event. | ||
@@ -128,3 +128,3 @@ */ | ||
| /** | ||
| * The value of the selected color ({@link module:ui/colorgrid/colorgrid~ColorDefinition#color `color.color`}). | ||
| * The value of the selected color ({@link module:ui/colorgrid/colorgridview~ColorDefinition#color `color.color`}). | ||
| */ | ||
@@ -134,9 +134,9 @@ value: string; | ||
| * The `hasBorder` property of the selected color | ||
| * ({@link module:ui/colorgrid/colorgrid~ColorDefinition#options `color.options.hasBorder`}). | ||
| * ({@link module:ui/colorgrid/colorgridview~ColorDefinition#options `color.options.hasBorder`}). | ||
| */ | ||
| hasBorder: boolean; | ||
| /** | ||
| * The label of the selected color ({@link module:ui/colorgrid/colorgrid~ColorDefinition#label `color.label`}) | ||
| * The label of the selected color ({@link module:ui/colorgrid/colorgridview~ColorDefinition#label `color.label`}) | ||
| */ | ||
| label: string; | ||
| } |
@@ -6,3 +6,3 @@ /** | ||
| /** | ||
| * @module ui/colorgrid/colorgrid | ||
| * @module ui/colorgrid/colorgridview | ||
| */ | ||
@@ -15,7 +15,7 @@ import View from '../view'; | ||
| /** | ||
| * A grid of {@link module:ui/colorgrid/colortile~ColorTileView color tiles}. | ||
| * A grid of {@link module:ui/colorgrid/colortileview~ColorTileView color tiles}. | ||
| */ | ||
| export default class ColorGridView extends View { | ||
| /** | ||
| * Creates an instance of a color grid containing {@link module:ui/colorgrid/colortile~ColorTileView tiles}. | ||
| * Creates an instance of a color grid containing {@link module:ui/colorgrid/colortileview~ColorTileView tiles}. | ||
| * | ||
@@ -26,9 +26,10 @@ * @fires execute | ||
| * @param options.colorDefinitions Array with definitions | ||
| * required to create the {@link module:ui/colorgrid/colortile~ColorTileView tiles}. | ||
| * required to create the {@link module:ui/colorgrid/colortileview~ColorTileView tiles}. | ||
| * @param options.columns A number of columns to display the tiles. | ||
| */ | ||
| constructor(locale, options) { | ||
| var _a, _b; | ||
| super(locale); | ||
| const colorDefinitions = options?.colorDefinitions ?? []; | ||
| this.columns = options?.columns ?? 5; | ||
| const colorDefinitions = (_a = options === null || options === void 0 ? void 0 : options.colorDefinitions) !== null && _a !== void 0 ? _a : []; | ||
| this.columns = (_b = options === null || options === void 0 ? void 0 : options.columns) !== null && _b !== void 0 ? _b : 5; | ||
| const viewStyleAttribute = { | ||
@@ -35,0 +36,0 @@ gridTemplateColumns: `repeat( ${this.columns}, 1fr)` |
@@ -6,3 +6,3 @@ /** | ||
| /** | ||
| * @module ui/colorgrid/colortile | ||
| * @module ui/colorgrid/colortileview | ||
| */ | ||
@@ -12,3 +12,3 @@ import ButtonView from '../button/buttonview'; | ||
| /** | ||
| * This class represents a single color tile in the {@link module:ui/colorgrid/colorgrid~ColorGridView}. | ||
| * This class represents a single color tile in the {@link module:ui/colorgrid/colorgridview~ColorGridView}. | ||
| */ | ||
@@ -15,0 +15,0 @@ export default class ColorTileView extends ButtonView { |
@@ -6,3 +6,3 @@ /** | ||
| /** | ||
| * @module ui/colorgrid/colortile | ||
| * @module ui/colorgrid/colortileview | ||
| */ | ||
@@ -12,3 +12,3 @@ import ButtonView from '../button/buttonview'; | ||
| /** | ||
| * This class represents a single color tile in the {@link module:ui/colorgrid/colorgrid~ColorGridView}. | ||
| * This class represents a single color tile in the {@link module:ui/colorgrid/colorgridview~ColorGridView}. | ||
| */ | ||
@@ -15,0 +15,0 @@ export default class ColorTileView extends ButtonView { |
@@ -44,5 +44,5 @@ /** | ||
| * The "normalization" means it will create full | ||
| * {@link module:ui/colorgrid/colorgrid~ColorDefinition `ColorDefinition-like`} | ||
| * {@link module:ui/colorgrid/colorgridview~ColorDefinition `ColorDefinition-like`} | ||
| * object for string values, and add a `view` property, for each definition. | ||
| */ | ||
| export declare function normalizeSingleColorDefinition(color: ColorOption): NormalizedColorOption; |
@@ -54,3 +54,3 @@ /** | ||
| * The "normalization" means it will create full | ||
| * {@link module:ui/colorgrid/colorgrid~ColorDefinition `ColorDefinition-like`} | ||
| * {@link module:ui/colorgrid/colorgridview~ColorDefinition `ColorDefinition-like`} | ||
| * object for string values, and add a `view` property, for each definition. | ||
@@ -57,0 +57,0 @@ */ |
@@ -81,3 +81,3 @@ /** | ||
| * the provided name is correct and the component has been correctly | ||
| * {@link #add added} to the factory. | ||
| * {@link module:ui/componentfactory~ComponentFactory#add added} to the factory. | ||
| * | ||
@@ -84,0 +84,0 @@ * @error componentfactory-item-missing |
@@ -18,5 +18,5 @@ /** | ||
| * Fired when the dropdown should be opened. | ||
| * It will not be fired when the button {@link #isEnabled is disabled}. | ||
| * It will not be fired when the button {@link module:ui/dropdown/button/dropdownbutton~DropdownButton#isEnabled is disabled}. | ||
| * | ||
| * @eventName open | ||
| * @eventName ~DropdownButton#open | ||
| */ | ||
@@ -23,0 +23,0 @@ export type DropdownButtonOpenEvent = { |
@@ -132,3 +132,3 @@ /** | ||
| /** | ||
| * Focuses the {@link #actionView#element} of the action part of split button. | ||
| * Focuses the {@link module:ui/button/buttonview~ButtonView#element} of the action part of split button. | ||
| */ | ||
@@ -135,0 +135,0 @@ focus(): void; |
@@ -108,3 +108,3 @@ /** | ||
| /** | ||
| * Focuses the {@link #actionView#element} of the action part of split button. | ||
| * Focuses the {@link module:ui/button/buttonview~ButtonView#element} of the action part of split button. | ||
| */ | ||
@@ -111,0 +111,0 @@ focus() { |
@@ -301,6 +301,6 @@ /** | ||
| * | ||
| * For {@link #listView} It fires when a child of some {@link module:ui/list/listitemview~ListItemView} | ||
| * For {@link ~DropdownView#listView} It fires when a child of some {@link module:ui/list/listitemview~ListItemView} | ||
| * fired `execute`. | ||
| * | ||
| * For {@link #toolbarView} It fires when one of the buttons has been | ||
| * For {@link ~DropdownView#toolbarView} It fires when one of the buttons has been | ||
| * {@link module:ui/button/buttonview~ButtonView#event:execute executed}. | ||
@@ -311,3 +311,3 @@ * | ||
| * | ||
| * @eventName execute | ||
| * @eventName ~DropdownView#execute | ||
| */ | ||
@@ -314,0 +314,0 @@ export type DropdownViewEvent = { |
@@ -54,3 +54,4 @@ /** | ||
| * Renders the view by either applying the {@link #template} to the existing | ||
| * {@link #_editableElement} or assigning {@link #element} as {@link #_editableElement}. | ||
| * {@link module:ui/editableui/editableuiview~EditableUIView#_editableElement} or assigning {@link #element} | ||
| * as {@link module:ui/editableui/editableuiview~EditableUIView#_editableElement}. | ||
| */ | ||
@@ -57,0 +58,0 @@ render(): void; |
@@ -47,3 +47,4 @@ /** | ||
| * Renders the view by either applying the {@link #template} to the existing | ||
| * {@link #_editableElement} or assigning {@link #element} as {@link #_editableElement}. | ||
| * {@link module:ui/editableui/editableuiview~EditableUIView#_editableElement} or assigning {@link #element} | ||
| * as {@link module:ui/editableui/editableuiview~EditableUIView#_editableElement}. | ||
| */ | ||
@@ -50,0 +51,0 @@ render() { |
@@ -6,3 +6,3 @@ /** | ||
| /** | ||
| * @module core/editor/editorui | ||
| * @module ui/editorui/editorui | ||
| */ | ||
@@ -15,3 +15,2 @@ import ComponentFactory from '../componentfactory'; | ||
| import type { Editor } from '@ckeditor/ckeditor5-core'; | ||
| import '../uiconfig'; | ||
| declare const EditorUI_base: { | ||
@@ -115,3 +114,3 @@ new (): import("@ckeditor/ckeditor5-utils").Observable; | ||
| /** | ||
| * Fires the {@link module:core/editor/editorui~EditorUI#event:update `update`} event. | ||
| * Fires the {@link module:ui/editorui/editorui~EditorUI#event:update `update`} event. | ||
| * | ||
@@ -187,3 +186,3 @@ * This method should be called when the editor UI (e.g. positions of its balloons) needs to be updated due to | ||
| * * already visible, | ||
| * * have `beforeFocus()` set in their {@link module:core/editor/editorui~FocusableToolbarDefinition definition} that suggests that | ||
| * * have `beforeFocus()` set in their {@link module:ui/editorui/editorui~FocusableToolbarDefinition definition} that suggests that | ||
| * they might show up when called. Keep in mind that determining whether a toolbar will show up (and become focusable) is impossible | ||
@@ -214,3 +213,3 @@ * at this stage because it depends on its implementation, that in turn depends on the editing context (selection). | ||
| * | ||
| * @eventName ready | ||
| * @eventName ~EditorUI#ready | ||
| */ | ||
@@ -225,5 +224,5 @@ export type EditorUIReadyEvent = { | ||
| * **Note:**: The event is fired after each {@link module:engine/view/document~Document#event:layoutChanged}. | ||
| * It can also be fired manually via the {@link module:core/editor/editorui~EditorUI#update} method. | ||
| * It can also be fired manually via the {@link module:ui/editorui/editorui~EditorUI#update} method. | ||
| * | ||
| * @eventName update | ||
| * @eventName ~EditorUI#update | ||
| */ | ||
@@ -235,3 +234,3 @@ export type EditorUIUpdateEvent = { | ||
| /** | ||
| * A definition of a focusable toolbar. Used by {@link module:core/editor/editorui~EditorUI#addToolbar}. | ||
| * A definition of a focusable toolbar. Used by {@link module:ui/editorui/editorui~EditorUI#addToolbar}. | ||
| */ | ||
@@ -267,3 +266,3 @@ export interface FocusableToolbarDefinition { | ||
| * Specify a callback executed after the toolbar instance DOM element loses focus upon | ||
| * <kbd>Esc</kbd> keystroke but before the focus goes back to the {@link #setEditableElement editable element}. | ||
| * <kbd>Esc</kbd> keystroke but before the focus goes back to the {@link ~EditorUI#setEditableElement editable element}. | ||
| */ | ||
@@ -270,0 +269,0 @@ afterBlur?: () => void; |
@@ -6,3 +6,3 @@ /** | ||
| /** | ||
| * @module core/editor/editorui | ||
| * @module ui/editorui/editorui | ||
| */ | ||
@@ -13,3 +13,2 @@ /* globals console */ | ||
| import { ObservableMixin, isVisible, FocusTracker } from '@ckeditor/ckeditor5-utils'; | ||
| import '../uiconfig'; | ||
| /** | ||
@@ -69,3 +68,3 @@ * A class providing the minimal interface that is required to successfully bootstrap any editor UI. | ||
| /** | ||
| * Fires the {@link module:core/editor/editorui~EditorUI#event:update `update`} event. | ||
| * Fires the {@link module:ui/editorui/editorui~EditorUI#event:update `update`} event. | ||
| * | ||
@@ -171,5 +170,6 @@ * This method should be called when the editor UI (e.g. positions of its balloons) needs to be updated due to | ||
| /** | ||
| * The {@link module:core/editor/editorui~EditorUI#_editableElements `EditorUI#_editableElements`} property has been | ||
| * deprecated and will be removed in the near future. Please use {@link #setEditableElement `setEditableElement()`} and | ||
| * {@link #getEditableElement `getEditableElement()`} methods instead. | ||
| * The {@link module:ui/editorui/editorui~EditorUI#_editableElements `EditorUI#_editableElements`} property has been | ||
| * deprecated and will be removed in the near future. Please use | ||
| * {@link module:ui/editorui/editorui~EditorUI#setEditableElement `setEditableElement()`} and | ||
| * {@link module:ui/editorui/editorui~EditorUI#getEditableElement `getEditableElement()`} methods instead. | ||
| * | ||
@@ -302,3 +302,3 @@ * @error editor-ui-deprecated-editable-elements | ||
| * * already visible, | ||
| * * have `beforeFocus()` set in their {@link module:core/editor/editorui~FocusableToolbarDefinition definition} that suggests that | ||
| * * have `beforeFocus()` set in their {@link module:ui/editorui/editorui~FocusableToolbarDefinition definition} that suggests that | ||
| * they might show up when called. Keep in mind that determining whether a toolbar will show up (and become focusable) is impossible | ||
@@ -305,0 +305,0 @@ * at this stage because it depends on its implementation, that in turn depends on the editing context (selection). |
@@ -45,3 +45,3 @@ /** | ||
| * | ||
| * @eventName loaded | ||
| * @eventName ~IframeView#loaded | ||
| */ | ||
@@ -48,0 +48,0 @@ export type IframeViewLoadedEvent = { |
@@ -51,5 +51,6 @@ /** | ||
| export { default as normalizeToolbarConfig } from './toolbar/normalizetoolbarconfig'; | ||
| export { default as BalloonToolbar, type BaloonToolbarShowEvent } from './toolbar/balloon/balloontoolbar'; | ||
| export { default as BalloonToolbar, type BalloonToolbarShowEvent } from './toolbar/balloon/balloontoolbar'; | ||
| export { default as BlockToolbar } from './toolbar/block/blocktoolbar'; | ||
| export { default as View, type UIViewRenderEvent } from './view'; | ||
| export { default as ViewCollection } from './viewcollection'; | ||
| import './augmentation'; |
@@ -54,1 +54,2 @@ /** | ||
| export { default as ViewCollection } from './viewcollection'; | ||
| import './augmentation'; |
@@ -116,3 +116,3 @@ /** | ||
| * | ||
| * @eventName input | ||
| * @eventName ~InputView#input | ||
| */ | ||
@@ -119,0 +119,0 @@ export type InputViewInputEvent = { |
@@ -163,3 +163,3 @@ /** | ||
| * | ||
| * @eventName show | ||
| * @eventName ~Notification#show | ||
| * @param data The notification data. | ||
@@ -174,3 +174,3 @@ */ | ||
| * | ||
| * @eventName show:success | ||
| * @eventName ~Notification#show:success | ||
| * @param data The notification data. | ||
@@ -182,3 +182,3 @@ */ | ||
| * | ||
| * @eventName show:info | ||
| * @eventName ~Notification#show:info | ||
| * @param data The notification data. | ||
@@ -193,3 +193,3 @@ */ | ||
| * | ||
| * @eventName show:warning | ||
| * @eventName ~Notification#show:warning | ||
| * @param data The notification data. | ||
@@ -216,6 +216,1 @@ */ | ||
| }; | ||
| declare module '@ckeditor/ckeditor5-core' { | ||
| interface PluginsMap { | ||
| [Notification.pluginName]: Notification; | ||
| } | ||
| } |
@@ -10,4 +10,6 @@ /** | ||
| import View from '../../view'; | ||
| import ButtonView from '../../button/buttonview'; | ||
| import type ViewCollection from '../../viewcollection'; | ||
| import { Plugin, type Editor } from '@ckeditor/ckeditor5-core'; | ||
| import { type PositionOptions } from '@ckeditor/ckeditor5-utils'; | ||
| import { FocusTracker, type Locale, type PositionOptions } from '@ckeditor/ckeditor5-utils'; | ||
| import '../../../theme/components/panel/balloonrotator.css'; | ||
@@ -237,6 +239,63 @@ import '../../../theme/components/panel/fakepanel.css'; | ||
| } | ||
| declare module '@ckeditor/ckeditor5-core' { | ||
| interface PluginsMap { | ||
| [ContextualBalloon.pluginName]: ContextualBalloon; | ||
| } | ||
| /** | ||
| * Rotator view is a helper class for the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon ContextualBalloon}. | ||
| * It is used for displaying the last view from the current stack and providing navigation buttons for switching stacks. | ||
| * See the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon ContextualBalloon} documentation to learn more. | ||
| */ | ||
| export declare class RotatorView extends View { | ||
| /** | ||
| * Used for checking if a view is focused or not. | ||
| */ | ||
| readonly focusTracker: FocusTracker; | ||
| /** | ||
| * Navigation button for switching the stack to the previous one. | ||
| */ | ||
| readonly buttonPrevView: ButtonView; | ||
| /** | ||
| * Navigation button for switching the stack to the next one. | ||
| */ | ||
| readonly buttonNextView: ButtonView; | ||
| /** | ||
| * A collection of the child views that creates the rotator content. | ||
| */ | ||
| readonly content: ViewCollection; | ||
| /** | ||
| * Defines whether navigation is visible or not. | ||
| * | ||
| * @observable | ||
| */ | ||
| isNavigationVisible: boolean; | ||
| /** | ||
| * @observable | ||
| */ | ||
| counter: string; | ||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| constructor(locale: Locale); | ||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| render(): void; | ||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| destroy(): void; | ||
| /** | ||
| * Shows a given view. | ||
| * | ||
| * @param view The view to show. | ||
| */ | ||
| showView(view: View): void; | ||
| /** | ||
| * Hides the currently displayed view. | ||
| */ | ||
| hideView(): void; | ||
| /** | ||
| * Creates a navigation button view. | ||
| * | ||
| * @param label The button label. | ||
| * @param icon The button icon. | ||
| */ | ||
| private _createButtonView; | ||
| } |
@@ -399,3 +399,3 @@ /** | ||
| */ | ||
| class RotatorView extends View { | ||
| export class RotatorView extends View { | ||
| /** | ||
@@ -402,0 +402,0 @@ * @inheritDoc |
@@ -64,3 +64,3 @@ /** | ||
| * | ||
| * Bound to {@link module:core/editor/editorui~EditorUI#viewportOffset `EditorUI#viewportOffset`}. | ||
| * Bound to {@link module:ui/editorui/editorui~EditorUI#viewportOffset `EditorUI#viewportOffset`}. | ||
| * | ||
@@ -67,0 +67,0 @@ * If {@link module:core/editor/editorconfig~EditorConfig#ui `EditorConfig#ui.viewportOffset.top`} is defined, then |
@@ -729,6 +729,6 @@ /** | ||
| export interface AttributeBinding { | ||
| [AttributeBindingSymbol]: 'AttributeBinding'; | ||
| _opaqueAttributeBinding: typeof AttributeBindingSymbol; | ||
| } | ||
| export interface ListenerBinding { | ||
| [ListenerBindingSymbol]: 'ListenerBinding'; | ||
| _opaqueListenerBinding: typeof ListenerBindingSymbol; | ||
| } | ||
@@ -781,2 +781,3 @@ /** | ||
| * | ||
| * @label ATTRIBUTE | ||
| * @param attribute An attribute name of {@link module:utils/observablemixin~Observable}. | ||
@@ -826,2 +827,3 @@ */ | ||
| * | ||
| * @label ATTRIBUTE_CALLBACK | ||
| * @param attribute An attribute name of {@link module:utils/observablemixin~Observable}. | ||
@@ -872,2 +874,3 @@ * @param callback Allows for processing of the value. Accepts `Node` and `value` as arguments. | ||
| * | ||
| * @label EVENT | ||
| * @param eventNameOrCallback A DOM event name or an event callback. | ||
@@ -915,3 +918,3 @@ */ | ||
| */ | ||
| interface RenderData { | ||
| export interface RenderData { | ||
| /** | ||
@@ -928,10 +931,9 @@ * A node which is being rendered. | ||
| /** | ||
| * Indicates whether the {@module:ui/template~RenderNodeOptions#node} has | ||
| * been provided by {@module:ui/template~Template#apply}. | ||
| * Indicates whether the {@link #node} has been provided by {@link module:ui/template~Template#apply}. | ||
| */ | ||
| isApplying: boolean; | ||
| /** | ||
| * An object storing the data that helps {@module:ui/template~Template#revert} | ||
| * An object storing the data that helps {@link module:ui/template~Template#revert} | ||
| * bringing back an element to its initial state, i.e. before | ||
| * {@module:ui/template~Template#apply} was called. | ||
| * {@link module:ui/template~Template#apply} was called. | ||
| */ | ||
@@ -938,0 +940,0 @@ revertData?: RevertData; |
@@ -312,3 +312,3 @@ /** | ||
| * the {@link module:ui/template~Template.extend extending} works for an element, | ||
| * make sure it happens before {@link #render} is called. | ||
| * make sure it happens before {@link module:ui/template~Template#render} is called. | ||
| * | ||
@@ -315,0 +315,0 @@ * @error template-extend-render |
@@ -8,3 +8,2 @@ /** | ||
| import { FocusTracker } from '@ckeditor/ckeditor5-utils'; | ||
| import '../../uiconfig'; | ||
| /** | ||
@@ -21,3 +20,3 @@ * The contextual toolbar. | ||
| /** | ||
| * Tracks the focus of the {@link module:core/editor/editorui~EditorUI#getEditableElement editable element} | ||
| * Tracks the focus of the {@link module:ui/editorui/editorui~EditorUI#getEditableElement editable element} | ||
| * and the {@link #toolbarView}. When both are blurred then the toolbar should hide. | ||
@@ -116,12 +115,7 @@ */ | ||
| * | ||
| * @eventName show | ||
| * @eventName ~BalloonToolbar#show | ||
| */ | ||
| export type BaloonToolbarShowEvent = { | ||
| export type BalloonToolbarShowEvent = { | ||
| name: 'show'; | ||
| args: []; | ||
| }; | ||
| declare module '@ckeditor/ckeditor5-core' { | ||
| interface PluginsMap { | ||
| [BalloonToolbar.pluginName]: BalloonToolbar; | ||
| } | ||
| } |
@@ -15,3 +15,2 @@ /** | ||
| import { debounce } from 'lodash-es'; | ||
| import '../../uiconfig'; | ||
| const toPx = toUnit('px'); | ||
@@ -18,0 +17,0 @@ /** |
@@ -12,3 +12,2 @@ /** | ||
| import ToolbarView from '../toolbarview'; | ||
| import '../../uiconfig'; | ||
| /** | ||
@@ -156,6 +155,1 @@ * The block toolbar plugin. | ||
| } | ||
| declare module '@ckeditor/ckeditor5-core' { | ||
| interface PluginsMap { | ||
| [BlockToolbar.pluginName]: BlockToolbar; | ||
| } | ||
| } |
@@ -16,3 +16,2 @@ /** | ||
| import normalizeToolbarConfig from '../normalizetoolbarconfig'; | ||
| import '../../uiconfig'; | ||
| const toPx = toUnit('px'); | ||
@@ -19,0 +18,0 @@ const { pilcrow } = icons; |
@@ -190,3 +190,3 @@ /** | ||
| /** | ||
| * Fired when some toolbar {@link #items} were grouped or ungrouped as a result of some change | ||
| * Fired when some toolbar {@link ~ToolbarView#items} were grouped or ungrouped as a result of some change | ||
| * in the toolbar geometry. | ||
@@ -200,3 +200,3 @@ * | ||
| * | ||
| * @eventName groupedItemsUpdate | ||
| * @eventName ~ToolbarView#groupedItemsUpdate | ||
| */ | ||
@@ -243,2 +243,26 @@ export type ToolbarViewGroupedItemsUpdateEvent = { | ||
| } | ||
| /** | ||
| * A class interface defining the behavior of the {@link module:ui/toolbar/toolbarview~ToolbarView}. | ||
| * | ||
| * Toolbar behaviors extend its look and functionality and have an impact on the | ||
| * {@link module:ui/toolbar/toolbarview~ToolbarView#element} template or | ||
| * {@link module:ui/toolbar/toolbarview~ToolbarView#render rendering}. They can be enabled | ||
| * conditionally, e.g. depending on the configuration of the toolbar. | ||
| */ | ||
| export interface ToolbarBehavior { | ||
| /** | ||
| * A method called after the toolbar has been {@link module:ui/toolbar/toolbarview~ToolbarView#render rendered}. | ||
| * It can be used to, for example, customize the behavior of the toolbar when its | ||
| * {@link module:ui/toolbar/toolbarview~ToolbarView#element} is available. | ||
| * | ||
| * @param view An instance of the toolbar being rendered. | ||
| */ | ||
| render(view: ToolbarView): void; | ||
| /** | ||
| * A method called after the toolbar has been {@link module:ui/toolbar/toolbarview~ToolbarView#destroy destroyed}. | ||
| * It allows cleaning up after the toolbar behavior, for instance, this is the right place to detach | ||
| * event listeners, free up references, etc. | ||
| */ | ||
| destroy(): void; | ||
| } | ||
| export {}; |
@@ -69,3 +69,3 @@ /** | ||
| * **Note**: This class is a singleton. All editor instances re-use the same instance loaded by | ||
| * {@link module:core/editor/editorui~EditorUI} of the first editor. | ||
| * {@link module:ui/editorui/editorui~EditorUI} of the first editor. | ||
| */ | ||
@@ -72,0 +72,0 @@ export default class TooltipManager extends TooltipManager_base { |
@@ -66,3 +66,3 @@ /** | ||
| * **Note**: This class is a singleton. All editor instances re-use the same instance loaded by | ||
| * {@link module:core/editor/editorui~EditorUI} of the first editor. | ||
| * {@link module:ui/editorui/editorui~EditorUI} of the first editor. | ||
| */ | ||
@@ -69,0 +69,0 @@ export default class TooltipManager extends DomEmitterMixin() { |
@@ -414,10 +414,10 @@ /** | ||
| /** | ||
| * Event fired by the {@link #render} method. Actual rendering is executed as a listener to | ||
| * Event fired by the {@link module:ui/view~View#render} method. Actual rendering is executed as a listener to | ||
| * this event with the default priority. | ||
| * | ||
| * See {@link module:utils/observablemixin~ObservableMixin#decorate} for more information and samples. | ||
| * See {@link module:utils/observablemixin~Observable#decorate} for more information and samples. | ||
| * | ||
| * @eventName render | ||
| * @eventName ~View#render | ||
| */ | ||
| export type UIViewRenderEvent = DecoratedMethodEvent<View, 'render'>; | ||
| export {}; |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.42%
907423
- Lines of code
- increased by0.42%
17582