UNPKG

@atlaskit/editor-plugin-context-panel

Version:

Context panel plugin for @atlaskit/editor-core

bitbucket.org/atlassian/atlassian-frontend-mirror

42 lines (30 loc) • 2.29 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# Editor Plugin Context Panel Context panel 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 Context Panel plugin provides UI panel management capabilities for the Atlassian Editor. It enables dynamic rendering of context-aware panels and object sidebars within the editor, supporting customizable panel layouts, multiple display behaviors, and integration with the editor's state management system. ## Key features - **Dynamic panel rendering** - Render context panels dynamically based on editor state - **Object sidebar management** - Show, hide, and manage object sidebar panels with configurable IDs - **Flexible panel behaviors** - Support 'push' and 'cover' display behaviors for sidebar panels - **Customizable panel layouts** - Configure header, body, and footer components with custom styling - **State change handling** - Apply transformations to trigger panel content updates ## Install --- - **Install** - *yarn add @atlaskit/editor-plugin-context-panel* - **npm** - [@atlaskit/editor-plugin-context-panel](https://www.npmjs.com/package/@atlaskit/editor-plugin-context-panel) - **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-context-panel) - **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-context-panel/dist/) ## Usage --- **Internal use only** @atlaskit/editor-plugin-context-panel is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product. Direct use of this component is not supported. Please see [Atlaskit - Editor plugin context panel](https://atlaskit.atlassian.com/packages/editor/editor-plugin-context-panel) for documentation and examples for this package. ## 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.