@editorjs/editorjs - npm Package Compare versions

Comparing version 2.18.0 to 2.19.0

dist/editor.js.LICENSE.txt

@@ -20,3 +20,3 @@ /*!
  * 
- * @version 2.18.0
+ * @version 2.19.0
  * 
@@ -23,0 +23,0 @@ * @licence Apache-2.0

package.json

 {
   "name": "@editorjs/editorjs",
-  "version": "2.18.0",
+  "version": "2.19.0",
   "description": "Editor.js — Native JS, based on API and Open Source",
@@ -5,0 +5,0 @@ "main": "dist/editor.js",

README.md

@@ -7,3 +7,3 @@ <a href="https://editorjs.io/"><p align="center"><img src="https://capella.pics/79ce946a-d636-41cd-aa96-d3bc5ecfde03.jpg"></p></a>
 [![Backers on Open Collective](https://opencollective.com/editorjs/backers/badge.svg)](#backers)
-[![Sponsors on Open Collective](https://opencollective.com/editorjs/sponsors/badge.svg)](#sponsors) 
+[![Sponsors on Open Collective](https://opencollective.com/editorjs/sponsors/badge.svg)](#sponsors)
 [![](https://flat.badgen.net/npm/license/@editorjs/editorjs)](https://www.npmjs.com/package/@editorjs/editorjs)
@@ -21,3 +21,3 @@ [![Join the chat at https://gitter.im/codex-team/editor.js](https://badges.gitter.im/codex-team/editor.js.svg)](https://gitter.im/codex-team/editor.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
  👉  [https://opencollective.com/editorjs](https://opencollective.com/editorjs)
- 
+
 ### Sponsors
@@ -28,9 +28,9 @@
 <a href="https://opencollective.com/editorjs/sponsor/0/website" target="_blank"><img src="https://opencollective.com/editorjs/sponsor/0/avatar.svg"></a>
- 
+
  ### Backers
- 
+
  Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/editorjs#backer)]
- 
+
  <a href="https://opencollective.com/editorjs#backers" target="_blank"><img src="https://opencollective.com/editorjs/backers.svg?width=890"></a>
- 
+
 ### Contributors
@@ -40,3 +40,3 @@
 
-We really welcome new contributors. If you want to make some code with us, please take a look at the [Good First Tasks](https://github.com/codex-team/editor.js/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+task%22). You can write to us on `[e-mail]` or via special [Telegram chat](https://t.me/editorjsdev), or any other way. 
+We really welcome new contributors. If you want to make some code with us, please take a look at the [Good First Tasks](https://github.com/codex-team/editor.js/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+task%22). You can write to us on `[e-mail]` or via special [Telegram chat](https://t.me/editorjsdev), or any other way.
 
@@ -149,3 +149,3 @@ ## Documentation
 ```javascript
-const EditorJS = require('@editorjs/editorjs');
+import EditorJS from '@editorjs/editorjs';
 ```
@@ -248,7 +248,7 @@
 
-- We use [HTMLJanitor](https://github.com/guardian/html-janitor) module in our Sanitizer module. 
+- We use [HTMLJanitor](https://github.com/guardian/html-janitor) module in our Sanitizer module.
 
 ## About team
 
-We are CodeX and we build products for developers and makers. 
+We are CodeX and we build products for developers and makers.
 
@@ -255,0 +255,0 @@ Follow us on Twitter: [twitter.com/codex_team](https://twitter.com/codex_team)

types/api/block.d.ts

 import {BlockToolData, ToolConfig} from '../tools';
-import {SavedData} from '../../src/types-internal/block-data';
+import {SavedData} from '../data-formats';
 
@@ -4,0 +4,0 @@ /**

types/api/blocks.d.ts

@@ -16,4 +16,6 @@ import {OutputData} from '../data-formats/output-data';
    * Render passed data
-   * @param {OutputData} data
-   * @return {Promise<void>}
+   *
+   * @param {OutputData} data - saved Block data
+   *
+   * @returns {Promise<void>}
    */
@@ -51,7 +53,6 @@ render(data: OutputData): Promise<void>;
   /**
-   * Returns Block holder by Block index
+   * Returns Block API object by passed Block index
    * @param {number} index
-   * @returns {HTMLElement}
    */
