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>
131 lines
3 KiB
TypeScript
131 lines
3 KiB
TypeScript
import {OutputData} from '../data-formats/output-data';
|
|
import {BlockToolData, ToolConfig} from '../tools';
|
|
import {BlockAPI} from './block';
|
|
|
|
/**
|
|
* Describes methods to manipulate with Editor`s blocks
|
|
*/
|
|
export interface Blocks {
|
|
/**
|
|
* Remove all blocks from Editor zone
|
|
*/
|
|
clear(): void;
|
|
|
|
/**
|
|
* Render passed data
|
|
*
|
|
* @param {OutputData} data - saved Block data
|
|
*
|
|
* @returns {Promise<void>}
|
|
*/
|
|
render(data: OutputData): Promise<void>;
|
|
|
|
/**
|
|
* Render passed HTML string
|
|
* @param {string} data
|
|
* @return {Promise<void>}
|
|
*/
|
|
renderFromHTML(data: string): Promise<void>;
|
|
|
|
/**
|
|
* Removes current Block
|
|
* @param {number} index - index of a block to delete
|
|
*/
|
|
delete(index?: number): void;
|
|
|
|
/**
|
|
* Swaps two Blocks
|
|
* @param {number} fromIndex - block to swap
|
|
* @param {number} toIndex - block to swap with
|
|
* @deprecated — use 'move' instead
|
|
*/
|
|
swap(fromIndex: number, toIndex: number): void;
|
|
|
|
/**
|
|
* Moves a block to a new index
|
|
* @param {number} toIndex - index where the block is moved to
|
|
* @param {number} fromIndex - block to move
|
|
*/
|
|
move(toIndex: number, fromIndex?: number): void;
|
|
|
|
/**
|
|
* Returns Block API object by passed Block index
|
|
* @param {number} index
|
|
*/
|
|
getBlockByIndex(index: number): BlockAPI | undefined;
|
|
|
|
/**
|
|
* Returns Block API object by passed Block id
|
|
* @param id - id of the block
|
|
*/
|
|
getById(id: string): BlockAPI | null;
|
|
|
|
/**
|
|
* Returns current Block index
|
|
* @returns {number}
|
|
*/
|
|
getCurrentBlockIndex(): number;
|
|
|
|
/**
|
|
* Returns the index of Block by id;
|
|
*/
|
|
getBlockIndex(blockId: string): number;
|
|
|
|
/**
|
|
* Mark Block as stretched
|
|
* @param {number} index - Block to mark
|
|
* @param {boolean} status - stretch status
|
|
*
|
|
* @deprecated Use BlockAPI interface to stretch Blocks
|
|
*/
|
|
stretchBlock(index: number, status?: boolean): void;
|
|
|
|
/**
|
|
* Returns Blocks count
|
|
* @return {number}
|
|
*/
|
|
getBlocksCount(): number;
|
|
|
|
/**
|
|
* Insert new Initial Block after current Block
|
|
*
|
|
* @deprecated
|
|
*/
|
|
insertNewBlock(): void;
|
|
|
|
/**
|
|
* Insert new Block and return inserted Block API
|
|
*
|
|
* @param {string} type — Tool name
|
|
* @param {BlockToolData} data — Tool data to insert
|
|
* @param {ToolConfig} config — Tool config
|
|
* @param {number?} index — index where to insert new Block
|
|
* @param {boolean?} needToFocus - flag to focus inserted Block
|
|
* @param {boolean?} replace - should the existed Block on that index be replaced or not
|
|
*/
|
|
insert(
|
|
type?: string,
|
|
data?: BlockToolData,
|
|
config?: ToolConfig,
|
|
index?: number,
|
|
needToFocus?: boolean,
|
|
replace?: boolean,
|
|
): BlockAPI;
|
|
|
|
|
|
/**
|
|
* Creates data of an empty block with a passed type.
|
|
*
|
|
* @param toolName - block tool name
|
|
*/
|
|
composeBlockData(toolName: string): Promise<BlockToolData>
|
|
|
|
/**
|
|
* Updates block data by id
|
|
*
|
|
* @param id - id of the block to update
|
|
* @param data - the new data
|
|
*/
|
|
update(id: string, data: BlockToolData): void;
|
|
}
|