mirror of
https://github.com/codex-team/editor.js
synced 2024-06-10 09:52:36 +02:00
581289c03e
* Default tunes to popover * Add the rest of default tunes * Add popover * Cleanup * Rename custom content * Cleanup * Add ability to open block settings upwards * Fix tests * Cleanup default tunes * Rename and cleanup * Add ability to display rendered custom tunes * cleanup * Rename * Add flag to close tunes popover * Cleanup * i18n * Cleanup * Fix build and tests * Fix for iframe * Add comments * Display active item, move closeOnActivate to popover * Add confirmation support to popover * Handle boolean value in confirmation param * Clarify flippable logic in popover * Comments * Pass editor element as a param of popover constructor * Fix readability * Tests * Fix flipper for confirmation element * Update confirmation config structure * Rename onClick to onActivate * Fix tests and build * Make confirmation props optional * Simplify processing tunes * Renamings * Fix text block tunes * Docs * Update event type * Move enabling confirmation state to separate method * move popover types * Unhardcode color * Support toggling * Add support of disabled items * Fix tab in empty block leading to selecting second item in popover * Remove margins for styles api settings button class * Fix arrow navigation between blocks after opening block tunes * Cleaup in default tunes code * Fix chaining confirmations * Colors * Types * Change the way flippable elements of popover custom area are set * Remove borders around popover icons * Fix untabbable inline toolbar * Fix locked scroll after closing tunes popover on mobile * Cleanup * Set max popover width * Make popover icon's border outside * Fix tab issue * Fix focus/hover issue * Reformat * Cleanup * Fix opening block tunes via keyboard * Add disableSpecialHoverAndFocusBehavior * Add deprecated comment * Cleanup * Fix popover active state * Fix checklist deletion with confirmation * Fix checklist deletion 2 * Fix popover focus * Fix popover items being impossible to flip after searching * Fix popover item highlighting issue * Update flipper.spec.ts * Fixes after review * Add Tunes Api tests * Fix multiple popover entries configured by one tune * Add tool's renderSettings() tests * Add popover confirmation state test * Fix popover width on mobile * Add popover tests * Add changelog and update version * Update changelog * Fix block tunes being unable to open after tune activation Co-authored-by: Peter Savchenko <specc.dev@gmail.com>
124 lines
2.8 KiB
TypeScript
124 lines
2.8 KiB
TypeScript
import { ConversionConfig, PasteConfig, SanitizerConfig } from '../configs';
|
|
import { BlockToolData } from './block-tool-data';
|
|
import { BaseTool, BaseToolConstructable } from './tool';
|
|
import { ToolConfig } from './tool-config';
|
|
import { API, BlockAPI, ToolboxConfig } from '../index';
|
|
import { PasteEvent } from './paste-events';
|
|
import { MoveEvent } from './hook-events';
|
|
import { TunesMenuConfig } from './tool-settings';
|
|
|
|
/**
|
|
* Describe Block Tool object
|
|
* @see {@link docs/tools.md}
|
|
*/
|
|
export interface BlockTool extends BaseTool {
|
|
/**
|
|
* Sanitizer rules description
|
|
*/
|
|
sanitize?: SanitizerConfig;
|
|
|
|
/**
|
|
* Process Tool's element in DOM and return raw data
|
|
* @param {HTMLElement} block - element created by {@link BlockTool#render} function
|
|
* @return {BlockToolData}
|
|
*/
|
|
save(block: HTMLElement): BlockToolData;
|
|
|
|
/**
|
|
* Create Block's settings block
|
|
*/
|
|
renderSettings?(): HTMLElement | TunesMenuConfig;
|
|
|
|
/**
|
|
* Validate Block's data
|
|
* @param {BlockToolData} blockData
|
|
* @return {boolean}
|
|
*/
|
|
validate?(blockData: BlockToolData): boolean;
|
|
|
|
/**
|
|
* Method that specified how to merge two Blocks with same type.
|
|
* Called by backspace at the beginning of the Block
|
|
* @param {BlockToolData} blockData
|
|
*/
|
|
merge?(blockData: BlockToolData): void;
|
|
|
|
/**
|
|
* On paste callback. Fired when pasted content can be substituted by a Tool
|
|
* @param {PasteEvent} event
|
|
*/
|
|
onPaste?(event: PasteEvent): void;
|
|
|
|
/**
|
|
* Cleanup resources used by your tool here
|
|
* Called when the editor is destroyed
|
|
*/
|
|
destroy?(): void;
|
|
|
|
/**
|
|
* Lifecycle hooks
|
|
*/
|
|
|
|
/**
|
|
* Called after block content added to the page
|
|
*/
|
|
rendered?(): void;
|
|
|
|
/**
|
|
* Called each time block content is updated
|
|
*/
|
|
updated?(): void;
|
|
|
|
/**
|
|
* Called after block removed from the page but before instance is deleted
|
|
*/
|
|
removed?(): void;
|
|
|
|
/**
|
|
* Called after block was moved
|
|
*/
|
|
moved?(event: MoveEvent): void;
|
|
}
|
|
|
|
/**
|
|
* Describe constructor parameters
|
|
*/
|
|
export interface BlockToolConstructorOptions<D extends object = any, C extends object = any> {
|
|
api: API;
|
|
data: BlockToolData<D>;
|
|
config?: ToolConfig<C>;
|
|
block?: BlockAPI;
|
|
readOnly: boolean;
|
|
}
|
|
|
|
export interface BlockToolConstructable extends BaseToolConstructable {
|
|
/**
|
|
* Tool's Toolbox settings
|
|
*/
|
|
toolbox?: ToolboxConfig;
|
|
|
|
/**
|
|
* Paste substitutions configuration
|
|
*/
|
|
pasteConfig?: PasteConfig | false;
|
|
|
|
/**
|
|
* Rules that specified how this Tool can be converted into/from another Tool
|
|
*/
|
|
conversionConfig?: ConversionConfig;
|
|
|
|
/**
|
|
* Is Tool supports read-only mode, this property should return true
|
|
*/
|
|
isReadOnlySupported?: boolean;
|
|
|
|
/**
|
|
* @constructor
|
|
*
|
|
* @param {BlockToolConstructorOptions} config - constructor parameters
|
|
*
|
|
* @return {BlockTool}
|
|
*/
|
|
new(config: BlockToolConstructorOptions): BlockTool;
|
|
}
|