Allowing deleting block by block id (codex-team#1108)

* Allowing deleting block by block id * Fixed no argument error * Making index value optional for delete operation * Added to changelog * Making index value optional for delete operation * Added parameter description * Update docs/CHANGELOG.md * Update types/api/blocks.d.ts * Update editor.js Co-authored-by: Peter Savchenko <[email protected]>
smb-ag · Apr 25, 2020 · 5218a6a · 5218a6a
1 parent 66e70fa
commit 5218a6a
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git a/dist/editor.js b/dist/editor.js
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -5,7 +5,8 @@
 - `Improvements` - TSLint (deprecated) replaced with ESLint, old config changed to [CodeX ESLint Config](https://github.com/codex-team/eslint-config).
 - `Improvements` - Fix many code-style issues, add missed annotations.
 - `Improvements` - Adjusted GitHub action for ESLint.
-- `Improvements` - API: If `blocks.delete` method is called, but no Block is selected, show warning instead of throwing an error [#1102](https://github.com/codex-team/editor.js/issues/1102)
+- `Improvements` - Blocks API: if `blocks.delete` method is called, but no Block is selected, show warning instead of throwing an error [#1102](https://github.com/codex-team/editor.js/issues/1102)
+- `Improvements` - Blocks API: allow deletion of blocks by specifying block index via `blocks.delete(index)`.
 - `Fix` - Editor's styles won't be appended to the `<head>` when another instance have already do that [#1079](https://github.com/codex-team/editor.js/issues/1079)
 - `New` *I18n API* — Ability to provide internalization for Editor.js core and tools. [#751](https://github.com/codex-team/editor.js/issues/751)
 - `Fix` - Fixed wrong toolbar icon centering in Firefox [#1120](https://github.com/codex-team/editor.js/pull/1120)

diff --git a/src/components/modules/api/blocks.ts b/src/components/modules/api/blocks.ts
@@ -19,7 +19,7 @@ export default class BlocksAPI extends Module {
       clear: (): void => this.clear(),
       render: (data: OutputData): Promise<void> => this.render(data),
       renderFromHTML: (data: string): Promise<void> => this.renderFromHTML(data),
-      delete: (): void => this.delete(),
+      delete: (index?: number): void => this.delete(index),
       swap: (fromIndex: number, toIndex: number): void => this.swap(fromIndex, toIndex),
       move: (toIndex: number, fromIndex?: number): void => this.move(toIndex, fromIndex),
       getBlockByIndex: (index: number): HTMLElement => this.getBlockByIndex(index),

diff --git a/types/api/blocks.d.ts b/types/api/blocks.d.ts
@@ -26,8 +26,9 @@ export interface Blocks {
 
   /**
    * Removes current Block
+   * @param {number} index - index of a block to delete
    */
-  delete(): void;
+  delete(index?: number): void;
 
   /**
    * Swaps two Blocks