@atlaskit/editor-plugin-decorations 8.0.0 → 8.0.2

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-decorations
 
+## 8.0.2
+
+### Patch Changes
+
+- [`5985f38f7104e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5985f38f7104e) -
+  Update README.md and 0-intro.tsx
+
+## 8.0.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 8.0.0
 
 ### Patch Changes

package/README.md

@@ -1,10 +1,23 @@
-# Editor plugin decorations
+# Editor Plugin Decorations
 
 Decorations 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 Decorations plugin provides visual styling capabilities for editor nodes through ProseMirror decorations. It enables hover effects and danger state styling on nodes, such as layouts, tables, and other container elements. The plugin integrates seamlessly with `@atlaskit/editor-core` to manage decoration state and lifecycle.
+
+## Key features
+
+- **Node decorations** - Apply visual decorations to specific nodes in the editor
+- **Hover effects** - Add hover-based styling to nodes and their contents
+- **Danger state styling** - Highlight nodes with danger styling (e.g., for destructive actions)
+- **Table support** - Apply decorations to tables and their individual cells
+- **Layout support** - Apply decorations to layout sections and columns with nested content handling
+- **State management** - Automatic decoration state tracking and cleanup
+
 ## Install
 ---
 - **Install** - *yarn add @atlaskit/editor-plugin-decorations*
@@ -25,6 +38,7 @@ Please see [Atlaskit - Editor plugin decorations](https://atlaskit.atlassian.com
 ## 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.
+Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

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

@@ -3,7 +3,7 @@ import type { Command } from '@atlaskit/editor-common/types';
 import { type NodeType } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
-export declare const decorationStateKey: PluginKey<any>;
+export declare const decorationStateKey: PluginKey;
 export declare enum ACTIONS {
     DECORATION_ADD = 0,
     DECORATION_REMOVE = 1

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

@@ -3,7 +3,7 @@ import type { Command } from '@atlaskit/editor-common/types';
 import { type NodeType } from '@atlaskit/editor-prosemirror/model';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { Decoration, DecorationSet } from '@atlaskit/editor-prosemirror/view';
-export declare const decorationStateKey: PluginKey<any>;
+export declare const decorationStateKey: PluginKey;
 export declare enum ACTIONS {
     DECORATION_ADD = 0,
     DECORATION_REMOVE = 1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-decorations",
-	"version": "8.0.0",
+	"version": "8.0.2",
 	"description": "Decorations plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -21,11 +21,11 @@
 	"dependencies": {
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/editor-tables": "^2.9.0",
-		"@atlaskit/tmp-editor-statsig": "^35.10.0",
+		"@atlaskit/tmp-editor-statsig": "^36.3.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.0.0",
+		"@atlaskit/editor-common": "^112.2.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},