@ckeditor/ckeditor5-bookmark 0.0.0-nightly-20241025.0

package/dist/insertbookmarkcommand.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @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-oss-license
+ */
+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

@@ -0,0 +1,106 @@
+/**
+ * @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-oss-license
+ */
+/**
+ * @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

@@ -0,0 +1,122 @@
+/**
+ * @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-oss-license
+ */
+/**
+ * @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;

package/dist/updatebookmarkcommand.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @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-oss-license
+ */
+/**
+ * @module bookmark/updatebookmarkcommand
+ */
+import { Command } from 'ckeditor5/src/core.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 default class UpdateBookmarkCommand extends Command {
+    /**
+     * The value of the `'bookmarkId'` attribute.
+     *
+     * @observable
+     * @readonly
+     */
+    value: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options Command options.
+     * @param options.bookmarkId The new value of the `bookmarkId` attribute to set.
+     */
+    execute(options: {
+        bookmarkId: string;
+    }): void;
+}

package/dist/utils.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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-oss-license
+ */
+/**
+ * @module bookmark/utils
+ */
+/**
+ * Returns `true` if the bookmark id is valid; otherwise, returns `false`.
+ */
+export declare function isBookmarkIdValid(id: string): boolean;

package/lang/contexts.json

@@ -0,0 +1,13 @@
+{
+	"Bookmark": "The label of the bookmark toolbar button. Also, a bookmark form header.",
+	"Insert": "The button in the bookmark insert form.",
+	"Update": "The button in the bookmark update form.",
+	"Edit bookmark": "Button opening the Bookmark editing balloon.",
+	"Remove bookmark": "Toolbar button tooltip for bookmark remove button.",
+	"Bookmark name": "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview.",
+	"Enter the bookmark name without spaces.": "The description of bookmark input in the bookmark insert form.",
+	"Bookmark must not be empty.": "The error message. Displayed when the bookmark name is empty.",
+	"Bookmark name cannot contain space characters.": "The error message. Displayed when provided name includes spaces.",
+	"Bookmark name already exists.": "The error message. Displayed when provided name already exists.",
+	"bookmark widget": "The label for the bookmark widget."
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@ckeditor/ckeditor5-bookmark",
+  "version": "0.0.0-nightly-20241025.0",
+  "description": "Bookmark feature for CKEditor 5.",
+  "keywords": [
+    "ckeditor",
+    "ckeditor5",
+    "ckeditor 5",
+    "ckeditor5-feature",
+    "ckeditor5-plugin",
+    "ckeditor5-dll"
+  ],
+  "type": "module",
+  "main": "src/index.js",
+  "dependencies": {
+    "ckeditor5": "0.0.0-nightly-20241025.0",
+    "@ckeditor/ckeditor5-core": "0.0.0-nightly-20241025.0",
+    "@ckeditor/ckeditor5-engine": "0.0.0-nightly-20241025.0",
+    "@ckeditor/ckeditor5-widget": "0.0.0-nightly-20241025.0",
+    "@ckeditor/ckeditor5-utils": "0.0.0-nightly-20241025.0",
+    "@ckeditor/ckeditor5-ui": "0.0.0-nightly-20241025.0"
+  },
+  "author": "CKSource (http://cksource.com/)",
+  "license": "GPL-2.0-or-later",
+  "homepage": "https://ckeditor.com/ckeditor-5",
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5.git",
+    "directory": "packages/ckeditor5-bookmark"
+  },
+  "files": [
+    "dist",
+    "lang",
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "theme",
+    "build",
+    "ckeditor5-metadata.json",
+    "CHANGELOG.md"
+  ],
+  "types": "src/index.d.ts"
+}

package/src/augmentation.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @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
+ */
+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/src/augmentation.js

@@ -0,0 +1,5 @@
+/**
+ * @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
+ */
+export {};

package/src/bookmark.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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
+ */
+/**
+ * @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/src/bookmark.js

@@ -0,0 +1,36 @@
+/**
+ * @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
+ */
+/**
+ * @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() {
+        return 'Bookmark';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [BookmarkEditing, BookmarkUI, Widget];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/bookmarkconfig.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @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
+ */
+/**
+ * @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/src/bookmarkconfig.js

@@ -0,0 +1,5 @@
+/**
+ * @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
+ */
+export {};

package/src/bookmarkediting.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @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
+ */
+/**
+ * @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;
+}