@atlaskit/editor-plugin-decorations 0.1.2 → 0.1.4

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-decorations
2
2
 
3
+ ## 0.1.4
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.3
10
+
11
+ ### Patch Changes
12
+
13
+ - Updated dependencies
14
+
3
15
  ## 0.1.2
4
16
 
5
17
  ### Patch Changes
@@ -1,2 +1,3 @@
1
1
  export { decorationsPlugin } from './plugin';
2
+ export type { DecorationsPlugin } from './plugin';
2
3
  export type { HoverDecorationHandler, DecorationState } from './pm-plugin';
@@ -1,9 +1,11 @@
1
1
  import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
2
- import { DecorationState, HoverDecorationHandler, removeDecoration } from './pm-plugin';
3
- export declare const decorationsPlugin: NextEditorPlugin<'decorations', {
2
+ import type { DecorationState, HoverDecorationHandler } from './pm-plugin';
3
+ import { removeDecoration } from './pm-plugin';
4
+ export type DecorationsPlugin = NextEditorPlugin<'decorations', {
4
5
  sharedState: DecorationState;
5
6
  actions: {
6
7
  hoverDecoration: HoverDecorationHandler;
7
8
  removeDecoration: typeof removeDecoration;
8
9
  };
9
10
  }>;
11
+ export declare const decorationsPlugin: DecorationsPlugin;
@@ -15,5 +15,5 @@ export type DecorationState = {
15
15
  };
16
16
  type HoverDecorationHandler = typeof hoverDecoration;
17
17
  export type { HoverDecorationHandler };
18
- declare const _default: () => SafePlugin<any>;
18
+ declare const _default: () => SafePlugin<DecorationState>;
19
19
  export default _default;
@@ -1,2 +1,3 @@
1
1
  export { decorationsPlugin } from './plugin';
2
+ export type { DecorationsPlugin } from './plugin';
2
3
  export type { HoverDecorationHandler, DecorationState } from './pm-plugin';
@@ -1,9 +1,11 @@
1
1
  import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
2
- import { DecorationState, HoverDecorationHandler, removeDecoration } from './pm-plugin';
3
- export declare const decorationsPlugin: NextEditorPlugin<'decorations', {
2
+ import type { DecorationState, HoverDecorationHandler } from './pm-plugin';
3
+ import { removeDecoration } from './pm-plugin';
4
+ export type DecorationsPlugin = NextEditorPlugin<'decorations', {
4
5
  sharedState: DecorationState;
5
6
  actions: {
6
7
  hoverDecoration: HoverDecorationHandler;
7
8
  removeDecoration: typeof removeDecoration;
8
9
  };
9
10
  }>;
11
+ export declare const decorationsPlugin: DecorationsPlugin;
@@ -15,5 +15,5 @@ export type DecorationState = {
15
15
  };
16
16
  type HoverDecorationHandler = typeof hoverDecoration;
17
17
  export type { HoverDecorationHandler };
18
- declare const _default: () => SafePlugin<any>;
18
+ declare const _default: () => SafePlugin<DecorationState>;
19
19
  export default _default;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-decorations",
3
- "version": "0.1.2",
3
+ "version": "0.1.4",
4
4
  "description": "Decorations plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -23,15 +23,14 @@
23
23
  ".": "./src/index.ts"
24
24
  },
25
25
  "dependencies": {
26
- "@atlaskit/editor-common": "^74.29.0",
27
- "@atlaskit/editor-prosemirror": "1.0.2",
26
+ "@atlaskit/editor-common": "^74.52.0",
27
+ "@atlaskit/editor-prosemirror": "1.1.0",
28
28
  "@babel/runtime": "^7.0.0"
29
29
  },
30
30
  "peerDependencies": {
31
31
  "react": "^16.8.0"
32
32
  },
33
33
  "devDependencies": {
34
- "@atlaskit/editor-test-helpers": "^18.10.0",
35
34
  "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
36
35
  "@testing-library/react": "^12.1.5",
37
36
  "react-dom": "^16.8.0",
package/report.api.md CHANGED
@@ -21,7 +21,7 @@ import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
21
21
  import { NodeType } from '@atlaskit/editor-prosemirror/model';
22
22
 
23
23
  // @public (undocumented)
24
- export const decorationsPlugin: NextEditorPlugin<
24
+ export type DecorationsPlugin = NextEditorPlugin<
25
25
  'decorations',
26
26
  {
27
27
  sharedState: DecorationState;
@@ -32,6 +32,9 @@ export const decorationsPlugin: NextEditorPlugin<
32
32
  }
33
33
  >;
34
34
 
35
+ // @public (undocumented)
36
+ export const decorationsPlugin: DecorationsPlugin;
37
+
35
38
  // @public (undocumented)
36
39
  export type DecorationState = {
37
40
  decoration?: Decoration;
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/editor-plugin-decorations",
3
- "version": "0.1.2",
4
- "sideEffects": false
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/editor-plugin-decorations",
3
- "version": "0.1.2",
4
- "sideEffects": false
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/editor-plugin-decorations",
3
- "version": "0.1.2",
4
- "sideEffects": false
5
- }
@@ -1,37 +0,0 @@
1
- ## API Report File for "@atlaskit/editor-plugin-decorations"
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 type { Command } from '@atlaskit/editor-common/types';
8
- import { Decoration } from '@atlaskit/editor-prosemirror/view';
9
- import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
10
- import { NodeType } from '@atlaskit/editor-prosemirror/model';
11
-
12
- // @public (undocumented)
13
- export const decorationsPlugin: NextEditorPlugin<'decorations', {
14
- sharedState: DecorationState;
15
- actions: {
16
- hoverDecoration: HoverDecorationHandler;
17
- removeDecoration: typeof removeDecoration;
18
- };
19
- }>;
20
-
21
- // @public (undocumented)
22
- export type DecorationState = {
23
- decoration?: Decoration;
24
- };
25
-
26
- // @public (undocumented)
27
- const hoverDecoration: (nodeType: Array<NodeType> | NodeType, add: boolean, className?: string) => Command;
28
-
29
- // @public (undocumented)
30
- export type HoverDecorationHandler = typeof hoverDecoration;
31
-
32
- // @public (undocumented)
33
- const removeDecoration: Command;
34
-
35
- // (No @packageDocumentation comment for this package)
36
-
37
- ```