UNPKG

@atlaskit/editor-plugin-placeholder

Version:

Placeholder plugin for @atlaskit/editor-core.

bitbucket.org/atlassian/atlassian-frontend-mirror

42 lines (30 loc) • 2.19 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 Placeholder Placeholder 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 Placeholder plugin provides customizable placeholder text and visual feedback for the Atlassian Editor. It enables dynamic placeholder content, animated prompts, and loading spinners to enhance the user experience in empty or loading states. ## Key features - **Customizable placeholder text** - Set dynamic placeholder content for the editor - **Placeholder prompts** - Display animated placeholder prompts to guide users - **Loading spinner** - Show a loading indicator during content initialization and collaborative editing sync - **Flexible configuration** - Configure placeholder behavior, visibility, and content styling - **Empty line hints** - Display bracket hints on empty lines for better user guidance ## Install --- - **Install** - *yarn add @atlaskit/editor-plugin-placeholder* - **npm** - [@atlaskit/editor-plugin-placeholder](https://www.npmjs.com/package/@atlaskit/editor-plugin-placeholder) - **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-placeholder) - **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-placeholder/dist/) ## Usage --- **Internal use only** @atlaskit/editor-plugin-placeholder 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 placeholder](https://atlaskit.atlassian.com/packages/editor/editor-plugin-placeholder) 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.