@knotx/plugins-selection 0.3.4 → 0.3.6

package/dist/index.cjs

@@ -73,8 +73,8 @@ var __privateIn = (member, obj) => Object(obj) !== obj ? __typeError('Cannot use
 var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
 var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
 var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "access private method"), method);
-var _destroy_dec, _clearSelection_dec, _select_dec, _getSelected_dec, _init_dec, _interaction_dec, _setElementOverlap_dec, _setClearSelectionBeforeStart_dec, _clearSelectionBeforeStart_dec, _setRuleEnabled_dec, _registerRules_dec, _selected_dec, _a, _init;
-class Selection extends (_a = core.BasePlugin, _selected_dec = [decorators.register("selected")], _registerRules_dec = [decorators.register("registerRules")], _setRuleEnabled_dec = [decorators.register("setRuleEnabled")], _clearSelectionBeforeStart_dec = [decorators.observable()], _setClearSelectionBeforeStart_dec = [decorators.register("setClearSelectionBeforeStart")], _setElementOverlap_dec = [decorators.register("setElementOverlap")], _interaction_dec = [decorators.inject.interaction()], _init_dec = [decorators.OnInit], _getSelected_dec = [decorators.tool("Get selected items", {})], _select_dec = [decorators.tool("Items that match the registered rules will be selected, manifested as the item showing a selected style.", {
+var _destroy_dec, _clearSelection_dec, _select_dec, _getSelected_dec, _init_dec, _edgeScroll_dec, _interaction_dec, _setElementOverlap_dec, _setClearSelectionBeforeStart_dec, _clearSelectionBeforeStart_dec, _setRuleEnabled_dec, _registerRules_dec, _selected_dec, _a, _init;
+class Selection extends (_a = core.BasePlugin, _selected_dec = [decorators.register("selected")], _registerRules_dec = [decorators.register("registerRules")], _setRuleEnabled_dec = [decorators.register("setRuleEnabled")], _clearSelectionBeforeStart_dec = [decorators.observable()], _setClearSelectionBeforeStart_dec = [decorators.register("setClearSelectionBeforeStart")], _setElementOverlap_dec = [decorators.register("setElementOverlap")], _interaction_dec = [decorators.inject.interaction()], _edgeScroll_dec = [decorators.inject.canvas.edgeScroll()], _init_dec = [decorators.OnInit], _getSelected_dec = [decorators.tool("Get selected items", {})], _select_dec = [decorators.tool("Items that match the registered rules will be selected, manifested as the item showing a selected style.", {
   type: "array",
   items: {
     type: "object",
@@ -105,6 +105,7 @@ class Selection extends (_a = core.BasePlugin, _selected_dec = [decorators.regis
     __publicField(this, "ruleMap", /* @__PURE__ */ new Map());
     __publicField(this, "enableDrag", true);
     __publicField(this, "isDragging", false);
+    __publicField(this, "enableEdgeScroll", false);
     __publicField(this, "updateFrameId");
     __publicField(this, "selected", __runInitializers(_init, 8, this, [])), __runInitializers(_init, 11, this);
     __publicField(this, "registerRules", __runInitializers(_init, 12, this, (rules) => {
@@ -136,6 +137,7 @@ class Selection extends (_a = core.BasePlugin, _selected_dec = [decorators.regis
       }
     })), __runInitializers(_init, 31, this);
     __publicField(this, "interaction", __runInitializers(_init, 32, this)), __runInitializers(_init, 35, this);
+    __publicField(this, "edgeScroll", __runInitializers(_init, 36, this)), __runInitializers(_init, 39, this);
     __publicField(this, "onBeforeStart", (_) => {
     });
     __publicField(this, "onBeforeDrag", () => {
@@ -145,6 +147,9 @@ class Selection extends (_a = core.BasePlugin, _selected_dec = [decorators.regis
     __publicField(this, "onStart", ({ event, store }) => {
       var _a2;
       this.interaction.start(this.pluginId, "select", core.InteractionPriority.MarqueeSelection);
+      if (this.enableEdgeScroll && this.edgeScroll) {
+        this.edgeScroll.setConfig({ enabled: true });
+      }
       if (!(event == null ? void 0 : event.ctrlKey) && !(event == null ? void 0 : event.metaKey) && !(event == null ? void 0 : event.shiftKey)) {
         if (this.clearSelectionBeforeStart) {
           store.stored.forEach((element) => {
@@ -215,6 +220,9 @@ class Selection extends (_a = core.BasePlugin, _selected_dec = [decorators.regis
     });
     __publicField(this, "onStop", ({ event }) => {
       this.interaction.end(this.pluginId, "select");
+      if (this.enableEdgeScroll && this.edgeScroll) {
+        this.edgeScroll.setConfig({ enabled: false });
+      }
       if (event) {
         if (this.isDragging) {
           this.isDragging = false;
@@ -253,6 +261,9 @@ class Selection extends (_a = core.BasePlugin, _selected_dec = [decorators.regis
     if (config.enableDrag !== void 0) {
       this.enableDrag = config.enableDrag;
     }
+    if (config.enableEdgeScroll !== void 0) {
+      this.enableEdgeScroll = config.enableEdgeScroll;
+    }
     queueMicrotask(() => this.createSelection());
   }
   createSelection() {
@@ -261,7 +272,12 @@ class Selection extends (_a = core.BasePlugin, _selected_dec = [decorators.regis
       // container,
       boundaries: [container],
       selectionAreaClass: this.selectionAreaClassName,
-      selectables: Array.from(new Set(Array.from(this.ruleMap.values()).map(({ className }) => `.${className}`)))
+      selectables: Array.from(new Set(Array.from(this.ruleMap.values()).map(({ className }) => `.${className}`))),
+      behaviour: {
+        scrolling: {
+          manualSpeed: 0
+        }
+      }
     }).on("beforedrag", this.onBeforeDrag).on("beforestart", this.onBeforeStart).on("start", this.onStart).on("move", this.onMove).on("stop", this.onStop);
   }
   getElementRule(element) {
@@ -309,6 +325,7 @@ __decorateElement(_init, 5, "clearSelectionBeforeStart", _clearSelectionBeforeSt
 __decorateElement(_init, 5, "setClearSelectionBeforeStart", _setClearSelectionBeforeStart_dec, Selection);
 __decorateElement(_init, 5, "setElementOverlap", _setElementOverlap_dec, Selection);
 __decorateElement(_init, 5, "interaction", _interaction_dec, Selection);
+__decorateElement(_init, 5, "edgeScroll", _edgeScroll_dec, Selection);
 __decoratorMetadata(_init, Selection);
 
 exports.Selection = Selection;

package/dist/index.d.cts

@@ -1,5 +1,5 @@
+import { BasePlugin, PluginData } from '@knotx/core';
 import { OverlapMode } from '@viselect/vanilla';
-import { BasePlugin } from '@knotx/core';
 
 interface SelectionSelectedItem {
     type: string;
@@ -89,6 +89,11 @@ interface SelectionConfig {
      * default: bemSelector('canvas', 'wrapper')
      */
     container?: string;
+    /**
+     * 是否启用边缘滚动
+     * default: false
+     */
+    enableEdgeScroll?: boolean;
 }
 declare class Selection extends BasePlugin<'selection', SelectionConfig> {
     name: "selection";
@@ -98,6 +103,7 @@ declare class Selection extends BasePlugin<'selection', SelectionConfig> {
     private ruleMap;
     private enableDrag;
     private isDragging;
+    private enableEdgeScroll;
     private updateFrameId;
     selected: SelectionSelectedItem[];
     registerRules: (rules: SelectionRule[]) => () => void;
@@ -106,6 +112,7 @@ declare class Selection extends BasePlugin<'selection', SelectionConfig> {
     setClearSelectionBeforeStart: (clearSelectionBeforeStart: boolean) => void;
     setElementOverlap: (overlap: OverlapMode) => void;
     private interaction;
+    edgeScroll: PluginData['canvas']['edgeScroll'];
     init(config?: SelectionConfig): void;
     private createSelection;
     private onBeforeStart;

package/dist/index.d.mts

@@ -1,5 +1,5 @@
+import { BasePlugin, PluginData } from '@knotx/core';
 import { OverlapMode } from '@viselect/vanilla';
-import { BasePlugin } from '@knotx/core';
 
 interface SelectionSelectedItem {
     type: string;
@@ -89,6 +89,11 @@ interface SelectionConfig {
      * default: bemSelector('canvas', 'wrapper')
      */
     container?: string;
+    /**
+     * 是否启用边缘滚动
+     * default: false
+     */
+    enableEdgeScroll?: boolean;
 }
 declare class Selection extends BasePlugin<'selection', SelectionConfig> {
     name: "selection";
@@ -98,6 +103,7 @@ declare class Selection extends BasePlugin<'selection', SelectionConfig> {
     private ruleMap;
     private enableDrag;
     private isDragging;
+    private enableEdgeScroll;
     private updateFrameId;
     selected: SelectionSelectedItem[];
     registerRules: (rules: SelectionRule[]) => () => void;
@@ -106,6 +112,7 @@ declare class Selection extends BasePlugin<'selection', SelectionConfig> {
     setClearSelectionBeforeStart: (clearSelectionBeforeStart: boolean) => void;
     setElementOverlap: (overlap: OverlapMode) => void;
     private interaction;
+    edgeScroll: PluginData['canvas']['edgeScroll'];
     init(config?: SelectionConfig): void;
     private createSelection;
     private onBeforeStart;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
+import { BasePlugin, PluginData } from '@knotx/core';
 import { OverlapMode } from '@viselect/vanilla';
-import { BasePlugin } from '@knotx/core';
 
 interface SelectionSelectedItem {
     type: string;
@@ -89,6 +89,11 @@ interface SelectionConfig {
      * default: bemSelector('canvas', 'wrapper')
      */
     container?: string;
+    /**
+     * 是否启用边缘滚动
+     * default: false
+     */
+    enableEdgeScroll?: boolean;
 }
 declare class Selection extends BasePlugin<'selection', SelectionConfig> {
     name: "selection";
@@ -98,6 +103,7 @@ declare class Selection extends BasePlugin<'selection', SelectionConfig> {
     private ruleMap;
     private enableDrag;
     private isDragging;
+    private enableEdgeScroll;
     private updateFrameId;
     selected: SelectionSelectedItem[];
     registerRules: (rules: SelectionRule[]) => () => void;
@@ -106,6 +112,7 @@ declare class Selection extends BasePlugin<'selection', SelectionConfig> {
     setClearSelectionBeforeStart: (clearSelectionBeforeStart: boolean) => void;
     setElementOverlap: (overlap: OverlapMode) => void;
     private interaction;
+    edgeScroll: PluginData['canvas']['edgeScroll'];
     init(config?: SelectionConfig): void;
     private createSelection;
     private onBeforeStart;

package/dist/index.js

@@ -67,8 +67,8 @@ var __privateIn = (member, obj) => Object(obj) !== obj ? __typeError('Cannot use
 var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
 var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
 var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "access private method"), method);
-var _destroy_dec, _clearSelection_dec, _select_dec, _getSelected_dec, _init_dec, _interaction_dec, _setElementOverlap_dec, _setClearSelectionBeforeStart_dec, _clearSelectionBeforeStart_dec, _setRuleEnabled_dec, _registerRules_dec, _selected_dec, _a, _init;
-class Selection extends (_a = BasePlugin, _selected_dec = [register("selected")], _registerRules_dec = [register("registerRules")], _setRuleEnabled_dec = [register("setRuleEnabled")], _clearSelectionBeforeStart_dec = [observable()], _setClearSelectionBeforeStart_dec = [register("setClearSelectionBeforeStart")], _setElementOverlap_dec = [register("setElementOverlap")], _interaction_dec = [inject.interaction()], _init_dec = [OnInit], _getSelected_dec = [tool("Get selected items", {})], _select_dec = [tool("Items that match the registered rules will be selected, manifested as the item showing a selected style.", {
+var _destroy_dec, _clearSelection_dec, _select_dec, _getSelected_dec, _init_dec, _edgeScroll_dec, _interaction_dec, _setElementOverlap_dec, _setClearSelectionBeforeStart_dec, _clearSelectionBeforeStart_dec, _setRuleEnabled_dec, _registerRules_dec, _selected_dec, _a, _init;
+class Selection extends (_a = BasePlugin, _selected_dec = [register("selected")], _registerRules_dec = [register("registerRules")], _setRuleEnabled_dec = [register("setRuleEnabled")], _clearSelectionBeforeStart_dec = [observable()], _setClearSelectionBeforeStart_dec = [register("setClearSelectionBeforeStart")], _setElementOverlap_dec = [register("setElementOverlap")], _interaction_dec = [inject.interaction()], _edgeScroll_dec = [inject.canvas.edgeScroll()], _init_dec = [OnInit], _getSelected_dec = [tool("Get selected items", {})], _select_dec = [tool("Items that match the registered rules will be selected, manifested as the item showing a selected style.", {
   type: "array",
   items: {
     type: "object",
@@ -99,6 +99,7 @@ class Selection extends (_a = BasePlugin, _selected_dec = [register("selected")]
     __publicField(this, "ruleMap", /* @__PURE__ */ new Map());
     __publicField(this, "enableDrag", true);
     __publicField(this, "isDragging", false);
+    __publicField(this, "enableEdgeScroll", false);
     __publicField(this, "updateFrameId");
     __publicField(this, "selected", __runInitializers(_init, 8, this, [])), __runInitializers(_init, 11, this);
     __publicField(this, "registerRules", __runInitializers(_init, 12, this, (rules) => {
@@ -130,6 +131,7 @@ class Selection extends (_a = BasePlugin, _selected_dec = [register("selected")]
       }
     })), __runInitializers(_init, 31, this);
     __publicField(this, "interaction", __runInitializers(_init, 32, this)), __runInitializers(_init, 35, this);
+    __publicField(this, "edgeScroll", __runInitializers(_init, 36, this)), __runInitializers(_init, 39, this);
     __publicField(this, "onBeforeStart", (_) => {
     });
     __publicField(this, "onBeforeDrag", () => {
@@ -139,6 +141,9 @@ class Selection extends (_a = BasePlugin, _selected_dec = [register("selected")]
     __publicField(this, "onStart", ({ event, store }) => {
       var _a2;
       this.interaction.start(this.pluginId, "select", InteractionPriority.MarqueeSelection);
+      if (this.enableEdgeScroll && this.edgeScroll) {
+        this.edgeScroll.setConfig({ enabled: true });
+      }
       if (!(event == null ? void 0 : event.ctrlKey) && !(event == null ? void 0 : event.metaKey) && !(event == null ? void 0 : event.shiftKey)) {
         if (this.clearSelectionBeforeStart) {
           store.stored.forEach((element) => {
@@ -209,6 +214,9 @@ class Selection extends (_a = BasePlugin, _selected_dec = [register("selected")]
     });
     __publicField(this, "onStop", ({ event }) => {
       this.interaction.end(this.pluginId, "select");
+      if (this.enableEdgeScroll && this.edgeScroll) {
+        this.edgeScroll.setConfig({ enabled: false });
+      }
       if (event) {
         if (this.isDragging) {
           this.isDragging = false;
@@ -247,6 +255,9 @@ class Selection extends (_a = BasePlugin, _selected_dec = [register("selected")]
     if (config.enableDrag !== void 0) {
       this.enableDrag = config.enableDrag;
     }
+    if (config.enableEdgeScroll !== void 0) {
+      this.enableEdgeScroll = config.enableEdgeScroll;
+    }
     queueMicrotask(() => this.createSelection());
   }
   createSelection() {
@@ -255,7 +266,12 @@ class Selection extends (_a = BasePlugin, _selected_dec = [register("selected")]
       // container,
       boundaries: [container],
       selectionAreaClass: this.selectionAreaClassName,
-      selectables: Array.from(new Set(Array.from(this.ruleMap.values()).map(({ className }) => `.${className}`)))
+      selectables: Array.from(new Set(Array.from(this.ruleMap.values()).map(({ className }) => `.${className}`))),
+      behaviour: {
+        scrolling: {
+          manualSpeed: 0
+        }
+      }
     }).on("beforedrag", this.onBeforeDrag).on("beforestart", this.onBeforeStart).on("start", this.onStart).on("move", this.onMove).on("stop", this.onStop);
   }
   getElementRule(element) {
@@ -303,6 +319,7 @@ __decorateElement(_init, 5, "clearSelectionBeforeStart", _clearSelectionBeforeSt
 __decorateElement(_init, 5, "setClearSelectionBeforeStart", _setClearSelectionBeforeStart_dec, Selection);
 __decorateElement(_init, 5, "setElementOverlap", _setElementOverlap_dec, Selection);
 __decorateElement(_init, 5, "interaction", _interaction_dec, Selection);
+__decorateElement(_init, 5, "edgeScroll", _edgeScroll_dec, Selection);
 __decoratorMetadata(_init, Selection);
 
 export { Selection };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knotx/plugins-selection",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "Selection Plugin for Knotx",
   "author": "boenfu",
   "license": "MIT",
@@ -27,16 +27,20 @@
   "files": [
     "dist"
   ],
+  "peerDependencies": {
+    "@knotx/plugins-canvas": "0.3.6"
+  },
   "dependencies": {
     "@viselect/vanilla": "^3.9.0",
     "rxjs": "^7.8.1",
-    "@knotx/core": "0.3.4",
-    "@knotx/decorators": "0.3.4"
+    "@knotx/core": "0.3.6",
+    "@knotx/decorators": "0.3.6"
   },
   "devDependencies": {
-    "@knotx/build-config": "0.3.4",
-    "@knotx/eslint-config": "0.3.4",
-    "@knotx/typescript-config": "0.3.4"
+    "@knotx/build-config": "0.3.6",
+    "@knotx/eslint-config": "0.3.6",
+    "@knotx/plugins-canvas": "0.3.6",
+    "@knotx/typescript-config": "0.3.6"
   },
   "scripts": {
     "build": "unbuild",