@atlaskit/editor-plugin-expand 9.0.1 → 9.0.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-expand
 
+## 9.0.2
+
+### Patch Changes
+
+- [`5985f38f7104e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5985f38f7104e) -
+  Update README.md and 0-intro.tsx
+- Updated dependencies
+
 ## 9.0.1
 
 ### Patch Changes

package/README.md

@@ -1,10 +1,25 @@
-# Editor plugin expand
+# Editor Plugin Expand
 
 Expand plugin for @atlaskit/editor-core
 
 **Note:** This component is designed for internal Atlassian development.
 External contributors will be able to use this component but will not be able to submit issues.
 
+## Overview
+
+The Expand plugin provides collapsible/expandable content sections for the Atlassian Editor. It supports both standard expand nodes and nested expand nodes, enabling users to organize and structure content with accordion-like functionality.
+
+## Key features
+
+- **Expand and nested expand nodes** - Support for both top-level expand and nested expand content structures
+- **Interactive expand/collapse** - Toggle expand nodes open or closed with configurable interactive behavior
+- **Quick insert integration** - Insert expand nodes via quick insert menu with keywords like 'accordion' and 'collapse'
+- **Range toggle commands** - Programmatically expand or collapse multiple expand nodes across a document range
+- **Floating toolbar** - Context-aware toolbar for expand node manipulation
+- **Keyboard shortcuts** - Keymap support for efficient expand node navigation and manipulation
+- **Configurable insertion** - Control expand node insertion permissions via plugin options
+- **Live Page support** - Special handling for Confluence Live Page editor with divergent behavior
+
 ## Install
 ---
 - **Install** - *yarn add @atlaskit/editor-plugin-expand*
@@ -27,4 +42,4 @@ Please see [Atlaskit - Editor plugin expand](https://atlaskit.atlassian.com/pack
 For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
 ## License
 ---
-Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#Platform-License) for more licensing information.
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

package/dist/cjs/legacyExpand/commands.js

@@ -15,6 +15,7 @@ var _utils = require("@atlaskit/editor-common/utils");
 var _state2 = require("@atlaskit/editor-prosemirror/state");
 var _utils2 = require("@atlaskit/editor-prosemirror/utils");
 var _utils3 = require("@atlaskit/editor-tables/utils");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _utils4 = require("../utils");
 var _pluginFactory = require("./pm-plugins/plugin-factory");
@@ -163,12 +164,13 @@ var insertExpandWithInputMethod = exports.insertExpandWithInputMethod = function
         state: state,
         type: expandNode.type
       });
+      var resolvedInputMethod = (0, _platformFeatureFlags.fg)('platform_editor_element_browser_analytic') ? inputMethod : _analytics.INPUT_METHOD.QUICK_INSERT;
       var payload = {
         action: _analytics.ACTION.INSERTED,
         actionSubject: _analytics.ACTION_SUBJECT.DOCUMENT,
         actionSubjectId: (expandNode === null || expandNode === void 0 ? void 0 : expandNode.type) === state.schema.nodes.expand ? _analytics.ACTION_SUBJECT_ID.EXPAND : _analytics.ACTION_SUBJECT_ID.NESTED_EXPAND,
         attributes: {
-          inputMethod: inputMethod
+          inputMethod: resolvedInputMethod
         },
         eventType: _analytics.EVENT_TYPE.TRACK
       };

package/dist/cjs/singlePlayerExpand/plugin.js

@@ -105,7 +105,7 @@ var expandPlugin = exports.expandPlugin = function expandPlugin(_ref) {
           icon: function icon() {
             return /*#__PURE__*/_react.default.createElement(_quickInsert.IconExpand, null);
           },
-          action: function action(insert, state) {
+          action: function action(insert, state, source) {
             var _api$analytics;
             var node = (0, _commands.createExpandNode)(state, undefined, !!(api !== null && api !== void 0 && api.localId));
             if (!node) {
@@ -120,7 +120,7 @@ var expandPlugin = exports.expandPlugin = function expandPlugin(_ref) {
               actionSubject: _analytics.ACTION_SUBJECT.DOCUMENT,
               actionSubjectId: node.type === state.schema.nodes.nestedExpand ? _analytics.ACTION_SUBJECT_ID.NESTED_EXPAND : _analytics.ACTION_SUBJECT_ID.EXPAND,
               attributes: {
-                inputMethod: _analytics.INPUT_METHOD.QUICK_INSERT
+                inputMethod: source !== null && source !== void 0 ? source : _analytics.INPUT_METHOD.QUICK_INSERT
               },
               eventType: _analytics.EVENT_TYPE.TRACK
             })(tr);

package/dist/es2019/legacyExpand/commands.js

@@ -7,6 +7,7 @@ import { createWrapSelectionTransaction } from '@atlaskit/editor-common/utils';
 import { Selection, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { safeInsert } from '@atlaskit/editor-prosemirror/utils';
 import { findTable } from '@atlaskit/editor-tables/utils';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { isNestedInExpand } from '../utils';
 import { createCommand } from './pm-plugins/plugin-factory';
@@ -150,12 +151,13 @@ export const insertExpandWithInputMethod = editorAnalyticsAPI => inputMethod =>
     state,
     type: expandNode.type
   });
+  const resolvedInputMethod = fg('platform_editor_element_browser_analytic') ? inputMethod : INPUT_METHOD.QUICK_INSERT;
   const payload = {
     action: ACTION.INSERTED,
     actionSubject: ACTION_SUBJECT.DOCUMENT,
     actionSubjectId: (expandNode === null || expandNode === void 0 ? void 0 : expandNode.type) === state.schema.nodes.expand ? ACTION_SUBJECT_ID.EXPAND : ACTION_SUBJECT_ID.NESTED_EXPAND,
     attributes: {
-      inputMethod
+      inputMethod: resolvedInputMethod
     },
     eventType: EVENT_TYPE.TRACK
   };

package/dist/es2019/singlePlayerExpand/plugin.js

@@ -95,7 +95,7 @@ export let expandPlugin = ({
           keywords: ['accordion', 'collapse'],
           priority: 600,
           icon: () => /*#__PURE__*/React.createElement(IconExpand, null),
-          action(insert, state) {
+          action(insert, state, source) {
             var _api$analytics;
             const node = createExpandNode(state, undefined, !!(api !== null && api !== void 0 && api.localId));
             if (!node) {
@@ -110,7 +110,7 @@ export let expandPlugin = ({
               actionSubject: ACTION_SUBJECT.DOCUMENT,
               actionSubjectId: node.type === state.schema.nodes.nestedExpand ? ACTION_SUBJECT_ID.NESTED_EXPAND : ACTION_SUBJECT_ID.EXPAND,
               attributes: {
-                inputMethod: INPUT_METHOD.QUICK_INSERT
+                inputMethod: source !== null && source !== void 0 ? source : INPUT_METHOD.QUICK_INSERT
               },
               eventType: EVENT_TYPE.TRACK
             })(tr);

package/dist/esm/legacyExpand/commands.js

@@ -10,6 +10,7 @@ import { createWrapSelectionTransaction } from '@atlaskit/editor-common/utils';
 import { Selection, TextSelection } from '@atlaskit/editor-prosemirror/state';
 import { safeInsert } from '@atlaskit/editor-prosemirror/utils';
 import { findTable } from '@atlaskit/editor-tables/utils';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { isNestedInExpand } from '../utils';
 import { createCommand } from './pm-plugins/plugin-factory';
@@ -156,12 +157,13 @@ export var insertExpandWithInputMethod = function insertExpandWithInputMethod(ed
         state: state,
         type: expandNode.type
       });
+      var resolvedInputMethod = fg('platform_editor_element_browser_analytic') ? inputMethod : INPUT_METHOD.QUICK_INSERT;
       var payload = {
         action: ACTION.INSERTED,
         actionSubject: ACTION_SUBJECT.DOCUMENT,
         actionSubjectId: (expandNode === null || expandNode === void 0 ? void 0 : expandNode.type) === state.schema.nodes.expand ? ACTION_SUBJECT_ID.EXPAND : ACTION_SUBJECT_ID.NESTED_EXPAND,
         attributes: {
-          inputMethod: inputMethod
+          inputMethod: resolvedInputMethod
         },
         eventType: EVENT_TYPE.TRACK
       };

package/dist/esm/singlePlayerExpand/plugin.js

@@ -99,7 +99,7 @@ export var expandPlugin = function expandPlugin(_ref) {
           icon: function icon() {
             return /*#__PURE__*/React.createElement(IconExpand, null);
           },
-          action: function action(insert, state) {
+          action: function action(insert, state, source) {
             var _api$analytics;
             var node = createExpandNode(state, undefined, !!(api !== null && api !== void 0 && api.localId));
             if (!node) {
@@ -114,7 +114,7 @@ export var expandPlugin = function expandPlugin(_ref) {
               actionSubject: ACTION_SUBJECT.DOCUMENT,
               actionSubjectId: node.type === state.schema.nodes.nestedExpand ? ACTION_SUBJECT_ID.NESTED_EXPAND : ACTION_SUBJECT_ID.EXPAND,
               attributes: {
-                inputMethod: INPUT_METHOD.QUICK_INSERT
+                inputMethod: source !== null && source !== void 0 ? source : INPUT_METHOD.QUICK_INSERT
               },
               eventType: EVENT_TYPE.TRACK
             })(tr);

package/dist/types/types.d.ts

@@ -23,7 +23,7 @@ export type ExpandPluginAction = {
 export type ExpandPluginSharedState = {
     allowInsertion?: boolean;
 } | undefined;
-export type InsertMethod = INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.INSERT_MENU;
+export type InsertMethod = INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.INSERT_MENU | INPUT_METHOD.ELEMENT_BROWSER | INPUT_METHOD.TOOLBAR;
 export interface ExpandPluginOptions extends LongPressSelectionPluginOptions {
     /**
      * There is expected to be temporary divergence between Live Page editor expand behaviour and the standard expand behaviour.

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

@@ -23,7 +23,7 @@ export type ExpandPluginAction = {
 export type ExpandPluginSharedState = {
     allowInsertion?: boolean;
 } | undefined;
-export type InsertMethod = INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.INSERT_MENU;
+export type InsertMethod = INPUT_METHOD.QUICK_INSERT | INPUT_METHOD.INSERT_MENU | INPUT_METHOD.ELEMENT_BROWSER | INPUT_METHOD.TOOLBAR;
 export interface ExpandPluginOptions extends LongPressSelectionPluginOptions {
     /**
      * There is expected to be temporary divergence between Live Page editor expand behaviour and the standard expand behaviour.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-expand",
-	"version": "9.0.1",
+	"version": "9.0.2",
 	"description": "Expand plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -47,7 +47,7 @@
 		"@atlaskit/icon-lab": "^5.17.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-history": "^0.2.0",
-		"@atlaskit/tmp-editor-statsig": "^36.0.0",
+		"@atlaskit/tmp-editor-statsig": "^36.3.0",
 		"@atlaskit/tokens": "^11.1.0",
 		"@atlaskit/tooltip": "^20.14.0",
 		"@babel/runtime": "^7.0.0",
@@ -56,7 +56,7 @@
 		"w3c-keyname": "^2.1.8"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.0.0",
+		"@atlaskit/editor-common": "^112.2.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
@@ -99,6 +99,9 @@
 		}
 	},
 	"platform-feature-flags": {
+		"platform_editor_element_browser_analytic": {
+			"type": "boolean"
+		},
 		"platform_editor_adf_with_localid": {
 			"type": "boolean"
 		},