zs_library 0.3.13 → 0.3.14

package/dist/components/Editor/components/BlockTools/TextAndTypography/Header/index.d.ts

@@ -1,249 +0,0 @@
-import { API, BlockTune, PasteEvent } from '@editorjs/editorjs';
-/**
- * @description Tool's input and output data format
- */
-export interface HeaderData {
-    /** Header's content */
-    text: string;
-    /** Header's level from 1 to 6 */
-    level: number;
-}
-/**
- * @description Tool's config from Editor
- */
-export interface HeaderConfig {
-    /** Block's placeholder */
-    placeholder?: string;
-    /** Heading levels */
-    levels?: number[];
-    /** Default level */
-    defaultLevel?: number;
-}
-/**
- * @description Heading level information
- */
-interface Level {
-    /** Level number */
-    number: number;
-    /** HTML tag corresponding with level number */
-    tag: string;
-    /** Icon */
-    svg: string;
-}
-/**
- * @description Constructor arguments for Header
- */
-interface ConstructorArgs {
-    /** Previously saved data */
-    data: HeaderData | {};
-    /** User config for the tool */
-    config: HeaderConfig;
-    /** Editor.js API */
-    api: API;
-    /** Read-only mode flag */
-    readOnly: boolean;
-}
-/**
- * Header block for the Editor.js.
- *
- * @author CodeX (team@ifmo.su)
- * @copyright CodeX 2018
- * @license MIT
- * @version 2.0.0
- */
-export default class Header {
-    /**
-     * Render plugin`s main Element and fill it with saved data
-     *
-     * @param {{data: HeaderData, config: HeaderConfig, api: object}}
-     *   data — previously saved data
-     *   config - user config for Tool
-     *   api - Editor.js API
-     *   readOnly - read only mode flag
-     */
-    /**
-     * Editor.js API
-     * @private
-     */
-    private api;
-    /**
-     * Read-only mode flag
-     * @private
-     */
-    private readOnly;
-    /**
-     * Tool's settings passed from Editor
-     * @private
-     */
-    private _settings;
-    /**
-     * Block's data
-     * @private
-     */
-    private _data;
-    /**
-     * Main Block wrapper
-     * @private
-     */
-    private _element;
-    constructor({ data, config, api, readOnly }: ConstructorArgs);
-    /**
-     * Styles
-     */
-    private get _CSS();
-    /**
-     * Check if data is valid
-     *
-     * @param {any} data - data to check
-     * @returns {data is HeaderData}
-     * @private
-     */
-    isHeaderData(data: HeaderData): data is HeaderData;
-    /**
-     * Normalize input data
-     *
-     * @param {HeaderData} data - saved data to process
-     *
-     * @returns {HeaderData}
-     * @private
-     */
-    normalizeData(data: HeaderData | {}): HeaderData;
-    /**
-     * Return Tool's view
-     *
-     * @returns {HTMLHeadingElement}
-     * @public
-     */
-    render(): HTMLHeadingElement;
-    /**
-     * Returns header block tunes config
-     *
-     * @returns {Array}
-     */
-    renderSettings(): BlockTune[];
-    /**
-     * Callback for Block's settings buttons
-     *
-     * @param {number} level - level to set
-     */
-    setLevel(level: number): void;
-    /**
-     * Method that specified how to merge two Text blocks.
-     * Called by Editor.js by backspace at the beginning of the Block
-     *
-     * @param {HeaderData} data - saved data to merger with current block
-     * @public
-     */
-    merge(data: HeaderData): void;
-    /**
-     * Validate Text block data:
-     * - check for emptiness
-     *
-     * @param {HeaderData} blockData — data received after saving
-     * @returns {boolean} false if saved data is not correct, otherwise true
-     * @public
-     */
-    validate(blockData: HeaderData): boolean;
-    /**
-     * Extract Tool's data from the view
-     *
-     * @param {HTMLHeadingElement} toolsContent - Text tools rendered view
-     * @returns {HeaderData} - saved data
-     * @public
-     */
-    save(toolsContent: HTMLHeadingElement): HeaderData;
-    /**
-     * Allow Header to be converted to/from other blocks
-     */
-    static get conversionConfig(): {
-        export: string;
-        import: string;
-    };
-    /**
-     * Sanitizer Rules
-     */
-    static get sanitize(): {
-        level: boolean;
-        text: {};
-    };
-    /**
-     * Returns true to notify core that read-only is supported
-     *
-     * @returns {boolean}
-     */
-    static get isReadOnlySupported(): boolean;
-    /**
-     * Get current Tools`s data
-     *
-     * @returns {HeaderData} Current data
-     * @private
-     */
-    get data(): HeaderData;
-    /**
-     * Store data in plugin:
-     * - at the this._data property
-     * - at the HTML
-     *
-     * @param {HeaderData} data — data to set
-     * @private
-     */
-    set data(data: HeaderData);
-    /**
-     * Get tag for target level
-     * By default returns second-leveled header
-     *
-     * @returns {HTMLElement}
-     */
-    getTag(): HTMLHeadingElement;
-    /**
-     * Get current level
-     *
-     * @returns {level}
-     */
-    get currentLevel(): Level;
-    /**
-     * Return default level
-     *
-     * @returns {level}
-     */
-    get defaultLevel(): Level;
-    /**
-     * @typedef {object} level
-     * @property {number} number - level number
-     * @property {string} tag - tag corresponds with level number
-     * @property {string} svg - icon
-     */
-    /**
-     * Available header levels
-     *
-     * @returns {level[]}
-     */
-    get levels(): Level[];
-    /**
-     * Handle H1-H6 tags on paste to substitute it with header Tool
-     *
-     * @param {PasteEvent} event - event with pasted content
-     */
-    onPaste(event: PasteEvent): void;
-    /**
-     * Used by Editor.js paste handling API.
-     * Provides configuration to handle H1-H6 tags.
-     *
-     * @returns {{handler: (function(HTMLElement): {text: string}), tags: string[]}}
-     */
-    static get pasteConfig(): {
-        tags: string[];
-    };
-    /**
-     * Get Tool toolbox settings
-     * icon - Tool icon's SVG
-     * title - title to show in toolbox
-     *
-     * @returns {{icon: string, title: string}}
-     */
-    static get toolbox(): {
-        icon: string;
-        title: string;
-    };
-}
-export {};

