@ckeditor/ckeditor5-bookmark 44.1.0 → 44.2.0-alpha.0

package/theme/bookmark.css

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * 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
  */
 

package/theme/bookmarkactions.css

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * 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
  */
 

package/theme/bookmarkform.css

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * 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
  */
 

package/dist/augmentation.d.ts

@@ -1,28 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type { Bookmark, BookmarkEditing, BookmarkUI, InsertBookmarkCommand, UpdateBookmarkCommand, BookmarkConfig } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:bookmark/bookmark~Bookmark} feature.
-         *
-         * Read more in {@link module:bookmark/bookmarkconfig~BookmarkConfig}.
-         */
-        bookmark?: BookmarkConfig;
-    }
-    interface PluginsMap {
-        [Bookmark.pluginName]: Bookmark;
-        [BookmarkEditing.pluginName]: BookmarkEditing;
-        [BookmarkUI.pluginName]: BookmarkUI;
-    }
-    interface CommandsMap {
-        insertBookmark: InsertBookmarkCommand;
-        updateBookmark: UpdateBookmarkCommand;
-    }
-}

package/dist/bookmark.d.ts

@@ -1,34 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module bookmark/bookmark
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { Widget } from 'ckeditor5/src/widget.js';
-import BookmarkUI from './bookmarkui.js';
-import BookmarkEditing from './bookmarkediting.js';
-/**
- * The bookmark feature.
- *
- * For a detailed overview, check the {@glink features/bookmarks Bookmarks} feature guide.
- */
-export default class Bookmark extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Bookmark";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof BookmarkEditing, typeof BookmarkUI, typeof Widget];
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-}

package/dist/bookmarkconfig.d.ts

@@ -1,52 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module bookmark/bookmarkconfig
- */
-/**
- * The configuration of the bookmark feature.
- *
- * The properties defined in this config are set in the `config.bookmark` namespace.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		bookmark: {
- * 			// Bookmark configuration.
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface BookmarkConfig {
-    /**
-     * Allows to convert into bookmarks non-empty anchor elements.
-     *
-     * With this option enabled you will have all non-empty anchors converted into bookmakrs.
-     * For example:
-     *
-     *```html
-     * <a id="bookmark">Bookmark</a>
-     *```
-     *
-     * will be converted into:
-     *
-     *```html
-     * <a id="bookmark"></a>Bookmark
-     *```
-     *
-     * **Note:** This is enabled by default.
-     *
-     * @default true
-     */
-    enableNonEmptyAnchorConversion?: boolean;
-}

package/dist/bookmarkediting.d.ts

@@ -1,55 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module bookmark/bookmarkediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import type { Element } from 'ckeditor5/src/engine.js';
-import '../theme/bookmark.css';
-/**
- * The bookmark editing plugin.
- */
-export default class BookmarkEditing extends Plugin {
-    /**
-     * A collection of bookmarks elements in the document.
-     */
-    private _bookmarkElements;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "BookmarkEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Returns the model element for the given bookmark ID if it exists.
-     */
-    getElementForBookmarkId(bookmarkId: string): Element | null;
-    /**
-     * Defines the schema for the bookmark feature.
-     */
-    private _defineSchema;
-    /**
-     * Defines the converters for the bookmark feature.
-     */
-    private _defineConverters;
-    /**
-     * Creates a UI element for the `bookmark` representation in editing view.
-     */
-    private _createBookmarkUIElement;
-    /**
-     * Tracking the added or removed bookmark elements.
-     */
-    private _trackBookmarkElements;
-}

package/dist/bookmarkui.d.ts

