UNPKG

@atlaskit/editor-plugin-placeholder-text

Version:

placeholder text plugin for @atlaskit/editor-core

43 lines (26 loc) 2.24 kB
# Editor Plugin Placeholder Text Placeholder Text 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 Text plugin provides functionality to insert and manage placeholder nodes within the Atlassian Editor. It enables users to add temporary text placeholders that can be edited or replaced, with support for floating toolbars and type-ahead integration. ## Key features - **Placeholder insertion** - Insert placeholder text nodes at the current selection - **Floating toolbar** - Interactive toolbar for managing placeholder text insertion - **Type-ahead integration** - Seamless integration with the type-ahead plugin for content suggestions - **Fake text cursor** - Visual feedback showing cursor position within placeholder nodes - **Auto-removal** - Automatic removal of empty placeholder nodes when content is added ## Install - **Install** - *yarn add @atlaskit/editor-plugin-placeholder-text* - **npm** - [@atlaskit/editor-plugin-placeholder-text](https://www.npmjs.com/package/@atlaskit/editor-plugin-placeholder-text) - **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-placeholder-text) - **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-placeholder-text/dist/) ## Usage **Internal use only** @atlaskit/editor-plugin-placeholder-text 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 text](https://atlaskit.atlassian.com/packages/editor/editor-plugin-placeholder-text) 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.