@ckeditor/ckeditor5-bookmark 0.0.0-nightly-next-20260105.0 → 0.0.0-nightly-next-20260106.0

package/src/insertbookmarkcommand.js

@@ -1,113 +0,0 @@
-/**
- * @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
- */
-import { logWarning } from 'ckeditor5/src/utils.js';
-import { Command } from 'ckeditor5/src/core.js';
-import { isBookmarkIdValid } from './utils.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 class InsertBookmarkCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const model = this.editor.model;
-        const selection = model.document.selection;
-        const position = this._getPositionToInsertBookmark(selection);
-        this.isEnabled = !!position;
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options Command options.
-     * @param options.bookmarkId The value of the `bookmarkId` attribute.
-     */
-    execute(options) {
-        if (!options) {
-            return;
-        }
-        const { bookmarkId } = options;
-        if (!isBookmarkIdValid(bookmarkId)) {
-            /**
-             * Insert bookmark command can be executed only with a valid name.
-             *
-             * A valid bookmark name must be a non-empty string and must not contain any spaces.
-             *
-             * @error insert-bookmark-command-executed-with-invalid-name
-             */
-            logWarning('insert-bookmark-command-executed-with-invalid-name');
-            return;
-        }
-        const editor = this.editor;
-        const model = editor.model;
-        const selection = model.document.selection;
-        model.change(writer => {
-            let position = this._getPositionToInsertBookmark(selection);
-            const isBookmarkAllowed = model.schema.checkChild(position, 'bookmark');
-            // If the position does not allow for `bookmark` but allows for a `paragraph`
-            // then insert a `paragraph` then we will insert a `bookmark` inside.
-            if (!isBookmarkAllowed) {
-                const newPosition = editor.execute('insertParagraph', { position });
-                if (!newPosition) {
-                    return;
-                }
-                position = newPosition;
-            }
-            const bookmarkElement = writer.createElement('bookmark', {
-                ...Object.fromEntries(selection.getAttributes()),
-                bookmarkId
-            });
-            model.insertObject(bookmarkElement, position, null, { setSelection: 'on' });
-        });
-    }
-    /**
-     * 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.
-     */
-    _getPositionToInsertBookmark(selection) {
-        const model = this.editor.model;
-        const schema = model.schema;
-        const firstRange = selection.getFirstRange();
-        const startPosition = firstRange.start;
-        // Return position if it is allowed to insert bookmark or if it is allowed to insert paragraph.
-        if (isBookmarkAllowed(startPosition, schema)) {
-            return startPosition;
-        }
-        for (const { previousPosition, item } of firstRange) {
-            // When the table cell is selected (from the outside) we look for the first paragraph-like element inside.
-            if (item.is('element') &&
-                schema.checkChild(item, '$text') &&
-                isBookmarkAllowed(item, schema)) {
-                return model.createPositionAt(item, 0);
-            }
-            if (isBookmarkAllowed(previousPosition, schema)) {
-                return previousPosition;
-            }
-        }
-        return null;
-    }
-}
-/**
- * Verify if the given position allows for bookmark insertion. Verify if auto-paragraphing could help.
- */
-function isBookmarkAllowed(position, schema) {
-    if (schema.checkChild(position, 'bookmark')) {
-        return true;
-    }
-    if (!schema.checkChild(position, 'paragraph')) {
-        return false;
-    }
-    return schema.checkChild('paragraph', 'bookmark');
-}

package/src/ui/bookmarkformview.js

