@atlaskit/editor-plugin-primary-toolbar 3.0.4 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-primary-toolbar
 
+## 3.1.0
+
+### Minor Changes
+
+- [#130044](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/130044)
+  [`cad348d512cdf`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/cad348d512cdf) -
+  [ux] ED-26802 contextual formatting configuration
+
+## 3.0.5
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.0.4
 
 ### Patch Changes

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

@@ -8,13 +8,19 @@ var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _toolbarConfiguration = require("./toolbar-configuration");
 var primaryToolbarPluginKey = exports.primaryToolbarPluginKey = new _state.PluginKey('primaryToolbar');
-var createPlugin = exports.createPlugin = function createPlugin(componentRegistry) {
+var createPlugin = exports.createPlugin = function createPlugin(_ref) {
+  var componentRegistry = _ref.componentRegistry,
+    contextualFormattingEnabled = _ref.contextualFormattingEnabled;
   return new _safePlugin.SafePlugin({
     key: primaryToolbarPluginKey,
     state: {
       init: function init(_config, editorState) {
         return {
-          components: (0, _toolbarConfiguration.getToolbarComponents)(componentRegistry, editorState)
+          components: (0, _toolbarConfiguration.getToolbarComponents)({
+            componentRegistry: componentRegistry,
+            editorState: editorState,
+            contextualFormattingEnabled: contextualFormattingEnabled
+          })
         };
       },
       apply: function apply(_tr, pluginState) {

package/dist/cjs/pm-plugins/toolbar-configuration.js

@@ -5,10 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getToolbarComponents = void 0;
 var _experiments = require("@atlaskit/tmp-editor-statsig/experiments");
-var getToolbarComponents = exports.getToolbarComponents = function getToolbarComponents(componentRegistry, editorState) {
-  return ((0, _experiments.editorExperiment)('platform_editor_controls', 'variant1', {
+var getToolbarComponents = exports.getToolbarComponents = function getToolbarComponents(_ref) {
+  var componentRegistry = _ref.componentRegistry,
+    editorState = _ref.editorState,
+    contextualFormattingEnabled = _ref.contextualFormattingEnabled;
+  var configuration = contextualFormattingEnabled && (0, _experiments.editorExperiment)('platform_editor_controls', 'variant1', {
     exposure: true
-  }) ? toolbarConfigurationV2 : toolbarConfiguration).filter(function (toolbarElement) {
+  }) ? toolbarConfigurationV2 : toolbarConfiguration;
+  return configuration.filter(function (toolbarElement) {
     return typeof toolbarElement.enabled === 'undefined' || toolbarElement.enabled(componentRegistry, editorState);
   }).reduce(function (acc, toolbarElement) {
     if (componentRegistry.has(toolbarElement.name)) {
@@ -98,7 +102,7 @@ var others = [{
 }, {
   name: 'findReplace'
 }, {
-  // TODO: Should likely be split into three: spelling & grammar, separator, and AI trigger
+  // TODO: ED-26962 - Should likely be split into three: spelling & grammar, separator, and AI trigger
   name: 'aiExperience'
 }, {
   name: 'loom'

package/dist/cjs/primaryToolbarPlugin.js

@@ -8,10 +8,11 @@ exports.primaryToolbarPlugin = void 0;
 var _actions = require("./editor-actions/actions");
 var _pmPlugin = require("./pm-plugins/pm-plugin");
 var _separator = _interopRequireDefault(require("./ui/separator"));
-var primaryToolbarPlugin = exports.primaryToolbarPlugin = function primaryToolbarPlugin() {
+var primaryToolbarPlugin = exports.primaryToolbarPlugin = function primaryToolbarPlugin(_ref) {
+  var config = _ref.config;
   // We use a plugin variable to store the component registry to avoid having to use
   // effects in each plugin, and to enable rendering the toolbar in SSR
-  // TODO: Replace this with something in plugin state once we have a way to initialise across plugins on plugin initialisation
+  // TODO: ED-26962 - Replace this with something in plugin state once we have a way to initialise across plugins on plugin initialisation
   var componentRegistry = new Map();
 
   // Pre-fill registry with the separator component
@@ -25,7 +26,10 @@ var primaryToolbarPlugin = exports.primaryToolbarPlugin = function primaryToolba
       return [{
         name: 'primaryToolbar',
         plugin: function plugin() {
-          return (0, _pmPlugin.createPlugin)(componentRegistry);
+          return (0, _pmPlugin.createPlugin)({
+            componentRegistry: componentRegistry,
+            contextualFormattingEnabled: config === null || config === void 0 ? void 0 : config.contextualFormattingEnabled
+          });
         }
       }];
     },

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

@@ -2,12 +2,19 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { getToolbarComponents } from './toolbar-configuration';
 export const primaryToolbarPluginKey = new PluginKey('primaryToolbar');
-export const createPlugin = componentRegistry => {
+export const createPlugin = ({
+  componentRegistry,
+  contextualFormattingEnabled
+}) => {
   return new SafePlugin({
     key: primaryToolbarPluginKey,
     state: {
       init: (_config, editorState) => ({
-        components: getToolbarComponents(componentRegistry, editorState)
+        components: getToolbarComponents({
+          componentRegistry,
+          editorState,
+          contextualFormattingEnabled
+        })
       }),
       apply: (_tr, pluginState) => pluginState
     }

package/dist/es2019/pm-plugins/toolbar-configuration.js

@@ -1,8 +1,13 @@
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
-export const getToolbarComponents = (componentRegistry, editorState) => {
-  return (editorExperiment('platform_editor_controls', 'variant1', {
+export const getToolbarComponents = ({
+  componentRegistry,
+  editorState,
+  contextualFormattingEnabled
+}) => {
+  const configuration = contextualFormattingEnabled && editorExperiment('platform_editor_controls', 'variant1', {
     exposure: true
-  }) ? toolbarConfigurationV2 : toolbarConfiguration).filter(toolbarElement => typeof toolbarElement.enabled === 'undefined' || toolbarElement.enabled(componentRegistry, editorState)).reduce((acc, toolbarElement) => {
+  }) ? toolbarConfigurationV2 : toolbarConfiguration;
+  return configuration.filter(toolbarElement => typeof toolbarElement.enabled === 'undefined' || toolbarElement.enabled(componentRegistry, editorState)).reduce((acc, toolbarElement) => {
     if (componentRegistry.has(toolbarElement.name)) {
       const component = componentRegistry.get(toolbarElement.name);
       if (!!component) {
@@ -74,7 +79,7 @@ const others = [{
 }, {
   name: 'findReplace'
 }, {
-  // TODO: Should likely be split into three: spelling & grammar, separator, and AI trigger
+  // TODO: ED-26962 - Should likely be split into three: spelling & grammar, separator, and AI trigger
   name: 'aiExperience'
 }, {
   name: 'loom'

package/dist/es2019/primaryToolbarPlugin.js

@@ -1,10 +1,12 @@
 import { registerComponent } from './editor-actions/actions';
 import { createPlugin, primaryToolbarPluginKey } from './pm-plugins/pm-plugin';
 import Separator from './ui/separator';
-export const primaryToolbarPlugin = () => {
+export const primaryToolbarPlugin = ({
+  config
+}) => {
   // We use a plugin variable to store the component registry to avoid having to use
   // effects in each plugin, and to enable rendering the toolbar in SSR
-  // TODO: Replace this with something in plugin state once we have a way to initialise across plugins on plugin initialisation
+  // TODO: ED-26962 - Replace this with something in plugin state once we have a way to initialise across plugins on plugin initialisation
   const componentRegistry = new Map();
 
   // Pre-fill registry with the separator component
@@ -16,7 +18,10 @@ export const primaryToolbarPlugin = () => {
     },
     pmPlugins: () => [{
       name: 'primaryToolbar',
-      plugin: () => createPlugin(componentRegistry)
+      plugin: () => createPlugin({
+        componentRegistry,
+        contextualFormattingEnabled: config === null || config === void 0 ? void 0 : config.contextualFormattingEnabled
+      })
     }],
     getSharedState(editorState) {
       if (!editorState) {

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

@@ -2,13 +2,19 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { getToolbarComponents } from './toolbar-configuration';
 export var primaryToolbarPluginKey = new PluginKey('primaryToolbar');
-export var createPlugin = function createPlugin(componentRegistry) {
+export var createPlugin = function createPlugin(_ref) {
+  var componentRegistry = _ref.componentRegistry,
+    contextualFormattingEnabled = _ref.contextualFormattingEnabled;
   return new SafePlugin({
     key: primaryToolbarPluginKey,
     state: {
       init: function init(_config, editorState) {
         return {
-          components: getToolbarComponents(componentRegistry, editorState)
+          components: getToolbarComponents({
+            componentRegistry: componentRegistry,
+            editorState: editorState,
+            contextualFormattingEnabled: contextualFormattingEnabled
+          })
         };
       },
       apply: function apply(_tr, pluginState) {

package/dist/esm/pm-plugins/toolbar-configuration.js

@@ -1,8 +1,12 @@
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
-export var getToolbarComponents = function getToolbarComponents(componentRegistry, editorState) {
-  return (editorExperiment('platform_editor_controls', 'variant1', {
+export var getToolbarComponents = function getToolbarComponents(_ref) {
+  var componentRegistry = _ref.componentRegistry,
+    editorState = _ref.editorState,
+    contextualFormattingEnabled = _ref.contextualFormattingEnabled;
+  var configuration = contextualFormattingEnabled && editorExperiment('platform_editor_controls', 'variant1', {
     exposure: true
-  }) ? toolbarConfigurationV2 : toolbarConfiguration).filter(function (toolbarElement) {
+  }) ? toolbarConfigurationV2 : toolbarConfiguration;
+  return configuration.filter(function (toolbarElement) {
     return typeof toolbarElement.enabled === 'undefined' || toolbarElement.enabled(componentRegistry, editorState);
   }).reduce(function (acc, toolbarElement) {
     if (componentRegistry.has(toolbarElement.name)) {
@@ -92,7 +96,7 @@ var others = [{
 }, {
   name: 'findReplace'
 }, {
-  // TODO: Should likely be split into three: spelling & grammar, separator, and AI trigger
+  // TODO: ED-26962 - Should likely be split into three: spelling & grammar, separator, and AI trigger
   name: 'aiExperience'
 }, {
   name: 'loom'

package/dist/esm/primaryToolbarPlugin.js

@@ -1,10 +1,11 @@
 import { registerComponent } from './editor-actions/actions';
 import { createPlugin, primaryToolbarPluginKey } from './pm-plugins/pm-plugin';
 import Separator from './ui/separator';
-export var primaryToolbarPlugin = function primaryToolbarPlugin() {
+export var primaryToolbarPlugin = function primaryToolbarPlugin(_ref) {
+  var config = _ref.config;
   // We use a plugin variable to store the component registry to avoid having to use
   // effects in each plugin, and to enable rendering the toolbar in SSR
-  // TODO: Replace this with something in plugin state once we have a way to initialise across plugins on plugin initialisation
+  // TODO: ED-26962 - Replace this with something in plugin state once we have a way to initialise across plugins on plugin initialisation
   var componentRegistry = new Map();
 
   // Pre-fill registry with the separator component
@@ -18,7 +19,10 @@ export var primaryToolbarPlugin = function primaryToolbarPlugin() {
       return [{
         name: 'primaryToolbar',
         plugin: function plugin() {
-          return createPlugin(componentRegistry);
+          return createPlugin({
+            componentRegistry: componentRegistry,
+            contextualFormattingEnabled: config === null || config === void 0 ? void 0 : config.contextualFormattingEnabled
+          });
         }
       }];
     },

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

@@ -2,4 +2,9 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { ComponentRegistry, PrimaryToolbarPluginState } from '../primaryToolbarPluginType';
 export declare const primaryToolbarPluginKey: PluginKey<PrimaryToolbarPluginState>;
-export declare const createPlugin: (componentRegistry: ComponentRegistry) => SafePlugin<PrimaryToolbarPluginState>;
+type PluginConfig = {
+    componentRegistry: ComponentRegistry;
+    contextualFormattingEnabled?: boolean;
+};
+export declare const createPlugin: ({ componentRegistry, contextualFormattingEnabled }: PluginConfig) => SafePlugin<PrimaryToolbarPluginState>;
+export {};

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

@@ -1,4 +1,10 @@
 import type { ToolbarUIComponentFactory } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { ComponentRegistry } from '../primaryToolbarPluginType';
-export declare const getToolbarComponents: (componentRegistry: ComponentRegistry, editorState: EditorState) => ToolbarUIComponentFactory[];
+type GetToolbarComponentsOptions = {
+    componentRegistry: ComponentRegistry;
+    editorState: EditorState;
+    contextualFormattingEnabled?: boolean;
+};
+export declare const getToolbarComponents: ({ componentRegistry, editorState, contextualFormattingEnabled, }: GetToolbarComponentsOptions) => ToolbarUIComponentFactory[];
+export {};

package/dist/types/primaryToolbarPluginType.d.ts

@@ -8,6 +8,9 @@ export type PrimaryToolbarPlugin = NextEditorPlugin<'primaryToolbar', {
             component: ToolbarUIComponentFactory;
         }) => void;
     };
+    pluginConfiguration?: {
+        contextualFormattingEnabled?: boolean;
+    };
 }>;
 export type ComponentRegistry = Map<string, ToolbarUIComponentFactory>;
 export type ToolbarElementNames = 'separator' | 'undoRedoPlugin' | 'blockType' | 'textFormatting' | 'alignment' | 'textColor' | 'highlight' | 'hyperlink' | 'toolbarListsIndentation' | 'insertBlock' | 'beforePrimaryToolbar' | 'avatarGroup' | 'findReplace' | 'aiExperience' | 'aiSimplified' | 'loom' | 'spellCheck' | 'overflowMenu';

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

@@ -2,4 +2,9 @@ import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import type { ComponentRegistry, PrimaryToolbarPluginState } from '../primaryToolbarPluginType';
 export declare const primaryToolbarPluginKey: PluginKey<PrimaryToolbarPluginState>;
-export declare const createPlugin: (componentRegistry: ComponentRegistry) => SafePlugin<PrimaryToolbarPluginState>;
+type PluginConfig = {
+    componentRegistry: ComponentRegistry;
+    contextualFormattingEnabled?: boolean;
+};
+export declare const createPlugin: ({ componentRegistry, contextualFormattingEnabled }: PluginConfig) => SafePlugin<PrimaryToolbarPluginState>;
+export {};

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

@@ -1,4 +1,10 @@
 import type { ToolbarUIComponentFactory } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { ComponentRegistry } from '../primaryToolbarPluginType';
-export declare const getToolbarComponents: (componentRegistry: ComponentRegistry, editorState: EditorState) => ToolbarUIComponentFactory[];
+type GetToolbarComponentsOptions = {
+    componentRegistry: ComponentRegistry;
+    editorState: EditorState;
+    contextualFormattingEnabled?: boolean;
+};
+export declare const getToolbarComponents: ({ componentRegistry, editorState, contextualFormattingEnabled, }: GetToolbarComponentsOptions) => ToolbarUIComponentFactory[];
+export {};

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

@@ -8,6 +8,9 @@ export type PrimaryToolbarPlugin = NextEditorPlugin<'primaryToolbar', {
             component: ToolbarUIComponentFactory;
         }) => void;
     };
+    pluginConfiguration?: {
+        contextualFormattingEnabled?: boolean;
+    };
 }>;
 export type ComponentRegistry = Map<string, ToolbarUIComponentFactory>;
 export type ToolbarElementNames = 'separator' | 'undoRedoPlugin' | 'blockType' | 'textFormatting' | 'alignment' | 'textColor' | 'highlight' | 'hyperlink' | 'toolbarListsIndentation' | 'insertBlock' | 'beforePrimaryToolbar' | 'avatarGroup' | 'findReplace' | 'aiExperience' | 'aiSimplified' | 'loom' | 'spellCheck' | 'overflowMenu';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-primary-toolbar",
-	"version": "3.0.4",
+	"version": "3.1.0",
 	"description": "Primary toolbar plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -36,9 +36,9 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/editor-common": "^102.0.0",
+		"@atlaskit/editor-common": "^102.12.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/tmp-editor-statsig": "^3.4.0",
+		"@atlaskit/tmp-editor-statsig": "^4.1.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1"
 	},