@atlaskit/editor-plugin-selection-toolbar 9.0.15 → 9.1.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-plugin-selection-toolbar
 
+## 9.1.0
+
+### Minor Changes
+
+- [`87752e143e30f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/87752e143e30f) -
+  PGXT-9997 introduce an option to disable the pin option in the selection toolbar
+
 ## 9.0.15
 
 ### Patch Changes

package/dist/cjs/selectionToolbarPlugin.js

@@ -43,7 +43,8 @@ var selectionToolbarPlugin = exports.selectionToolbarPlugin = function selection
   var primaryToolbarComponent;
   var isToolbarAIFCEnabled = Boolean(api === null || api === void 0 ? void 0 : api.toolbar);
   var userPreferencesProvider = config.userPreferencesProvider,
-    contextualFormattingEnabled = config.contextualFormattingEnabled;
+    contextualFormattingEnabled = config.contextualFormattingEnabled,
+    disablePin = config.disablePin;
   if (isToolbarAIFCEnabled) {
     var _api$toolbar;
     /**
@@ -51,7 +52,7 @@ var selectionToolbarPlugin = exports.selectionToolbarPlugin = function selection
      */
     if ((api === null || api === void 0 || (_api$toolbar = api.toolbar) === null || _api$toolbar === void 0 ? void 0 : _api$toolbar.actions.contextualFormattingMode()) === 'controlled') {
       var _api$toolbar2;
-      api === null || api === void 0 || (_api$toolbar2 = api.toolbar) === null || _api$toolbar2 === void 0 || _api$toolbar2.actions.registerComponents((0, _toolbarComponents.getToolbarComponents)(api, true));
+      api === null || api === void 0 || (_api$toolbar2 = api.toolbar) === null || _api$toolbar2 === void 0 || _api$toolbar2.actions.registerComponents((0, _toolbarComponents.getToolbarComponents)(api, true, disablePin));
     }
   } else {
     if ((0, _experiments.editorExperiment)('platform_editor_controls', 'variant1', {

package/dist/cjs/ui/PinMenuItem.js

@@ -29,14 +29,15 @@ var usePluginState = function usePluginState(_api) {
  * The menu-item version of pin only appears in selection toolbar - the primary toolbar will have its own component
  */
 var PinMenuItem = exports.PinMenuItem = function PinMenuItem(_ref) {
-  var api = _ref.api;
+  var api = _ref.api,
+    disablePin = _ref.disablePin;
   var intl = (0, _reactIntlNext.useIntl)();
   var _usePluginState = usePluginState(api),
     editorViewMode = _usePluginState.editorViewMode,
     editorToolbarDockingPreference = _usePluginState.editorToolbarDockingPreference,
     isDisabled = _usePluginState.isOffline;
   var isToolbarDocked = editorToolbarDockingPreference === 'top';
-  if (!shouldShowPinMenuItem(editorViewMode)) {
+  if (disablePin || !shouldShowPinMenuItem(editorViewMode)) {
     return null;
   }
   var onClick = function onClick() {

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

@@ -10,7 +10,7 @@ var _toolbar = require("@atlaskit/editor-common/toolbar");
 var _MenuSection = require("./MenuSection");
 var _PinButton = require("./PinButton");
 var _PinMenuItem = require("./PinMenuItem");
-var getToolbarComponents = exports.getToolbarComponents = function getToolbarComponents(api, contextualFormattingEnabled) {
+var getToolbarComponents = exports.getToolbarComponents = function getToolbarComponents(api, contextualFormattingEnabled, disablePin) {
   var components = [{
     type: _toolbar.PIN_MENU_SECTION.type,
     key: _toolbar.PIN_MENU_SECTION.key,
@@ -35,7 +35,8 @@ var getToolbarComponents = exports.getToolbarComponents = function getToolbarCom
     }],
     component: function component() {
       return /*#__PURE__*/_react.default.createElement(_PinMenuItem.PinMenuItem, {
-        api: api
+        api: api,
+        disablePin: disablePin
       });
     }
   }];

package/dist/es2019/selectionToolbarPlugin.js

@@ -34,7 +34,8 @@ export const selectionToolbarPlugin = ({
   const isToolbarAIFCEnabled = Boolean(api === null || api === void 0 ? void 0 : api.toolbar);
   const {
     userPreferencesProvider,
-    contextualFormattingEnabled
+    contextualFormattingEnabled,
+    disablePin
   } = config;
   if (isToolbarAIFCEnabled) {
     var _api$toolbar;
@@ -43,7 +44,7 @@ export const selectionToolbarPlugin = ({
      */
     if ((api === null || api === void 0 ? void 0 : (_api$toolbar = api.toolbar) === null || _api$toolbar === void 0 ? void 0 : _api$toolbar.actions.contextualFormattingMode()) === 'controlled') {
       var _api$toolbar2;
-      api === null || api === void 0 ? void 0 : (_api$toolbar2 = api.toolbar) === null || _api$toolbar2 === void 0 ? void 0 : _api$toolbar2.actions.registerComponents(getToolbarComponents(api, true));
+      api === null || api === void 0 ? void 0 : (_api$toolbar2 = api.toolbar) === null || _api$toolbar2 === void 0 ? void 0 : _api$toolbar2.actions.registerComponents(getToolbarComponents(api, true, disablePin));
     }
   } else {
     if (editorExperiment('platform_editor_controls', 'variant1', {

package/dist/es2019/ui/PinMenuItem.js

@@ -23,7 +23,8 @@ const usePluginState = _api => {
  * The menu-item version of pin only appears in selection toolbar - the primary toolbar will have its own component
  */
 export const PinMenuItem = ({
-  api
+  api,
+  disablePin
 }) => {
   const intl = useIntl();
   const {
@@ -32,7 +33,7 @@ export const PinMenuItem = ({
     isOffline: isDisabled
   } = usePluginState(api);
   const isToolbarDocked = editorToolbarDockingPreference === 'top';
-  if (!shouldShowPinMenuItem(editorViewMode)) {
+  if (disablePin || !shouldShowPinMenuItem(editorViewMode)) {
     return null;
   }
   const onClick = () => {

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

@@ -3,7 +3,7 @@ import { OVERFLOW_MENU, OVERFLOW_MENU_RANK, PIN_BUTTON, PIN_GROUP, PIN_MENU_ITEM
 import { MenuSection } from './MenuSection';
 import { PinButton } from './PinButton';
 import { PinMenuItem } from './PinMenuItem';
-export const getToolbarComponents = (api, contextualFormattingEnabled) => {
+export const getToolbarComponents = (api, contextualFormattingEnabled, disablePin) => {
   const components = [{
     type: PIN_MENU_SECTION.type,
     key: PIN_MENU_SECTION.key,
@@ -29,7 +29,8 @@ export const getToolbarComponents = (api, contextualFormattingEnabled) => {
     }],
     component: () => {
       return /*#__PURE__*/React.createElement(PinMenuItem, {
-        api: api
+        api: api,
+        disablePin: disablePin
       });
     }
   }];

package/dist/esm/selectionToolbarPlugin.js

@@ -36,7 +36,8 @@ export var selectionToolbarPlugin = function selectionToolbarPlugin(_ref) {
   var primaryToolbarComponent;
   var isToolbarAIFCEnabled = Boolean(api === null || api === void 0 ? void 0 : api.toolbar);
   var userPreferencesProvider = config.userPreferencesProvider,
-    contextualFormattingEnabled = config.contextualFormattingEnabled;
+    contextualFormattingEnabled = config.contextualFormattingEnabled,
+    disablePin = config.disablePin;
   if (isToolbarAIFCEnabled) {
     var _api$toolbar;
     /**
@@ -44,7 +45,7 @@ export var selectionToolbarPlugin = function selectionToolbarPlugin(_ref) {
      */
     if ((api === null || api === void 0 || (_api$toolbar = api.toolbar) === null || _api$toolbar === void 0 ? void 0 : _api$toolbar.actions.contextualFormattingMode()) === 'controlled') {
       var _api$toolbar2;
-      api === null || api === void 0 || (_api$toolbar2 = api.toolbar) === null || _api$toolbar2 === void 0 || _api$toolbar2.actions.registerComponents(getToolbarComponents(api, true));
+      api === null || api === void 0 || (_api$toolbar2 = api.toolbar) === null || _api$toolbar2 === void 0 || _api$toolbar2.actions.registerComponents(getToolbarComponents(api, true, disablePin));
     }
   } else {
     if (editorExperiment('platform_editor_controls', 'variant1', {

package/dist/esm/ui/PinMenuItem.js

@@ -22,14 +22,15 @@ var usePluginState = function usePluginState(_api) {
  * The menu-item version of pin only appears in selection toolbar - the primary toolbar will have its own component
  */
 export var PinMenuItem = function PinMenuItem(_ref) {
-  var api = _ref.api;
+  var api = _ref.api,
+    disablePin = _ref.disablePin;
   var intl = useIntl();
   var _usePluginState = usePluginState(api),
     editorViewMode = _usePluginState.editorViewMode,
     editorToolbarDockingPreference = _usePluginState.editorToolbarDockingPreference,
     isDisabled = _usePluginState.isOffline;
   var isToolbarDocked = editorToolbarDockingPreference === 'top';
-  if (!shouldShowPinMenuItem(editorViewMode)) {
+  if (disablePin || !shouldShowPinMenuItem(editorViewMode)) {
     return null;
   }
   var onClick = function onClick() {

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

@@ -3,7 +3,7 @@ import { OVERFLOW_MENU, OVERFLOW_MENU_RANK, PIN_BUTTON, PIN_GROUP, PIN_MENU_ITEM
 import { MenuSection } from './MenuSection';
 import { PinButton } from './PinButton';
 import { PinMenuItem } from './PinMenuItem';
-export var getToolbarComponents = function getToolbarComponents(api, contextualFormattingEnabled) {
+export var getToolbarComponents = function getToolbarComponents(api, contextualFormattingEnabled, disablePin) {
   var components = [{
     type: PIN_MENU_SECTION.type,
     key: PIN_MENU_SECTION.key,
@@ -28,7 +28,8 @@ export var getToolbarComponents = function getToolbarComponents(api, contextualF
     }],
     component: function component() {
       return /*#__PURE__*/React.createElement(PinMenuItem, {
-        api: api
+        api: api,
+        disablePin: disablePin
       });
     }
   }];

package/dist/types/selectionToolbarPluginType.d.ts

@@ -16,6 +16,12 @@ export type SelectionToolbarPluginOptions = {
      * allows more control over toolbar placement.
      */
     contextualFormattingEnabled?: boolean;
+    /**
+     * When true, hides the pin/unpin option from the toolbar menu.
+     * Use this in contexts where toolbar docking should be permanently fixed
+     * @defaults false
+     */
+    disablePin?: boolean;
     /** @defaults false */
     preferenceToolbarAboveSelection?: boolean;
     userPreferencesProvider?: UserPreferencesProvider;

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

@@ -3,9 +3,10 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { SelectionToolbarPlugin } from '../selectionToolbarPluginType';
 type PinMenuItemProps = {
     api?: ExtractInjectionAPI<SelectionToolbarPlugin>;
+    disablePin?: boolean;
 };
 /**
  * The menu-item version of pin only appears in selection toolbar - the primary toolbar will have its own component
  */
-export declare const PinMenuItem: ({ api }: PinMenuItemProps) => React.JSX.Element | null;
+export declare const PinMenuItem: ({ api, disablePin }: PinMenuItemProps) => React.JSX.Element | null;
 export {};

package/dist/types/ui/toolbar-components.d.ts

@@ -1,4 +1,4 @@
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { RegisterComponent } from '@atlaskit/editor-toolbar-model';
 import type { SelectionToolbarPlugin } from '../selectionToolbarPluginType';
-export declare const getToolbarComponents: (api?: ExtractInjectionAPI<SelectionToolbarPlugin>, contextualFormattingEnabled?: boolean) => RegisterComponent[];
+export declare const getToolbarComponents: (api?: ExtractInjectionAPI<SelectionToolbarPlugin>, contextualFormattingEnabled?: boolean, disablePin?: boolean) => RegisterComponent[];

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

@@ -16,6 +16,12 @@ export type SelectionToolbarPluginOptions = {
      * allows more control over toolbar placement.
      */
     contextualFormattingEnabled?: boolean;
+    /**
+     * When true, hides the pin/unpin option from the toolbar menu.
+     * Use this in contexts where toolbar docking should be permanently fixed
+     * @defaults false
+     */
+    disablePin?: boolean;
     /** @defaults false */
     preferenceToolbarAboveSelection?: boolean;
     userPreferencesProvider?: UserPreferencesProvider;

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

@@ -3,9 +3,10 @@ import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { SelectionToolbarPlugin } from '../selectionToolbarPluginType';
 type PinMenuItemProps = {
     api?: ExtractInjectionAPI<SelectionToolbarPlugin>;
+    disablePin?: boolean;
 };
 /**
  * The menu-item version of pin only appears in selection toolbar - the primary toolbar will have its own component
  */
-export declare const PinMenuItem: ({ api }: PinMenuItemProps) => React.JSX.Element | null;
+export declare const PinMenuItem: ({ api, disablePin }: PinMenuItemProps) => React.JSX.Element | null;
 export {};

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

@@ -1,4 +1,4 @@
 import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { RegisterComponent } from '@atlaskit/editor-toolbar-model';
 import type { SelectionToolbarPlugin } from '../selectionToolbarPluginType';
-export declare const getToolbarComponents: (api?: ExtractInjectionAPI<SelectionToolbarPlugin>, contextualFormattingEnabled?: boolean) => RegisterComponent[];
+export declare const getToolbarComponents: (api?: ExtractInjectionAPI<SelectionToolbarPlugin>, contextualFormattingEnabled?: boolean, disablePin?: boolean) => RegisterComponent[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-selection-toolbar",
-	"version": "9.0.15",
+	"version": "9.1.0",
 	"description": "@atlaskit/editor-plugin-selection-toolbar for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",