@atlaskit/editor-plugin-text-formatting 8.2.8 → 8.2.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +15 -1
- package/docs/0-intro.tsx +13 -6
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# @atlaskit/editor-plugin-text-formatting
|
|
2
2
|
|
|
3
|
+
## 8.2.9
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`9ff7d1c1aa288`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9ff7d1c1aa288) -
|
|
8
|
+
Update README.md and 0-intro.tsx
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
|
|
3
11
|
## 8.2.8
|
|
4
12
|
|
|
5
13
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1,10 +1,24 @@
|
|
|
1
|
-
# Editor
|
|
1
|
+
# Editor Plugin Text Formatting
|
|
2
2
|
|
|
3
3
|
Text formatting plugin for @atlaskit/editor-core
|
|
4
4
|
|
|
5
5
|
**Note:** This component is designed for internal Atlassian development.
|
|
6
6
|
External contributors will be able to use this component but will not be able to submit issues.
|
|
7
7
|
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
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.
|
|
11
|
+
|
|
12
|
+
## Key features
|
|
13
|
+
|
|
14
|
+
- **Text mark support** - Apply bold, italic, strikethrough, code, underline, and superscript/subscript formatting
|
|
15
|
+
- **Flexible configuration** - Disable specific formatting options (strikethrough, code, superscript/subscript, smart text completion) as needed
|
|
16
|
+
- **Toolbar integration** - Primary toolbar and floating toolbar components for accessing text formatting tools
|
|
17
|
+
- **Clear formatting** - Remove all formatting from selected text with keyboard shortcuts and UI controls
|
|
18
|
+
- **Smart input rules** - Automatic formatting detection and application based on input patterns
|
|
19
|
+
- **Cursor handling** - Intelligent cursor behavior when entering and exiting formatted regions
|
|
20
|
+
- **Analytics integration** - Track all formatting operations with comprehensive event reporting
|
|
21
|
+
|
|
8
22
|
## Install
|
|
9
23
|
---
|
|
10
24
|
- **Install** - *yarn add @atlaskit/editor-plugin-text-formatting*
|
package/docs/0-intro.tsx
CHANGED
|
@@ -34,17 +34,24 @@ ${code`
|
|
|
34
34
|
type TextFormattingPlugin = NextEditorPlugin<
|
|
35
35
|
'textFormatting',
|
|
36
36
|
{
|
|
37
|
-
pluginConfiguration: TextFormattingPluginOptions | undefined;
|
|
38
|
-
dependencies: [OptionalPlugin<typeof analyticsPlugin>];
|
|
39
37
|
commands: {
|
|
40
|
-
toggleSuperscript: ToggleMarkEditorCommand;
|
|
41
|
-
toggleSubscript: ToggleMarkEditorCommand;
|
|
42
|
-
toggleStrike: ToggleMarkEditorCommand;
|
|
43
38
|
toggleCode: ToggleMarkEditorCommand;
|
|
44
|
-
toggleUnderline: ToggleMarkEditorCommand;
|
|
45
39
|
toggleEm: ToggleMarkEditorCommand;
|
|
40
|
+
toggleStrike: ToggleMarkEditorCommand;
|
|
46
41
|
toggleStrong: ToggleMarkEditorCommand;
|
|
42
|
+
toggleSubscript: ToggleMarkEditorCommand;
|
|
43
|
+
toggleSuperscript: ToggleMarkEditorCommand;
|
|
44
|
+
toggleUnderline: ToggleMarkEditorCommand;
|
|
47
45
|
};
|
|
46
|
+
dependencies: [
|
|
47
|
+
OptionalPlugin<AnalyticsPlugin>,
|
|
48
|
+
OptionalPlugin<PrimaryToolbarPlugin>,
|
|
49
|
+
OptionalPlugin<BasePlugin>,
|
|
50
|
+
OptionalPlugin<SelectionToolbarPlugin>,
|
|
51
|
+
OptionalPlugin<UserPreferencesPlugin>,
|
|
52
|
+
OptionalPlugin<ToolbarPlugin>,
|
|
53
|
+
];
|
|
54
|
+
pluginConfiguration: TextFormattingPluginOptions | undefined;
|
|
48
55
|
sharedState: TextFormattingState | undefined;
|
|
49
56
|
}
|
|
50
57
|
>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/editor-plugin-text-formatting",
|
|
3
|
-
"version": "8.2.
|
|
3
|
+
"version": "8.2.9",
|
|
4
4
|
"description": "Text-formatting plugin for @atlaskit/editor-core",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"@atlaskit/icon": "^34.0.0",
|
|
47
47
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
48
48
|
"@atlaskit/prosemirror-input-rules": "^3.6.0",
|
|
49
|
-
"@atlaskit/tmp-editor-statsig": "^
|
|
49
|
+
"@atlaskit/tmp-editor-statsig": "^58.0.0",
|
|
50
50
|
"@atlaskit/tokens": "^12.0.0",
|
|
51
51
|
"@babel/runtime": "^7.0.0",
|
|
52
52
|
"@emotion/react": "^11.7.1",
|