@atlaskit/editor-plugin-loom 9.3.2 → 9.3.3

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-loom
 
+## 9.3.3
+
+### Patch Changes
+
+- [`52d4b8fab3118`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/52d4b8fab3118) -
+  Add platform_editor_toolbar_hide_overflow_menu experiment, add logic to hide menu button if there
+  are no menu items rendered
+- Updated dependencies
+
 ## 9.3.2
 
 ### Patch Changes

package/dist/cjs/ui/LoomMenuItem.js

@@ -4,7 +4,7 @@ var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.LoomMenuItem = void 0;
+exports.LoomMenuItem = exports.CustomisableLoomMenuItem = void 0;
 var _react = _interopRequireWildcard(require("react"));
 var _reactIntlNext = require("react-intl-next");
 var _hooks = require("@atlaskit/editor-common/hooks");
@@ -40,7 +40,7 @@ var LoomMenuItem = exports.LoomMenuItem = function LoomMenuItem(_ref) {
     });
   }
 };
-var CustomisableLoomMenuItem = function CustomisableLoomMenuItem(api) {
+var CustomisableLoomMenuItem = exports.CustomisableLoomMenuItem = function CustomisableLoomMenuItem(api) {
   return /*#__PURE__*/_react.default.forwardRef(function (_ref2, ref) {
     var _ref2$isDisabled = _ref2.isDisabled,
       isDisabled = _ref2$isDisabled === void 0 ? false : _ref2$isDisabled,

package/dist/cjs/ui/toolbar-components.js

@@ -41,6 +41,14 @@ var getToolbarComponents = exports.getToolbarComponents = function getToolbarCom
         api: api,
         renderButton: config.renderButton
       });
+    },
+    isHidden: function isHidden() {
+      var _api$loom, _api$editorViewMode$s, _api$editorViewMode, _config$shouldRenderB, _config$shouldRenderB2;
+      var loomState = api === null || api === void 0 || (_api$loom = api.loom) === null || _api$loom === void 0 ? void 0 : _api$loom.sharedState.currentState();
+      var editorViewMode = (_api$editorViewMode$s = api === null || api === void 0 || (_api$editorViewMode = api.editorViewMode) === null || _api$editorViewMode === void 0 ? void 0 : _api$editorViewMode.sharedState.currentState()) !== null && _api$editorViewMode$s !== void 0 ? _api$editorViewMode$s : 'edit';
+      // if shouldRenderButton is not provided, default to true
+      var shouldRenderButton = (_config$shouldRenderB = config === null || config === void 0 || (_config$shouldRenderB2 = config.shouldRenderButton) === null || _config$shouldRenderB2 === void 0 ? void 0 : _config$shouldRenderB2.call(config)) !== null && _config$shouldRenderB !== void 0 ? _config$shouldRenderB : true;
+      return 'renderButton' in config && shouldRenderButton === false || (loomState === null || loomState === void 0 ? void 0 : loomState.isEnabled) === undefined || editorViewMode !== 'edit';
     }
   }];
 };

package/dist/es2019/ui/LoomMenuItem.js

@@ -35,7 +35,7 @@ export const LoomMenuItem = ({
     });
   }
 };
-const CustomisableLoomMenuItem = api => /*#__PURE__*/React.forwardRef(({
+export const CustomisableLoomMenuItem = api => /*#__PURE__*/React.forwardRef(({
   isDisabled = false,
   onClickBeforeInit,
   href,

package/dist/es2019/ui/toolbar-components.js

@@ -35,6 +35,14 @@ export const getToolbarComponents = (config, api) => {
         api: api,
         renderButton: config.renderButton
       });
+    },
+    isHidden: () => {
+      var _api$loom, _api$editorViewMode$s, _api$editorViewMode, _config$shouldRenderB, _config$shouldRenderB2;
+      const loomState = api === null || api === void 0 ? void 0 : (_api$loom = api.loom) === null || _api$loom === void 0 ? void 0 : _api$loom.sharedState.currentState();
+      const editorViewMode = (_api$editorViewMode$s = api === null || api === void 0 ? void 0 : (_api$editorViewMode = api.editorViewMode) === null || _api$editorViewMode === void 0 ? void 0 : _api$editorViewMode.sharedState.currentState()) !== null && _api$editorViewMode$s !== void 0 ? _api$editorViewMode$s : 'edit';
+      // if shouldRenderButton is not provided, default to true
+      const shouldRenderButton = (_config$shouldRenderB = config === null || config === void 0 ? void 0 : (_config$shouldRenderB2 = config.shouldRenderButton) === null || _config$shouldRenderB2 === void 0 ? void 0 : _config$shouldRenderB2.call(config)) !== null && _config$shouldRenderB !== void 0 ? _config$shouldRenderB : true;
+      return 'renderButton' in config && shouldRenderButton === false || (loomState === null || loomState === void 0 ? void 0 : loomState.isEnabled) === undefined || editorViewMode !== 'edit';
     }
   }];
 };

package/dist/esm/ui/LoomMenuItem.js

@@ -32,7 +32,7 @@ export var LoomMenuItem = function LoomMenuItem(_ref) {
     });
   }
 };