@@ -1,170 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module bookmark/bookmarkui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { ContextualBalloon, type ViewWithCssTransitionDisabler } from 'ckeditor5/src/ui.js';
-import BookmarkFormView from './ui/bookmarkformview.js';
-import BookmarkActionsView from './ui/bookmarkactionsview.js';
-import BookmarkEditing from './bookmarkediting.js';
-/**
- * The UI plugin of the bookmark feature.
- *
- * It registers the `'bookmark'` UI button in the editor's {@link module:ui/componentfactory~ComponentFactory component factory}
- * which inserts the `bookmark` element upon selection.
- */
-export default class BookmarkUI extends Plugin {
-    /**
-     * The actions view displayed inside of the balloon.
-     */
-    actionsView: BookmarkActionsView | null;
-    /**
-     * The form view displayed inside the balloon.
-     */
-    formView: BookmarkFormView & ViewWithCssTransitionDisabler | null;
-    /**
-     * The contextual balloon plugin instance.
-     */
-    private _balloon;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof BookmarkEditing, typeof ContextualBalloon];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "BookmarkUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Creates views.
-     */
-    private _createViews;
-    /**
-     * Creates the {@link module:bookmark/ui/bookmarkactionsview~BookmarkActionsView} instance.
-     */
-    private _createActionsView;
-    /**
-     * Creates the {@link module:bookmark/ui/bookmarkformview~BookmarkFormView} instance.
-     */
-    private _createFormView;
-    /**
-     * Creates a toolbar Bookmark button. Clicking this button will show
-     * a {@link #_balloon} attached to the selection.
-     */
-    private _createToolbarBookmarkButton;
-    /**
-     * Creates a button for `bookmark` command to use either in toolbar or in menu bar.
-     */
-    private _createButton;
-    /**
-     * Attaches actions that control whether the balloon panel containing the
-     * {@link #formView} should be displayed.
-     */
-    private _enableBalloonActivators;
-    /**
-     * Attaches actions that control whether the balloon panel containing the
-     * {@link #formView} is visible or not.
-     */
-    private _enableUserBalloonInteractions;
-    /**
-     * Updates the button label. If bookmark is selected label is set to 'Update' otherwise
-     * it is 'Insert'.
-     */
-    private _updateFormButtonLabel;
-    /**
-     * Adds the {@link #actionsView} to the {@link #_balloon}.
-     *
-     * @internal
-     */
-    _addActionsView(): void;
-    /**
-     * Adds the {@link #formView} to the {@link #_balloon}.
-     */
-    private _addFormView;
-    /**
-     * Closes the form view. Decides whether the balloon should be hidden completely.
-     */
-    private _closeFormView;
-    /**
-     * Removes the {@link #formView} from the {@link #_balloon}.
-     */
-    private _removeFormView;
-    /**
-     * Shows the correct UI type. It is either {@link #formView} or {@link #actionsView}.
-     */
-    private _showUI;
-    /**
-     * Removes the {@link #formView} from the {@link #_balloon}.
-     *
-     * See {@link #_addFormView}, {@link #_addActionsView}.
-     */
-    private _hideUI;
-    /**
-     * Makes the UI react to the {@link module:ui/editorui/editorui~EditorUI#event:update} event to
-     * reposition itself when the editor UI should be refreshed.
-     *
-     * See: {@link #_hideUI} to learn when the UI stops reacting to the `update` event.
-     */
-    private _startUpdatingUI;
-    /**
-     * Returns `true` when {@link #formView} is in the {@link #_balloon}.
-     */
-    private get _isFormInPanel();
-    /**
-     * Returns `true` when {@link #actionsView} is in the {@link #_balloon}.
-     */
-    private get _areActionsInPanel();
-    /**
-     * Returns `true` when {@link #actionsView} is in the {@link #_balloon} and it is
-     * currently visible.
-     */
-    private get _areActionsVisible();
-    /**
-     * Returns `true` when {@link #actionsView} or {@link #formView} is in the {@link #_balloon}.
-     */
-    private get _isUIInPanel();
-    /**
-     * Returns `true` when {@link #actionsView} or {@link #formView} is in the {@link #_balloon} and it is
-     * currently visible.
-     */
-    private get _isUIVisible();
-    /**
-     * Returns positioning options for the {@link #_balloon}. They control the way the balloon is attached
-     * to the target element or selection.
-     */
-    private _getBalloonPositionData;
-    /**
-     * Returns the bookmark {@link module:engine/view/attributeelement~AttributeElement} under
-     * the {@link module:engine/view/document~Document editing view's} selection or `null`
-     * if there is none.
-     */
-    private _getSelectedBookmarkElement;
-    /**
-     * Displays a fake visual selection when the contextual balloon is displayed.
-     *
-     * This adds a 'bookmark-ui' marker into the document that is rendered as a highlight on selected text fragment.
-     */
-    private _showFakeVisualSelection;
-    /**
-     * Hides the fake visual selection created in {@link #_showFakeVisualSelection}.
-     */
-    private _hideFakeVisualSelection;
-}

package/dist/index.d.ts

@@ -1,18 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module bookmark
- */
-export { default as Bookmark } from './bookmark.js';
-export { default as BookmarkEditing } from './bookmarkediting.js';
-export { default as BookmarkUI } from './bookmarkui.js';
-export { default as InsertBookmarkCommand } from './insertbookmarkcommand.js';
-export { default as UpdateBookmarkCommand } from './updatebookmarkcommand.js';
-export type { BookmarkConfig } from './bookmarkconfig.js';
-import './augmentation.js';

package/dist/insertbookmarkcommand.d.ts

@@ -1,42 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { Command } from 'ckeditor5/src/core.js';
-/**
- * The insert bookmark command.
- *
- * The command is registered by {@link module:bookmark/bookmarkediting~BookmarkEditing} as `'insertBookmark'`.
- *
- * To insert a bookmark element at place where is the current collapsed selection or where is the beginning of document selection,
- * execute the command passing the bookmark id as a parameter:
- *
- * ```ts
- * editor.execute( 'insertBookmark', { bookmarkId: 'foo_bar' } );
- * ```
- */
-export default class InsertBookmarkCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options Command options.
-     * @param options.bookmarkId The value of the `bookmarkId` attribute.
-     */
-    execute(options: {
-        bookmarkId: string;
-    }): void;
-    /**
-     * Returns the position where the bookmark can be inserted. And if it is not possible to insert a bookmark,
-     * check if it is possible to insert a paragraph.
-     */
-    private _getPositionToInsertBookmark;
-}

package/dist/ui/bookmarkactionsview.d.ts

