@atlaskit/editor-plugin-floating-toolbar 8.2.0 → 8.2.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-floating-toolbar
 
+## 8.2.1
+
+### Patch Changes
+
+- [`5292689cffab1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5292689cffab1) -
+  fix/ignore minor eslint issues ahead of bug fix for confirming the removal of tables
+- Updated dependencies
+
 ## 8.2.0
 
 ### Minor Changes

package/dist/cjs/floatingToolbarPlugin.js

@@ -209,6 +209,24 @@ var floatingToolbarPlugin = exports.floatingToolbarPlugin = function floatingToo
     }
   };
 };
+
+/**
+ * React component that renders the floating toolbar UI for the editor.
+ *
+ * This component manages the display of floating toolbars based on the current editor state,
+ * selection, and configuration. It handles visibility conditions, positioning, toolbar items
+ * consolidation, and confirmation dialogs.
+ *
+ * @param props - Component properties
+ * @param props.pluginInjectionApi - Plugin injection API for accessing other plugin states
+ * @param props.editorView - ProseMirror EditorView instance
+ * @param props.popupsMountPoint - DOM element where popups should be mounted
+ * @param props.popupsBoundariesElement - Element that defines popup boundaries
+ * @param props.popupsScrollableElement - Scrollable container element for popups
+ * @param props.providerFactory - Factory for creating various providers
+ * @param props.dispatchAnalyticsEvent - Function to dispatch analytics events
+ * @returns JSX element representing the floating toolbar or null if not visible
+ */
 function ContentComponent(_ref5) {
   var _configWithNodeInfo$c, _configWithNodeInfo$c2, _items, _pluginInjectionApi$c, _pluginInjectionApi$d;
   var pluginInjectionApi = _ref5.pluginInjectionApi,
@@ -489,6 +507,20 @@ function sanitizeFloatingToolbarConfig(config) {
   }
   return config;
 }
+
+/**
+ * Creates a floating toolbar plugin for the ProseMirror editor.
+ *
+ * This factory function creates a SafePlugin that manages floating toolbars in the editor.
+ * It processes an array of floating toolbar handlers and determines which toolbar configuration
+ * should be active based on the current editor state and selection.
+ *
+ * @param options - Configuration object for the floating toolbar plugin
+ * @param options.floatingToolbarHandlers - Array of handlers that return toolbar configurations
+ * @param options.getIntl - Function that returns the IntlShape instance for internationalization
+ * @param options.providerFactory - Factory for creating various providers used by the editor
+ * @returns A SafePlugin instance that manages floating toolbar state and behavior
+ */
 function floatingToolbarPluginFactory(options) {
   var floatingToolbarHandlers = options.floatingToolbarHandlers,
     providerFactory = options.providerFactory,

package/dist/cjs/ui/Toolbar.js

@@ -43,6 +43,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsxRuntime classic
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+// eslint-disable-next-line jsdoc/require-jsdoc
 function groupItems(items, areAnyNewToolbarFlagsEnabled) {
   var groupItems = items.reduce(function (accumulator, item, i) {
     var finalOutput = accumulator.finalOutput,

package/dist/es2019/floatingToolbarPlugin.js

@@ -195,6 +195,24 @@ export const floatingToolbarPlugin = ({
     }
   };
 };
+
+/**
+ * React component that renders the floating toolbar UI for the editor.
+ *
+ * This component manages the display of floating toolbars based on the current editor state,
+ * selection, and configuration. It handles visibility conditions, positioning, toolbar items
+ * consolidation, and confirmation dialogs.
+ *
+ * @param props - Component properties
+ * @param props.pluginInjectionApi - Plugin injection API for accessing other plugin states
+ * @param props.editorView - ProseMirror EditorView instance
+ * @param props.popupsMountPoint - DOM element where popups should be mounted
+ * @param props.popupsBoundariesElement - Element that defines popup boundaries
+ * @param props.popupsScrollableElement - Scrollable container element for popups
+ * @param props.providerFactory - Factory for creating various providers
+ * @param props.dispatchAnalyticsEvent - Function to dispatch analytics events
+ * @returns JSX element representing the floating toolbar or null if not visible
+ */
 export function ContentComponent({
   pluginInjectionApi,
   editorView,
@@ -472,6 +490,20 @@ function sanitizeFloatingToolbarConfig(config) {
   }
   return config;
 }
+
+/**
+ * Creates a floating toolbar plugin for the ProseMirror editor.
+ *
+ * This factory function creates a SafePlugin that manages floating toolbars in the editor.
+ * It processes an array of floating toolbar handlers and determines which toolbar configuration
+ * should be active based on the current editor state and selection.
+ *
+ * @param options - Configuration object for the floating toolbar plugin
+ * @param options.floatingToolbarHandlers - Array of handlers that return toolbar configurations
+ * @param options.getIntl - Function that returns the IntlShape instance for internationalization
+ * @param options.providerFactory - Factory for creating various providers used by the editor
+ * @returns A SafePlugin instance that manages floating toolbar state and behavior
+ */
 export function floatingToolbarPluginFactory(options) {
   const {
     floatingToolbarHandlers,

package/dist/es2019/ui/Toolbar.js

@@ -30,6 +30,7 @@ import { Input } from './Input';
 import { ScrollButton } from './ScrollButton';
 import { ScrollButtons } from './ScrollButtons';
 import Select from './Select';
+// eslint-disable-next-line jsdoc/require-jsdoc
 export function groupItems(items, areAnyNewToolbarFlagsEnabled) {
   const groupItems = items.reduce((accumulator, item, i) => {
     const {

package/dist/esm/floatingToolbarPlugin.js

@@ -200,6 +200,24 @@ export var floatingToolbarPlugin = function floatingToolbarPlugin(_ref) {
     }
   };
 };
+
+/**
+ * React component that renders the floating toolbar UI for the editor.
+ *
+ * This component manages the display of floating toolbars based on the current editor state,
+ * selection, and configuration. It handles visibility conditions, positioning, toolbar items
+ * consolidation, and confirmation dialogs.
+ *
+ * @param props - Component properties
+ * @param props.pluginInjectionApi - Plugin injection API for accessing other plugin states
+ * @param props.editorView - ProseMirror EditorView instance
+ * @param props.popupsMountPoint - DOM element where popups should be mounted
+ * @param props.popupsBoundariesElement - Element that defines popup boundaries
+ * @param props.popupsScrollableElement - Scrollable container element for popups
+ * @param props.providerFactory - Factory for creating various providers
+ * @param props.dispatchAnalyticsEvent - Function to dispatch analytics events
+ * @returns JSX element representing the floating toolbar or null if not visible
+ */
 export function ContentComponent(_ref5) {
   var _configWithNodeInfo$c, _configWithNodeInfo$c2, _items, _pluginInjectionApi$c, _pluginInjectionApi$d;
   var pluginInjectionApi = _ref5.pluginInjectionApi,
@@ -480,6 +498,20 @@ function sanitizeFloatingToolbarConfig(config) {
   }
   return config;
 }
+
+/**
+ * Creates a floating toolbar plugin for the ProseMirror editor.
+ *
+ * This factory function creates a SafePlugin that manages floating toolbars in the editor.
+ * It processes an array of floating toolbar handlers and determines which toolbar configuration
+ * should be active based on the current editor state and selection.
+ *
+ * @param options - Configuration object for the floating toolbar plugin
+ * @param options.floatingToolbarHandlers - Array of handlers that return toolbar configurations
+ * @param options.getIntl - Function that returns the IntlShape instance for internationalization
+ * @param options.providerFactory - Factory for creating various providers used by the editor
+ * @returns A SafePlugin instance that manages floating toolbar state and behavior
+ */
 export function floatingToolbarPluginFactory(options) {
   var floatingToolbarHandlers = options.floatingToolbarHandlers,
     providerFactory = options.providerFactory,

package/dist/esm/ui/Toolbar.js

@@ -37,6 +37,7 @@ import { Input } from './Input';
 import { ScrollButton } from './ScrollButton';
 import { ScrollButtons } from './ScrollButtons';
 import Select from './Select';
+// eslint-disable-next-line jsdoc/require-jsdoc
 export function groupItems(items, areAnyNewToolbarFlagsEnabled) {
   var groupItems = items.reduce(function (accumulator, item, i) {
     var finalOutput = accumulator.finalOutput,

package/dist/types/floatingToolbarPlugin.d.ts

@@ -9,6 +9,23 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { ConfigWithNodeInfo, FloatingToolbarPlugin, FloatingToolbarPluginState } from './floatingToolbarPluginType';
 export declare const getRelevantConfig: (selection: Selection, configs: Array<FloatingToolbarConfig>) => ConfigWithNodeInfo | undefined;
 export declare const floatingToolbarPlugin: FloatingToolbarPlugin;
+/**
+ * React component that renders the floating toolbar UI for the editor.
+ *
+ * This component manages the display of floating toolbars based on the current editor state,
+ * selection, and configuration. It handles visibility conditions, positioning, toolbar items
+ * consolidation, and confirmation dialogs.
+ *
+ * @param props - Component properties
+ * @param props.pluginInjectionApi - Plugin injection API for accessing other plugin states
+ * @param props.editorView - ProseMirror EditorView instance
+ * @param props.popupsMountPoint - DOM element where popups should be mounted
+ * @param props.popupsBoundariesElement - Element that defines popup boundaries
+ * @param props.popupsScrollableElement - Scrollable container element for popups
+ * @param props.providerFactory - Factory for creating various providers
+ * @param props.dispatchAnalyticsEvent - Function to dispatch analytics events
+ * @returns JSX element representing the floating toolbar or null if not visible
+ */
 export declare function ContentComponent({ pluginInjectionApi, editorView, popupsMountPoint, popupsBoundariesElement, popupsScrollableElement, providerFactory, dispatchAnalyticsEvent, }: Pick<UiComponentFactoryParams, 'editorView' | 'popupsMountPoint' | 'popupsBoundariesElement' | 'providerFactory' | 'dispatchAnalyticsEvent' | 'popupsScrollableElement'> & {
     pluginInjectionApi: ExtractInjectionAPI<FloatingToolbarPlugin> | undefined;
 } & {
@@ -20,6 +37,19 @@ export declare function ContentComponent({ pluginInjectionApi, editorView, popup
  *
  */
 export declare const pluginKey: PluginKey<FloatingToolbarPluginState>;
+/**
+ * Creates a floating toolbar plugin for the ProseMirror editor.
+ *
+ * This factory function creates a SafePlugin that manages floating toolbars in the editor.
+ * It processes an array of floating toolbar handlers and determines which toolbar configuration
+ * should be active based on the current editor state and selection.
+ *
+ * @param options - Configuration object for the floating toolbar plugin
+ * @param options.floatingToolbarHandlers - Array of handlers that return toolbar configurations
+ * @param options.getIntl - Function that returns the IntlShape instance for internationalization
+ * @param options.providerFactory - Factory for creating various providers used by the editor
+ * @returns A SafePlugin instance that manages floating toolbar state and behavior
+ */
 export declare function floatingToolbarPluginFactory(options: {
     floatingToolbarHandlers: Array<FloatingToolbarHandler>;
     getIntl: () => IntlShape;

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

@@ -9,6 +9,23 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { ConfigWithNodeInfo, FloatingToolbarPlugin, FloatingToolbarPluginState } from './floatingToolbarPluginType';
 export declare const getRelevantConfig: (selection: Selection, configs: Array<FloatingToolbarConfig>) => ConfigWithNodeInfo | undefined;
 export declare const floatingToolbarPlugin: FloatingToolbarPlugin;
+/**
+ * React component that renders the floating toolbar UI for the editor.
+ *
+ * This component manages the display of floating toolbars based on the current editor state,
+ * selection, and configuration. It handles visibility conditions, positioning, toolbar items
+ * consolidation, and confirmation dialogs.
+ *
+ * @param props - Component properties
+ * @param props.pluginInjectionApi - Plugin injection API for accessing other plugin states
+ * @param props.editorView - ProseMirror EditorView instance
+ * @param props.popupsMountPoint - DOM element where popups should be mounted
+ * @param props.popupsBoundariesElement - Element that defines popup boundaries
+ * @param props.popupsScrollableElement - Scrollable container element for popups
+ * @param props.providerFactory - Factory for creating various providers
+ * @param props.dispatchAnalyticsEvent - Function to dispatch analytics events
+ * @returns JSX element representing the floating toolbar or null if not visible
+ */
 export declare function ContentComponent({ pluginInjectionApi, editorView, popupsMountPoint, popupsBoundariesElement, popupsScrollableElement, providerFactory, dispatchAnalyticsEvent, }: Pick<UiComponentFactoryParams, 'editorView' | 'popupsMountPoint' | 'popupsBoundariesElement' | 'providerFactory' | 'dispatchAnalyticsEvent' | 'popupsScrollableElement'> & {
     pluginInjectionApi: ExtractInjectionAPI<FloatingToolbarPlugin> | undefined;
 } & {
@@ -20,6 +37,19 @@ export declare function ContentComponent({ pluginInjectionApi, editorView, popup
  *
  */
 export declare const pluginKey: PluginKey<FloatingToolbarPluginState>;
+/**
+ * Creates a floating toolbar plugin for the ProseMirror editor.
+ *
+ * This factory function creates a SafePlugin that manages floating toolbars in the editor.
+ * It processes an array of floating toolbar handlers and determines which toolbar configuration
+ * should be active based on the current editor state and selection.
+ *
+ * @param options - Configuration object for the floating toolbar plugin
+ * @param options.floatingToolbarHandlers - Array of handlers that return toolbar configurations
+ * @param options.getIntl - Function that returns the IntlShape instance for internationalization
+ * @param options.providerFactory - Factory for creating various providers used by the editor
+ * @returns A SafePlugin instance that manages floating toolbar state and behavior
+ */
 export declare function floatingToolbarPluginFactory(options: {
     floatingToolbarHandlers: Array<FloatingToolbarHandler>;
     getIntl: () => IntlShape;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-floating-toolbar",
-	"version": "8.2.0",
+	"version": "8.2.1",
 	"description": "Floating toolbar plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",