@atlaskit/editor-plugin-block-type 12.1.8 → 12.1.9

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-block-type
 
+## 12.1.9
+
+### Patch Changes
+
+- [`ceefea718fc6d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ceefea718fc6d) -
+  Add keyboard shortcut (Cmd+Opt+7 on Mac, Ctrl+Alt+7 on Windows) for the small text feature in the
+  editor, gated behind the platform_editor_small_font_size experiment. Also adds the shortcut to the
+  toolbar tooltip and help dialog.
+- [`d7123d7a16015`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d7123d7a16015) -
+  Use TextSmallIcon instead of TextIcon for small text block type
+- Updated dependencies
+
 ## 12.1.8
 
 ### Patch Changes

package/dist/cjs/pm-plugins/block-types.js

@@ -36,7 +36,7 @@ var SMALL_TEXT = exports.SMALL_TEXT = {
   title: _messages.blockTypeMessages.smallText,
   nodeName: 'paragraph',
   markName: 'fontSize',
-  icon: /*#__PURE__*/_react.default.createElement(_text.default, {
+  icon: /*#__PURE__*/_react.default.createElement(_editorToolbar.TextSmallIcon, {
     label: ""
   }),
   LEGACY_icon: /*#__PURE__*/_react.default.createElement(_icons.Text, null)
@@ -153,7 +153,7 @@ var toolbarBlockTypesWithRank = exports.toolbarBlockTypesWithRank = function too
     })
   }, allowFontSize && (0, _expValEquals.expValEquals)('platform_editor_small_font_size', 'isEnabled', true) && {
     smallText: _objectSpread(_objectSpread({}, SMALL_TEXT), {}, {
-      icon: /*#__PURE__*/_react.default.createElement(_text.default, {
+      icon: /*#__PURE__*/_react.default.createElement(_editorToolbar.TextSmallIcon, {
         size: "small",
         label: ""
       }),

package/dist/cjs/pm-plugins/consts.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.HEADING_NUMPAD_KEYS = exports.HEADING_KEYS = void 0;
+exports.KEY_7 = exports.HEADING_NUMPAD_KEYS = exports.HEADING_KEYS = void 0;
 var KEY_0 = 48;
 var KEY_1 = 49;
 var KEY_2 = 50;
@@ -11,6 +11,7 @@ var KEY_3 = 51;
 var KEY_4 = 52;
 var KEY_5 = 53;
 var KEY_6 = 54;
+var KEY_7 = exports.KEY_7 = 55;
 var HEADING_KEYS = exports.HEADING_KEYS = [KEY_0, KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, KEY_6];
 var NUMPAD_KEY_0 = 96;
 var NUMPAD_KEY_1 = 97;

package/dist/cjs/pm-plugins/main.js

@@ -164,6 +164,14 @@ var createPlugin = exports.createPlugin = function createPlugin(editorAPI, dispa
             var _editorAPI$core$actio2, _editorAPI$core2;
             return (_editorAPI$core$actio2 = editorAPI === null || editorAPI === void 0 || (_editorAPI$core2 = editorAPI.core) === null || _editorAPI$core2 === void 0 ? void 0 : _editorAPI$core2.actions.execute(autoformatHeading(headingLevel, editorAnalyticsApi))) !== null && _editorAPI$core$actio2 !== void 0 ? _editorAPI$core$actio2 : false;
           }
+        } else if (event.keyCode === _consts.KEY_7 && event.altKey && (0, _expValEquals.expValEquals)('platform_editor_small_font_size', 'isEnabled', true)) {
+          if (browser.mac && event.metaKey) {
+            var _editorAPI$core$actio3, _editorAPI$core3;
+            return (_editorAPI$core$actio3 = editorAPI === null || editorAPI === void 0 || (_editorAPI$core3 = editorAPI.core) === null || _editorAPI$core3 === void 0 ? void 0 : _editorAPI$core3.actions.execute((0, _blockType.setSmallTextWithAnalytics)(_analytics.INPUT_METHOD.SHORTCUT, editorAnalyticsApi))) !== null && _editorAPI$core$actio3 !== void 0 ? _editorAPI$core$actio3 : false;
+          } else if (!browser.mac && event.ctrlKey && altKeyLocation !== event.DOM_KEY_LOCATION_RIGHT) {
+            var _editorAPI$core$actio4, _editorAPI$core4;
+            return (_editorAPI$core$actio4 = editorAPI === null || editorAPI === void 0 || (_editorAPI$core4 = editorAPI.core) === null || _editorAPI$core4 === void 0 ? void 0 : _editorAPI$core4.actions.execute((0, _blockType.setSmallTextWithAnalytics)(_analytics.INPUT_METHOD.SHORTCUT, editorAnalyticsApi))) !== null && _editorAPI$core$actio4 !== void 0 ? _editorAPI$core$actio4 : false;
+          }
         } else if (event.key === 'Alt') {
           // event.location is for the current key only; when a user hits Ctrl-Alt-1 the
           // location refers to the location of the '1' key

package/dist/cjs/pm-plugins/ui/ToolbarBlockType/HeadingButton.js

@@ -105,11 +105,7 @@ var headingSizeStylesMap = {
 };
 var shortcuts = {
   normal: _keymaps.setNormalText,
-  smallText: {
-    description: '',
-    mac: '',
-    windows: ''
-  },
+  smallText: _keymaps.toggleSmallText,
   heading1: _keymaps.toggleHeading1,
   heading2: _keymaps.toggleHeading2,
   heading3: _keymaps.toggleHeading3,

package/dist/es2019/pm-plugins/block-types.js

@@ -1,7 +1,7 @@
 import React from 'react';
 import { blockTypeMessages as messages } from '@atlaskit/editor-common/messages';
 import { BLOCK_QUOTE_MENU_ITEM, HEADING_1_MENU_ITEM, HEADING_2_MENU_ITEM, HEADING_3_MENU_ITEM, HEADING_4_MENU_ITEM, HEADING_5_MENU_ITEM, HEADING_6_MENU_ITEM, NORMAL_TEXT_MENU_ITEM, SMALL_TEXT_MENU_ITEM, TEXT_STYLES_MENU_SECTION_RANK } from '@atlaskit/editor-common/toolbar';
-import { TextIcon as EditorToolbarTextIcon, QuoteIcon, HeadingOneIcon, HeadingTwoIcon, HeadingThreeIcon, HeadingFourIcon, HeadingFiveIcon, HeadingSixIcon } from '@atlaskit/editor-toolbar';
+import { TextIcon as EditorToolbarTextIcon, QuoteIcon, HeadingOneIcon, HeadingTwoIcon, HeadingThreeIcon, HeadingFourIcon, HeadingFiveIcon, HeadingSixIcon, TextSmallIcon } from '@atlaskit/editor-toolbar';
 import TextHeadingFiveIcon from '@atlaskit/icon-lab/core/text-heading-five';
 import TextHeadingFourIcon from '@atlaskit/icon-lab/core/text-heading-four';
 import TextHeadingOneIcon from '@atlaskit/icon-lab/core/text-heading-one';
@@ -26,7 +26,7 @@ export const SMALL_TEXT = {
   title: messages.smallText,
   nodeName: 'paragraph',
   markName: 'fontSize',
-  icon: /*#__PURE__*/React.createElement(TextIcon, {
+  icon: /*#__PURE__*/React.createElement(TextSmallIcon, {
     label: ""
   }),
   LEGACY_icon: /*#__PURE__*/React.createElement(Text, null)
@@ -145,7 +145,7 @@ export const toolbarBlockTypesWithRank = ({
   ...(allowFontSize && expValEquals('platform_editor_small_font_size', 'isEnabled', true) && {
     smallText: {
       ...SMALL_TEXT,
-      icon: /*#__PURE__*/React.createElement(TextIcon, {
+      icon: /*#__PURE__*/React.createElement(TextSmallIcon, {
         size: "small",
         label: ""
       }),

package/dist/es2019/pm-plugins/consts.js

@@ -5,6 +5,7 @@ const KEY_3 = 51;
 const KEY_4 = 52;
 const KEY_5 = 53;
 const KEY_6 = 54;
+export const KEY_7 = 55;
 export const HEADING_KEYS = [KEY_0, KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, KEY_6];
 const NUMPAD_KEY_0 = 96;
 const NUMPAD_KEY_1 = 97;

package/dist/es2019/pm-plugins/main.js

@@ -5,8 +5,8 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { BLOCK_QUOTE, CODE_BLOCK, HEADING_1, HEADING_2, HEADING_3, HEADING_4, HEADING_5, HEADING_6, HEADINGS_BY_LEVEL, NORMAL_TEXT, OTHER, PANEL, TEXT_BLOCK_TYPES, WRAPPER_BLOCK_TYPES, getBlockTypesInDropdown, SMALL_TEXT } from './block-types';
-import { setHeadingWithAnalytics, setNormalTextWithAnalytics } from './commands/block-type';
-import { HEADING_KEYS, HEADING_NUMPAD_KEYS } from './consts';
+import { setHeadingWithAnalytics, setNormalTextWithAnalytics, setSmallTextWithAnalytics } from './commands/block-type';
+import { HEADING_KEYS, HEADING_NUMPAD_KEYS, KEY_7 } from './consts';
 import { areBlockTypesDisabled, checkFormattingIsPresent, hasBlockQuoteInOptions } from './utils';
 const blockTypeForNode = (node, schema) => {
   if (node.type === schema.nodes.heading) {
@@ -148,6 +148,14 @@ export const createPlugin = (editorAPI, dispatch, lastNodeMustBeParagraph, inclu
             var _editorAPI$core$actio2, _editorAPI$core2;
             return (_editorAPI$core$actio2 = editorAPI === null || editorAPI === void 0 ? void 0 : (_editorAPI$core2 = editorAPI.core) === null || _editorAPI$core2 === void 0 ? void 0 : _editorAPI$core2.actions.execute(autoformatHeading(headingLevel, editorAnalyticsApi))) !== null && _editorAPI$core$actio2 !== void 0 ? _editorAPI$core$actio2 : false;
           }
+        } else if (event.keyCode === KEY_7 && event.altKey && expValEquals('platform_editor_small_font_size', 'isEnabled', true)) {
+          if (browser.mac && event.metaKey) {
+            var _editorAPI$core$actio3, _editorAPI$core3;
+            return (_editorAPI$core$actio3 = editorAPI === null || editorAPI === void 0 ? void 0 : (_editorAPI$core3 = editorAPI.core) === null || _editorAPI$core3 === void 0 ? void 0 : _editorAPI$core3.actions.execute(setSmallTextWithAnalytics(INPUT_METHOD.SHORTCUT, editorAnalyticsApi))) !== null && _editorAPI$core$actio3 !== void 0 ? _editorAPI$core$actio3 : false;
+          } else if (!browser.mac && event.ctrlKey && altKeyLocation !== event.DOM_KEY_LOCATION_RIGHT) {
+            var _editorAPI$core$actio4, _editorAPI$core4;
+            return (_editorAPI$core$actio4 = editorAPI === null || editorAPI === void 0 ? void 0 : (_editorAPI$core4 = editorAPI.core) === null || _editorAPI$core4 === void 0 ? void 0 : _editorAPI$core4.actions.execute(setSmallTextWithAnalytics(INPUT_METHOD.SHORTCUT, editorAnalyticsApi))) !== null && _editorAPI$core$actio4 !== void 0 ? _editorAPI$core$actio4 : false;
+          }
         } else if (event.key === 'Alt') {
           // event.location is for the current key only; when a user hits Ctrl-Alt-1 the
           // location refers to the location of the '1' key

package/dist/es2019/pm-plugins/ui/ToolbarBlockType/HeadingButton.js

@@ -6,7 +6,7 @@ import * as React from 'react';
 import { ax, ix } from "@compiled/react/runtime";
 import { useIntl } from 'react-intl-next';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import { formatShortcut, setNormalText, toggleHeading1, toggleHeading2, toggleHeading3, toggleHeading4, toggleHeading5, toggleHeading6 } from '@atlaskit/editor-common/keymaps';
+import { formatShortcut, setNormalText, toggleHeading1, toggleHeading2, toggleHeading3, toggleHeading4, toggleHeading5, toggleHeading6, toggleSmallText } from '@atlaskit/editor-common/keymaps';
 import { useEditorToolbar } from '@atlaskit/editor-common/toolbar';
 import { editorUGCToken } from '@atlaskit/editor-common/ugc-tokens';
 import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared-plugin-state-selector';
@@ -98,11 +98,7 @@ const headingSizeStylesMap = {
 };
 const shortcuts = {
   normal: setNormalText,
-  smallText: {
-    description: '',
-    mac: '',
-    windows: ''
-  },
+  smallText: toggleSmallText,
   heading1: toggleHeading1,
   heading2: toggleHeading2,
   heading3: toggleHeading3,

package/dist/esm/pm-plugins/block-types.js

@@ -4,7 +4,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import React from 'react';
 import { blockTypeMessages as messages } from '@atlaskit/editor-common/messages';
 import { BLOCK_QUOTE_MENU_ITEM, HEADING_1_MENU_ITEM, HEADING_2_MENU_ITEM, HEADING_3_MENU_ITEM, HEADING_4_MENU_ITEM, HEADING_5_MENU_ITEM, HEADING_6_MENU_ITEM, NORMAL_TEXT_MENU_ITEM, SMALL_TEXT_MENU_ITEM, TEXT_STYLES_MENU_SECTION_RANK } from '@atlaskit/editor-common/toolbar';
-import { TextIcon as EditorToolbarTextIcon, QuoteIcon, HeadingOneIcon, HeadingTwoIcon, HeadingThreeIcon, HeadingFourIcon, HeadingFiveIcon, HeadingSixIcon } from '@atlaskit/editor-toolbar';
+import { TextIcon as EditorToolbarTextIcon, QuoteIcon, HeadingOneIcon, HeadingTwoIcon, HeadingThreeIcon, HeadingFourIcon, HeadingFiveIcon, HeadingSixIcon, TextSmallIcon } from '@atlaskit/editor-toolbar';
 import TextHeadingFiveIcon from '@atlaskit/icon-lab/core/text-heading-five';
 import TextHeadingFourIcon from '@atlaskit/icon-lab/core/text-heading-four';
 import TextHeadingOneIcon from '@atlaskit/icon-lab/core/text-heading-one';
@@ -29,7 +29,7 @@ export var SMALL_TEXT = {
   title: messages.smallText,
   nodeName: 'paragraph',
   markName: 'fontSize',
-  icon: /*#__PURE__*/React.createElement(TextIcon, {
+  icon: /*#__PURE__*/React.createElement(TextSmallIcon, {
     label: ""
   }),
   LEGACY_icon: /*#__PURE__*/React.createElement(Text, null)
@@ -146,7 +146,7 @@ export var toolbarBlockTypesWithRank = function toolbarBlockTypesWithRank(_ref)
     })
   }, allowFontSize && expValEquals('platform_editor_small_font_size', 'isEnabled', true) && {
     smallText: _objectSpread(_objectSpread({}, SMALL_TEXT), {}, {
-      icon: /*#__PURE__*/React.createElement(TextIcon, {
+      icon: /*#__PURE__*/React.createElement(TextSmallIcon, {
         size: "small",
         label: ""
       }),

package/dist/esm/pm-plugins/consts.js

@@ -5,6 +5,7 @@ var KEY_3 = 51;
 var KEY_4 = 52;
 var KEY_5 = 53;
 var KEY_6 = 54;
+export var KEY_7 = 55;
 export var HEADING_KEYS = [KEY_0, KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, KEY_6];
 var NUMPAD_KEY_0 = 96;
 var NUMPAD_KEY_1 = 97;

package/dist/esm/pm-plugins/main.js

@@ -8,8 +8,8 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { BLOCK_QUOTE, CODE_BLOCK, HEADING_1, HEADING_2, HEADING_3, HEADING_4, HEADING_5, HEADING_6, HEADINGS_BY_LEVEL, NORMAL_TEXT, OTHER, PANEL, TEXT_BLOCK_TYPES, WRAPPER_BLOCK_TYPES, getBlockTypesInDropdown, SMALL_TEXT } from './block-types';
-import { setHeadingWithAnalytics, setNormalTextWithAnalytics } from './commands/block-type';
-import { HEADING_KEYS, HEADING_NUMPAD_KEYS } from './consts';
+import { setHeadingWithAnalytics, setNormalTextWithAnalytics, setSmallTextWithAnalytics } from './commands/block-type';
+import { HEADING_KEYS, HEADING_NUMPAD_KEYS, KEY_7 } from './consts';
 import { areBlockTypesDisabled, checkFormattingIsPresent, hasBlockQuoteInOptions } from './utils';
 var blockTypeForNode = function blockTypeForNode(node, schema) {
   if (node.type === schema.nodes.heading) {
@@ -157,6 +157,14 @@ export var createPlugin = function createPlugin(editorAPI, dispatch, lastNodeMus
             var _editorAPI$core$actio2, _editorAPI$core2;
             return (_editorAPI$core$actio2 = editorAPI === null || editorAPI === void 0 || (_editorAPI$core2 = editorAPI.core) === null || _editorAPI$core2 === void 0 ? void 0 : _editorAPI$core2.actions.execute(autoformatHeading(headingLevel, editorAnalyticsApi))) !== null && _editorAPI$core$actio2 !== void 0 ? _editorAPI$core$actio2 : false;
           }
+        } else if (event.keyCode === KEY_7 && event.altKey && expValEquals('platform_editor_small_font_size', 'isEnabled', true)) {
+          if (browser.mac && event.metaKey) {
+            var _editorAPI$core$actio3, _editorAPI$core3;
+            return (_editorAPI$core$actio3 = editorAPI === null || editorAPI === void 0 || (_editorAPI$core3 = editorAPI.core) === null || _editorAPI$core3 === void 0 ? void 0 : _editorAPI$core3.actions.execute(setSmallTextWithAnalytics(INPUT_METHOD.SHORTCUT, editorAnalyticsApi))) !== null && _editorAPI$core$actio3 !== void 0 ? _editorAPI$core$actio3 : false;
+          } else if (!browser.mac && event.ctrlKey && altKeyLocation !== event.DOM_KEY_LOCATION_RIGHT) {
+            var _editorAPI$core$actio4, _editorAPI$core4;
+            return (_editorAPI$core$actio4 = editorAPI === null || editorAPI === void 0 || (_editorAPI$core4 = editorAPI.core) === null || _editorAPI$core4 === void 0 ? void 0 : _editorAPI$core4.actions.execute(setSmallTextWithAnalytics(INPUT_METHOD.SHORTCUT, editorAnalyticsApi))) !== null && _editorAPI$core$actio4 !== void 0 ? _editorAPI$core$actio4 : false;
+          }
         } else if (event.key === 'Alt') {
           // event.location is for the current key only; when a user hits Ctrl-Alt-1 the
           // location refers to the location of the '1' key

package/dist/esm/pm-plugins/ui/ToolbarBlockType/HeadingButton.js

@@ -6,7 +6,7 @@ import * as React from 'react';
 import { ax, ix } from "@compiled/react/runtime";
 import { useIntl } from 'react-intl-next';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import { formatShortcut, setNormalText, toggleHeading1, toggleHeading2, toggleHeading3, toggleHeading4, toggleHeading5, toggleHeading6 } from '@atlaskit/editor-common/keymaps';
+import { formatShortcut, setNormalText, toggleHeading1, toggleHeading2, toggleHeading3, toggleHeading4, toggleHeading5, toggleHeading6, toggleSmallText } from '@atlaskit/editor-common/keymaps';
 import { useEditorToolbar } from '@atlaskit/editor-common/toolbar';
 import { editorUGCToken } from '@atlaskit/editor-common/ugc-tokens';
 import { useSharedPluginStateSelector } from '@atlaskit/editor-common/use-shared-plugin-state-selector';
@@ -97,11 +97,7 @@ var headingSizeStylesMap = {
 };
 var shortcuts = {
   normal: setNormalText,
-  smallText: {
-    description: '',
-    mac: '',
-    windows: ''
-  },
+  smallText: toggleSmallText,
   heading1: toggleHeading1,
   heading2: toggleHeading2,
   heading3: toggleHeading3,

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

@@ -1,2 +1,3 @@
+export declare const KEY_7 = 55;
 export declare const HEADING_KEYS: number[];
 export declare const HEADING_NUMPAD_KEYS: number[];

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

@@ -1,2 +1,3 @@
+export declare const KEY_7 = 55;
 export declare const HEADING_KEYS: number[];
 export declare const HEADING_NUMPAD_KEYS: number[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-type",
-	"version": "12.1.8",
+	"version": "12.1.9",
 	"description": "BlockType plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,7 +33,7 @@
 		"@atlaskit/css": "^0.19.0",
 		"@atlaskit/editor-plugin-analytics": "^8.0.0",
 		"@atlaskit/editor-plugin-block-menu": "^7.0.0",
-		"@atlaskit/editor-plugin-list": "^10.0.0",
+		"@atlaskit/editor-plugin-list": "^10.1.0",
 		"@atlaskit/editor-plugin-primary-toolbar": "^9.0.0",
 		"@atlaskit/editor-plugin-selection": "^8.0.0",
 		"@atlaskit/editor-plugin-selection-toolbar": "^9.0.0",
@@ -50,14 +50,14 @@
 		"@atlaskit/prosemirror-history": "^0.2.0",
 		"@atlaskit/prosemirror-input-rules": "^3.6.0",
 		"@atlaskit/theme": "^22.0.0",
-		"@atlaskit/tmp-editor-statsig": "^44.0.0",
+		"@atlaskit/tmp-editor-statsig": "^44.2.0",
 		"@atlaskit/tokens": "^11.1.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0",
 		"@emotion/react": "^11.7.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.7.0",
+		"@atlaskit/editor-common": "^112.8.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"