@atlaskit/editor-plugin-breakout 8.0.0 → 8.0.2
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 +14 -0
- package/README.md +14 -1
- package/dist/cjs/ui/LayoutButton.js +2 -1
- package/dist/es2019/ui/LayoutButton.js +2 -1
- package/dist/esm/ui/LayoutButton.js +2 -1
- package/dist/types/pm-plugins/get-guidelines.d.ts +2 -1
- package/dist/types/ui/LayoutButton.d.ts +9 -4
- package/dist/types-ts4.5/pm-plugins/get-guidelines.d.ts +2 -1
- package/dist/types-ts4.5/ui/LayoutButton.d.ts +9 -4
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @atlaskit/editor-plugin-breakout
|
|
2
2
|
|
|
3
|
+
## 8.0.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`d84e100ff2136`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d84e100ff2136) -
|
|
8
|
+
Update README.md and 0-intro.tsx
|
|
9
|
+
- Updated dependencies
|
|
10
|
+
|
|
11
|
+
## 8.0.1
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- Updated dependencies
|
|
16
|
+
|
|
3
17
|
## 8.0.0
|
|
4
18
|
|
|
5
19
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1,10 +1,23 @@
|
|
|
1
|
-
# Editor
|
|
1
|
+
# Editor Plugin Breakout
|
|
2
2
|
|
|
3
3
|
Breakout 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 Breakout plugin enables content within the Atlassian Editor to break out of the standard layout constraints. It provides interactive resizing and layout mode controls for supported nodes like code blocks, expansions, and other block-level content, allowing them to extend beyond their normal container boundaries.
|
|
11
|
+
|
|
12
|
+
## Key features
|
|
13
|
+
|
|
14
|
+
- **Layout modes** - Support for wide and full-width breakout modes
|
|
15
|
+
- **Interactive resizing** - Drag-based resizing of breakout nodes with visual guidelines
|
|
16
|
+
- **Multi-node support** - Breakout functionality for code blocks, expansions, and other configurable nodes
|
|
17
|
+
- **Guidelines and measurements** - Visual layout guidelines to assist with content positioning
|
|
18
|
+
- **Block control integration** - Seamless integration with editor block controls for easy mode switching
|
|
19
|
+
- **Responsive layout handling** - Proper layout adjustments across different editor appearances
|
|
20
|
+
|
|
8
21
|
## Install
|
|
9
22
|
---
|
|
10
23
|
- **Install** - *yarn add @atlaskit/editor-plugin-breakout*
|
|
@@ -180,4 +180,5 @@ var LayoutButton = function LayoutButton(_ref) {
|
|
|
180
180
|
})));
|
|
181
181
|
};
|
|
182
182
|
LayoutButton.displayName = 'LayoutButton';
|
|
183
|
-
var
|
|
183
|
+
var _default_1 = (0, _reactIntlNext.injectIntl)(LayoutButton);
|
|
184
|
+
var _default = exports.default = _default_1;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type MemoizedFn } from 'memoize-one';
|
|
1
2
|
import type { GuidelineConfig } from '@atlaskit/editor-common/guideline';
|
|
2
3
|
import type { EditorContainerWidth } from '@atlaskit/editor-common/types';
|
|
3
4
|
import { type NodeType } from '@atlaskit/editor-prosemirror/model';
|
|
@@ -11,4 +12,4 @@ export declare const GUIDELINE_KEYS: {
|
|
|
11
12
|
readonly maxWidthLeft: "max_width_left";
|
|
12
13
|
readonly maxWidthRight: "max_width_right";
|
|
13
14
|
};
|
|
14
|
-
export declare const getGuidelines:
|
|
15
|
+
export declare const getGuidelines: MemoizedFn<(isResizing: boolean, newWidth: number, getEditorWidth: () => EditorContainerWidth | undefined, nodeType?: NodeType | undefined) => GuidelineConfig[]>;
|
|
@@ -1,4 +1,9 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ComponentType, type FC } from 'react';
|
|
6
|
+
import type { WithIntlProps, WrappedComponentProps } from 'react-intl-next';
|
|
2
7
|
import type { BreakoutMode, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
|
|
3
8
|
import type { EditorView } from '@atlaskit/editor-prosemirror/view';
|
|
4
9
|
import type { BreakoutPlugin } from '../breakoutPluginType';
|
|
@@ -13,7 +18,7 @@ export interface Props {
|
|
|
13
18
|
mountPoint?: HTMLElement;
|
|
14
19
|
scrollableElement?: HTMLElement;
|
|
15
20
|
}
|
|
16
|
-
declare const
|
|
17
|
-
WrappedComponent:
|
|
21
|
+
declare const _default_1: FC<WithIntlProps<Props & WrappedComponentProps>> & {
|
|
22
|
+
WrappedComponent: ComponentType<Props & WrappedComponentProps>;
|
|
18
23
|
};
|
|
19
|
-
export default
|
|
24
|
+
export default _default_1;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type MemoizedFn } from 'memoize-one';
|
|
1
2
|
import type { GuidelineConfig } from '@atlaskit/editor-common/guideline';
|
|
2
3
|
import type { EditorContainerWidth } from '@atlaskit/editor-common/types';
|
|
3
4
|
import { type NodeType } from '@atlaskit/editor-prosemirror/model';
|
|
@@ -11,4 +12,4 @@ export declare const GUIDELINE_KEYS: {
|
|
|
11
12
|
readonly maxWidthLeft: "max_width_left";
|
|
12
13
|
readonly maxWidthRight: "max_width_right";
|
|
13
14
|
};
|
|
14
|
-
export declare const getGuidelines:
|
|
15
|
+
export declare const getGuidelines: MemoizedFn<(isResizing: boolean, newWidth: number, getEditorWidth: () => EditorContainerWidth | undefined, nodeType?: NodeType | undefined) => GuidelineConfig[]>;
|
|
@@ -1,4 +1,9 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ComponentType, type FC } from 'react';
|
|
6
|
+
import type { WithIntlProps, WrappedComponentProps } from 'react-intl-next';
|
|
2
7
|
import type { BreakoutMode, ExtractInjectionAPI } from '@atlaskit/editor-common/types';
|
|
3
8
|
import type { EditorView } from '@atlaskit/editor-prosemirror/view';
|
|
4
9
|
import type { BreakoutPlugin } from '../breakoutPluginType';
|
|
@@ -13,7 +18,7 @@ export interface Props {
|
|
|
13
18
|
mountPoint?: HTMLElement;
|
|
14
19
|
scrollableElement?: HTMLElement;
|
|
15
20
|
}
|
|
16
|
-
declare const
|
|
17
|
-
WrappedComponent:
|
|
21
|
+
declare const _default_1: FC<WithIntlProps<Props & WrappedComponentProps>> & {
|
|
22
|
+
WrappedComponent: ComponentType<Props & WrappedComponentProps>;
|
|
18
23
|
};
|
|
19
|
-
export default
|
|
24
|
+
export default _default_1;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/editor-plugin-breakout",
|
|
3
|
-
"version": "8.0.
|
|
3
|
+
"version": "8.0.2",
|
|
4
4
|
"description": "Breakout plugin for @atlaskit/editor-core",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
44
44
|
"@atlaskit/pragmatic-drag-and-drop": "^1.7.0",
|
|
45
45
|
"@atlaskit/theme": "^22.0.0",
|
|
46
|
-
"@atlaskit/tmp-editor-statsig": "^
|
|
46
|
+
"@atlaskit/tmp-editor-statsig": "^36.3.0",
|
|
47
47
|
"@atlaskit/tokens": "^11.1.0",
|
|
48
48
|
"@atlaskit/tooltip": "^20.14.0",
|
|
49
49
|
"@babel/runtime": "^7.0.0",
|
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
"uuid": "^3.1.0"
|
|
54
54
|
},
|
|
55
55
|
"peerDependencies": {
|
|
56
|
-
"@atlaskit/editor-common": "^112.
|
|
56
|
+
"@atlaskit/editor-common": "^112.2.0",
|
|
57
57
|
"react": "^18.2.0",
|
|
58
58
|
"react-dom": "^18.2.0",
|
|
59
59
|
"react-intl-next": "npm:react-intl@^5.18.1"
|