cx-diagrams 22.3.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2022 Codaxy d.o.o. Banja Luka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+<br />
+
+<p align="center">
+  <a href="https://diagrams.cxjs.io">
+    <img src="../../docs/assets/img/logo.svg" height="142" alt="logo">
+  </a>
+</p>
+
+<p align="center" style="font-weight: bold; font-size: 24px">
+CxJS Diagrams
+</p>
+
+<p align="center">
+    <img src="https://img.shields.io/npm/v/cx-diagrams" alt="version" /> 
+</p>
+
+<br />
+
+This is a simple library that allows you to create diagrams within CxJS applications.
+
+```js
+import { Diagram, Flow, Cell, Shape } from "cx-diagrams";
+
+<Svg class="w-auto h-full bg-white">
+  <Diagram unitSize={32} showGrid center>
+    <Flow gap={1}>
+      <Cell width={2}>
+        <Shape stroke="red" fill="white" text="Red" />
+      </Cell>
+      <Cell width={2}>
+        <Shape stroke="blue" fill="white" text="Blue" />
+      </Cell>
+    </Flow>
+  </Diagram>
+</Svg>;
+```
+
+Please refer to [the documentation](https://diagrams.cxjs.io) and [the GitHub repository](https://github.com/codaxy/cx-diagrams) for more information and usage examples.
+
+## License
+
+This package is available under [the MIT license](./LICENSE.md).

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "cx-diagrams",
+  "version": "22.3.0",
+  "description": "A library for creating diagrams within CxJS applications",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "diagrams",
+    "cxjs"
+  ],
+  "author": "Codaxy d.o.o.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:codaxy/cx-diagrams.git"
+  },
+  "peerDependencies": {
+    "cx": "^22.1.0"
+  }
+}

package/src/Cell.d.ts

@@ -0,0 +1,18 @@
+import { NumberProp, Widget } from "cx/src/core";
+import { NodeProps } from "./Node";
+
+export interface CellProps extends NodeProps {
+   /**Width of the cell. */
+   width?: NumberProp;
+
+   /**Width of the cell. */
+   w?: NumberProp;
+
+   /**Height of the cell. */
+   height?: NumberProp;
+
+   /**Height of the cell. */
+   h?: NumberProp;
+}
+
+export class Cell extends Widget<CellProps> {}

package/src/Cell.js

@@ -0,0 +1,37 @@
+import { isDefined } from "cx/util";
+import { Node } from "./Node";
+
+export class Cell extends Node {
+   init() {
+      if (isDefined(this.w)) this.width = this.w;
+      if (isDefined(this.h)) this.height = this.h;
+      super.init();
+   }
+   declareData(...args) {
+      super.declareData(...args, {
+         width: undefined,
+         height: undefined,
+      });
+   }
+
+   explore(context, instance) {
+      instance.diagram = context.diagram;
+      let { data } = instance;
+      instance.box = {
+         row: 0,
+         col: 0,
+         width: data.width,
+         height: data.height,
+         ml: data.ml,
+         mr: data.mr,
+         mt: data.mt,
+         mb: data.mb,
+         ms: data.ms,
+         me: data.me,
+      };
+      super.explore(context, instance);
+   }
+}
+
+Cell.prototype.width = 1;
+Cell.prototype.height = 1;

package/src/Diagram.d.ts

@@ -0,0 +1,32 @@
+import { BooleanProp, NumberProp, Widget } from "cx/src/core";
+import { BoundedObjectProps } from "cx/src/svg/BoundedObject";
+
+export interface DiagramProps extends BoundedObjectProps {
+   /** Zoom level. */
+   zoom?: NumberProp;
+
+   /** Horizontal offset (pan). */
+   offsetX?: NumberProp;
+
+   /** Vertical offset (pan). */
+   offsetY?: NumberProp;
+
+   /** Unit size in pixels. */
+   unitSize?: NumberProp;
+
+   /** Set to true to center the content both horizontally and vertically. */
+   center?: boolean;
+
+   /** Set to true to center the content horizontally. */
+   centerX?: boolean;
+
+   /** Set to true to center the content vertically. */
+   centerY?: boolean;
+
+   showGrid?: BooleanProp;
+
+   /** Set to true to disable zooming and panning. */
+   fixed?: BooleanProp;
+}
+
+export class Diagram extends Widget<DiagramProps> {}

