@ckeditor/ckeditor5-comments 44.1.0-alpha.5 → 44.2.0-alpha.0

package/dist/comments/ui/view/commentinputview.d.ts

@@ -1,105 +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 comments/comments/ui/view/commentinputview
- */
-import { View, FocusCycler, ButtonView, type FocusableView, type ViewCollection } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import { type EditorConfig, type DataApi } from 'ckeditor5/src/core.js';
-import CommentEditor from '../commenteditor/commenteditor.js';
-/**
- * A view for the comment input section that includes a comment editor.
- */
-export default class CommentInputView extends View {
-    /**
-     * Comment editor.
-     */
-    editor: CommentEditor & DataApi | null;
-    /**
-     * The input value (comment editor content).
-     *
-     * @observable
-     */
-    value: string;
-    /**
-     * When set to `true` it is not possible to submit the commit.
-     *
-     * @observable
-     */
-    disabledSubmit: boolean;
-    /**
-     * Specifies whether the buttons should be visible (`true`) or hidden (`false`).
-     *
-     * @observable
-     */
-    showButtons: boolean;
-    /**
-     * The comment editor placeholder.
-     *
-     * @observable
-     */
-    placeholder: string;
-    /**
-     * The submit button label.
-     *
-     * @observable
-     */
-    submitLabel: string;
-    element: HTMLElement;
-    /**
-     * Keystroke handler for the view.
-     */
-    keystrokes: KeystrokeHandler;
-    /**
-     * Focus tracker for the view.
-     */
-    focusTracker: FocusTracker;
-    /**
-     * Collection of focusable sub-views in the input component.
-     */
-    focusables: ViewCollection<FocusableView>;
-    /**
-     * Helps providing keyboard navigation between {@link #focusables}.
-     */
-    focusCycler: FocusCycler;
-    /**
-     * Button view for the button which submits the comment.
-     */
-    submitButtonView: ButtonView;
-    /**
-     * Button view for the button which cancels comment input.
-     */
-    cancelButtonView: ButtonView;
-    constructor(locale: Locale, editorConfig?: EditorConfig);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Creates the comment editor instance.
-     *
-     * @returns Promise resolved after the editor instance is initialized.
-     */
-    createEditor(): Promise<CommentEditor | undefined>;
-    /**
-     * Focuses the view.
-     */
-    focus(direction?: 1 | -1): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
-}
-/**
- * An event fired when a user successfully submits a comment. The event carries the comment content.
- */
-export type CommentInputSubmitEvent = {
-    name: 'submit';
-    args: [cotnent: string];
-};

package/dist/comments/ui/view/commentsarchiveview.d.ts

@@ -1,50 +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 comments/comments/ui/view/commentslistview
- */
-import { View, FocusCycler, type ViewCollection, type FocusableView } from 'ckeditor5/src/ui.js';
-import { FocusTracker, type Locale } from 'ckeditor5/src/utils.js';
-import type AnnotationView from '../../../annotations/view/annotationview.js';
-/**
- * A view representing the content of comments archive.
- */
-export default class CommentsArchiveView extends View implements FocusableView {
-    /**
-     * The flag indicating whether there are items to display in the comments archive.
-     *
-     * @observable
-     */
-    isEmpty: boolean;
-    /**
-     * Tracks information about the DOM focus in the comments archive.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * @param locale The localization service instance.
-     * @param annotationViews Resolved comment thread annotation views to render inside the comments archive.
-     */
-    constructor(locale: Locale, annotationViews: ViewCollection<AnnotationView>);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-}

package/dist/comments/ui/view/commentslistview.d.ts

