@atlaskit/editor-plugin-layout 3.1.10 → 3.1.11

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 CHANGED
@@ -1,5 +1,13 @@
1
1
  # @atlaskit/editor-plugin-layout
2
2
 
3
+ ## 3.1.11
4
+
5
+ ### Patch Changes
6
+
7
+ - [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
8
+ Sorted type and interface props to improve Atlaskit docs
9
+ - Updated dependencies
10
+
3
11
  ## 3.1.10
4
12
 
5
13
  ### Patch Changes
@@ -18,9 +18,9 @@ export type LayoutPluginDependencies = [
18
18
  OptionalPlugin<InteractionPlugin>
19
19
  ];
20
20
  export type LayoutPlugin = NextEditorPlugin<'layout', {
21
- pluginConfiguration: LayoutPluginOptions | undefined;
22
- dependencies: LayoutPluginDependencies;
23
21
  actions: {
24
22
  insertLayoutColumns: ReturnType<typeof insertLayoutColumnsWithAnalytics>;
25
23
  };
24
+ dependencies: LayoutPluginDependencies;
25
+ pluginConfiguration: LayoutPluginOptions | undefined;
26
26
  }>;
@@ -8,13 +8,13 @@ import { type EditorView } from '@atlaskit/editor-prosemirror/view';
8
8
  import { type LayoutPlugin } from '../layoutPluginType';
9
9
  import { type LayoutPluginOptions } from '../types';
10
10
  type LayoutSectionViewProps = {
11
- node: PMNode;
12
- view: EditorView;
13
- getPos: getPosHandlerNode;
14
- portalProviderAPI: PortalProviderAPI;
15
11
  eventDispatcher: EventDispatcher;
16
- pluginInjectionApi?: ExtractInjectionAPI<LayoutPlugin>;
12
+ getPos: getPosHandlerNode;
13
+ node: PMNode;
17
14
  options: LayoutPluginOptions;
15
+ pluginInjectionApi?: ExtractInjectionAPI<LayoutPlugin>;
16
+ portalProviderAPI: PortalProviderAPI;
17
+ view: EditorView;
18
18
  };
19
19
  type ForwardRef = (ref: HTMLElement | null) => void;
20
20
  /**
@@ -37,13 +37,13 @@ export declare class LayoutSectionView extends ReactNodeView<LayoutSectionViewPr
37
37
  * @example
38
38
  */
39
39
  constructor(props: {
40
- node: PMNode;
41
- view: EditorView;
42
- getPos: getPosHandlerNode;
43
- portalProviderAPI: PortalProviderAPI;
44
40
  eventDispatcher: EventDispatcher;
45
- pluginInjectionApi: ExtractInjectionAPI<LayoutPlugin>;
41
+ getPos: getPosHandlerNode;
42
+ node: PMNode;
46
43
  options: LayoutPluginOptions;
44
+ pluginInjectionApi: ExtractInjectionAPI<LayoutPlugin>;
45
+ portalProviderAPI: PortalProviderAPI;
46
+ view: EditorView;
47
47
  });
48
48
  /**
49
49
  * getContentDOM
@@ -76,8 +76,8 @@ export declare class LayoutSectionView extends ReactNodeView<LayoutSectionViewPr
76
76
  * @returns
77
77
  */
78
78
  ignoreMutation(mutation: MutationRecord | {
79
- type: 'selection';
80
79
  target: Node;
80
+ type: 'selection';
81
81
  }): boolean;
82
82
  }
83
83
  export {};
@@ -1,15 +1,15 @@
1
1
  import type { Slice } from '@atlaskit/editor-prosemirror/model';
2
2
  import type { PresetLayout } from '../types';
3
3
  export type LayoutState = {
4
- pos: number | null;
5
- allowBreakout: boolean;
6
4
  addSidebarLayouts: boolean;
7
- selectedLayout: PresetLayout | undefined;
5
+ allowBreakout: boolean;
8
6
  allowSingleColumnLayout: boolean;
9
7
  isResizing: boolean;
8
+ pos: number | null;
9
+ selectedLayout: PresetLayout | undefined;
10
10
  };