package/src/Diagram.js

@@ -0,0 +1,312 @@
+import { VDOM } from "cx/ui";
+import { BoundedObject } from "cx/svg";
+import { DiagramState } from "./DiagramState";
+import { addEventListenerWithOptions, debounce } from "cx/util";
+import { getCursorPos, captureMouseOrTouch } from "cx/widgets";
+
+export class Diagram extends BoundedObject {
+   init() {
+      if (this.center) {
+         this.centerX = true;
+         this.centerY = true;
+      }
+      super.init();
+   }
+
+   declareData(...args) {
+      super.declareData(...args, {
+         offsetX: undefined,
+         offsetY: undefined,
+         zoom: undefined,
+         unitSize: undefined,
+         showGrid: undefined,
+         fixed: undefined,
+      });
+   }
+
+   prepareData(context, instance) {
+      let { data } = instance;
+      data.stateMods = {
+         ...data.stateMods,
+         pannable: !data.fixed,
+      };
+      super.prepareData(context, instance);
+   }
+
+   explore(context, instance) {
+      let { data } = instance;
+      let ds = (instance.diagramState = new DiagramState());
+      ds.unitSize = data.unitSize;
+      context.push("diagram", ds);
+      super.explore(context, instance);
+   }
+
+   exploreCleanup(context, instance) {
+      context.pop("diagram");
+   }
+
+   prepare(context, instance) {
+      let r2 = 0;
+      let c2 = 0;
+      let r1 = 0;
+      let c1 = 0;
+
+      let { children } = instance;
+      if (this.centerX || this.centerY) {
+         for (let { box } of children) {
+            if (!box) continue;
+            if (box.row < r1) r1 = box.row;
+            if (box.row + box.height > r2) r2 = box.row + box.height;
+            if (box.col < c1) c1 = box.col;
+            if (box.col + box.width > c2) c2 = box.col + box.width;
+         }
+
+         let dc = (c1 - c2) / 2;
+         let dr = (r1 - r2) / 2;
+
+         for (let { box } of children) {
+            if (!box) continue;
+            box.row += dr;
+            box.col += dc;
+         }
+      }
+
+      super.prepare(context, instance);
+      context.push("diagram", instance.diagramState);
+   }
+
+   prepareCleanup(context, instance) {
+      context.pop("diagram");
+      super.prepareCleanup(context, instance);
+   }
+
+   render(context, instance, key) {
+      let { data } = instance;
+      return (
+         <DiagramComponent key={key} data={data} instance={instance}>
+            {this.renderChildren(context, instance)}
+         </DiagramComponent>
+      );
+   }
+}
+
+Diagram.prototype.offsetX = 0;
+Diagram.prototype.offsetY = 0;
+Diagram.prototype.zoom = 1;
+Diagram.prototype.anchors = "0 1 1 0";
+Diagram.prototype.baseClass = "diagram";
+Diagram.prototype.styled = true;
+Diagram.prototype.unitSize = 32;
+Diagram.prototype.centerX = false;
+Diagram.prototype.centerY = false;
+Diagram.prototype.center = false;
+Diagram.prototype.showGrid = false;
+Diagram.prototype.fixed = false;
+
+const defaultZoomStep = 0.05;
+const minZoom = 0.25;
+const maxZoom = 4;
+
+class DiagramComponent extends VDOM.Component {
+   constructor(props) {
+      super(props);
+      this.state = {
+         zoom: props.data.zoom,
+         offsetX: props.data.offsetX,
+         offsetY: props.data.offsetY,
+      };
+      this.touchOperation = 0;
+
+      this.saveState = debounce(() => {
+         let { instance } = this.props;
+         let { zoom, offsetX, offsetY } = this.state;
+         instance.set("zoom", zoom);
+         instance.set("offsetX", offsetX);
+         instance.set("offsetY", offsetY);
+      }, 100);
+
+      this.handleInitialMouseMove = this.handleInitialMouseMove.bind(this);
+      this.elRef = (el) => {
+         this.el = el;
+      };
+   }
+
+   componentWillReceiveProps(props) {
+      this.setState({
+         zoom: props.data.zoom,
+         offsetX: props.data.offsetX,
+         offsetY: props.data.offsetY,
+      });
+   }
+
+   render() {
+      let { offsetX, offsetY, zoom } = this.state;
+      let { data, children } = this.props;
+      let { bounds } = data;
+
+      let cx = (bounds.r - bounds.l) / 2 + offsetX;
+      let cy = (bounds.b - bounds.t) / 2 + offsetY;
+
+      let path = null;
+      if (data.showGrid) {
+         let p = "";
+         let d = data.unitSize * zoom;
+
+         let fromX = Math.ceil((bounds.l - cx) / d);
+         let toX = Math.floor((bounds.r - cx) / d);
+
+         for (let x = fromX; x <= toX; x++) p += `M ${cx + x * d} ${bounds.t} L ${cx + x * d} ${bounds.b}`;
+
+         let fromY = Math.ceil((bounds.t - cy) / d);
+         let toY = Math.floor((bounds.b - cy) / d);
+
+         for (let y = fromY; y <= toY; y++) p += `M ${bounds.l} ${cy + y * d} L ${bounds.r} ${cy + y * d}`;
+
+         path = <path style={data.style} d={p} stroke="lightgray" strokeWidth={0.5} />;
+      }
+
+      return (
+         <g className={data.classNames} ref={this.elRef} onMouseMove={this.handleInitialMouseMove}>
+            <rect
+               x={data.bounds.l}
+               y={data.bounds.t}
+               width={data.bounds.width()}
+               height={data.bounds.height()}
+               fill="transparent"
+               stroke="transparent"
+            />
+            {path}
+            <g transform={`translate(${cx}, ${cy}) scale(${zoom}, ${zoom})`}>{children}</g>
+         </g>
+      );
+   }
+
+   componentDidMount() {
+      this.offWheel = addEventListenerWithOptions(this.el, "wheel", (e) => this.handleWheel(e));
+   }
+
+   componentWillUnmount() {
+      this.offWheel();
+   }
+
+   handleWheel(ev) {
+      if (this.props.data.fixed) return;
+      if (ev.deltaY > 0) this.zoomOut(ev, false);
+      else this.zoomIn(ev, false);
+
+      ev.stopPropagation();
+      ev.preventDefault();
+   }
+
+   zoom(e, factor, center = true, zoomStep = defaultZoomStep, pinchPoint) {
+      let nzoom = (1 + factor * zoomStep) * this.state.zoom;
+      this.zoomTo(e, nzoom, center, pinchPoint);
+   }
+
+   zoomTo(e, zoom, center, pinchPoint) {
+      let mx, my;
+
+      if (pinchPoint) {
+         let el = e.currentTarget;
+         let bounds = el.getBoundingClientRect();
+         mx = pinchPoint.x - bounds.left;
+         my = pinchPoint.y - bounds.top;
+      } else if (!center) {
+         let el = e.currentTarget;
+         let bounds = this.el.firstElementChild.getBoundingClientRect();
+         let cursor = getCursorPos(e);
+         mx = cursor.clientX - (bounds.left + bounds.right) / 2;
+         my = cursor.clientY - (bounds.top + bounds.bottom) / 2;
+      }
+
+      zoom = Math.max(minZoom, Math.min(maxZoom, zoom));
+
+      let offsetX = mx - (zoom / this.state.zoom) * (mx - this.state.offsetX);
+      let offsetY = my - (zoom / this.state.zoom) * (my - this.state.offsetY);
+
+      this.setState(
+         {
+            zoom,
+            offsetX,
+            offsetY,
+         },
+         this.saveState
+      );
+   }
+
+   zoomIn(e, center) {
+      this.zoom(e, 1, center);
+   }
+
+   zoomOut(e, center) {
+      this.zoom(e, -1, center);
+   }
+
+   handleInitialMouseMove(e) {
+      if (e.buttons != 1) return;
+      if (this.props.data.fixed) return;
+      let cursor = getCursorPos(e);
+      let mode = e.touches && e.touches.length >= 2 ? "zoom" : "pan";
+      let captureData = {
+         mode,
+         touchOperation: ++this.touchOperation,
+      };
+
+      if (mode == "pan") {
+         captureData.dx = this.state.offsetX - cursor.clientX;
+         captureData.dy = this.state.offsetY - cursor.clientY;
+      } else {
+         captureData.cx = (e.touches[0].clientX + e.touches[1].clientX) / 2;
+         captureData.cy = (e.touches[0].clientY + e.touches[1].clientY) / 2;
+         captureData.originalZoom = view.zoom;
+         captureData.pointsDistance = Math.sqrt(
+            Math.pow(e.touches[0].clientX - e.touches[1].clientX, 2) +
+               Math.pow(e.touches[0].clientY - e.touches[1].clientY, 2)
+         );
+      }
+
+      captureMouseOrTouch(
+         e,
+         (e, captureData) => {
+            this.handleMouseMove(e, captureData);
+         },
+         () => {},
+         captureData,
+         "grabbing"
+      );
+
+      e.stopPropagation();
+      //e.preventDefault(); //prevents clicks
+      document.activeElement.blur(); //hide the context menu
+   }
+
+   handleMouseMove(e, captureData) {
+      if (captureData.touchOperation != this.touchOperation) return;
+
+      if (captureData.mode == "pan") {
+         let cursor = getCursorPos(e);
+         let offsetX = cursor.clientX + captureData.dx;
+         let offsetY = cursor.clientY + captureData.dy;
+         if (offsetX != NaN && offsetY != NaN) {
+            this.setState(
+               {
+                  offsetX: offsetX,
+                  offsetY: offsetY,
+               },
+               this.saveState
+            );
+         }
+      } else {
+         let pointsDistance = Math.sqrt(
+            Math.pow(e.touches[0].clientX - e.touches[1].clientX, 2) +
+               Math.pow(e.touches[0].clientY - e.touches[1].clientY, 2)
+         );
+         //console.log(captureData, e.touches);
+         let newZoom = (pointsDistance / captureData.pointsDistance) * captureData.originalZoom;
+         this.zoomTo(e, newZoom, false, { x: captureData.cx, y: captureData.cy });
+         //console.log('ZOOM');
+         e.stopPropagation();
+         e.preventDefault();
+      }
+   }
+}

