Editor Plugin Rule

Rule 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 Rule plugin provides horizontal rule (divider) insertion capabilities for the Atlassian Editor. It enables users to insert horizontal rules within documents through multiple input methods including keyboard shortcuts, quick insert, and programmatic actions.

Key features

• Horizontal rule insertion - Insert horizontal dividers into editor content
• Input rule support - Use keyboard shortcut --- to quickly insert a rule
• Quick insert integration - Access horizontal rule from the quick insert menu
• Action API - Programmatic insertion through insertHorizontalRule action
• Analytics tracking - Track horizontal rule insertion events for analytics

Install

• Install - yarn add @atlaskit/editor-plugin-rule
• npm - @atlaskit/editor-plugin-rule
• Source - Bitbucket
• Bundle - unpkg.com

Usage

Internal use only

@atlaskit/editor-plugin-rule 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 rule for documentation and examples for this package.

Support

For internal Atlassian, visit the slack channel #help-editor for support or visit go/editor-help to submit a bug.

License

Please see Atlassian Frontend - License for more licensing information.