@ckeditor/ckeditor5-comments 41.3.0-alpha.3 → 41.3.0

package/dist/types/config.d.ts

@@ -1,202 +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-oss-license
- */
-/**
- * @module comments/config
- * @publicApi
- */
-import type { EditorConfig, PartialBy } from 'ckeditor5/src/core.js';
-import type CommentView from './comments/ui/view/commentview.js';
-import type BaseCommentThreadView from './comments/ui/view/basecommentthreadview.js';
-/**
- * The configuration of the comments feature.
- *
- * ```ts
- * ClassicEditor.create( {
- * 	comments: ... // Comments feature configuration.
- * } )
- * .then( ... )
- * .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface CommentsConfig {
-    /**
-     * Specifies whether comment markers should be preserved on copy-paste and cut-and-paste actions.
-     *
-     * The following values are available:
-     *
-     * * `'default'` - the comments will be preserved on cut-paste and drag and drop actions only.
-     * * `'always'` - the markers will be preserved on all clipboard actions (cut, copy, drag and drop).
-     * * `'never'` - the markers will be ignored by clipboard.
-     *
-     * Defaults to `'default'`.
-     */
-    copyMarkers?: CommentsClipboardCopyConfig;
-    /**
-     * The total number of comments shown when the thread view is collapsed.
-     *
-     * The comments are displayed in the following way:
-     *
-     * * The first comment is displayed.
-     * * Some comments may be hidden (collapsed).
-     * * An appropriate number of the most recent comments is displayed.
-     *
-     * For example, if this parameter is set to 3, when collapsed,
-     * the thread view will display the first comment and two most recent comments.
-     *
-     * Defaults to `2`.
-     */
-    maxCommentsWhenCollapsed?: number;
-    /**
-     * The maximum total weight of a thread before the thread becomes collapsed when it is not active:
-     *
-     * * Thread weight is a sum of the weight of its comments.
-     * * Comment weight is equal to the comment length.
-     * * The minimal comment weight is 200.
-     *
-     * Defaults to `500`.
-     */
-    maxThreadTotalWeight?: number;
-    /**
-     * The maximum number of characters displayed in a comment when the thread view is collapsed.
-     * Longer comments will be trimmed.
-     *
-     * Defaults to `140`.
-     */
-    maxCommentCharsWhenCollapsed?: number;
-    /**
-     * A view class to be used to create comment views.
-     *
-     * {@link module:comments/comments/ui/view/commentview~CommentView} is used by default when this property is not set.
-     */
-    CommentView?: typeof CommentView;
-    /**
-     * A view class to be used to create comment thread views
-     * (used as annotations - in sidebar balloons or in inline annotations).
-     *
-     * {@link module:comments/comments/ui/view/commentthreadview~CommentThreadView} is used by default
-     *  when this property is not set.
-     */
-    CommentThreadView?: typeof BaseCommentThreadView;
-    /**
-     * Configuration for the comments editor.
-     *
-     * By using this property, you can customize the editor instance used in the comments
-     * reply field (e.g. by adding plugins or changing features configuration).
-     *
-     * To use the default configuration (allows only for text input, no formatting), you can pass `{}`
-     * to the comments editor configuration.
-     *
-     * ```ts
-     * ClassicEditor.create( element, {
-     * 	comments: {
-     * 		editorConfig: {}
-     * 	}
-     * } );
-     * ```
-     *
-     * To provide a better experience, you may add more plugins, that will extend the default editor configuration.
-     *
-     * ```ts
-     * import Autoformat from '@ckeditor/ckeditor5-autoformat/src/autoformat';
-     * import List from '@ckeditor/ckeditor5-list/src/list';
-     * import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
-     * import Italic from '@ckeditor/ckeditor5-italic/src/italic';
-     *
-     * ClassicEditor
-     * 	.create( {
-     * 		comments: {
-     * 			editorConfig: {
-     * 				extraPlugins: [ Autoformat, Bold, Italic, List ]
-     * 			}
-     * 		}
-     * 	} )
-     * ```
-     *
-     * Importing plugins may not be possible in some scenarios (e.g. when using a build created by the online builder tool).
-     * In that case, it is possible to get the plugin constructors from the editor builtin plugins.
-     *
-     * ```ts
-     * const extraCommentsPlugins = ClassicEditor.builtinPlugins.filter( plugin => {
-     * 	return [ 'Bold', 'Italic', Autoformat, List ].includes( plugin.pluginName );
-     * } );
-     *
-     *
-     * ClassicEditor
-     * 	.create( {
-     * 		comments: {
-     * 			editorConfig: {
-     * 				extraPlugins: extraCommentsPlugins
-     * 			}
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     */
-    editorConfig?: EditorConfig;
-    /**
-     * A function that takes a `Date` object, formats it to a desired string and returns it.
-     * It should be used when displaying the comment creation date.
-     */
-    formatDateTime?: (date: Date) => string;
-}
-/**
- * The configuration of the sidebar feature.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		sidebar: {
- * 			// Sidebar feature configuration.
- * 		}
- * 	} )
- * .then( ... )
- * .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
- */
-export interface SidebarConfig {
-    /**
-     * DOM element into which the sidebar will be inserted.
-     */
-    container?: HTMLElement;
-    /**
-     * Changes how the annotations are positioned inside the sidebar.
-     *
-     * If set to `true`, the top annotation in the sidebar will never be scrolled
-     * above the top edge of the sidebar (which would make it hidden).
-     *
-     * On the other hand, with this setting enabled, if there is not enough space,
-     * annotations will not be positioned exactly next to their linked elements
-     * when selected.
-     *
-     * @default false
-     */
-    preventScrollOutOfView?: boolean;
-}
-export type CommentThreadConfig = PartialBy<Required<Omit<CommentsConfig, 'CommentThreadView'>>, 'copyMarkers'>;
-export type CommentViewConfig = Required<Pick<CommentsConfig, 'maxCommentCharsWhenCollapsed' | 'formatDateTime' | 'editorConfig'>> & {
-    /**
-     * Defines whether the comment is created by the system.
-     */
-    isSystemComment?: boolean;
-};
-/**
- * Specifies whether comment markers should be preserved on copy-paste and cut-paste actions.
- *
- * Following values are available:
- *
- * * `'default'` - the comments will be preserved on cut-paste and drag and drop actions only.
- * * `'always'` - the markers will be preserved on all clipboard actions (cut, copy, drag and drop).
- * * `'never'` - the markers will be ignored by clipboard.
- */
-export type CommentsClipboardCopyConfig = 'default' | 'always' | 'never';

