@atlaskit/editor-plugin-block-menu 0.0.2 → 0.0.3

package/dist/types/blockMenuPluginType.d.ts

@@ -3,4 +3,45 @@ import type { BlockControlsPlugin } from '@atlaskit/editor-plugin-block-controls
 import type { UserIntentPlugin } from '@atlaskit/editor-plugin-user-intent';
 export type BlockMenuPlugin = NextEditorPlugin<'blockMenu', {
     dependencies: [OptionalPlugin<BlockControlsPlugin>, OptionalPlugin<UserIntentPlugin>];
+    actions: {
+        registerBlockMenuComponents: (blockMenuComponents: Array<RegisterBlockMenuComponent>) => void;
+        getBlockMenuComponents: () => Array<RegisterBlockMenuComponent>;
+    };
 }>;
+type WithRank<T> = T & {
+    rank: number;
+};
+export type Parent<T> = WithRank<T>;
+type ComponentType = BlockMenuSection | BlockMenuItem | BlockMenuNested;
+export type ComponentTypes = Array<ComponentType>;
+type BlockMenuItem = {
+    key: string;
+    type: 'block-menu-item';
+};
+type BlockMenuSection = {
+    key: string;
+    type: 'block-menu-section';
+};
+type BlockMenuNested = {
+    key: string;
+    type: 'block-menu-nested';
+};
+export type BlockMenuNestedComponent = () => React.ReactNode;
+export type BlockMenuSectionComponent = (props: {
+    children: React.ReactNode;
+}) => React.ReactNode;
+export type BlockMenuItemComponent = () => React.ReactNode;
+export type RegisterBlockMenuNested = BlockMenuNested & {
+    parent: Parent<BlockMenuSection>;
+    component?: BlockMenuNestedComponent;
+};
+export type RegisterBlockMenuSection = BlockMenuSection & {
+    rank: number;
+    component?: BlockMenuSectionComponent;
+};
+export type RegisterBlockMenuItem = BlockMenuItem & {
+    parent: Parent<BlockMenuSection>;
+    component?: BlockMenuItemComponent;
+};
+export type RegisterBlockMenuComponent = RegisterBlockMenuNested | RegisterBlockMenuSection | RegisterBlockMenuItem;
+export {};

package/dist/types/editor-actions/index.d.ts

@@ -0,0 +1,52 @@
+import type { RegisterBlockMenuComponent } from '../blockMenuPluginType';
+/**
+ * Create a simple registry for block menu components.
+ *
+ * @returns A registry object with a `register` method and a `components` array.
+ *
+ * @example
+ * ```ts
+ * const registry = createBlockMenuRegistry();
+ * registry.register(
+ *   [{
+ *     type: 'block-menu-section' as const,
+ *     key: 'block-menu-section-format',
+ *     rank: 100,
+ *     component: ({ children }: { children: React.ReactNode }) => {
+ *       return <ToolbarDropdownItemSection>{children}</ToolbarDropdownItemSection>;
+ *     },
+ *   },
+ *   {
+ *     type: 'block-menu-nested' as const,
+ *     key: 'nested-menu',
+ *     parent: {
+ *       type: 'block-menu-section' as const,
+ *       key: 'block-menu-section-format',
+ *       rank: 100,
+ *     },
+ *     component: () => {
+ *       return (
+ *         <ToolbarNestedDropdownMenu>{...}</ToolbarNestedDropdownMenu>
+ *       );
+ *     },
+ *   },
+ *   {
+ *     type: 'block-menu-item' as const,
+ *     key: 'block-menu-item-create-jira',
+ *     parent: {
+ *       type: 'block-menu-section' as const,
+ *       key: 'block-menu-section-format',
+ *       rank: 200,
+ *     },
+ *     component: () => {
+ *       return <ToolbarDropdownItem elemBefore={<JiraIcon label="" />}>Create Jira work item</ToolbarDropdownItem>;
+ *     },
+ *   },
+ *   ]);
+ * ```
+ *
+ */
+export declare const createBlockMenuRegistry: () => {
+    register: (blockMenuComponents: RegisterBlockMenuComponent[]) => void;
+    components: RegisterBlockMenuComponent[];
+};

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
 export { blockMenuPlugin } from './blockMenuPlugin';
-export type { BlockMenuPlugin } from './blockMenuPluginType';
+export type { BlockMenuPlugin, RegisterBlockMenuComponent, Parent } from './blockMenuPluginType';

package/dist/types/ui/block-menu-components.d.ts

@@ -0,0 +1,2 @@
+import { type RegisterBlockMenuComponent } from '../blockMenuPluginType';
+export declare const getBlockMenuComponents: () => RegisterBlockMenuComponent[];

package/dist/types/ui/block-menu-renderer.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import type { RegisterBlockMenuComponent, BlockMenuNestedComponent, BlockMenuSectionComponent, BlockMenuItemComponent } from '../blockMenuPluginType';
+type BlockMenuProps = {
+    /**
+     * Every registered block menu component
+     */
+    components: RegisterBlockMenuComponent[];
+    /**
+     * Fallback components used in rendering
+     */
+    fallbacks: {
+        nestedMenu: BlockMenuNestedComponent;
+        section: BlockMenuSectionComponent;
+        item: BlockMenuItemComponent;
+    };
+};
+export declare const BlockMenuRenderer: ({ components, fallbacks }: BlockMenuProps) => React.JSX.Element;
+export {};

package/dist/types/ui/consts.d.ts

@@ -0,0 +1 @@
+export declare const BLOCK_MENU_LABEL = "Editor Block Menu";

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

