@atlaskit/editor-plugin-toolbar 4.1.11 → 4.1.12

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-toolbar
 
+## 4.1.12
+
+### Patch Changes
+
+- [`fb3129f46e923`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/fb3129f46e923) -
+  Update config options
+- Updated dependencies
+
 ## 4.1.11
 
 ### Patch Changes

package/dist/types/toolbarPluginType.d.ts

@@ -30,7 +30,8 @@ export type ToolbarPlugin = NextEditorPlugin<'toolbar', {
          * @returns The active contextual formatting mode:
          * - `always-inline`: Formatting controls appear in a floating toolbar near selected text
          * - `always-pinned`: Formatting controls are pinned to the top toolbar (default)
-         * - `controlled`: Both inline and primary toolbars are available
+         * - `controlled`: Both inline and primary toolbars are available - this option requires editor-plugin-selection-toolbar to be configured with
+         * userPreferencesProvider to control the toolbar pinning.
          */
         contextualFormattingMode: () => ContextualFormattingEnabledOptions;
         /**

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

@@ -10,12 +10,21 @@ export type ToolbarPluginOptions = {
      * Controls which toolbars are available for in the editor.
      *
      * The contextual formatting toolbar provides text formatting options (bold, italic, links, etc.)
-     * that appear contextually based on user selection and interaction.
+     * that appear contextually based on user selection.
+     *
+     * **Notes:**
+     * - The inline text toolbar has only been tested to work in the full-page and chromless editor appearances.
+     *
+     * **Options:**
+     * - `always-inline`: Formatting controls appear in a floating toolbar near selected text
+     * - `always-pinned`: Formatting controls are pinned to the top toolbar (default)
+     * - `controlled`: Both inline and primary toolbars are available - this option requires editor-plugin-selection-toolbar to be configured with
+     * userPreferencesProvider to control the toolbar pinning.
      *
      * @remarks
      * This option determines where and when the formatting toolbar is displayed:
-     * - **Primary Toolbar**: The toolbar mounted at the top of the editor that is always visible
-     * - **Inline Text Toolbar**: A floating toolbar that appears near the selected text
+     * - **Primary toolbar**: The toolbar mounted at the top of the editor that is always visible
+     * - **Inline text toolbar**: A floating toolbar that appears near the selected text
      *
      * @example
      * ```tsx
@@ -35,6 +44,7 @@ export type ToolbarPluginOptions = {
      *
      * @example
      * ```tsx
+     * // Must have editor-plugin-selection-toolbar configured with userPreferencesProvider
      * // Allow dynamic control of toolbar placement (both inline and primary available)
      * const toolbarPlugin = createToolbarPlugin({
      *   contextualFormattingEnabled: 'controlled',

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

@@ -30,7 +30,8 @@ export type ToolbarPlugin = NextEditorPlugin<'toolbar', {
          * @returns The active contextual formatting mode:
          * - `always-inline`: Formatting controls appear in a floating toolbar near selected text
          * - `always-pinned`: Formatting controls are pinned to the top toolbar (default)
-         * - `controlled`: Both inline and primary toolbars are available
+         * - `controlled`: Both inline and primary toolbars are available - this option requires editor-plugin-selection-toolbar to be configured with
+         * userPreferencesProvider to control the toolbar pinning.
          */
         contextualFormattingMode: () => ContextualFormattingEnabledOptions;
         /**

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

@@ -10,12 +10,21 @@ export type ToolbarPluginOptions = {
      * Controls which toolbars are available for in the editor.
      *
      * The contextual formatting toolbar provides text formatting options (bold, italic, links, etc.)
-     * that appear contextually based on user selection and interaction.
+     * that appear contextually based on user selection.
+     *
+     * **Notes:**
+     * - The inline text toolbar has only been tested to work in the full-page and chromless editor appearances.
+     *
+     * **Options:**
+     * - `always-inline`: Formatting controls appear in a floating toolbar near selected text
+     * - `always-pinned`: Formatting controls are pinned to the top toolbar (default)
+     * - `controlled`: Both inline and primary toolbars are available - this option requires editor-plugin-selection-toolbar to be configured with
+     * userPreferencesProvider to control the toolbar pinning.
      *
      * @remarks
      * This option determines where and when the formatting toolbar is displayed:
-     * - **Primary Toolbar**: The toolbar mounted at the top of the editor that is always visible
-     * - **Inline Text Toolbar**: A floating toolbar that appears near the selected text
+     * - **Primary toolbar**: The toolbar mounted at the top of the editor that is always visible
+     * - **Inline text toolbar**: A floating toolbar that appears near the selected text
      *
      * @example
      * ```tsx
@@ -35,6 +44,7 @@ export type ToolbarPluginOptions = {
      *
      * @example
      * ```tsx
+     * // Must have editor-plugin-selection-toolbar configured with userPreferencesProvider
      * // Allow dynamic control of toolbar placement (both inline and primary available)
      * const toolbarPlugin = createToolbarPlugin({
      *   contextualFormattingEnabled: 'controlled',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-toolbar",
-	"version": "4.1.11",
+	"version": "4.1.12",
 	"description": "Toolbar plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -39,7 +39,7 @@
 		"@atlaskit/editor-toolbar": "^0.19.0",
 		"@atlaskit/editor-toolbar-model": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^21.0.0",
+		"@atlaskit/tmp-editor-statsig": "^22.0.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"