@atlaskit/editor-plugin-hyperlink
Version:
Hyperlink plugin for @atlaskit/editor-core
45 lines (32 loc) • 2.32 kB
Markdown
# Editor Plugin Hyperlink
Hyperlink 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 Hyperlink plugin provides comprehensive hyperlink management capabilities for the Atlassian Editor. It integrates with `@atlaskit/editor-core` to enable inserting, editing, and managing links within editor content. The plugin includes toolbar integration, keyboard shortcuts, and input rules for efficient link manipulation.
## Key features
- **Link insertion** - Insert and create hyperlinks with custom text
- **Link editing** - Edit existing hyperlinks and update URLs and link text
- **Link removal** - Remove hyperlinks from selected content
- **Toolbar integration** - Floating toolbar for easy link management and editing
- **Keyboard shortcuts** - Support for keyboard shortcuts to insert and manage links
- **Input rules** - Automatic link detection and creation from URL patterns
- **Analytics integration** - Track link-related user actions and interactions
## Install
---
- **Install** - *yarn add @atlaskit/editor-plugin-hyperlink*
- **npm** - [@atlaskit/editor-plugin-hyperlink](https://www.npmjs.com/package/@atlaskit/editor-plugin-hyperlink)
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-hyperlink)
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-hyperlink/dist/)
## Usage
---
**Internal use only**
@atlaskit/editor-plugin-hyperlink 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 hyperlink](https://atlaskit.atlassian.com/packages/editor/editor-plugin-hyperlink) 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.