@atlaskit/editor-plugin-guideline 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-plugin-guideline
 
+## 0.3.1
+
+### Patch Changes
+
+- [`7cd4abcdc0d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7cd4abcdc0d) - Fix workaround in `editor-plugin-width`. This involved removing `WidthEmitter` in `editor-core`, removing `containerWidth` from `WidthPluginState`. This change also introduces `usePluginHook` for an `EditorPlugin` - this enables a react hook to be mounted for plugins (in all appearances).
+- Updated dependencies
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/cjs/plugin.js

@@ -59,7 +59,7 @@ var ContentComponent = function ContentComponent(_ref) {
   var _useSharedPluginState = (0, _hooks.useSharedPluginState)(api, ['width', 'guideline']),
     widthState = _useSharedPluginState.widthState,
     guidelineState = _useSharedPluginState.guidelineState;
-  if (!widthState || !widthState.containerWidth || !widthState.lineLength || !guidelineState || !guidelineState.guidelines || guidelineState.guidelines.length === 0) {
+  if (!widthState || !widthState.width || !widthState.lineLength || !guidelineState || !guidelineState.guidelines || guidelineState.guidelines.length === 0) {
     return null;
   }
   return (0, _react.jsx)("div", {
@@ -68,7 +68,7 @@ var ContentComponent = function ContentComponent(_ref) {
     guidelines: guidelineState.guidelines,
     height: editorView.dom.scrollHeight,
     centerOffset: (0, _utils.getEditorCenterX)(editorView),
-    containerWidth: widthState.containerWidth,
+    width: widthState.width,
     editorWidth: widthState.lineLength
   }));
 };

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-plugin-guideline",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"sideEffects": false
 }

package/dist/es2019/plugin.js

@@ -53,7 +53,7 @@ const ContentComponent = ({
     widthState,
     guidelineState
   } = useSharedPluginState(api, ['width', 'guideline']);
-  if (!widthState || !widthState.containerWidth || !widthState.lineLength || !guidelineState || !guidelineState.guidelines || guidelineState.guidelines.length === 0) {
+  if (!widthState || !widthState.width || !widthState.lineLength || !guidelineState || !guidelineState.guidelines || guidelineState.guidelines.length === 0) {
     return null;
   }
   return jsx("div", {
@@ -62,7 +62,7 @@ const ContentComponent = ({
     guidelines: guidelineState.guidelines,
     height: editorView.dom.scrollHeight,
     centerOffset: getEditorCenterX(editorView),
-    containerWidth: widthState.containerWidth,
+    width: widthState.width,
     editorWidth: widthState.lineLength
   }));
 };

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-plugin-guideline",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"sideEffects": false
 }

package/dist/esm/plugin.js

@@ -51,7 +51,7 @@ var ContentComponent = function ContentComponent(_ref) {
   var _useSharedPluginState = useSharedPluginState(api, ['width', 'guideline']),
     widthState = _useSharedPluginState.widthState,
     guidelineState = _useSharedPluginState.guidelineState;
-  if (!widthState || !widthState.containerWidth || !widthState.lineLength || !guidelineState || !guidelineState.guidelines || guidelineState.guidelines.length === 0) {
+  if (!widthState || !widthState.width || !widthState.lineLength || !guidelineState || !guidelineState.guidelines || guidelineState.guidelines.length === 0) {
     return null;
   }
   return jsx("div", {
@@ -60,7 +60,7 @@ var ContentComponent = function ContentComponent(_ref) {
     guidelines: guidelineState.guidelines,
     height: editorView.dom.scrollHeight,
     centerOffset: getEditorCenterX(editorView),
-    containerWidth: widthState.containerWidth,
+    width: widthState.width,
     editorWidth: widthState.lineLength
   }));
 };

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-plugin-guideline",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"sideEffects": false
 }

package/dist/types/guildelineContainer.d.ts

@@ -4,7 +4,7 @@ type ContainerProps = {
     guidelines: GuidelineConfig[];
     height: number;
     centerOffset: number;
-    containerWidth: number;
+    width: number;
     editorWidth: number;
 };
 export declare const GuidelineContainer: (props: ContainerProps) => jsx.JSX.Element;

package/dist/types-ts4.5/guildelineContainer.d.ts

@@ -4,7 +4,7 @@ type ContainerProps = {
     guidelines: GuidelineConfig[];
     height: number;
     centerOffset: number;
-    containerWidth: number;
+    width: number;
     editorWidth: number;
 };
 export declare const GuidelineContainer: (props: ContainerProps) => jsx.JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-guideline",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "guideline plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -9,7 +9,7 @@
   },
   "atlassian": {
     "team": "Editor",
-    "releaseModel": "scheduled"
+    "releaseModel": "continuous"
   },
   "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
   "main": "dist/cjs/index.js",
@@ -22,8 +22,8 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.4.0",
-    "@atlaskit/editor-plugin-width": "^0.0.1",
+    "@atlaskit/editor-common": "^74.5.0",
+    "@atlaskit/editor-plugin-width": "^0.1.0",
     "@atlaskit/editor-shared-styles": "^2.4.0",
     "@atlaskit/theme": "^12.5.0",
     "@atlaskit/tokens": "^1.4.2",

package/report.api.md

@@ -28,23 +28,13 @@ type DisplayGuideline = (view: EditorView) => DisplayGrid;
 // @public (undocumented)
 export type GuidelineConfig = {
   key: string;
-  position: GuidelinePosition;
+  position: Position;
   active?: boolean;
   show?: boolean;
   style?: 'dashed' | 'solid';
   color?: string;
 };
 
-// @public (undocumented)
-enum GuidelineContainerArea {
-  // (undocumented)
-  EditorContent = 'editorContent',
-  // (undocumented)
-  EditorLeftMargin = 'editorLeftMargin',
-  // (undocumented)
-  EditorRightMargin = 'editorRightMargin',
-}
-
 // @public (undocumented)
 export const guidelinePlugin: NextEditorPlugin<
   'guideline',
@@ -63,23 +53,9 @@ type GuidelinePluginState = {
 };
 
 // @public (undocumented)
-type GuidelinePosition = {
-  containerArea?: GuidelineContainerArea;
-} & PositionSide;
-
-// @public (undocumented)
-type PositionSide =
-  | {
-      left: PositionValue;
-      right?: never;
-    }
-  | {
-      right: PositionValue;
-      left?: never;
-    };
-
-// @public (undocumented)
-type PositionValue = 0 | `${number}%` | `${number}px`;
+type Position = {
+  x: number;
+};
 
 // (No @packageDocumentation comment for this package)
 ```

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,48 @@
+## API Report File for "@atlaskit/editor-plugin-guideline"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { EditorView } from 'prosemirror-view';
+import { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { widthPlugin } from '@atlaskit/editor-plugin-width';
+
+// @public (undocumented)
+type DisplayGrid = (props: Required<GuidelinePluginState>) => boolean;
+
+// @public (undocumented)
+type DisplayGuideline = (view: EditorView) => DisplayGrid;
+
+// @public (undocumented)
+export type GuidelineConfig = {
+    key: string;
+    position: Position;
+    active?: boolean;
+    show?: boolean;
+    style?: 'dashed' | 'solid';
+    color?: string;
+};
+
+// @public (undocumented)
+export const guidelinePlugin: NextEditorPlugin<'guideline', {
+    dependencies: [typeof widthPlugin];
+    sharedState: GuidelinePluginState | null;
+    actions: {
+        displayGuideline: DisplayGuideline;
+    };
+}>;
+
+// @public (undocumented)
+type GuidelinePluginState = {
+    guidelines: GuidelineConfig[];
+};
+
+// @public (undocumented)
+type Position = {
+    x: number;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```