mirror of
https://github.com/codex-team/editor.js
synced 2024-05-06 16:36:47 +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>
71 lines
1.4 KiB
TypeScript
71 lines
1.4 KiB
TypeScript
import {API, BlockAPI, SanitizerConfig, ToolConfig} from '../index';
|
|
import { BlockTuneData } from './block-tune-data';
|
|
import { TunesMenuConfig } from '../tools';
|
|
|
|
/**
|
|
* Describes BLockTune blueprint
|
|
*/
|
|
export interface BlockTune {
|
|
/**
|
|
* Returns block tune HTMLElement
|
|
*/
|
|
render(): HTMLElement | TunesMenuConfig;
|
|
|
|
/**
|
|
* Method called on Tool render. Pass Tool content as an argument.
|
|
*
|
|
* You can wrap Tool's content with any wrapper you want to provide Tune's UI
|
|
*
|
|
* @param {HTMLElement} pluginsContent — Tool's content wrapper
|
|
*
|
|
* @return {HTMLElement}
|
|
*/
|
|
wrap?(pluginsContent: HTMLElement): HTMLElement;
|
|
|
|
/**
|
|
* Called on Tool's saving. Should return any data Tune needs to save
|
|
*
|
|
* @return {BlockTuneData}
|
|
*/
|
|
save?(): BlockTuneData;
|
|
}
|
|
|
|
/**
|
|
* Describes BlockTune class constructor function
|
|
*/
|
|
export interface BlockTuneConstructable {
|
|
|
|
/**
|
|
* Flag show Tool is Block Tune
|
|
*/
|
|
isTune: boolean;
|
|
|
|
/**
|
|
* Tune's sanitize configuration
|
|
*/
|
|
sanitize?: SanitizerConfig;
|
|
|
|
/**
|
|
* @constructor
|
|
*
|
|
* @param config - Block Tune config
|
|
*/
|
|
new(config: {
|
|
api: API,
|
|
config?: ToolConfig,
|
|
block: BlockAPI,
|
|
data: BlockTuneData,
|
|
}): BlockTune;
|
|
|
|
/**
|
|
* Tune`s prepare method. Can be async
|
|
* @param data
|
|
*/
|
|
prepare?(): Promise<void> | void;
|
|
|
|
/**
|
|
* Tune`s reset method to clean up anything set by prepare. Can be async
|
|
*/
|
|
reset?(): void | Promise<void>;
|
|
}
|