@ckeditor/ckeditor5-source-editing 41.3.0-alpha.4 → 41.3.0

package/dist/types/sourceediting.d.ts

@@ -1,107 +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 source-editing/sourceediting
- */
-import { type Editor, Plugin, PendingActions } from 'ckeditor5/src/core.js';
-import '../theme/sourceediting.css';
-/**
- * The source editing feature.
- *
- * It provides the possibility to view and edit the source of the document.
- *
- * For a detailed overview, check the {@glink features/source-editing source editing feature documentation} and the
- * {@glink api/source-editing package page}.
- */
-export default class SourceEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "SourceEditing";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof PendingActions];
-    /**
-     * Flag indicating whether the document source mode is active.
-     *
-     * @observable
-     */
-    isSourceEditingMode: boolean;
-    /**
-     * The element replacer instance used to replace the editing roots with the wrapper elements containing the document source.
-     */
-    private _elementReplacer;
-    /**
-     * Maps all root names to wrapper elements containing the document source.
-     */
-    private _replacedRoots;
-    /**
-     * Maps all root names to their document data.
-     */
-    private _dataFromRoots;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Updates the source data in all hidden editing roots.
-     */
-    updateEditorData(): void;
-    private _checkCompatibility;
-    /**
-     * Creates source editing wrappers that replace each editing root. Each wrapper contains the document source from the corresponding
-     * root.
-     *
-     * The wrapper element contains a textarea and it solves the problem, that the textarea element cannot auto expand its height based on
-     * the content it contains. The solution is to make the textarea more like a plain div element, which expands in height as much as it
-     * needs to, in order to display the whole document source without scrolling. The wrapper element is a parent for the textarea and for
-     * the pseudo-element `::after`, that replicates the look, content, and position of the textarea. The pseudo-element replica is hidden,
-     * but it is styled to be an identical visual copy of the textarea with the same content. Then, the wrapper is a grid container and both
-     * of its children (the textarea and the `::after` pseudo-element) are positioned within a CSS grid to occupy the same grid cell. The
-     * content in the pseudo-element `::after` is set in CSS and it stretches the grid to the appropriate size based on the textarea value.
-     * Since both children occupy the same grid cell, both have always the same height.
-     */
-    private _showSourceEditing;
-    /**
-     * Restores all hidden editing roots and sets the source data in them.
-     */
-    private _hideSourceEditing;
-    /**
-     * Focuses the textarea containing document source from the first editing root.
-     */
-    private _focusSourceEditing;
-    /**
-     * Disables all commands.
-     */
-    private _disableCommands;
-    /**
-     * Clears forced disable for all commands, that was previously set through {@link #_disableCommands}.
-     */
-    private _enableCommands;
-    /**
-     * Adds or removes the `readonly` attribute from the textarea from all roots, if document source mode is active.
-     *
-     * @param isReadOnly Indicates whether all textarea elements should be read-only.
-     */
-    private _handleReadOnlyMode;
-    /**
-     * Checks, if the plugin is allowed to handle the source editing mode by itself. Currently, the source editing mode is supported only
-     * for the {@link module:editor-classic/classiceditor~ClassicEditor classic editor}.
-     */
-    private _isAllowedToHandleSourceEditingMode;
-    /**
-     * If any {@link module:ui/dialog/dialogview~DialogView editor dialog} is currently visible, hide it.
-     */
-    private _hideVisibleDialog;
-}

package/dist/types/sourceeditingconfig.d.ts

@@ -1,38 +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 source-editing/sourceeditingconfig
- */
-/**
- * The configuration of the source editing feature.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     sourceEditing: {
- *         allowCollaborationFeatures: true
- *     }
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface SourceEditingConfig {
-    /**
-     * Set to `true` to enable source editing feature for real-time collaboration.
-     *
-     * Please note that source editing feature is not fully compatible with real-time collaboration and using it may lead to data loss.
-     * {@glink features/source-editing#limitations-and-incompatibilities Read more}.
-     *
-     * @default false
-     */
-    allowCollaborationFeatures?: boolean;
-}

package/dist/types/utils/formathtml.d.ts

@@ -1,23 +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 source-editing/utils/formathtml
- */
-/**
- * A simple (and naive) HTML code formatter that returns a formatted HTML markup that can be easily
- * parsed by human eyes. It beautifies the HTML code by adding new lines between elements that behave like block elements
- * (https://developer.mozilla.org/en-US/docs/Web/HTML/Block-level_elements
- * and a few more like `tr`, `td`, and similar ones) and inserting indents for nested content.
- *
- * WARNING: This function works only on a text that does not contain any indentations or new lines.
- * Calling this function on the already formatted text will damage the formatting.
- *
- * @param input An HTML string to format.
- */
-export declare function formatHtml(input: string): string;