@ckeditor/ckeditor5-bookmark 0.0.1 → 44.0.0-alpha.1

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/lang/translations/af.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: af\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/lang/translations/ar.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: ar\n"
+"Plural-Forms: nplurals=6; plural=(n == 0 ? 0 : n == 1 ? 1 : n == 2 ? 2 : n % 100 >= 3 && n % 100 <= 10 ? 3 : n % 100 >= 11 ? 4 : 5);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/lang/translations/ast.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: ast\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/lang/translations/az.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: az\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/lang/translations/bg.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: bg\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/lang/translations/bn.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: bn\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""