@@ -1,106 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module bookmark/ui/bookmarkactionsview
- */
-import { LabelView, ButtonView, View } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type LocaleTranslate, type Locale } from 'ckeditor5/src/utils.js';
-import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
-import '../../theme/bookmarkactions.css';
-/**
- * The bookmark actions view class. This view displays the bookmark preview, allows
- * removing or editing the bookmark.
- */
-export default class BookmarkActionsView extends View {
-    /**
-     * Tracks information about DOM focus in the actions.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * The bookmark preview view.
-     */
-    bookmarkPreviewView: LabelView;
-    /**
-     * The remove button view.
-     */
-    removeButtonView: ButtonView;
-    /**
-     * The edit bookmark button view.
-     */
-    editButtonView: ButtonView;
-    /**
-     * The id preview view.
-     *
-     * @observable
-     */
-    id: string | undefined;
-    /**
-     * A collection of views that can be focused in the view.
-     */
-    private readonly _focusables;
-    /**
-     * Helps cycling over {@link #_focusables} in the view.
-     */
-    private readonly _focusCycler;
-    t: LocaleTranslate;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the fist {@link #_focusables} in the actions.
-     */
-    focus(): void;
-    /**
-     * Creates a button view.
-     *
-     * @param label The button label.
-     * @param icon The button icon.
-     * @param eventName An event name that the `ButtonView#execute` event will be delegated to.
-     * @param additionalLabel An additional label outside the button.
-     * @returns The button view instance.
-     */
-    private _createButton;
-    /**
-     * Creates a bookmark name preview label.
-     *
-     * @returns The label view instance.
-     */
-    private _createBookmarkPreviewView;
-}
-/**
- * Fired when the {@link ~BookmarkActionsView#editButtonView} is clicked.
- *
- * @eventName ~BookmarkActionsView#edit
- */
-export type EditEvent = {
-    name: 'edit';
-    args: [];
-};
-/**
- * Fired when the {@link ~BookmarkActionsView#removeButtonView} is clicked.
- *
- * @eventName ~BookmarkActionsView#remove
- */
-export type RemoveEvent = {
-    name: 'remove';
-    args: [];
-};

package/dist/ui/bookmarkformview.d.ts

@@ -1,122 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module bookmark/ui/bookmarkformview
- */
-import { ButtonView, LabeledFieldView, View, ViewCollection, type InputTextView } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
-import '../../theme/bookmarkform.css';
-/**
- * The bookmark form view controller class.
- *
- * See {@link module:bookmark/ui/bookmarkformview~BookmarkFormView}.
- */
-export default class BookmarkFormView extends View {
-    /**
-     * Tracks information about DOM focus in the form.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * The ID input view.
-     */
-    idInputView: LabeledFieldView<InputTextView>;
-    /**
-     * The Submit button view.
-     */
-    buttonView: ButtonView;
-    /**
-     * A collection of form child views in the form.
-     */
-    readonly children: ViewCollection;
-    /**
-     * An array of form validators used by {@link #isValid}.
-     */
-    private readonly _validators;
-    /**
-     * A collection of views that can be focused in the form.
-     */
-    private readonly _focusables;
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    private readonly _focusCycler;
-    /**
-     * Creates an instance of the {@link module:bookmark/ui/bookmarkformview~BookmarkFormView} class.
-     *
-     * Also see {@link #render}.
-     *
-     * @param locale The localization services instance.
-     * @param validators  Form validators used by {@link #isValid}.
-     */
-    constructor(locale: Locale, validators: Array<BookmarkFormValidatorCallback>);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the fist {@link #_focusables} in the form.
-     */
-    focus(): void;
-    /**
-     * Validates the form and returns `false` when some fields are invalid.
-     */
-    isValid(): boolean;
-    /**
-     * Cleans up the supplementary error and information text of the {@link #idInputView}
-     * bringing them back to the state when the form has been displayed for the first time.
-     *
-     * See {@link #isValid}.
-     */
-    resetFormStatus(): void;
-    /**
-     * Creates header and form view.
-     */
-    private _createViewChildren;
-    /**
-     * Creates form content view with input and button.
-     */
-    private _createFormContentView;
-    /**
-     * Creates a labeled input view.
-     *
-     * @returns Labeled field view instance.
-     */
-    private _createIdInput;
-    /**
-     * Creates a button view.
-     *
-     * @param label The button label.
-     * @param className The additional button CSS class name.
-     * @returns The button view instance.
-     */
-    private _createButton;
-    /**
-     * The native DOM `value` of the {@link #idInputView} element.
-     *
-     * **Note**: Do not confuse it with the {@link module:ui/inputtext/inputtextview~InputTextView#value}
-     * which works one way only and may not represent the actual state of the component in the DOM.
-     */
-    get id(): string | null;
-}
-/**
- * Callback used by {@link ~BookmarkFormView} to check if passed form value is valid.
- *
- * If `undefined` is returned, it is assumed that the form value is correct and there is no error.
- * If string is returned, it is assumed that the form value is incorrect and the returned string is displayed in the error label
- */
-export type BookmarkFormValidatorCallback = (form: BookmarkFormView) => string | undefined;