@@ -6,4 +6,45 @@ export type BlockMenuPlugin = NextEditorPlugin<'blockMenu', {
         OptionalPlugin<BlockControlsPlugin>,
         OptionalPlugin<UserIntentPlugin>
     ];
+    actions: {
+        registerBlockMenuComponents: (blockMenuComponents: Array<RegisterBlockMenuComponent>) => void;
+        getBlockMenuComponents: () => Array<RegisterBlockMenuComponent>;
+    };
 }>;
+type WithRank<T> = T & {
+    rank: number;
+};
+export type Parent<T> = WithRank<T>;
+type ComponentType = BlockMenuSection | BlockMenuItem | BlockMenuNested;
+export type ComponentTypes = Array<ComponentType>;
+type BlockMenuItem = {
+    key: string;
+    type: 'block-menu-item';
+};
+type BlockMenuSection = {
+    key: string;
+    type: 'block-menu-section';
+};
+type BlockMenuNested = {
+    key: string;
+    type: 'block-menu-nested';
+};
+export type BlockMenuNestedComponent = () => React.ReactNode;
+export type BlockMenuSectionComponent = (props: {
+    children: React.ReactNode;
+}) => React.ReactNode;
+export type BlockMenuItemComponent = () => React.ReactNode;
+export type RegisterBlockMenuNested = BlockMenuNested & {
+    parent: Parent<BlockMenuSection>;
+    component?: BlockMenuNestedComponent;
+};
+export type RegisterBlockMenuSection = BlockMenuSection & {
+    rank: number;
+    component?: BlockMenuSectionComponent;
+};
+export type RegisterBlockMenuItem = BlockMenuItem & {
+    parent: Parent<BlockMenuSection>;
+    component?: BlockMenuItemComponent;
+};
+export type RegisterBlockMenuComponent = RegisterBlockMenuNested | RegisterBlockMenuSection | RegisterBlockMenuItem;
+export {};

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

@@ -0,0 +1,52 @@
+import type { RegisterBlockMenuComponent } from '../blockMenuPluginType';
+/**
+ * Create a simple registry for block menu components.
+ *
+ * @returns A registry object with a `register` method and a `components` array.
+ *
+ * @example
+ * ```ts
+ * const registry = createBlockMenuRegistry();
+ * registry.register(
+ *   [{
+ *     type: 'block-menu-section' as const,
+ *     key: 'block-menu-section-format',
+ *     rank: 100,
+ *     component: ({ children }: { children: React.ReactNode }) => {
+ *       return <ToolbarDropdownItemSection>{children}</ToolbarDropdownItemSection>;
+ *     },
+ *   },
+ *   {
+ *     type: 'block-menu-nested' as const,
+ *     key: 'nested-menu',
+ *     parent: {
+ *       type: 'block-menu-section' as const,
+ *       key: 'block-menu-section-format',
+ *       rank: 100,
+ *     },
+ *     component: () => {
+ *       return (
+ *         <ToolbarNestedDropdownMenu>{...}</ToolbarNestedDropdownMenu>
+ *       );
+ *     },
+ *   },
+ *   {
+ *     type: 'block-menu-item' as const,
+ *     key: 'block-menu-item-create-jira',
+ *     parent: {
+ *       type: 'block-menu-section' as const,
+ *       key: 'block-menu-section-format',
+ *       rank: 200,
+ *     },
+ *     component: () => {
+ *       return <ToolbarDropdownItem elemBefore={<JiraIcon label="" />}>Create Jira work item</ToolbarDropdownItem>;
+ *     },
+ *   },
+ *   ]);
+ * ```
+ *
+ */
+export declare const createBlockMenuRegistry: () => {
+    register: (blockMenuComponents: RegisterBlockMenuComponent[]) => void;
+    components: RegisterBlockMenuComponent[];
+};

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

@@ -1,2 +1,2 @@
 export { blockMenuPlugin } from './blockMenuPlugin';
-export type { BlockMenuPlugin } from './blockMenuPluginType';
+export type { BlockMenuPlugin, RegisterBlockMenuComponent, Parent } from './blockMenuPluginType';

package/dist/types-ts4.5/ui/block-menu-components.d.ts

@@ -0,0 +1,2 @@
+import { type RegisterBlockMenuComponent } from '../blockMenuPluginType';
+export declare const getBlockMenuComponents: () => RegisterBlockMenuComponent[];

package/dist/types-ts4.5/ui/block-menu-renderer.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import type { RegisterBlockMenuComponent, BlockMenuNestedComponent, BlockMenuSectionComponent, BlockMenuItemComponent } from '../blockMenuPluginType';
+type BlockMenuProps = {
+    /**
+     * Every registered block menu component
+     */
+    components: RegisterBlockMenuComponent[];
+    /**
+     * Fallback components used in rendering
+     */
+    fallbacks: {
+        nestedMenu: BlockMenuNestedComponent;
+        section: BlockMenuSectionComponent;
+        item: BlockMenuItemComponent;
+    };
+};
+export declare const BlockMenuRenderer: ({ components, fallbacks }: BlockMenuProps) => React.JSX.Element;
+export {};

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

@@ -0,0 +1 @@
+export declare const BLOCK_MENU_LABEL = "Editor Block Menu";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -37,6 +37,7 @@
 		"@atlaskit/editor-plugin-user-intent": "^1.1.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.6.0",
+		"@atlaskit/editor-toolbar": "^0.2.0",
 		"@atlaskit/icon": "^27.11.0",
 		"@atlaskit/icon-lab": "^5.4.0",
 		"@atlaskit/primitives": "^14.11.0",