@atlaskit/editor-plugin-code-block 9.0.14 → 9.0.16
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 +12 -0
- package/README.md +31 -2
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,10 +1,23 @@
|
|
|
1
|
-
# Editor
|
|
1
|
+
# Editor Plugin Code Block
|
|
2
2
|
|
|
3
3
|
Code Block 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 code block plugin extends the Atlassian Editor with rich code editing functionality. It provides the code block node with language selection and IDE-like keyboard shortcuts for a better code editing experience.
|
|
11
|
+
|
|
12
|
+
## Key features
|
|
13
|
+
|
|
14
|
+
- **Language Selection** - Support for multiple programming languages
|
|
15
|
+
- **IDE-like Keyboard Shortcuts** - Auto-closing brackets and quotes, smart indentation
|
|
16
|
+
- **Line Numbers** - Display of line numbers and tracking of line positions
|
|
17
|
+
- **Word Wrapping** - Support for toggling word wrap in code blocks
|
|
18
|
+
- **Toolbar Support** - Floating toolbar with language selector and additional actions
|
|
19
|
+
- **Quick Insert** - Insert code blocks using the quick insert menu with `/` or ` ``` `
|
|
20
|
+
|
|
8
21
|
## Install
|
|
9
22
|
---
|
|
10
23
|
- **Install** - *yarn add @atlaskit/editor-plugin-code-block*
|
|
@@ -22,9 +35,25 @@ Direct use of this component is not supported.
|
|
|
22
35
|
|
|
23
36
|
Please see [Atlaskit - Editor plugin code block](https://atlaskit.atlassian.com/packages/editor/editor-plugin-code-block) for documentation and examples for this package.
|
|
24
37
|
|
|
38
|
+
### Plugin Configuration
|
|
39
|
+
|
|
40
|
+
The plugin accepts the following configuration options via `CodeBlockPluginOptions`:
|
|
41
|
+
|
|
42
|
+
- `allowCopyToClipboard`: Enable/disable the copy to clipboard button (boolean)
|
|
43
|
+
- `overrideLanguageName`: Function to customize language display names
|
|
44
|
+
- `useLongPressSelection`: Enable long-press selection on mobile (boolean)
|
|
45
|
+
- `allowCompositionInputOverride`: Allow composition input override on mobile (boolean)
|
|
46
|
+
|
|
47
|
+
### Plugin Actions
|
|
48
|
+
|
|
49
|
+
The plugin provides the following action:
|
|
50
|
+
|
|
51
|
+
- `insertCodeBlock(inputMethod)`: Insert a code block at the current selection with analytics tracking
|
|
52
|
+
|
|
25
53
|
## Support
|
|
26
54
|
---
|
|
27
55
|
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.
|
|
56
|
+
|
|
28
57
|
## License
|
|
29
58
|
---
|
|
30
|
-
|
|
59
|
+
Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/editor-plugin-code-block",
|
|
3
|
-
"version": "9.0.
|
|
3
|
+
"version": "9.0.16",
|
|
4
4
|
"description": "Code block plugin for @atlaskit/editor-core",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -43,11 +43,11 @@
|
|
|
43
43
|
"@atlaskit/icon": "^31.0.0",
|
|
44
44
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
45
45
|
"@atlaskit/prosemirror-input-rules": "^3.6.0",
|
|
46
|
-
"@atlaskit/tmp-editor-statsig": "^
|
|
46
|
+
"@atlaskit/tmp-editor-statsig": "^26.0.0",
|
|
47
47
|
"@babel/runtime": "^7.0.0"
|
|
48
48
|
},
|
|
49
49
|
"peerDependencies": {
|
|
50
|
-
"@atlaskit/editor-common": "^111.
|
|
50
|
+
"@atlaskit/editor-common": "^111.16.0",
|
|
51
51
|
"react": "^18.2.0",
|
|
52
52
|
"react-intl-next": "npm:react-intl@^5.18.1"
|
|
53
53
|
},
|