-var CustomisableLoomMenuItem = function CustomisableLoomMenuItem(api) {
+export var CustomisableLoomMenuItem = function CustomisableLoomMenuItem(api) {
   return /*#__PURE__*/React.forwardRef(function (_ref2, ref) {
     var _ref2$isDisabled = _ref2.isDisabled,
       isDisabled = _ref2$isDisabled === void 0 ? false : _ref2$isDisabled,

package/dist/esm/ui/toolbar-components.js

@@ -34,6 +34,14 @@ export var getToolbarComponents = function getToolbarComponents(config, api) {
         api: api,
         renderButton: config.renderButton
       });
+    },
+    isHidden: function isHidden() {
+      var _api$loom, _api$editorViewMode$s, _api$editorViewMode, _config$shouldRenderB, _config$shouldRenderB2;
+      var loomState = api === null || api === void 0 || (_api$loom = api.loom) === null || _api$loom === void 0 ? void 0 : _api$loom.sharedState.currentState();
+      var editorViewMode = (_api$editorViewMode$s = api === null || api === void 0 || (_api$editorViewMode = api.editorViewMode) === null || _api$editorViewMode === void 0 ? void 0 : _api$editorViewMode.sharedState.currentState()) !== null && _api$editorViewMode$s !== void 0 ? _api$editorViewMode$s : 'edit';
+      // if shouldRenderButton is not provided, default to true
+      var shouldRenderButton = (_config$shouldRenderB = config === null || config === void 0 || (_config$shouldRenderB2 = config.shouldRenderButton) === null || _config$shouldRenderB2 === void 0 ? void 0 : _config$shouldRenderB2.call(config)) !== null && _config$shouldRenderB !== void 0 ? _config$shouldRenderB : true;
+      return 'renderButton' in config && shouldRenderButton === false || (loomState === null || loomState === void 0 ? void 0 : loomState.isEnabled) === undefined || editorViewMode !== 'edit';
     }
   }];
 };

package/dist/types/loomPluginType.d.ts