11
11
  export type Change = {
12
12
  from: number;
13
- to: number;
14
13
  slice: Slice;
14
+ to: number;
15
15
  };
@@ -2,6 +2,7 @@ import type { EditorAppearance, LongPressSelectionPluginOptions } from '@atlaski
2
2
  import type { Slice } from '@atlaskit/editor-prosemirror/model';
3
3
  export interface LayoutPluginOptions extends LongPressSelectionPluginOptions {
4
4
  allowBreakout?: boolean;
5
+ editorAppearance?: EditorAppearance;
5
6
  UNSAFE_addSidebarLayouts?: boolean;
6
7
  /**
7
8
  * @private
@@ -9,11 +10,10 @@ export interface LayoutPluginOptions extends LongPressSelectionPluginOptions {
9
10
  * @see https://product-fabric.atlassian.net/browse/ED-26662
10
11
  */
11
12
  UNSAFE_allowSingleColumnLayout?: boolean;
12
- editorAppearance?: EditorAppearance;
13
13
  }
14
14
  export type PresetLayout = 'single' | 'two_equal' | 'three_equal' | 'two_right_sidebar' | 'two_left_sidebar' | 'three_with_sidebars' | 'three_left_sidebars' | 'three_right_sidebars' | 'four_equal' | 'five_equal';
15
15
  export interface Change {
16
16
  from: number;
17
- to: number;
18
17
  slice: Slice;
18
+ to: number;
19
19
  }
@@ -18,9 +18,9 @@ export type LayoutPluginDependencies = [
18
18
  OptionalPlugin<InteractionPlugin>
19
19
  ];
20
20
  export type LayoutPlugin = NextEditorPlugin<'layout', {
21
- pluginConfiguration: LayoutPluginOptions | undefined;
22
- dependencies: LayoutPluginDependencies;
23
21
  actions: {
24
22
  insertLayoutColumns: ReturnType<typeof insertLayoutColumnsWithAnalytics>;
25
23
  };
24
+ dependencies: LayoutPluginDependencies;
25
+ pluginConfiguration: LayoutPluginOptions | undefined;
26
26
  }>;
@@ -8,13 +8,13 @@ import { type EditorView } from '@atlaskit/editor-prosemirror/view';
8
8
  import { type LayoutPlugin } from '../layoutPluginType';
9
9
  import { type LayoutPluginOptions } from '../types';
10
10
  type LayoutSectionViewProps = {
11
- node: PMNode;
12
- view: EditorView;
13
- getPos: getPosHandlerNode;
14
- portalProviderAPI: PortalProviderAPI;
15
11
  eventDispatcher: EventDispatcher;
16
- pluginInjectionApi?: ExtractInjectionAPI<LayoutPlugin>;
12
+ getPos: getPosHandlerNode;
13
+ node: PMNode;
17
14
  options: LayoutPluginOptions;
15
+ pluginInjectionApi?: ExtractInjectionAPI<LayoutPlugin>;
16
+ portalProviderAPI: PortalProviderAPI;
17
+ view: EditorView;
18
18
  };
19
19
  type ForwardRef = (ref: HTMLElement | null) => void;
20
20
  /**
@@ -37,13 +37,13 @@ export declare class LayoutSectionView extends ReactNodeView<LayoutSectionViewPr
37
37
  * @example
38
38
  */
39
39
  constructor(props: {
40
- node: PMNode;
41
- view: EditorView;
42
- getPos: getPosHandlerNode;
43
- portalProviderAPI: PortalProviderAPI;
44
40
  eventDispatcher: EventDispatcher;
45
- pluginInjectionApi: ExtractInjectionAPI<LayoutPlugin>;
41
+ getPos: getPosHandlerNode;
42
+ node: PMNode;
46
43
  options: LayoutPluginOptions;
44
+ pluginInjectionApi: ExtractInjectionAPI<LayoutPlugin>;
45
+ portalProviderAPI: PortalProviderAPI;
46
+ view: EditorView;
47
47
  });
