@atlaskit/editor-plugin-guideline 0.3.5 → 0.3.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-plugin-guideline
 
+## 0.3.6
+
+### Patch Changes
+
+- [`3d065399b07`](https://bitbucket.org/atlassian/atlassian-frontend/commits/3d065399b07) - ED-18969 refactor guideline plugin interface.
+
 ## 0.3.5
 
 ### Patch Changes

package/README.md

@@ -85,15 +85,19 @@ type GuidelineConfig = {
   ...
   active?: boolean;
   show?: boolean;
-  style?: 'dashed' | 'solid'; // default solid
-  color?: CSSToken;
+  styles: {
+    lineStyle?: 'dashed' | 'solid'; // default solid
+    color?: CSSToken;
+    capStyle?: 'line'
+  }
 };
 ```
 
 - `active` default `false`, equivalent to the `highlight` state in the `grid` plugin.
-- `style` default `solid`, and we also support `dashed`
 - `show` default `true` and you can also hide a guideline, could be useful when you need animations.
-- `color`: default `undefined` you can override the color of a guideline with a valid `css` color
+- `styles.color`: default `undefined` you can override the color of a guideline with a valid `css` color
+- `styles.lineStyle` default `solid`, and we also support `dashed`
+- `styles.capStyle` default undefined, and support `line`
 
 ## TODO
 - [ ] Add unit/vr tests

package/dist/cjs/guideline.js

@@ -75,12 +75,14 @@ var Guideline = function Guideline(props) {
     active = props.active,
     _props$show = props.show,
     show = _props$show === void 0 ? true : _props$show,
-    style = props.style,
-    color = props.color,
-    styles = props.styles;
+    _props$styles = props.styles,
+    styles = _props$styles === void 0 ? {} : _props$styles;
   var isVerticalPos = (0, _guideline.isVerticalPosition)(position);
+  var lineStyle = styles.lineStyle,
+    color = styles.color,
+    capStyle = styles.capStyle;
   return (0, _react.jsx)("div", {
-    css: [basicGuidelineStyles, isVerticalPos ? verticalStyles : horizontalStyles, (styles === null || styles === void 0 ? void 0 : styles.capStyle) === 'line' && (isVerticalPos ? horizontalCapStyles : verticalCapStyles), active && activeGuidelineStyles, !show && hiddenGuidelineStyles, style === 'dashed' && dashedGuidelineStyles],
+    css: [basicGuidelineStyles, isVerticalPos ? verticalStyles : horizontalStyles, capStyle === 'line' && (isVerticalPos ? horizontalCapStyles : verticalCapStyles), active && activeGuidelineStyles, !show && hiddenGuidelineStyles, lineStyle === 'dashed' && dashedGuidelineStyles],
     style: _objectSpread(_objectSpread({}, color && {
       borderColor: "".concat(color)
     }), (0, _positionStyles.getPositionStyles)(position)),

package/dist/cjs/version.json

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

package/dist/es2019/guideline.js

@@ -66,13 +66,16 @@ export const Guideline = props => {
     position,
     active,
     show = true,
-    style,
-    color,
-    styles
+    styles = {}
   } = props;
   const isVerticalPos = isVerticalPosition(position);
+  const {
+    lineStyle,
+    color,
+    capStyle
+  } = styles;
   return jsx("div", {
-    css: [basicGuidelineStyles, isVerticalPos ? verticalStyles : horizontalStyles, (styles === null || styles === void 0 ? void 0 : styles.capStyle) === 'line' && (isVerticalPos ? horizontalCapStyles : verticalCapStyles), active && activeGuidelineStyles, !show && hiddenGuidelineStyles, style === 'dashed' && dashedGuidelineStyles],
+    css: [basicGuidelineStyles, isVerticalPos ? verticalStyles : horizontalStyles, capStyle === 'line' && (isVerticalPos ? horizontalCapStyles : verticalCapStyles), active && activeGuidelineStyles, !show && hiddenGuidelineStyles, lineStyle === 'dashed' && dashedGuidelineStyles],
     style: {
       ...(color && {
         borderColor: `${color}`

package/dist/es2019/version.json

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

package/dist/esm/guideline.js

@@ -69,12 +69,14 @@ export var Guideline = function Guideline(props) {
     active = props.active,
     _props$show = props.show,
     show = _props$show === void 0 ? true : _props$show,
-    style = props.style,
-    color = props.color,
-    styles = props.styles;
+    _props$styles = props.styles,
+    styles = _props$styles === void 0 ? {} : _props$styles;
   var isVerticalPos = isVerticalPosition(position);
+  var lineStyle = styles.lineStyle,
+    color = styles.color,
+    capStyle = styles.capStyle;
   return jsx("div", {
-    css: [basicGuidelineStyles, isVerticalPos ? verticalStyles : horizontalStyles, (styles === null || styles === void 0 ? void 0 : styles.capStyle) === 'line' && (isVerticalPos ? horizontalCapStyles : verticalCapStyles), active && activeGuidelineStyles, !show && hiddenGuidelineStyles, style === 'dashed' && dashedGuidelineStyles],
+    css: [basicGuidelineStyles, isVerticalPos ? verticalStyles : horizontalStyles, capStyle === 'line' && (isVerticalPos ? horizontalCapStyles : verticalCapStyles), active && activeGuidelineStyles, !show && hiddenGuidelineStyles, lineStyle === 'dashed' && dashedGuidelineStyles],
     style: _objectSpread(_objectSpread({}, color && {
       borderColor: "".concat(color)
     }), getPositionStyles(position)),

package/dist/esm/version.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-guideline",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "description": "guideline plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -25,7 +25,7 @@
   "dependencies": {
     "@atlaskit/editor-common": "^74.26.0",
     "@atlaskit/editor-plugin-width": "^0.1.0",
-    "@atlaskit/editor-shared-styles": "^2.4.0",
+    "@atlaskit/editor-shared-styles": "^2.5.0",
     "@atlaskit/theme": "^12.5.0",
     "@atlaskit/tokens": "^1.13.0",
     "@babel/runtime": "^7.0.0",