@atlaskit/editor-plugin-block-menu 0.0.9 → 0.0.10

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-block-menu
 
+## 0.0.10
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 0.0.9
 
 ### Patch Changes

package/dist/types/blockMenuPluginType.d.ts

@@ -3,27 +3,27 @@ import type { BlockControlsPlugin } from '@atlaskit/editor-plugin-block-controls
 import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
 import type { UserIntentPlugin } from '@atlaskit/editor-plugin-user-intent';
 export type BlockMenuPlugin = NextEditorPlugin<'blockMenu', {
+    actions: {
+        getBlockMenuComponents: () => Array<RegisterBlockMenuComponent>;
+        registerBlockMenuComponents: (blockMenuComponents: Array<RegisterBlockMenuComponent>) => void;
+    };
     dependencies: [
         OptionalPlugin<BlockControlsPlugin>,
         OptionalPlugin<UserIntentPlugin>,
         OptionalPlugin<SelectionPlugin>
     ];
     pluginConfiguration?: BlockMenuPluginOptions;
-    actions: {
-        registerBlockMenuComponents: (blockMenuComponents: Array<RegisterBlockMenuComponent>) => void;
-        getBlockMenuComponents: () => Array<RegisterBlockMenuComponent>;
-    };
 }>;
 export type BlockMenuPluginOptions = {
+    /**
+     * Optional query parameter name used for block-specific URL to create a deep link to specific block
+     */
+    blockQueryParam?: string;
     /**
      * Optional function to retrieve the current link path for the editor context.
      * @returns The current link path as a string, or null if no path is available
      */
     getLinkPath?: () => string | null;
-    /**
-     * Optional query parameter name used for block-specific URL to create a deep link to specific block
-     */
-    blockQueryParam?: string;
 };
 type WithRank<T> = T & {
     rank: number;
@@ -49,16 +49,16 @@ export type BlockMenuSectionComponent = (props: {
 }) => React.ReactNode;
 export type BlockMenuItemComponent = () => React.ReactNode;
 export type RegisterBlockMenuNested = BlockMenuNested & {
-    parent: Parent<BlockMenuSection>;
     component?: BlockMenuNestedComponent;
+    parent: Parent<BlockMenuSection>;
 };
 export type RegisterBlockMenuSection = BlockMenuSection & {
-    rank: number;
     component?: BlockMenuSectionComponent;
+    rank: number;
 };
 export type RegisterBlockMenuItem = BlockMenuItem & {
-    parent: Parent<BlockMenuSection>;
     component?: BlockMenuItemComponent;
+    parent: Parent<BlockMenuSection>;
 };
 export type RegisterBlockMenuComponent = RegisterBlockMenuNested | RegisterBlockMenuSection | RegisterBlockMenuItem;
 export {};

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

@@ -9,9 +9,9 @@ type BlockMenuProps = {
      * Fallback components used in rendering
      */
     fallbacks: {
+        item: BlockMenuItemComponent;
         nestedMenu: BlockMenuNestedComponent;
         section: BlockMenuSectionComponent;
-        item: BlockMenuItemComponent;
     };
 };
 export declare const BlockMenuRenderer: ({ components, fallbacks }: BlockMenuProps) => React.JSX.Element;

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

@@ -4,10 +4,10 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { BlockMenuPlugin } from '../blockMenuPluginType';
 type BlockMenuProps = {
-    editorView: EditorView | undefined;
     api: ExtractInjectionAPI<BlockMenuPlugin> | undefined;
-    mountTo?: HTMLElement;
     boundariesElement?: HTMLElement;
+    editorView: EditorView | undefined;
+    mountTo?: HTMLElement;
     scrollableElement?: HTMLElement;
 };
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<BlockMenuProps & WrappedComponentProps>> & {

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

@@ -3,27 +3,27 @@ import type { BlockControlsPlugin } from '@atlaskit/editor-plugin-block-controls
 import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
 import type { UserIntentPlugin } from '@atlaskit/editor-plugin-user-intent';
 export type BlockMenuPlugin = NextEditorPlugin<'blockMenu', {
+    actions: {
+        getBlockMenuComponents: () => Array<RegisterBlockMenuComponent>;
+        registerBlockMenuComponents: (blockMenuComponents: Array<RegisterBlockMenuComponent>) => void;
+    };
     dependencies: [
         OptionalPlugin<BlockControlsPlugin>,
         OptionalPlugin<UserIntentPlugin>,
         OptionalPlugin<SelectionPlugin>
     ];
     pluginConfiguration?: BlockMenuPluginOptions;
-    actions: {
-        registerBlockMenuComponents: (blockMenuComponents: Array<RegisterBlockMenuComponent>) => void;
-        getBlockMenuComponents: () => Array<RegisterBlockMenuComponent>;
-    };
 }>;
 export type BlockMenuPluginOptions = {
+    /**
+     * Optional query parameter name used for block-specific URL to create a deep link to specific block
+     */
+    blockQueryParam?: string;
     /**
      * Optional function to retrieve the current link path for the editor context.
      * @returns The current link path as a string, or null if no path is available
      */
     getLinkPath?: () => string | null;
-    /**
-     * Optional query parameter name used for block-specific URL to create a deep link to specific block
-     */
-    blockQueryParam?: string;
 };
 type WithRank<T> = T & {
     rank: number;
@@ -49,16 +49,16 @@ export type BlockMenuSectionComponent = (props: {
 }) => React.ReactNode;
 export type BlockMenuItemComponent = () => React.ReactNode;
 export type RegisterBlockMenuNested = BlockMenuNested & {
-    parent: Parent<BlockMenuSection>;
     component?: BlockMenuNestedComponent;
+    parent: Parent<BlockMenuSection>;
 };
 export type RegisterBlockMenuSection = BlockMenuSection & {
-    rank: number;
     component?: BlockMenuSectionComponent;
+    rank: number;
 };
 export type RegisterBlockMenuItem = BlockMenuItem & {
-    parent: Parent<BlockMenuSection>;
     component?: BlockMenuItemComponent;
+    parent: Parent<BlockMenuSection>;
 };
 export type RegisterBlockMenuComponent = RegisterBlockMenuNested | RegisterBlockMenuSection | RegisterBlockMenuItem;
 export {};

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

@@ -9,9 +9,9 @@ type BlockMenuProps = {
      * Fallback components used in rendering
      */
     fallbacks: {
+        item: BlockMenuItemComponent;
         nestedMenu: BlockMenuNestedComponent;
         section: BlockMenuSectionComponent;
-        item: BlockMenuItemComponent;
     };
 };
 export declare const BlockMenuRenderer: ({ components, fallbacks }: BlockMenuProps) => React.JSX.Element;

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

@@ -4,10 +4,10 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import { type EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { BlockMenuPlugin } from '../blockMenuPluginType';
 type BlockMenuProps = {
-    editorView: EditorView | undefined;
     api: ExtractInjectionAPI<BlockMenuPlugin> | undefined;
-    mountTo?: HTMLElement;
     boundariesElement?: HTMLElement;
+    editorView: EditorView | undefined;
+    mountTo?: HTMLElement;
     scrollableElement?: HTMLElement;
 };
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<BlockMenuProps & WrappedComponentProps>> & {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "0.0.9",
+	"version": "0.0.10",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",