@atlaskit/editor-plugin-list 1.4.7 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @atlaskit/editor-plugin-list
 
+## 2.0.0
+
+### Major Changes
+
+- [#61903](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/61903) [`fb2eb9474b05`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/fb2eb9474b05) - WHAT?
+  Removing `toggleList` from public exports.
+
+  WHY?
+  It is an antipattern to export utilities from a plugin package.
+
+  The preferred approach is using the editor API.
+
+  HOW DO I WORKAROUND IT?
+  This can be accessed via the commands of the list plugin using the editor API.
+
+  Example to toggle bullet list:
+
+  ```ts
+  editorAPI?.core.actions.execute(
+    editorAPI?.list.commands.toggleBulletList(INPUT_METHOD.TOOLBAR),
+  );
+  ```
+
+  Example to toggle ordered list:
+
+  ```ts
+  editorAPI?.core.actions.execute(
+    editorAPI?.list.commands.toggleOrderedList(INPUT_METHOD.TOOLBAR),
+  );
+  ```
+
 ## 1.4.7
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -9,11 +9,4 @@ Object.defineProperty(exports, "listPlugin", {
     return _plugin.listPlugin;
   }
 });
-Object.defineProperty(exports, "toggleList", {
-  enumerable: true,
-  get: function get() {
-    return _commands.toggleList;
-  }
-});
-var _plugin = require("./plugin");
-var _commands = require("./commands");
+var _plugin = require("./plugin");

package/dist/es2019/index.js

@@ -1,2 +1 @@
-export { listPlugin } from './plugin';
-export { toggleList } from './commands';
+export { listPlugin } from './plugin';

package/dist/esm/index.js

@@ -1,2 +1 @@
-export { listPlugin } from './plugin';
-export { toggleList } from './commands';
+export { listPlugin } from './plugin';

package/dist/types/index.d.ts

@@ -1,3 +1,2 @@
 export type { ListPlugin, ListPluginOptions, FindRootParentListNode, ListState, InputMethod, } from './types';
 export { listPlugin } from './plugin';
-export { toggleList } from './commands';

package/dist/types-ts4.5/index.d.ts

@@ -1,3 +1,2 @@
 export type { ListPlugin, ListPluginOptions, FindRootParentListNode, ListState, InputMethod, } from './types';
 export { listPlugin } from './plugin';
-export { toggleList } from './commands';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-list",
-  "version": "1.4.7",
+  "version": "2.0.0",
   "description": "List plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",