-  getBlockByIndex(index: number): BlockAPI;
+  getBlockByIndex(index: number): BlockAPI | void;
 
@@ -58,0 +59,0 @@ /**

types/api/index.d.ts

@@ -14,2 +14,3 @@ export * from './blocks';
 export * from './block';
+export * from './readonly';
 export * from './i18n';

types/configs/editor-config.d.ts

@@ -28,2 +28,9 @@ import {ToolConstructable, ToolSettings} from '../tools';
    */
+  defaultBlock?: string;
+
+  /**
+   * @deprecated
+   * This property will be deprecated in the next major release.
+   * Use the 'defaultBlock' property instead.
+   */
   initialBlock?: string;
@@ -68,2 +75,7 @@
   /**
+   * Enable read-only mode
+   */
+  readOnly?: boolean;
+
+  /**
    * Internalization config
@@ -83,2 +95,7 @@ */
   onChange?(api: API): void;
+
+  /**
+   * Defines default toolbar for all tools.
+   */
+  inlineToolbar?: string[]|boolean;
 }

types/configs/i18n-config.d.ts

@@ -10,3 +10,8 @@ /**
    */
-  messages: I18nDictionary;
+  messages?: I18nDictionary;
+
+  /**
+   * Text direction. If not set, uses ltr
+   */
+  direction?: 'ltr' | 'rtl';
 }

types/index.d.ts

@@ -8,8 +8,9 @@ /**
 import {
-  EditorConfig,
-  I18nDictionary,
   Dictionary,
   DictValue,
+  EditorConfig,
   I18nConfig,
+  I18nDictionary,
 } from './configs';
+
 import {
@@ -22,2 +23,3 @@ Blocks,
   Notifier,
+  ReadOnly,
   Sanitizer,
@@ -31,4 +33,5 @@ Saver,
 } from './api';
-import {OutputData} from './data-formats/output-data';
 
+import { OutputData } from './data-formats';
+
 /**
@@ -94,2 +97,3 @@ * Interfaces used for development
   i18n: I18n;
+  readOnly: ReadOnly;
 }
@@ -115,2 +119,3 @@
   public inlineToolbar: InlineToolbar;
+  public readOnly: ReadOnly;
   constructor(configuration?: EditorConfig|string);
@@ -117,0 +122,0 @@

types/tools/block-tool.d.ts

@@ -53,2 +53,8 @@ import { ConversionConfig, PasteConfig, SanitizerConfig } from '../configs';
   /**
+   * Cleanup resources used by your tool here
+   * Called when the editor is destroyed
+   */
+  destroy?(): void;
+
+  /**
    * Lifecycle hooks
@@ -86,2 +92,3 @@ */
   block?: BlockAPI;
+  readOnly: boolean;
 }
@@ -116,2 +123,7 @@
   /**
+   * Is Tool supports read-only mode, this property should return true
+   */
+  isReadOnlySupported?: boolean;
+
+  /**
    * @constructor
@@ -118,0 +130,0 @@ *

types/tools/inline-tool.d.ts

@@ -34,2 +34,4 @@ import {BaseTool, BaseToolConstructable} from './tool';
    * Function called with Inline Toolbar closing
+   * @deprecated 2020 10/02 - The new instance will be created each time the button is rendered. So clear is not needed.
+   *                          Better to create the 'destroy' method in a future.
    */
@@ -36,0 +38,0 @@ clear?(): void;

types/tools/tool-settings.d.ts

@@ -47,4 +47,5 @@ import {ToolConfig} from './tool-config';
    * Tool's Toolbox settings
+   * It will be hidden from Toolbox when false is specified.
    */
-  toolbox?: ToolboxConfig;
+  toolbox?: ToolboxConfig | false;
 }

types/tools/tool.d.ts

@@ -43,2 +43,7 @@ import {API} from '../index';
   prepare?(data: {toolName: string, config: ToolConfig}): void | Promise<void>;
+
+  /**
+   * Tool`s reset method to clean up anything set by prepare. Can be async
+   */
+  reset?(): void | Promise<void>;
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

440613

increased by3.82%

Number of package files

49

increased by6.52%

Lines of code

1261

increased by6.06%

No dependency changes