package/src/Diagram.scss

@@ -0,0 +1,13 @@
+.cxb-diagram {
+   fill: none;
+   stroke: none;
+   stroke-width: 1;
+}
+
+.cxb-diagram.cxs-pannable {
+   cursor: grab;
+
+   &:active {
+      cursor: grabbing;
+   }
+}

package/src/DiagramState.js

@@ -0,0 +1,24 @@
+export class DiagramState {
+   unitSize = 16;
+   shapes = {};
+
+   map(x, y) {
+      return { x: x * this.unitSize, y: y * this.unitSize };
+   }
+
+   registerShapeBounds(id, shape, bounds) {
+      let data = this.shapes[id];
+      if (!data) data = this.shapes[id] = {};
+      data.bounds = bounds;
+      data.shape = shape;
+   }
+
+   getShape(id) {
+      let data = this.shapes[id];
+      if (!data || !data.bounds)
+         throw new Error(
+            `Shape ${id} has no registered bounds. Please make sure that shapes have correct ids and connections come afterwards.`
+         );
+      return data;
+   }
+}

package/src/Flow.d.ts

@@ -0,0 +1,39 @@
+import { NumberProp, Widget } from "cx/src/core";
+import { NodeProps } from "./Node";
+
+export interface FlowProps extends NodeProps {
+   /** Gap between items. */
+   gap?: NumberProp;
+
+   /** Padding. */
+   p?: NumberProp;
+
+   /** Padding. */
+   padding?: NumberProp;
+
+   /** Left padding. */
+   pl?: NumberProp;
+
+   /** Right padding. */
+   pr?: NumberProp;
+
+   /** Top paddding. */
+   pt?: NumberProp;
+
+   /** Bottom padding. */
+   pb?: NumberProp;
+
+   /** Horizontal padding. */
+   px?: NumberProp;
+
+   /** Vertical padding. */
+   py?: NumberProp;
+
+   /** Set to true to disable rotation. */
+   fixed?: boolean;
+
+   /** Direction of the flow. Default value is `right`. */
+   direction?: "right" | "left" | "up" | "down";
+}
+
+export class Flow extends Widget<FlowProps> {}