@@ -1,116 +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 comments/comments/ui/view/commentslistview
- */
-import { View, FocusCycler, type ViewCollection, type FocusableView } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import type { CommentThread } from '../../commentsrepository.js';
-import type CommentView from './commentview.js';
-import type { CommentThreadConfig } from '../../../config.js';
-/**
- * A view representing the list of comments. It should be used as a part of the comment thread view.
- */
-export default class CommentsListView extends View implements FocusableView {
-    locale: Locale;
-    /**
-     * Informs whether the list contains any comment view that is in the editing mode.
-     *
-     * @observable
-     */
-    hasDirtyComment: boolean;
-    /**
-     * Number of comments in the list.
-     *
-     * @observable
-     */
-    length: number;
-    /**
-     * Informs whether the comments list view is in the active state ("highlighted").
-     * Comment list view is in that state when it is focused or it was activated by the user in any different way.
-     *
-     * @observable
-     */
-    isActive: boolean;
-    /**
-     * View collection which holds all comment views to be displayed.
-     * It may also contain collapsed count view if the comments list view is collapsed and some comment views are hidden.
-     *
-     * @readonly
-     */
-    readonly visibleViews: ViewCollection;
-    /**
-     * View collection which holds all comment views created for given comment thread.
-     *
-     * @readonly
-     */
-    readonly commentViews: ViewCollection<CommentView>;
-    /**
-     * Comment view used to display information that comment has been resolved.
-     *
-     * @readonly
-     */
-    resolvedCommentView: CommentView | null;
-    /**
-     * Tracks information about DOM focus in the comments list.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Helps cycling over focusable {@link #commentViews} in the list.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * @param locale The localization service instance.
-     * @param model The model on which the view will base.
-     * @param config Additional view configuration.
-     */
-    constructor(locale: Locale, model: CommentThread, config: CommentThreadConfig);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Focuses the view.
-     */
-    focus(direction?: 1 | -1): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Refreshes the list of the visible views.
-     *
-     * When doing so, it performs a minimal amount of changes, so that views are not re-added, which might cause undesirable effects
-     * like focus loss or glitches due to CSS animations.
-     *
-     * The comments list may be collapsed or expanded:
-     *
-     * * it is expanded, if it {@link ~#isActive is active},
-     * * it is expanded, if {@link module:comments/comments/commentsrepository~CommentThread#weight comment thread weight}
-     * is lower than allowed (`config.comments.maxThreadTotalWeight`),
-     * * it is expanded, if it {@link ~#hasDirtyComment has any comments in edit mode},
-     * * it is collapsed, if neither of above is true.
-     *
-     * When comments list is in collapsed state, it displays at most `config.comments.maxCommentsWhenCollapsed` comment views:
-     *
-     * * first comment view,
-     * * {@link ~#_collapsedCommentsView collapsed comments counter} (if there are any hidden views),
-     * * appropriate number of the comments from the bottom of the thread.
-     *
-     * All the comments are also {@link module:comments/comments/ui/view/basecommentview~BaseCommentView#collapse set to collapsed state}.
-     *
-     * When comments list in in expanded state, it displays all comment views for all comments. All the comments are also
-     * {@link module:comments/comments/ui/view/basecommentview~BaseCommentView#expand set to expanded state}.
-     */
-    refreshVisibleViews(): void;
-}

package/dist/comments/ui/view/commentthreadheadercontextview.d.ts

@@ -1,25 +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 { View, type FocusableView } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-/**
- * A view displaying the context of a comment thread. The context is a piece of text from editor content
- * that comment was created on. It gives users a better understanding of what is discussed in the thread.
- */
-export default class CommentThreadHeaderContextView extends View implements FocusableView {
-    /**
-     * The text of the content, it corresponds to some of the content in the editor.
-     */
-    contextValue: string;
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-}

package/dist/comments/ui/view/commentthreadheaderview.d.ts

@@ -1,80 +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 comments/comments/ui/view/commentthreadheaderview
- */
-import { View, ButtonView, FocusCycler, type FocusableView, type ViewCollection } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import type { CommentThread } from '../../commentsrepository.js';
-import CommentThreadHeaderContextView from './commentthreadheadercontextview.js';
-export declare const MAX_CONTENT_LENGTH = 150;
-/**
- * A view for the comment thread header.
- */
-export default class CommentThreadHeaderView extends View implements FocusableView {
-    locale: Locale;
-    /**
-     * Defines whether the context value exists.
-     *
-     * @observable
-     */
-    hasContext: boolean;
-    /**
-     * Context value to display in the header.
-     *
-     * @observable
-     */
-    contextValue: string;
-    /**
-     * Button view for the button which reopen the comment thread.
-     */
-    reopenButtonView: ButtonView;
-    /**
-     * The view that displays the context of the comment thread to the user, for instance,
-     * the part of text the thread (first comment) relates to.
-     */
-    contextView: CommentThreadHeaderContextView;
-    /**
-     * The collection of focusable sub-views in the header.
-     */
-    readonly focusables: ViewCollection<FocusableView>;
-    /**
-     * Tracks information about DOM focus in the header view.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Helps cycling over focusable {@link #commentThreadChildren} in the header view.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, model: CommentThread);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-}
-/**
- * Fired when a user performed an action that should lead to reopen the resolved comment thread.
- *
- * @eventName ~CommentThreadHeaderView#reopenCommentThread
- */
-export type UIReopenCommentThreadEvent = {
-    name: 'reopenCommentThread';
-    args: [id: string];
-};

package/dist/comments/ui/view/commentthreadinputview.d.ts

@@ -1,60 +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 comments/comments/ui/view/commentthreadinputview
- */
-import { type FocusableView, type FocusCycler, View } from 'ckeditor5/src/ui.js';
-import CommentInputView from './commentinputview.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import type { EditorConfig } from 'ckeditor5/src/core.js';
-import { UserView, type User } from 'ckeditor5-collaboration/src/collaboration-core.js';
-/**
- * View that represents comment input area for a comment thread. Includes editor, user view and buttons.
- */
-export default class CommentThreadInputView extends View implements FocusableView {
-    /**
-     * Specifies whether the comment input view should be visible (`true`) or hidden (`false`).
-     *
-     * @observable
-     */
-    showInput: boolean;
-    /**
-     * Comment input view.
-     */
-    commentInputView: CommentInputView;
-    /**
-     * Helps move focus between focusable elements.
-     *
-     * **Note:** This property is a proxy is exposed for parent views to discover and use focus cycling capabilities of the view
-     * while in fact the actual implementation is in the {@link #commentInputView}.
-     */
-    focusCycler: FocusCycler;
-    /**
-     * User view for the input area. Presents the local user.
-     */
-    userView: UserView;
-    /**
-     * @param locale The localization service instance.
-     * @param localUser Current local user.
-     * @param editorConfig
-     */
-    constructor(locale: Locale, localUser: User, editorConfig: EditorConfig);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): Promise<void>;
-    /**
-     * @inheritDoc
-     */
-    focus(direction?: 1 | -1): void;
-}

package/dist/comments/ui/view/commentthreadview.d.ts

@@ -1,127 +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 comments/comments/ui/view/commentthreadview
- * @publicApi
- */
-import { type Locale } from 'ckeditor5/src/utils.js';
-import { LateFocusButtonView, type User } from 'ckeditor5-collaboration/src/collaboration-core.js';
-import { type View, type ViewWithFocusCycler, type TemplateDefinition, type ViewCollection } from 'ckeditor5/src/ui.js';
-import BaseCommentThreadView from './basecommentthreadview.js';
-import type { CommentThread } from '../../commentsrepository.js';
-import type { CommentThreadConfig } from '../../../config.js';
-declare const CommentThreadView_base: import("ckeditor5/src/utils.js").Mixed<typeof BaseCommentThreadView, import("@ckeditor/ckeditor5-collaboration-core/src/utils/confirmmixin.js").ConfirmApi>;
-/**
- * The default view for comment thread.
- */
-export default class CommentThreadView extends /* #__PURE__ -- @preserve */ CommentThreadView_base implements ViewWithFocusCycler {
-    isConfirm: boolean;
-    cancelConfirm: () => void;
-    showConfirm: (key: string, element: unknown) => Promise<void>;
-    /**
-     * The locale instance.
-     */
-    readonly locale: Locale;
-    /**
-     * A property used by the template.
-     *
-     * It works as a visual indicator for the user that an action is about to be performed.
-     * The value of this property is used in setting the CSS class.
-     * The property is used when the user interacts with the view.
-     *
-     * @observable
-     */
-    actionIndicator: string | null;
-    /**
-     * View collection which holds all comment thread children elements.
-     *
-     * These views are:
-     *
-     * * {@link ~CommentThreadView#commentThreadHeaderView `commentThreadHeaderView`} (added at the beginning when the comment thread is
-     * resolved),
-     * * {@link ~CommentThreadView#commentsListView `commentsListView`},
-     * * {@link ~CommentThreadView#commentThreadInputView `commentThreadInputView`}.
-     *
-     * @readonly
-     */
-    readonly commentThreadChildren: ViewCollection<View>;
-    /**
-     * `ConfirmView` uses this element as a container for confirmation dialog.
-     *
-     * The element is set after `view#render()` is called.
-     *
-     * @member {HTMLElement|null} #containerElement
-     */
-    containerElement: HTMLElement | null;
-    /**
-     * Resolve button view. Resolve button fires the 'resolveCommentThread' event when submitted.
-     *
-     * @readonly
-     */
-    readonly resolveButton: LateFocusButtonView;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, model: CommentThread, localUser: User, config: CommentThreadConfig);
-    /**
-     * Returns a template definition that will be passed to {@link module:ui/view~View#setTemplate}.
-     *
-     * Overwrite this method if you want to set a custom template for the comment thread view.
-     *
-     * The default template looks as follows:
-     *
-     * ```ts
-     * const bind = this.bindTemplate;
-     *
-     * {
-     * 	tag: 'div',
-     *
-     * 	attributes: {
-     * 		class: [
-     * 			'ck',
-     * 			'ck-thread',
-     * 			'ck-reset_all-excluded',
-     * 			'ck-rounded-corners',
-     * 			bind.if( 'isActive', 'ck-thread--active' ),
-     * 			bind.if( 'isUnlinked', 'ck-thread--unlinked' ),
-     * 			bind.if( 'isConfirm', 'ck-thread--remove-confirmation' ),
-     * 			bind.to( 'actionIndicator', value => value ? `ck-thread--${ value }` : '' )
-     * 		],
-     * 		'data-thread-id': this._model.id,
-     * 		// Needed for managing focus after adding new comment.
-     * 		tabindex: 0,
-     * 		role: 'listitem',
-     * 		'aria-label': bind.to( 'ariaLabel' ),
-     * 		'aria-describedby': this.ariaDescriptionView.id
-     * 	},
-     *
-     * 	children: [
-     * 		{
-     * 			tag: 'div',
-     * 			attributes: {
-     * 				class: 'ck-thread__container'
-     * 			},
-     * 			children: this.commentThreadChildren
-     * 		}
-     * 	]
-     * };
-     * ```
-     *
-     * See the {@glink features/collaboration/annotations/annotations-custom-view Annotation custom view guide} to learn more about
-     * the possible annotation customizations.
-     *
-     * @returns The definition of a comment thread view's template.
-     */
-    getTemplate(): TemplateDefinition;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-}
-export {};