@atlaskit/editor-plugin-block-menu 7.0.2 → 7.0.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-block-menu
 
+## 7.0.3
+
+### Patch Changes
+
+- [`d84e100ff2136`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d84e100ff2136) -
+  Update README.md and 0-intro.tsx
+- Updated dependencies
+
 ## 7.0.2
 
 ### Patch Changes

package/README.md

@@ -1 +1,45 @@
-# Editor plugin block menu
+# Editor Plugin Block Menu
+
+Block Menu 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 Block Menu plugin provides a context menu for block-level transformations and operations in the Atlassian Editor. It enables users to quickly transform content blocks (paragraphs, lists, headings, etc.) into different node types and perform block-level actions like moving, copying, and deleting content through an interactive menu interface.
+
+## Key features
+
+- **Block transformation** - Transform content blocks between different node types (paragraphs, lists, headings, blockquotes, code blocks, etc.)
+- **Customizable menu** - Register custom menu items, sections, and nested menus through a flexible component registry
+- **Block actions** - Move blocks up/down, delete, copy links to specific blocks with deep linking support
+- **Intelligent transformations** - Handle complex transformations with proper handling of nested content, lists, and mixed content types
+- **Analytics integration** - Built-in event tracking for menu interactions and block transformations
+- **Performance monitoring** - Measure and track transformation performance metrics
+- **Keyboard and mouse support** - Open menu via drag handle, keyboard shortcut, or custom triggers
+
+## Install
+
+- **Install** - *yarn add @atlaskit/editor-plugin-block-menu*
+- **npm** - [@atlaskit/editor-plugin-block-menu](https://www.npmjs.com/package/@atlaskit/editor-plugin-block-menu)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-block-menu)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-block-menu/dist/)
+
+## Usage
+
+**Internal use only**
+
+@atlaskit/editor-plugin-block-menu is intended for internal use by @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
+
+Direct use of this component is not supported.
+
+Please see [Atlaskit - Editor plugin block menu](https://atlaskit.atlassian.com/packages/editor/editor-plugin-block-menu) for documentation and examples for this package.
+
+## Support
+
+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#License) for more licensing information.

package/docs/0-intro.tsx

@@ -30,7 +30,85 @@ The \`dependencies\`, \`configuration\`, \`state\`, \`actions\`, and \`commands\
 below:
 
 ${code`
-type BlockMenuPlugin = NextEditorPlugin<'blockMenu'>
+enum FLAG_ID {
+  LINK_COPIED_TO_CLIPBOARD = 'link-copied-to-clipboard',
+}
+
+type BlockMenuPlugin = NextEditorPlugin<
+  'blockMenu',
+  {
+    actions: {
+      getBlockMenuComponents: () => Array<RegisterBlockMenuComponent>;
+      isTransformOptionDisabled: (
+        optionNodeTypeName: string,
+        optionNodeTypeAttrs?: Record<string, unknown>,
+      ) => boolean;
+      registerBlockMenuComponents: (blockMenuComponents: Array<RegisterBlockMenuComponent>) => void;
+    };
+    commands: {
+      transformNode: TransformNodeCommand;
+    };
+    dependencies: [
+      OptionalPlugin<BlockControlsPlugin>,
+      OptionalPlugin<UserIntentPlugin>,
+      OptionalPlugin<SelectionPlugin>,
+      OptionalPlugin<DecorationsPlugin>,
+      OptionalPlugin<AnalyticsPlugin>,
+    ];
+    pluginConfiguration?: BlockMenuPluginOptions;
+    sharedState: BlockMenuSharedState;
+  }
+>;
+
+type BlockMenuPluginOptions = {
+  blockLinkHashPrefix?: string;
+  getLinkPath?: () => string | null;
+};
+
+type BlockMenuSharedState =
+  | {
+      currentSelectedNodeName: string | undefined;
+      showFlag: FLAG_ID | false;
+    }
+  | undefined;
+
+type Parent<T> = T & { rank: number };
+
+type ComponentTypes = Array<BlockMenuSection | BlockMenuItem | BlockMenuNested>;
+
+type BlockMenuNestedComponent = (props: { children: React.ReactNode }) => React.ReactNode;
+
+type BlockMenuSectionComponent = (props: { children: React.ReactNode }) => React.ReactNode;
+
+type BlockMenuNestedSectionComponent = (props: {
+  children: React.ReactNode;
+}) => React.ReactNode;
+
+type BlockMenuItemComponent = () => React.ReactNode;
+
+type RegisterBlockMenuNested = BlockMenuNested & {
+  component?: BlockMenuNestedComponent;
+  parent: Parent<BlockMenuSection>;
+};
+
+type RegisterBlockMenuSection = BlockMenuSection & {
+  component?: BlockMenuSectionComponent;
+  parent?: Parent<BlockMenuNested>;
+  rank?: number;
+};
+
+type RegisterBlockMenuItem = BlockMenuItem & {
+  component?: BlockMenuItemComponent;
+  isHidden?: () => boolean;
+  parent: Parent<BlockMenuSection>;
+};
+
+type RegisterBlockMenuComponent =
+  | RegisterBlockMenuNested
+  | RegisterBlockMenuSection
+  | RegisterBlockMenuItem;
+
+type RegisterBlockMenuComponentType = RegisterBlockMenuComponent['type'];
 `}
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "7.0.2",
+	"version": "7.0.3",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -44,13 +44,13 @@
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^18.0.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",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.1.0",
+		"@atlaskit/editor-common": "^112.2.0",
 		"react": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},