@atlaskit/editor-plugin-grid 0.1.4 → 0.1.6

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,17 @@
1
1
  # @atlaskit/editor-plugin-grid
2
2
 
3
+ ## 0.1.6
4
+
5
+ ### Patch Changes
6
+
7
+ - [`24e27147cbd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/24e27147cbd) - Added atlaskit docs to all existing plugins.
8
+
9
+ ## 0.1.5
10
+
11
+ ### Patch Changes
12
+
13
+ - Updated dependencies
14
+
3
15
  ## 0.1.4
4
16
 
5
17
  ### Patch Changes
@@ -1,2 +1,3 @@
1
1
  export { gridPlugin } from './plugin';
2
+ export type { GridPlugin } from './plugin';
2
3
  export type { Highlights } from './types';
@@ -1,6 +1,6 @@
1
- import { NextEditorPlugin } from '@atlaskit/editor-common/types';
2
- import type { widthPlugin } from '@atlaskit/editor-plugin-width';
3
- import { EditorView } from '@atlaskit/editor-prosemirror/view';
1
+ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
2
+ import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
3
+ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
4
4
  import type { GridPluginState } from './types';
5
5
  export declare const GRID_SIZE = 12;
6
6
  type Required<T> = {
@@ -11,12 +11,13 @@ type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
11
11
  export interface GridPluginOptions {
12
12
  shouldCalcBreakoutGridLines?: boolean;
13
13
  }
14
- export declare const gridPlugin: NextEditorPlugin<'grid', {
14
+ export type GridPlugin = NextEditorPlugin<'grid', {
15
15
  pluginConfiguration: GridPluginOptions | undefined;
16
- dependencies: [typeof widthPlugin];
16
+ dependencies: [WidthPlugin];
17
17
  sharedState: GridPluginState | null;
18
18
  actions: {
19
19
  displayGrid: CreateDisplayGrid;
20
20
  };
21
21
  }>;
22
+ export declare const gridPlugin: GridPlugin;
22
23
  export {};
@@ -1,2 +1,3 @@
1
1
  export { gridPlugin } from './plugin';
2
+ export type { GridPlugin } from './plugin';
2
3
  export type { Highlights } from './types';
@@ -1,6 +1,6 @@
1
- import { NextEditorPlugin } from '@atlaskit/editor-common/types';
2
- import type { widthPlugin } from '@atlaskit/editor-plugin-width';
3
- import { EditorView } from '@atlaskit/editor-prosemirror/view';
1
+ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
2
+ import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
3
+ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
4
4
  import type { GridPluginState } from './types';
5
5
  export declare const GRID_SIZE = 12;
6
6
  type Required<T> = {
@@ -11,14 +11,15 @@ type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
11
11
  export interface GridPluginOptions {
12
12
  shouldCalcBreakoutGridLines?: boolean;
13
13
  }
14
- export declare const gridPlugin: NextEditorPlugin<'grid', {
14
+ export type GridPlugin = NextEditorPlugin<'grid', {
15
15
  pluginConfiguration: GridPluginOptions | undefined;
16
16
  dependencies: [
17
- typeof widthPlugin
17
+ WidthPlugin
18
18
  ];
19
19
  sharedState: GridPluginState | null;
20
20
  actions: {
21
21
  displayGrid: CreateDisplayGrid;
22
22
  };
23
23
  }>;
24
+ export declare const gridPlugin: GridPlugin;
24
25
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-grid",
3
- "version": "0.1.4",
3
+ "version": "0.1.6",
4
4
  "description": "Grid plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -23,10 +23,10 @@
23
23
  ".": "./src/index.ts"
24
24
  },
25
25
  "dependencies": {
26
- "@atlaskit/editor-common": "^74.29.0",
26
+ "@atlaskit/editor-common": "^74.52.0",
27
27
  "@atlaskit/editor-plugin-width": "^0.1.0",
28
- "@atlaskit/editor-prosemirror": "1.0.2",
29
- "@atlaskit/editor-shared-styles": "^2.5.0",
28
+ "@atlaskit/editor-prosemirror": "1.1.0",
29
+ "@atlaskit/editor-shared-styles": "^2.6.0",
30
30
  "@babel/runtime": "^7.0.0",
31
31
  "@emotion/react": "^11.7.1",
32
32
  "classnames": "^2.2.5"
@@ -35,7 +35,6 @@
35
35
  "react": "^16.8.0"
36
36
  },
37
37
  "devDependencies": {
38
- "@atlaskit/editor-test-helpers": "^18.10.0",
39
38
  "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
40
39
  "@testing-library/react": "^12.1.5",
41
40
  "react-dom": "^16.8.0",
package/report.api.md CHANGED
@@ -15,10 +15,10 @@
15
15
  <!--SECTION START: Main Entry Types-->
16
16
 
17
17
  ```ts
18
- import { EditorView } from '@atlaskit/editor-prosemirror/view';
18
+ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
19
19
  import type { GridType } from '@atlaskit/editor-common/types';
20
- import { NextEditorPlugin } from '@atlaskit/editor-common/types';
21
- import type { widthPlugin } from '@atlaskit/editor-plugin-width';
20
+ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
21
+ import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
22
22
 
23
23
  // @public (undocumented)
24
24
  type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
@@ -27,11 +27,11 @@ type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
27
27
  type DisplayGrid = (props: Required_2<GridPluginState>) => boolean;
28
28
 
29
29
  // @public (undocumented)
30
- export const gridPlugin: NextEditorPlugin<
30
+ export type GridPlugin = NextEditorPlugin<
31
31
  'grid',
32
32
  {
33
33
  pluginConfiguration: GridPluginOptions | undefined;
34
- dependencies: [typeof widthPlugin];
34
+ dependencies: [WidthPlugin];
35
35
  sharedState: GridPluginState | null;
36
36
  actions: {
37
37
  displayGrid: CreateDisplayGrid;
@@ -39,6 +39,9 @@ export const gridPlugin: NextEditorPlugin<
39
39
  }
40
40
  >;
41
41
 
42
+ // @public (undocumented)
43
+ export const gridPlugin: GridPlugin;
44
+
42
45
  // @public (undocumented)
43
46
  interface GridPluginOptions {
44
47
  // (undocumented)
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/editor-plugin-grid",
3
- "version": "0.1.4",
4
- "sideEffects": false
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/editor-plugin-grid",
3
- "version": "0.1.4",
4
- "sideEffects": false
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/editor-plugin-grid",
3
- "version": "0.1.4",
4
- "sideEffects": false
5
- }
@@ -1,51 +0,0 @@
1
- ## API Report File for "@atlaskit/editor-plugin-grid"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { EditorView } from '@atlaskit/editor-prosemirror/view';
8
- import type { GridType } from '@atlaskit/editor-common/types';
9
- import { NextEditorPlugin } from '@atlaskit/editor-common/types';
10
- import type { widthPlugin } from '@atlaskit/editor-plugin-width';
11
-
12
- // @public (undocumented)
13
- type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
14
-
15
- // @public (undocumented)
16
- type DisplayGrid = (props: Required_2<GridPluginState>) => boolean;
17
-
18
- // @public (undocumented)
19
- export const gridPlugin: NextEditorPlugin<'grid', {
20
- pluginConfiguration: GridPluginOptions | undefined;
21
- dependencies: [typeof widthPlugin];
22
- sharedState: GridPluginState | null;
23
- actions: {
24
- displayGrid: CreateDisplayGrid;
25
- };
26
- }>;
27
-
28
- // @public (undocumented)
29
- interface GridPluginOptions {
30
- // (undocumented)
31
- shouldCalcBreakoutGridLines?: boolean;
32
- }
33
-
34
- // @public (undocumented)
35
- type GridPluginState = {
36
- visible: boolean;
37
- gridType?: GridType;
38
- highlight: Highlights;
39
- };
40
-
41
- // @public (undocumented)
42
- export type Highlights = Array<'full-width' | 'wide' | number>;
43
-
44
- // @public (undocumented)
45
- type Required_2<T> = {
46
- [P in keyof T]-?: T[P];
47
- };
48
-
49
- // (No @packageDocumentation comment for this package)
50
-
51
- ```