mirror of
https://github.com/codex-team/editor.js
synced 2024-06-29 02:40:23 +02:00
ff91466b14
* chore(block-tune-toggler): toggler moved to the left (draft) * toolbox ui updated * fixd caret jumpling, improved some styles * toolbar moving by block-hover - UI module triggers 'block-hovered' event - Toolbar uses 'block-hovered' for appearing - `currentBlock` setter added to the BlockManager - (reactangle-selection): the throttling added to the mousemove and scroll handlers - `getBlockIndex` method added to the Api - (api-blocks): toolbar moving logic removed from `blocks.move()` and `blocks.swap()` methods. Instead, MoveUp and MoveDown tunes uses Toolbar API * the dark-theme to the example-dev.html * positioning improved * fix(rectangle-selection): first click after RS does not clears selection state * toolbox position fixed * the toolbox module became a standalone class - Toolbox became a standalone class from the editor module. It can be accessed only via the owner (the Toolbar module) - (api.blocks) the insert() method now has the `replace` param. Also, it returns inserted Block API now. * new(api.listeners): `on()` now returns the listener id. The new `offById()` method added * fix bug with Tab pressing on hovered but not focused block * mobile version improved * upd example dev * small updaets * add nested-list * linting * (api.toolbar): `toggleBlockSettings` now fires toggling event with the same state * EventDispatcher used instead of callbacks for the Toolbox * UIApi added * fix ci * git submodules removed from the ci flow * add paragraph submodule to the ci flow * Update CHANGELOG.md * Update package.json * use ubuntu-latest for chrome ci
124 lines
2.8 KiB
TypeScript
124 lines
2.8 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 | void;
|
|
|
|
/**
|
|
* 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;
|
|
|
|
|
|
/**
|
|
* Updates block data by id
|
|
*
|
|
* @param id - id of the block to update
|
|
* @param data - the new data
|
|
*/
|
|
update(id: string, data: BlockToolData): void;
|
|
}
|