48
48
  /**
49
49
  * getContentDOM
@@ -76,8 +76,8 @@ export declare class LayoutSectionView extends ReactNodeView<LayoutSectionViewPr
76
76
  * @returns
77
77
  */
78
78
  ignoreMutation(mutation: MutationRecord | {
79
- type: 'selection';
80
79
  target: Node;
80
+ type: 'selection';
81
81
  }): boolean;
82
82
  }
83
83
  export {};
@@ -1,15 +1,15 @@
1
1
  import type { Slice } from '@atlaskit/editor-prosemirror/model';
2
2
  import type { PresetLayout } from '../types';
3
3
  export type LayoutState = {
4
- pos: number | null;
5
- allowBreakout: boolean;
6
4
  addSidebarLayouts: boolean;
7
- selectedLayout: PresetLayout | undefined;
5
+ allowBreakout: boolean;
8
6
  allowSingleColumnLayout: boolean;
9
7
  isResizing: boolean;
8
+ pos: number | null;
9
+ selectedLayout: PresetLayout | undefined;
10
10
  };
11
11
  export type Change = {
12
12
  from: number;
13
- to: number;
14
13
  slice: Slice;
14
+ to: number;
15
15
  };
@@ -2,6 +2,7 @@ import type { EditorAppearance, LongPressSelectionPluginOptions } from '@atlaski
2
2
  import type { Slice } from '@atlaskit/editor-prosemirror/model';
3
3
  export interface LayoutPluginOptions extends LongPressSelectionPluginOptions {
4
4
  allowBreakout?: boolean;
5
+ editorAppearance?: EditorAppearance;
5
6
  UNSAFE_addSidebarLayouts?: boolean;
6
7
  /**
7
8
  * @private
@@ -9,11 +10,10 @@ export interface LayoutPluginOptions extends LongPressSelectionPluginOptions {
9
10
  * @see https://product-fabric.atlassian.net/browse/ED-26662
10
11
  */
11
12
  UNSAFE_allowSingleColumnLayout?: boolean;
12
- editorAppearance?: EditorAppearance;
13
13
  }
14
14
  export type PresetLayout = 'single' | 'two_equal' | 'three_equal' | 'two_right_sidebar' | 'two_left_sidebar' | 'three_with_sidebars' | 'three_left_sidebars' | 'three_right_sidebars' | 'four_equal' | 'five_equal';
15
15
  export interface Change {
16
16
  from: number;
17
- to: number;
18
17
  slice: Slice;
18
+ to: number;
19
19
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-layout",
3
- "version": "3.1.10",
3
+ "version": "3.1.11",
4
4
  "description": "Layout plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -38,20 +38,20 @@
38
38
  "@atlaskit/editor-plugin-editor-disabled": "^3.0.0",
39
39
  "@atlaskit/editor-plugin-guideline": "^3.0.0",
40
40
  "@atlaskit/editor-plugin-interaction": "^5.0.0",
41
- "@atlaskit/editor-plugin-selection": "^3.1.0",
41
+ "@atlaskit/editor-plugin-selection": "^3.2.0",
42
42
  "@atlaskit/editor-plugin-width": "^4.0.0",
43
43
  "@atlaskit/editor-prosemirror": "7.0.0",
44
44
  "@atlaskit/editor-shared-styles": "^3.6.0",
45
45
  "@atlaskit/icon": "^28.0.0",
46
46
  "@atlaskit/icon-lab": "^5.6.0",
47
47
  "@atlaskit/platform-feature-flags": "^1.1.0",
48
- "@atlaskit/tmp-editor-statsig": "^11.3.0",
48
+ "@atlaskit/tmp-editor-statsig": "^11.5.0",
49
49
  "@atlaskit/tokens": "^6.0.0",
50
50
  "@babel/runtime": "^7.0.0",
51
51
  "@emotion/react": "^11.7.1"
52
52
  },
53
53
  "peerDependencies": {
54
- "@atlaskit/editor-common": "^107.26.0",
54
+ "@atlaskit/editor-common": "^107.28.0",
55
55
  "react": "^18.2.0",
56
56
  "react-intl-next": "npm:react-intl@^5.18.1"
57
57
  },