package/dist/types/index.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-oss-license
- */
-export { default as Comments } from './comments.js';
-export { default as CommentsOnly } from './commentsonly.js';
-export { default as CommentsUI } from './comments/commentsui.js';
-export { default as CommentsRepository, CommentThread, Comment, type CommentDataJSON, type CommentThreadContext, type CommentThreadDataJSON } from './comments/commentsrepository.js';
-export { default as CommentThreadController } from './comments/ui/commentthreadcontroller.js';
-export { default as Annotations } from './annotations/annotations.js';
-export { default as AnnotationsUIs } from './annotations/annotationsuis.js';
-export { default as EditorAnnotations } from './annotations/editorannotations.js';
-export { default as InlineAnnotations } from './annotations/inlineannotations.js';
-export { default as WideSidebar } from './annotations/widesidebar.js';
-export { default as NarrowSidebar } from './annotations/narrowsidebar.js';
-export { default as AnnotationView } from './annotations/view/annotationview.js';
-export { default as BaseCommentView } from './comments/ui/view/basecommentview.js';
-export { default as BaseCommentThreadView } from './comments/ui/view/basecommentthreadview.js';
-export { default as CommentsListView } from './comments/ui/view/commentslistview.js';
-export { default as CommentView } from './comments/ui/view/commentview.js';
-export { default as CommentThreadInputView } from './comments/ui/view/commentthreadinputview.js';
-export type { CommentsConfig, SidebarConfig, CommentsClipboardCopyConfig } from './config.js';
-export type { default as CommentsEditing } from './comments/commentsediting.js';
-import './augmentation.js';

package/dist/types/utils/common-translations.d.ts

@@ -1,13 +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-oss-license
- */
-/**
- * @module comments/utils/common-translations
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-export declare function getTranslation(locale: Locale, id: string, values?: string | Array<string> | number): string;

package/dist/types/utils/createmutationobserver.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-oss-license
- */
-/**
- * Creates mutation observer to observe changes that might cause height change.
- *
- * @param callback Callback executed after throttled mutations.
- */
-export default function createMutationObserver(callback: (...args: Array<any>) => unknown): MutationObserver;
-export interface MutationObserver {
-    attach: (element: Node) => void;
-    detach: () => void;
-}