@atlaskit/editor-plugin-block-type 6.2.9 → 6.2.11

package/CHANGELOG.md

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

package/dist/types/blockTypePluginType.d.ts

@@ -9,7 +9,14 @@ import type { ClearFormattingInputMethod, InputMethod } from './pm-plugins/comma
 import type { BlockTypeState } from './pm-plugins/main';
 import type { BlockTypePluginOptions } from './pm-plugins/types';
 export type BlockTypePlugin = NextEditorPlugin<'blockType', {
-    pluginConfiguration: BlockTypePluginOptions | undefined;
+    actions: {
+        insertBlockQuote: (inputMethod: InputMethod) => Command;
+    };
+    commands: {
+        clearFormatting: (inputMethod: ClearFormattingInputMethod) => EditorCommand;
+        insertBlockQuote: (inputMethod: InputMethod) => EditorCommand;
+        setTextLevel: (level: TextBlockTypes, inputMethod: InputMethod, fromBlockQuote?: boolean) => EditorCommand;
+    };
     dependencies: [
         OptionalPlugin<AnalyticsPlugin>,
         OptionalPlugin<PrimaryToolbarPlugin>,
@@ -17,13 +24,6 @@ export type BlockTypePlugin = NextEditorPlugin<'blockType', {
         OptionalPlugin<UserPreferencesPlugin>,
         OptionalPlugin<ToolbarPlugin>
     ];
+    pluginConfiguration: BlockTypePluginOptions | undefined;
     sharedState: BlockTypeState | undefined;
-    actions: {
-        insertBlockQuote: (inputMethod: InputMethod) => Command;
-    };
-    commands: {
-        setTextLevel: (level: TextBlockTypes, inputMethod: InputMethod, fromBlockQuote?: boolean) => EditorCommand;
-        insertBlockQuote: (inputMethod: InputMethod) => EditorCommand;
-        clearFormatting: (inputMethod: ClearFormattingInputMethod) => EditorCommand;
-    };
 }>;

package/dist/types/pm-plugins/main.d.ts

@@ -4,11 +4,11 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { BlockTypePlugin } from '../blockTypePluginType';
 import type { BlockType } from './types';
 export type BlockTypeState = {
-    currentBlockType: BlockType;
-    blockTypesDisabled: boolean;
     availableBlockTypes: BlockType[];
-    availableWrapperBlockTypes: BlockType[];
     availableBlockTypesInDropdown: BlockType[];
+    availableWrapperBlockTypes: BlockType[];
+    blockTypesDisabled: boolean;
+    currentBlockType: BlockType;
     formattingIsPresent?: boolean;
 };
 export declare const pluginKey: PluginKey<BlockTypeState>;

package/dist/types/pm-plugins/types.d.ts

@@ -4,27 +4,27 @@ import type { AllowedBlockTypes, HeadingLevelsAndNormalText } from '@atlaskit/ed
 import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
 export type BlockTypeName = 'normal' | 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'blockquote' | 'codeblock' | 'panel' | 'notePanel' | 'successPanel' | 'warningPanel' | 'errorPanel' | 'other';
 export interface BlockType {
+    icon?: ReactElement;
+    LEGACY_icon?: ReactElement;
+    level?: HeadingLevelsAndNormalText;
     name: string;
-    title: MessageDescriptor;
     nodeName: string;
     tagName?: string;
-    level?: HeadingLevelsAndNormalText;
-    icon?: ReactElement;
-    LEGACY_icon?: ReactElement;
+    title: MessageDescriptor;
 }
 export interface BlockTypeWithRank extends BlockType {
-    toolbarRank: number;
     toolbarKey: string;
+    toolbarRank: number;
 }
 export interface BlockTypeNode {
     name: AllowedBlockTypes;
     node: NodeSpec;
 }
 export interface BlockTypePluginOptions {
-    lastNodeMustBeParagraph?: boolean;
     allowBlockType?: {
         exclude?: Array<AllowedBlockTypes>;
     };
-    isUndoRedoButtonsEnabled?: boolean;
     includeBlockQuoteAsTextstyleOption?: boolean;
+    isUndoRedoButtonsEnabled?: boolean;
+    lastNodeMustBeParagraph?: boolean;
 }

package/dist/types/pm-plugins/ui/PrimaryToolbarComponent.d.ts

@@ -2,12 +2,12 @@ import React from 'react';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { BlockTypePlugin } from '../../blockTypePluginType';
 interface PrimaryToolbarComponentProps {
+    api: ExtractInjectionAPI<BlockTypePlugin> | undefined;
+    disabled: boolean;
     isSmall: boolean;
     isToolbarReducedSpacing: boolean;
-    disabled: boolean;
-    api: ExtractInjectionAPI<BlockTypePlugin> | undefined;
-    popupsMountPoint?: HTMLElement;
     popupsBoundariesElement?: HTMLElement;
+    popupsMountPoint?: HTMLElement;
     popupsScrollableElement?: HTMLElement;
     shouldUseDefaultRole: boolean;
 }

package/dist/types/pm-plugins/ui/ToolbarBlockType/HeadingButton.d.ts

@@ -3,8 +3,8 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { BlockTypePlugin } from '../../../blockTypePluginType';
 import type { BlockTypeWithRank } from '../../types';
 type HeadingButtonProps = {
-    blockType: BlockTypeWithRank;
     api?: ExtractInjectionAPI<BlockTypePlugin>;
+    blockType: BlockTypeWithRank;
 };
 export declare const HeadingButton: ({ blockType, api }: HeadingButtonProps) => React.JSX.Element | null;
 export {};

package/dist/types/pm-plugins/ui/ToolbarBlockType/QuoteButton.d.ts

@@ -3,8 +3,8 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { BlockTypePlugin } from '../../../blockTypePluginType';
 import type { BlockTypeWithRank } from '../../types';
 type QuoteButtonProps = {
-    blockType: BlockTypeWithRank;
     api?: ExtractInjectionAPI<BlockTypePlugin>;
+    blockType: BlockTypeWithRank;
 };
 export declare const QuoteButton: ({ blockType, api }: QuoteButtonProps) => React.JSX.Element | null;
 export {};

package/dist/types/pm-plugins/ui/ToolbarBlockType/blocktype-button.d.ts

@@ -6,16 +6,16 @@ import React, { type ReactElement } from 'react';
 import { jsx } from '@emotion/react';
 import type { MessageDescriptor, WrappedComponentProps } from 'react-intl-next';
 export interface BlockTypeButtonProps {
-    isSmall?: boolean;
-    isReducedSpacing?: boolean;
     'aria-expanded': React.AriaAttributes['aria-expanded'];
-    selected: boolean;
+    blockTypeIcon?: ReactElement;
+    blockTypeName?: string;
     disabled: boolean;
-    title: MessageDescriptor;
+    formatMessage: WrappedComponentProps['intl']['formatMessage'];
+    isReducedSpacing?: boolean;
+    isSmall?: boolean;
     onClick(e: React.MouseEvent): void;
     onKeyDown(e: React.KeyboardEvent): void;
-    formatMessage: WrappedComponentProps['intl']['formatMessage'];
-    blockTypeName?: string;
-    blockTypeIcon?: ReactElement;
+    selected: boolean;
+    title: MessageDescriptor;
 }
 export declare const BlockTypeButton: (props: BlockTypeButtonProps) => jsx.JSX.Element;

package/dist/types/pm-plugins/ui/ToolbarBlockType/index.d.ts

@@ -15,29 +15,29 @@ export type DropdownItem = MenuItem & {
     value: BlockType;
 };
 export interface Props {
-    isDisabled?: boolean;
-    isSmall?: boolean;
-    isReducedSpacing?: boolean;
-    currentBlockType?: BlockType;
-    blockTypesDisabled?: boolean;
+    api: ExtractInjectionAPI<BlockTypePlugin> | undefined;
     availableBlockTypes?: BlockType[];
     availableBlockTypesInDropdown?: BlockType[];
+    blockTypesDisabled?: boolean;
+    clearFormatting: () => void;
+    currentBlockType?: BlockType;
+    editorView?: EditorView;
     formattingIsPresent?: boolean;
-    popupsMountPoint?: HTMLElement;
+    isDisabled?: boolean;
+    isReducedSpacing?: boolean;
+    isSmall?: boolean;
     popupsBoundariesElement?: HTMLElement;
+    popupsMountPoint?: HTMLElement;
     popupsScrollableElement?: HTMLElement;
-    editorView?: EditorView;
     setTextLevel: (type: TextBlockTypes, fromBlockQuote?: boolean) => void;
-    wrapBlockQuote: (type: TextBlockTypes) => void;
-    clearFormatting: () => void;
     shouldUseDefaultRole?: boolean;
-    api: ExtractInjectionAPI<BlockTypePlugin> | undefined;
+    wrapBlockQuote: (type: TextBlockTypes) => void;
 }
 export interface State {
     active: boolean;
     isOpenedByKeyboard: boolean;
-    typographyTheme: 'typography' | 'typography-adg3' | 'typography-modernized' | 'typography-refreshed' | undefined;
     observer: ThemeMutationObserver | null;
+    typographyTheme: 'typography' | 'typography-adg3' | 'typography-modernized' | 'typography-refreshed' | undefined;
 }
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps>> & {
     WrappedComponent: React.ComponentType<Props & WrappedComponentProps>;

package/dist/types/pm-plugins/utils.d.ts

@@ -5,9 +5,9 @@ import type { BlockType } from './types';
 export declare const isNodeAWrappingBlockNode: (node?: PMNode | null) => boolean;
 export declare const createJoinNodesRule: (match: RegExp, nodeType: NodeType) => InputRuleWrapper;
 type WrappingTextRuleProps = {
+    getAttrs?: Record<string, any> | ((matchResult: RegExpExecArray) => Record<string, any>);
     match: RegExp;
     nodeType: NodeType;
-    getAttrs?: Record<string, any> | ((matchResult: RegExpExecArray) => Record<string, any>);
 };
 export declare const createWrappingTextBlockRule: ({ match, nodeType, getAttrs, }: WrappingTextRuleProps) => InputRuleWrapper;
 /**

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

@@ -9,7 +9,14 @@ import type { ClearFormattingInputMethod, InputMethod } from './pm-plugins/comma
 import type { BlockTypeState } from './pm-plugins/main';
 import type { BlockTypePluginOptions } from './pm-plugins/types';
 export type BlockTypePlugin = NextEditorPlugin<'blockType', {
-    pluginConfiguration: BlockTypePluginOptions | undefined;
+    actions: {
+        insertBlockQuote: (inputMethod: InputMethod) => Command;
+    };
+    commands: {
+        clearFormatting: (inputMethod: ClearFormattingInputMethod) => EditorCommand;
+        insertBlockQuote: (inputMethod: InputMethod) => EditorCommand;
+        setTextLevel: (level: TextBlockTypes, inputMethod: InputMethod, fromBlockQuote?: boolean) => EditorCommand;
+    };
     dependencies: [
         OptionalPlugin<AnalyticsPlugin>,
         OptionalPlugin<PrimaryToolbarPlugin>,
@@ -17,13 +24,6 @@ export type BlockTypePlugin = NextEditorPlugin<'blockType', {
         OptionalPlugin<UserPreferencesPlugin>,
         OptionalPlugin<ToolbarPlugin>
     ];
+    pluginConfiguration: BlockTypePluginOptions | undefined;
     sharedState: BlockTypeState | undefined;
-    actions: {
-        insertBlockQuote: (inputMethod: InputMethod) => Command;
-    };
-    commands: {
-        setTextLevel: (level: TextBlockTypes, inputMethod: InputMethod, fromBlockQuote?: boolean) => EditorCommand;
-        insertBlockQuote: (inputMethod: InputMethod) => EditorCommand;
-        clearFormatting: (inputMethod: ClearFormattingInputMethod) => EditorCommand;
-    };
 }>;

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -4,11 +4,11 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { BlockTypePlugin } from '../blockTypePluginType';
 import type { BlockType } from './types';
 export type BlockTypeState = {
-    currentBlockType: BlockType;
-    blockTypesDisabled: boolean;
     availableBlockTypes: BlockType[];
-    availableWrapperBlockTypes: BlockType[];
     availableBlockTypesInDropdown: BlockType[];
+    availableWrapperBlockTypes: BlockType[];
+    blockTypesDisabled: boolean;
+    currentBlockType: BlockType;
     formattingIsPresent?: boolean;
 };
 export declare const pluginKey: PluginKey<BlockTypeState>;

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

@@ -4,27 +4,27 @@ import type { AllowedBlockTypes, HeadingLevelsAndNormalText } from '@atlaskit/ed
 import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
 export type BlockTypeName = 'normal' | 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'blockquote' | 'codeblock' | 'panel' | 'notePanel' | 'successPanel' | 'warningPanel' | 'errorPanel' | 'other';
 export interface BlockType {
+    icon?: ReactElement;
+    LEGACY_icon?: ReactElement;
+    level?: HeadingLevelsAndNormalText;
     name: string;
-    title: MessageDescriptor;
     nodeName: string;
     tagName?: string;
-    level?: HeadingLevelsAndNormalText;
-    icon?: ReactElement;
-    LEGACY_icon?: ReactElement;
+    title: MessageDescriptor;
 }
 export interface BlockTypeWithRank extends BlockType {
-    toolbarRank: number;
     toolbarKey: string;
+    toolbarRank: number;
 }
 export interface BlockTypeNode {
     name: AllowedBlockTypes;
     node: NodeSpec;
 }
 export interface BlockTypePluginOptions {
-    lastNodeMustBeParagraph?: boolean;
     allowBlockType?: {
         exclude?: Array<AllowedBlockTypes>;
     };
-    isUndoRedoButtonsEnabled?: boolean;
     includeBlockQuoteAsTextstyleOption?: boolean;
+    isUndoRedoButtonsEnabled?: boolean;
+    lastNodeMustBeParagraph?: boolean;
 }

package/dist/types-ts4.5/pm-plugins/ui/PrimaryToolbarComponent.d.ts

@@ -2,12 +2,12 @@ import React from 'react';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { BlockTypePlugin } from '../../blockTypePluginType';
 interface PrimaryToolbarComponentProps {
+    api: ExtractInjectionAPI<BlockTypePlugin> | undefined;
+    disabled: boolean;
     isSmall: boolean;
     isToolbarReducedSpacing: boolean;
-    disabled: boolean;
-    api: ExtractInjectionAPI<BlockTypePlugin> | undefined;
-    popupsMountPoint?: HTMLElement;
     popupsBoundariesElement?: HTMLElement;
+    popupsMountPoint?: HTMLElement;
     popupsScrollableElement?: HTMLElement;
     shouldUseDefaultRole: boolean;
 }

package/dist/types-ts4.5/pm-plugins/ui/ToolbarBlockType/HeadingButton.d.ts

@@ -3,8 +3,8 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { BlockTypePlugin } from '../../../blockTypePluginType';
 import type { BlockTypeWithRank } from '../../types';
 type HeadingButtonProps = {
-    blockType: BlockTypeWithRank;
     api?: ExtractInjectionAPI<BlockTypePlugin>;
+    blockType: BlockTypeWithRank;
 };
 export declare const HeadingButton: ({ blockType, api }: HeadingButtonProps) => React.JSX.Element | null;
 export {};

package/dist/types-ts4.5/pm-plugins/ui/ToolbarBlockType/QuoteButton.d.ts

@@ -3,8 +3,8 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { BlockTypePlugin } from '../../../blockTypePluginType';
 import type { BlockTypeWithRank } from '../../types';
 type QuoteButtonProps = {
-    blockType: BlockTypeWithRank;
     api?: ExtractInjectionAPI<BlockTypePlugin>;
+    blockType: BlockTypeWithRank;
 };
 export declare const QuoteButton: ({ blockType, api }: QuoteButtonProps) => React.JSX.Element | null;
 export {};

package/dist/types-ts4.5/pm-plugins/ui/ToolbarBlockType/blocktype-button.d.ts

@@ -6,16 +6,16 @@ import React, { type ReactElement } from 'react';
 import { jsx } from '@emotion/react';
 import type { MessageDescriptor, WrappedComponentProps } from 'react-intl-next';
 export interface BlockTypeButtonProps {
-    isSmall?: boolean;
-    isReducedSpacing?: boolean;
     'aria-expanded': React.AriaAttributes['aria-expanded'];
-    selected: boolean;
+    blockTypeIcon?: ReactElement;
+    blockTypeName?: string;
     disabled: boolean;
-    title: MessageDescriptor;
+    formatMessage: WrappedComponentProps['intl']['formatMessage'];
+    isReducedSpacing?: boolean;
+    isSmall?: boolean;
     onClick(e: React.MouseEvent): void;
     onKeyDown(e: React.KeyboardEvent): void;
-    formatMessage: WrappedComponentProps['intl']['formatMessage'];
-    blockTypeName?: string;
-    blockTypeIcon?: ReactElement;
+    selected: boolean;
+    title: MessageDescriptor;
 }
 export declare const BlockTypeButton: (props: BlockTypeButtonProps) => jsx.JSX.Element;

package/dist/types-ts4.5/pm-plugins/ui/ToolbarBlockType/index.d.ts

@@ -15,29 +15,29 @@ export type DropdownItem = MenuItem & {
     value: BlockType;
 };
 export interface Props {
-    isDisabled?: boolean;
-    isSmall?: boolean;
-    isReducedSpacing?: boolean;
-    currentBlockType?: BlockType;
-    blockTypesDisabled?: boolean;
+    api: ExtractInjectionAPI<BlockTypePlugin> | undefined;
     availableBlockTypes?: BlockType[];
     availableBlockTypesInDropdown?: BlockType[];
+    blockTypesDisabled?: boolean;
+    clearFormatting: () => void;
+    currentBlockType?: BlockType;
+    editorView?: EditorView;
     formattingIsPresent?: boolean;
-    popupsMountPoint?: HTMLElement;
+    isDisabled?: boolean;
+    isReducedSpacing?: boolean;
+    isSmall?: boolean;
     popupsBoundariesElement?: HTMLElement;
+    popupsMountPoint?: HTMLElement;
     popupsScrollableElement?: HTMLElement;
-    editorView?: EditorView;
     setTextLevel: (type: TextBlockTypes, fromBlockQuote?: boolean) => void;
-    wrapBlockQuote: (type: TextBlockTypes) => void;
-    clearFormatting: () => void;
     shouldUseDefaultRole?: boolean;
-    api: ExtractInjectionAPI<BlockTypePlugin> | undefined;
+    wrapBlockQuote: (type: TextBlockTypes) => void;
 }
 export interface State {
     active: boolean;
     isOpenedByKeyboard: boolean;
-    typographyTheme: 'typography' | 'typography-adg3' | 'typography-modernized' | 'typography-refreshed' | undefined;
     observer: ThemeMutationObserver | null;
+    typographyTheme: 'typography' | 'typography-adg3' | 'typography-modernized' | 'typography-refreshed' | undefined;
 }
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps>> & {
     WrappedComponent: React.ComponentType<Props & WrappedComponentProps>;

package/dist/types-ts4.5/pm-plugins/utils.d.ts

@@ -5,9 +5,9 @@ import type { BlockType } from './types';
 export declare const isNodeAWrappingBlockNode: (node?: PMNode | null) => boolean;
 export declare const createJoinNodesRule: (match: RegExp, nodeType: NodeType) => InputRuleWrapper;
 type WrappingTextRuleProps = {
+    getAttrs?: Record<string, any> | ((matchResult: RegExpExecArray) => Record<string, any>);
     match: RegExp;
     nodeType: NodeType;
-    getAttrs?: Record<string, any> | ((matchResult: RegExpExecArray) => Record<string, any>);
 };
 export declare const createWrappingTextBlockRule: ({ match, nodeType, getAttrs, }: WrappingTextRuleProps) => InputRuleWrapper;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-type",
-	"version": "6.2.9",
+	"version": "6.2.11",
 	"description": "BlockType plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -39,7 +39,7 @@
 		"@atlaskit/editor-plugin-analytics": "^3.0.0",
 		"@atlaskit/editor-plugin-primary-toolbar": "^4.1.0",
 		"@atlaskit/editor-plugin-selection-toolbar": "^4.3.0",
-		"@atlaskit/editor-plugin-toolbar": "^0.3.0",
+		"@atlaskit/editor-plugin-toolbar": "^0.4.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.6.0",
 		"@atlaskit/editor-tables": "^2.9.0",
@@ -51,7 +51,7 @@
 		"@atlaskit/primitives": "^14.11.0",
 		"@atlaskit/prosemirror-input-rules": "^3.4.0",
 		"@atlaskit/theme": "^19.0.0",
-		"@atlaskit/tmp-editor-statsig": "^11.4.0",
+		"@atlaskit/tmp-editor-statsig": "^11.5.0",
 		"@atlaskit/tokens": "^6.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1"
@@ -68,7 +68,6 @@
 		"@atlaskit/editor-plugin-quick-insert": "^3.0.0",
 		"@atlaskit/editor-plugin-type-ahead": "^3.1.0",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlaskit/visual-regression": "workspace:^",
 		"@testing-library/react": "^13.4.0",
 		"@testing-library/user-event": "^14.4.3",
 		"wait-for-expect": "^1.2.0"