@atlaskit/editor-plugin-interaction 15.0.0 → 16.0.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-interaction
 
+## 16.0.1
+
+### Patch Changes
+
+- [`14803a836f641`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/14803a836f641) -
+  Update README.md and 0-intro.tsx
+
+## 16.0.0
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 15.0.0
 
 ### Patch Changes

package/README.md

@@ -5,6 +5,17 @@ Interaction plugin for @atlaskit/editor-core
 **Note:** This component is designed for internal Atlassian development.
 External contributors will be able to use this component but will not be able to submit issues.
 
+## Overview
+
+The Interaction plugin tracks user interactions with the Atlassian Editor. It monitors mouse clicks, keyboard input, drag-and-drop operations, and focus events to detect whether a user has interacted with the editor, providing state management for interaction detection across editor operations.
+
+## Key features
+
+- **Interaction tracking** - Detect and track user interactions including clicks, keyboard input, drag-and-drop, and focus events
+- **Interaction state management** - Maintain state indicating whether the editor has received any user interaction
+- **Event handling** - Handle multiple DOM event types through integrated ProseMirror plugins
+- **Command support** - Expose `handleInteraction` command for programmatic interaction state updates
+
 ## Install
 ---
 - **Install** - *yarn add @atlaskit/editor-plugin-interaction*

package/docs/0-intro.tsx

@@ -0,0 +1,58 @@
+import React from 'react';
+
+import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
+// eslint-disable-next-line @atlassian/tangerine/import/entry-points
+import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils';
+import { token } from '@atlaskit/tokens';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any -- md template from @atlaskit/docs
+const _default_1: any = md`
+
+${createEditorUseOnlyNotice('Editor Plugin Interaction', [
+	{ name: 'Editor Core', link: '/packages/editor/editor-core' },
+])},
+
+
+  ${
+		(
+			// eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
+			<div style={{ marginTop: token('space.100', '8px') }}>
+				<AtlassianInternalWarning />
+			</div>
+		)
+	}
+
+  This package includes the interaction plugin used by \`@atlaskit/editor-core\`.
+
+  ## Usage
+---
+
+The \`commands\` and \`state\` of the plugin are defined below:
+
+${code`
+type InteractionCommands = {
+	handleInteraction: EditorCommand;
+};
+
+export type SharedInteractionState = {
+	interactionState: null | 'hasNotHadInteraction';
+};
+
+export type InteractionPlugin = NextEditorPlugin<
+	'interaction',
+	{
+		commands: InteractionCommands;
+		sharedState: SharedInteractionState;
+	}
+>;
+`}
+
+
+  ## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
+`;
+export default _default_1;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-interaction",
-	"version": "15.0.0",
+	"version": "16.0.1",
 	"description": "Interaction plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -23,8 +23,8 @@
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.0.0",
-		"@atlaskit/tokens": "^11.1.0",
+		"@atlaskit/editor-common": "^112.18.0",
+		"@atlaskit/tokens": "^12.0.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},