@@ -3,6 +3,7 @@ import { type INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { ConnectivityPlugin } from '@atlaskit/editor-plugin-connectivity';
+import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { HyperlinkPlugin } from '@atlaskit/editor-plugin-hyperlink';
 import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 import { type QuickInsertPlugin } from '@atlaskit/editor-plugin-quick-insert';
@@ -41,7 +42,8 @@ export type LoomPlugin = NextEditorPlugin<'loom', {
         OptionalPlugin<PrimaryToolbarPlugin>,
         OptionalPlugin<QuickInsertPlugin>,
         OptionalPlugin<ConnectivityPlugin>,
-        OptionalPlugin<ToolbarPlugin>
+        OptionalPlugin<ToolbarPlugin>,
+        OptionalPlugin<EditorViewModePlugin>
     ];
     pluginConfiguration: LoomPluginOptions;
     sharedState: LoomPluginState | undefined;

package/dist/types/types/index.d.ts

@@ -44,6 +44,11 @@ export type LoomPluginOptionsWithProvider = {
      * @param ButtonComponent Loom toolbar button component (mainly UI)
      */
     renderButton?: RenderButton;
+    /**
+     * Due to contrainsts with the toolbar model the menu needs to know if any menu items will truely render. Right now
+     * it's not possible to inspect the output of renderButton to detemine this so we need to pass it in as a prop.
+     */
+    shouldRenderButton?: () => boolean;
     shouldShowToolbarButton?: boolean;
 };
 export type LoomPluginOptionsWithoutProvider = {
@@ -55,6 +60,11 @@ export type LoomPluginOptionsWithoutProvider = {
      * @param ButtonComponent Loom toolbar button component (mainly UI)
      */
     renderButton: RenderButton;
+    /**
+     * Due to contrainsts with the toolbar model the menu needs to know if any menu items will truely render. Right now
+     * it's not possible to inspect the output of renderButton to detemine this so we need to pass it in as a prop.
+     */
+    shouldRenderButton?: () => boolean;
     shouldShowToolbarButton?: boolean;
 };
 export type LoomPluginOptions = LoomPluginOptionsWithProvider | LoomPluginOptionsWithoutProvider;

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

@@ -1,6 +1,8 @@
+import React from 'react';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { LoomPlugin } from '../loomPluginType';
-import type { LoomPluginOptions } from '../types';
+import type { ButtonComponentProps, LoomPluginOptions } from '../types';
 export declare const LoomMenuItem: ({ api, renderButton, }: {
     api: ExtractInjectionAPI<LoomPlugin> | undefined;
 } & Pick<LoomPluginOptions, "renderButton">) => JSX.Element | null | undefined;
+export declare const CustomisableLoomMenuItem: (api: ExtractInjectionAPI<LoomPlugin> | undefined) => React.ForwardRefExoticComponent<ButtonComponentProps & React.RefAttributes<HTMLElement>>;

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

@@ -3,6 +3,7 @@ import { type INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import type { EditorCommand, NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { ConnectivityPlugin } from '@atlaskit/editor-plugin-connectivity';
+import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { HyperlinkPlugin } from '@atlaskit/editor-plugin-hyperlink';
 import type { PrimaryToolbarPlugin } from '@atlaskit/editor-plugin-primary-toolbar';
 import { type QuickInsertPlugin } from '@atlaskit/editor-plugin-quick-insert';
@@ -41,7 +42,8 @@ export type LoomPlugin = NextEditorPlugin<'loom', {
         OptionalPlugin<PrimaryToolbarPlugin>,
         OptionalPlugin<QuickInsertPlugin>,
         OptionalPlugin<ConnectivityPlugin>,
-        OptionalPlugin<ToolbarPlugin>
+        OptionalPlugin<ToolbarPlugin>,
+        OptionalPlugin<EditorViewModePlugin>
     ];
     pluginConfiguration: LoomPluginOptions;
     sharedState: LoomPluginState | undefined;

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

@@ -44,6 +44,11 @@ export type LoomPluginOptionsWithProvider = {
      * @param ButtonComponent Loom toolbar button component (mainly UI)
      */
     renderButton?: RenderButton;
+    /**
+     * Due to contrainsts with the toolbar model the menu needs to know if any menu items will truely render. Right now
+     * it's not possible to inspect the output of renderButton to detemine this so we need to pass it in as a prop.
+     */
+    shouldRenderButton?: () => boolean;
     shouldShowToolbarButton?: boolean;
 };
 export type LoomPluginOptionsWithoutProvider = {
@@ -55,6 +60,11 @@ export type LoomPluginOptionsWithoutProvider = {
      * @param ButtonComponent Loom toolbar button component (mainly UI)
      */
     renderButton: RenderButton;
+    /**
+     * Due to contrainsts with the toolbar model the menu needs to know if any menu items will truely render. Right now
+     * it's not possible to inspect the output of renderButton to detemine this so we need to pass it in as a prop.
+     */
+    shouldRenderButton?: () => boolean;
     shouldShowToolbarButton?: boolean;
 };
 export type LoomPluginOptions = LoomPluginOptionsWithProvider | LoomPluginOptionsWithoutProvider;

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

@@ -1,6 +1,8 @@
+import React from 'react';
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { LoomPlugin } from '../loomPluginType';
-import type { LoomPluginOptions } from '../types';
+import type { ButtonComponentProps, LoomPluginOptions } from '../types';
 export declare const LoomMenuItem: ({ api, renderButton, }: {
     api: ExtractInjectionAPI<LoomPlugin> | undefined;
 } & Pick<LoomPluginOptions, "renderButton">) => JSX.Element | null | undefined;
+export declare const CustomisableLoomMenuItem: (api: ExtractInjectionAPI<LoomPlugin> | undefined) => React.ForwardRefExoticComponent<ButtonComponentProps & React.RefAttributes<HTMLElement>>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-loom",
-	"version": "9.3.2",
+	"version": "9.3.3",
 	"description": "Loom plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -35,9 +35,10 @@
 		"@atlaskit/button": "^23.9.0",
 		"@atlaskit/editor-plugin-analytics": "^7.0.0",
 		"@atlaskit/editor-plugin-connectivity": "^7.0.0",
+		"@atlaskit/editor-plugin-editor-viewmode": "^9.0.0",
 		"@atlaskit/editor-plugin-hyperlink": "^9.0.0",
 		"@atlaskit/editor-plugin-primary-toolbar": "^8.0.0",
-		"@atlaskit/editor-plugin-quick-insert": "^7.3.0",
+		"@atlaskit/editor-plugin-quick-insert": "^7.4.0",
 		"@atlaskit/editor-plugin-toolbar": "^4.1.0",
 		"@atlaskit/editor-plugin-width": "^8.1.0",
 		"@atlaskit/editor-prosemirror": "^7.3.0",
@@ -47,10 +48,10 @@
 		"@atlaskit/tokens": "^11.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1",
-		"@loomhq/record-sdk": "^4.9.0"
+		"@loomhq/record-sdk": "^4.9.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.12.0",
+		"@atlaskit/editor-common": "^111.19.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"