@@ -1,244 +0,0 @@
-/**
- * @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 bookmark/ui/bookmarkformview
- */
-import { ButtonView, FocusCycler, FormRowView, LabeledFieldView, View, ViewCollection, createLabeledInputText, submitHandler, FormHeaderView } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler } from 'ckeditor5/src/utils.js';
-import { IconPreviousArrow } from '@ckeditor/ckeditor5-icons';
-// See: #8833.
-// eslint-disable-next-line ckeditor5-rules/ckeditor-imports
-import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
-// eslint-disable-next-line ckeditor5-rules/ckeditor-imports
-import '@ckeditor/ckeditor5-ui/theme/components/form/form.css';
-import '../../theme/bookmarkform.css';
-/**
- * The bookmark form view controller class.
- *
- * See {@link module:bookmark/ui/bookmarkformview~BookmarkFormView}.
- */
-export class BookmarkFormView extends View {
-    /**
-     * Tracks information about DOM focus in the form.
-     */
-    focusTracker = new FocusTracker();
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    keystrokes = new KeystrokeHandler();
-    /**
-     * The ID input view.
-     */
-    idInputView;
-    /**
-     * The Back button view displayed in the header.
-     */
-    backButtonView;
-    /**
-     * A button used to submit the form.
-     */
-    saveButtonView;
-    /**
-     * A collection of form child views in the form.
-     */
-    children;
-    /**
-     * An array of form validators used by {@link #isValid}.
-     */
-    _validators;
-    /**
-     * A collection of views that can be focused in the form.
-     */
-    _focusables = new ViewCollection();
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    _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, validators) {
-        super(locale);
-        this._validators = validators;
-        // Create buttons.
-        this.backButtonView = this._createBackButton();
-        this.saveButtonView = this._createSaveButton();
-        // Create input fields.
-        this.idInputView = this._createIdInput();
-        this.children = this.createCollection([this._createHeaderView()]);
-        this.children.add(new FormRowView(locale, {
-            children: [
-                this.idInputView,
-                this.saveButtonView
-            ],
-            class: [
-                'ck-form__row_with-submit',
-                'ck-form__row_large-top-padding'
-            ]
-        }));
-        // Close the panel on esc key press when the **form has focus**.
-        this.keystrokes.set('Esc', (data, cancel) => {
-            this.fire('cancel');
-            cancel();
-        });
-        this._focusCycler = new FocusCycler({
-            focusables: this._focusables,
-            focusTracker: this.focusTracker,
-            keystrokeHandler: this.keystrokes,
-            actions: {
-                // Navigate form fields backwards using the Shift + Tab keystroke.
-                focusPrevious: 'shift + tab',
-                // Navigate form fields forwards using the Tab key.
-                focusNext: 'tab'
-            }
-        });
-        this.setTemplate({
-            tag: 'form',
-            attributes: {
-                class: [
-                    'ck',
-                    'ck-form',
-                    'ck-bookmark-form',
-                    'ck-responsive-form'
-                ],
-                // https://github.com/ckeditor/ckeditor5-link/issues/90
-                tabindex: '-1'
-            },
-            children: this.children
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    render() {
-        super.render();
-        submitHandler({
-            view: this
-        });
-        const childViews = [
-            this.backButtonView,
-            this.idInputView,
-            this.saveButtonView
-        ];
-        childViews.forEach(v => {
-            // Register the view as focusable.
-            this._focusables.add(v);
-            // Register the view in the focus tracker.
-            this.focusTracker.add(v.element);
-        });
-        // Start listening for the keystrokes coming from #element.
-        this.keystrokes.listenTo(this.element);
-    }
-    /**
-     * @inheritDoc
-     */
-    destroy() {
-        super.destroy();
-        this.focusTracker.destroy();
-        this.keystrokes.destroy();
-    }
-    /**
-     * Focuses the fist {@link #_focusables} in the form.
-     */
-    focus() {
-        this.idInputView.focus();
-    }
-    /**
-     * Validates the form and returns `false` when some fields are invalid.
-     */
-    isValid() {
-        this.resetFormStatus();
-        for (const validator of this._validators) {
-            const errorText = validator(this);
-            // One error per field is enough.
-            if (errorText) {
-                // Apply updated error.
-                this.idInputView.errorText = errorText;
-                return false;
-            }
-        }
-        return true;
-    }
-    /**
-     * 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() {
-        this.idInputView.errorText = null;
-    }
-    /**
-     * Creates a back button view that cancels the form.
-     */
-    _createBackButton() {
-        const t = this.locale.t;
-        const backButton = new ButtonView(this.locale);
-        backButton.set({
-            class: 'ck-button-back',
-            label: t('Back'),
-            icon: IconPreviousArrow,
-            tooltip: true
-        });
-        backButton.delegate('execute').to(this, 'cancel');
-        return backButton;
-    }
-    /**
-     * Creates a save button view that saves the bookmark.
-     */
-    _createSaveButton() {
-        const t = this.locale.t;
-        const saveButton = new ButtonView(this.locale);
-        saveButton.set({
-            label: t('Save'),
-            withText: true,
-            type: 'submit',
-            class: 'ck-button-action ck-button-bold'
-        });
-        return saveButton;
-    }
-    /**
-     * Creates a header view for the form.
-     */
-    _createHeaderView() {
-        const t = this.locale.t;
-        const header = new FormHeaderView(this.locale, {
-            label: t('Bookmark')
-        });
-        header.children.add(this.backButtonView, 0);
-        return header;
-    }
-    /**
-     * Creates a labeled input view.
-     *
-     * @returns Labeled field view instance.
-     */
-    _createIdInput() {
-        const t = this.locale.t;
-        const labeledInput = new LabeledFieldView(this.locale, createLabeledInputText);
-        labeledInput.label = t('Bookmark name');
-        labeledInput.infoText = t('Enter the bookmark name without spaces.');
-        labeledInput.class = 'ck-labeled-field-view_full-width';
-        return labeledInput;
-    }
-    /**
-     * 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() {
-        const { element } = this.idInputView.fieldView;
-        if (!element) {
-            return null;
-        }
-        return element.value.trim();
-    }
-}

package/src/updatebookmarkcommand.js

@@ -1,75 +0,0 @@
-/**
- * @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 bookmark/updatebookmarkcommand
- */
-import { Command } from 'ckeditor5/src/core.js';
-import { logWarning } from 'ckeditor5/src/utils.js';
-import { isBookmarkIdValid } from './utils.js';
-/**
- * The update bookmark command.
- *
- * The command is registered by {@link module:bookmark/bookmarkediting~BookmarkEditing} as `'updateBookmark'`.
- *
- * To update the `bookmarkId` of current selected bookmark element, execute the command passing the bookmark id as a parameter:
- *
- * ```ts
- * editor.execute( 'updateBookmark', { bookmarkId: 'newId' } );
- * ```
- */
-export class UpdateBookmarkCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const model = this.editor.model;
-        const selection = model.document.selection;
-        const selectedBookmark = getSelectedBookmark(selection);
-        this.isEnabled = !!selectedBookmark;
-        this.value = selectedBookmark ? selectedBookmark.getAttribute('bookmarkId') : undefined;
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options Command options.
-     * @param options.bookmarkId The new value of the `bookmarkId` attribute to set.
-     */
-    execute(options) {
-        if (!options) {
-            return;
-        }
-        const { bookmarkId } = options;
-        if (!isBookmarkIdValid(bookmarkId)) {
-            /**
-             * Update bookmark command can be executed only with a valid name.
-             *
-             * A valid bookmark name must be a non-empty string and must not contain any spaces.
-             *
-             * @error update-bookmark-command-executed-with-invalid-name
-             */
-            logWarning('update-bookmark-command-executed-with-invalid-name');
-            return;
-        }
-        const model = this.editor.model;
-        const selection = model.document.selection;
-        const selectedBookmark = getSelectedBookmark(selection);
-        if (selectedBookmark) {
-            model.change(writer => {
-                writer.setAttribute('bookmarkId', bookmarkId, selectedBookmark);
-            });
-        }
-    }
-}
-/**
- * Returns the selected `bookmark` element in the model, if any.
- */
-function getSelectedBookmark(selection) {
-    const element = selection.getSelectedElement();
-    if (!!element && element.is('element', 'bookmark')) {
-        return element;
-    }
-    return null;
-}

package/src/utils.js

@@ -1,21 +0,0 @@
-/**
- * @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 bookmark/utils
- */
-/**
- * Returns `true` if the bookmark id is valid; otherwise, returns `false`.
- *
- * @internal
- */
-export function isBookmarkIdValid(id) {
-    if (!id || typeof id !== 'string') {
-        return false;
-    }
-    if (/\s/.test(id)) {
-        return false;
-    }
-    return true;
-}