@atlaskit/editor-plugin-text-formatting/README.md

Text-formatting plugin for @atlaskit/editor-core

# Editor Plugin Text Formatting

Text formatting 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 Text Formatting plugin provides essential text formatting capabilities for the Atlassian Editor. It enables users to apply and manage various text marks including bold, italic, strikethrough, code, underline, and superscript/subscript. The plugin integrates seamlessly with the editor's primary and selection toolbars, offering both keyboard shortcuts and UI controls for text formatting operations.

## Key features

- **Text mark support** - Apply bold, italic, strikethrough, code, underline, and superscript/subscript formatting
- **Flexible configuration** - Disable specific formatting options (strikethrough, code, superscript/subscript, smart text completion) as needed
- **Toolbar integration** - Primary toolbar and floating toolbar components for accessing text formatting tools
- **Clear formatting** - Remove all formatting from selected text with keyboard shortcuts and UI controls
- **Smart input rules** - Automatic formatting detection and application based on input patterns
- **Cursor handling** - Intelligent cursor behavior when entering and exiting formatted regions
- **Analytics integration** - Track all formatting operations with comprehensive event reporting

## Install
---
- **Install** - *yarn add @atlaskit/editor-plugin-text-formatting*
- **npm** - [@atlaskit/editor-plugin-text-formatting](https://www.npmjs.com/package/@atlaskit/editor-plugin-text-formatting)
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-text-formatting)
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-text-formatting/dist/)

## Usage
---
**Internal use only**

@atlaskit/editor-plugin-text-formatting 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 text formatting](https://atlaskit.atlassian.com/packages/editor/editor-plugin-text-formatting) 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.