package/dist/components/Editor/components/BlockTools/TextAndTypography/Paragraph/index.d.ts

@@ -1,189 +0,0 @@
-import { API, ConversionConfig, HTMLPasteEvent, PasteConfig, SanitizerConfig, ToolConfig, ToolboxConfig } from '@editorjs/editorjs';
-/**
- * Base Paragraph Block for the Editor.js.
- * Represents a regular text block
- *
- * @author CodeX (team@codex.so)
- * @copyright CodeX 2018
- * @license The MIT License (MIT)
- */
-/**
- * @typedef {object} ParagraphConfig
- * @property {string} placeholder - placeholder for the empty paragraph
- * @property {boolean} preserveBlank - Whether or not to keep blank paragraphs when saving editor data
- */
-export interface ParagraphConfig extends ToolConfig {
-    /**
-     * Placeholder for the empty paragraph
-     */
-    placeholder?: string;
-    /**
-     * Whether or not to keep blank paragraphs when saving editor data
-     */
-    preserveBlank?: boolean;
-}
-/**
- * @typedef {object} ParagraphData
- * @description Tool's input and output data format
- * @property {string} text — Paragraph's content. Can include HTML tags: <a><b><i>
- */
-export interface ParagraphData {
-    /**
-     * Paragraph's content
-     */
-    text: string;
-}
-/**
- * @typedef {object} ParagraphParams
- * @description Constructor params for the Paragraph tool, use to pass initial data and settings
- * @property {ParagraphData} data - Preload data for the paragraph.
- * @property {ParagraphConfig} config - The configuration for the paragraph.
- * @property {API} api - The Editor.js API.
- * @property {boolean} readOnly - Is paragraph is read-only.
- */
-interface ParagraphParams {
-    /**
-     * Initial data for the paragraph
-     */
-    data: ParagraphData;
-    /**
-     * Paragraph tool configuration
-     */
-    config: ParagraphConfig;
-    /**
-     * Editor.js API
-     */
-    api: API;
-    /**
-     * Is paragraph read-only.
-     */
-    readOnly: boolean;
-}
-export default class Paragraph {
-    /**
-     * Default placeholder for Paragraph Tool
-     *
-     * @returns {string}
-     * @class
-     */
-    static get DEFAULT_PLACEHOLDER(): string;
-    /**
-     * The Editor.js API
-     */
-    api: API;
-    /**
-     * Is Paragraph Tool read-only
-     */
-    readOnly: boolean;
-    /**
-     * Paragraph Tool's CSS classes
-     */
-    private _CSS;
-    /**
-     * Placeholder for Paragraph Tool
-     */
-    private _placeholder;
-    /**
-     * Paragraph's data
-     */
-    private _data;
-    /**
-     * Paragraph's main Element
-     */
-    private _element;
-    /**
-     * Whether or not to keep blank paragraphs when saving editor data
-     */
-    private _preserveBlank;
-    /**
-     * Render plugin`s main Element and fill it with saved data
-     *
-     * @param {object} params - constructor params
-     * @param {ParagraphData} params.data - previously saved data
-     * @param {ParagraphConfig} params.config - user config for Tool
-     * @param {object} params.api - editor.js api
-     * @param {boolean} readOnly - read only mode flag
-     */
-    constructor({ data, config, api, readOnly }: ParagraphParams);
-    /**
-     * Check if text content is empty and set empty string to inner html.
-     * We need this because some browsers (e.g. Safari) insert <br> into empty contenteditanle elements
-     *
-     * @param {KeyboardEvent} e - key up event
-     */
-    onKeyUp(e: KeyboardEvent): void;
-    /**
-     * Create Tool's view
-     *
-     * @returns {HTMLDivElement}
-     * @private
-     */
-    drawView(): HTMLDivElement;
-    /**
-     * Return Tool's view
-     *
-     * @returns {HTMLDivElement}
-     */
-    render(): HTMLDivElement;
-    /**
-     * Method that specified how to merge two Text blocks.
-     * Called by Editor.js by backspace at the beginning of the Block
-     *
-     * @param {ParagraphData} data
-     * @public
-     */
-    merge(data: ParagraphData): void;
-    /**
-     * Validate Paragraph block data:
-     * - check for emptiness
-     *
-     * @param {ParagraphData} savedData — data received after saving
-     * @returns {boolean} false if saved data is not correct, otherwise true
-     * @public
-     */
-    validate(savedData: ParagraphData): boolean;
-    /**
-     * Extract Tool's data from the view
-     *
-     * @param {HTMLDivElement} toolsContent - Paragraph tools rendered view
-     * @returns {ParagraphData} - saved data
-     * @public
-     */
-    save(toolsContent: HTMLDivElement): ParagraphData;
-    /**
-     * On paste callback fired from Editor.
-     *
-     * @param {HTMLPasteEvent} event - event with pasted data
-     */
-    onPaste(event: HTMLPasteEvent): void;
-    /**
-     * Enable Conversion Toolbar. Paragraph can be converted to/from other tools
-     * @returns {ConversionConfig}
-     */
-    static get conversionConfig(): ConversionConfig;
-    /**
-     * Sanitizer rules
-     * @returns {SanitizerConfig} - Edtior.js sanitizer config
-     */
-    static get sanitize(): SanitizerConfig;
-    /**
-     * Returns true to notify the core that read-only mode is supported
-     *
-     * @returns {boolean}
-     */
-    static get isReadOnlySupported(): boolean;
-    /**
-     * Used by Editor paste handling API.
-     * Provides configuration to handle P tags.
-     *
-     * @returns {PasteConfig} - Paragraph Paste Setting
-     */
-    static get pasteConfig(): PasteConfig;
-    /**
-     * Icon and title for displaying at the Toolbox
-     *
-     * @returns {ToolboxConfig} - Paragraph Toolbox Setting
-     */
-    static get toolbox(): ToolboxConfig;
-}
-export {};

package/dist/components/Editor/components/BlockTools/TextAndTypography/Paragraph/utils/makeFragment.d.ts

@@ -1,7 +0,0 @@
-/**
- * Create a DocumentFragment and fill it with HTML from a string
- *
- * @param {string} htmlString - A string of valid HTML
- * @returns {DocumentFragment}
- */
-export default function makeFragment(htmlString: string): DocumentFragment;

package/dist/components/Editor/components/BlockTools/TextAndTypography/Quote/index.d.ts

@@ -1,282 +0,0 @@
-import { API, BlockAPI, BlockTool, ToolConfig } from '@editorjs/editorjs';
-import { MenuConfig } from '@editorjs/editorjs/types/tools';
-/**
- * @typedef {object} QuoteConfig
- * @description Quote Tool`s initial configuration
- * @property {string} quotePlaceholder - placeholder to show in quote`s text input
- * @property {string} captionPlaceholder - placeholder to show in quote`s caption input
- * @property {'center'|'left'} defaultAlignment - alignment to use as default
- */
-export interface QuoteConfig extends ToolConfig {
-    /**
-     * Placeholder text to display in the quote's text input.
-     */
-    quotePlaceholder: string;
-    /**
-     * Placeholder text to display in the quote's caption input.
-     */
-    captionPlaceholder: string;
-    /**
-     * Default alignment for the quote.
-     */
-    defaultAlignment: Alignment;
-}
-/**
- * @typedef {object} QuoteData
- * @description Quote Tool`s input and output data
- * @property {string} text - quote`s text
- * @property {string} caption - quote`s caption
- * @property {'center'|'left'} alignment - quote`s alignment
- */
-export interface QuoteData {
-    /**
-     * The text of the quote.
-     */
-    text: string;
-    /**
-     * The caption for the quote.
-     */
-    caption: string;
-    /**
-     * The alignment of the quote.
-     */
-    alignment: Alignment;
-}
-/**
- * @typedef {object} QuoteParams
- * @description Constructor params for the Quote tool, use to pass initial data and settings
- * @property {QuoteData} data - Preload data for the quote.
- * @property {QuoteConfig} config - The configuration for the quote.
- * @property {API} api - The Editor.js API.
- * @property {boolean} readOnly - Is quote is read-only.
- * @property {BlockAPI} block - BlockAPI object of Quote.
- */
-interface QuoteParams {
-    /**
-     * Initial data for the quote
-     */
-    data: QuoteData;
-    /**
-     * Quote tool configuration
-     */
-    config: QuoteConfig;
-    /**
-     * Editor.js API
-     */
-    api: API;
-    /**
-     * Is quote read-only.
-     */
-    readOnly: boolean;
-    /**
-     * BlockAPI object of Quote.
-     */
-    block: BlockAPI;
-}
-/**
- * @typedef {object} QuoteCSS
- * @description CSS classes names
- * @property {string} block - Editor.js CSS Class for block
- * @property {string} wrapper - Quote CSS Class
- */
-interface QuoteCSS {
-    /**
-     * Editor.js CSS Class for block
-     */
-    baseClass: string;
-    /**
-     * Quote CSS Class
-     */
-    wrapper: string;
-    /**
-     * Quote CSS Class
-     */
-    input: string;
-    /**
-     * Quote CSS Class
-     */
-    text: string;
-    /**
-     * Quote CSS Class
-     */
-    caption: string;
-}
-/**
- * @typedef {Enum} Alignment
- * @description Enum for Quote Alignment
- */
-declare enum Alignment {
-    Left = "left",
-    Center = "center"
-}
-/**
- * @class Quote
- * @classdesc Quote Tool for Editor.js
- * @property {QuoteData} data - Tool`s input and output data
- * @propert {API} api - Editor.js API instance
- */
-export default class Quote implements BlockTool {
-    /**
-     * The Editor.js API
-     */
-    api: API;
-    /**
-     * Is Quote Tool read-only
-     */
-    readOnly: boolean;
-    /**
-     * Placeholder for Quote Tool
-     */
-    private _quotePlaceholder;
-    /**
-     * Current quote element
-     */
-    private _block;
-    /**
-     * Caption placeholder for Quote Tool
-     */
-    private _captionPlaceholder;
-    /**
-     * Quote's data
-     */
-    private _data;
-    /**
-     * Quote Tool's CSS classes
-     */
-    private _CSS;
-    /**
-     * Render plugin`s main Element and fill it with saved data
-     *
-     * @param {object} params - constructor params
-     * @param {QuoteData} params.data - previously saved data
-     * @param {QuoteConfig} params.config - user config for Tool
-     * @param {API} params.api - editor.js api
-     * @param {boolean} params.readOnly - read only mode flag
-     */
-    constructor({ data, config, api, readOnly, block }: QuoteParams);
-    /**
-     * Notify core that read-only mode is supported
-     *
-     * @returns {boolean}
-     */
-    static get isReadOnlySupported(): boolean;
-    /**
-     * Get Tool toolbox settings
-     * icon - Tool icon's SVG
-     * title - title to show in toolbox
-     *
-     * @returns {{icon: string, title: string}}
-     */
-    static get toolbox(): {
-        icon: string;
-        title: "Quote";
-    };
-    /**
-     * Empty Quote is not empty Block
-     *
-     * @public
-     * @returns {boolean}
-     */
-    static get contentless(): boolean;
-    /**
-     * Allow to press Enter inside the Quote
-     *
-     * @public
-     * @returns {boolean}
-     */
-    static get enableLineBreaks(): boolean;
-    /**
-     * Default placeholder for quote text
-     *
-     * @public
-     * @returns {string}
-     */
-    static get DEFAULT_QUOTE_PLACEHOLDER(): string;
-    /**
-     * Default placeholder for quote caption
-     *
-     * @public
-     * @returns {string}
-     */
-    static get DEFAULT_CAPTION_PLACEHOLDER(): string;
-    /**
-     * Default quote alignment
-     *
-     * @public
-     * @returns {string}
-     */
-    static get DEFAULT_ALIGNMENT(): Alignment;
-    /**
-     * Allow Quote to be converted to/from other blocks
-     */
-    static get conversionConfig(): {
-        /**
-         * To create Quote data from string, simple fill 'text' property
-         */
-        import: string;
-        /**
-         * To create string from Quote data, concatenate text and caption
-         *
-         * @param {QuoteData} quoteData
-         * @returns {string}
-         */
-        export: (quoteData: QuoteData) => string;
-    };
-    /**
-     * Tool`s styles
-     *
-     * @returns {QuoteCSS}
-     */
-    get CSS(): QuoteCSS;
-    /**
-     * Tool`s settings properties
-     *
-     * @returns {*[]}
-     */
-    get settings(): {
-        name: Alignment;
-        icon: string;
-    }[];
-    /**
-     * Create Quote Tool container with inputs
-     *
-     * @returns {Element}
-     */
-    render(): HTMLElement;
-    /**
-     * Extract Quote data from Quote Tool element
-     *
-     * @param {HTMLDivElement} quoteElement - element to save
-     * @returns {QuoteData}
-     */
-    save(quoteElement: HTMLDivElement): QuoteData;
-    /**
-     * Sanitizer rules
-     */
-    static get sanitize(): {
-        text: {
-            br: boolean;
-        };
-        caption: {
-            br: boolean;
-        };
-        alignment: {};
-    };
-    /**
-     * Create wrapper for Tool`s settings buttons:
-     * 1. Left alignment
-     * 2. Center alignment
-     *
-     * @returns {MenuConfig}
-     *
-     */
-    renderSettings(): HTMLElement | MenuConfig;
-    /**
-     * Toggle quote`s alignment
-     *
-     * @param {string} tune - alignment
-     * @private
-     */
-    _toggleTune(tune: Alignment): void;
-}
-export {};