uiik 1.3.0-alpha → 1.3.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uiik",
-  "version": "1.3.0-alpha",
+  "version": "1.3.0-beta.1",
   "description": "A UI interactions kit includes draggable, splittable, rotatable, selectable, etc.",
   "main": "index.js",
   "module": "index.esm.js",
@@ -28,6 +28,7 @@
   "scripts": {
     "build": "rollup --config",
     "test": "rollup --config rollup.config.test.js --watch",
+    "release": "rollup --config rollup.config.release.js",
     "doc": "npx typedoc"
   },
   "dependencies": {

package/resizable.d.ts

@@ -1,7 +1,21 @@
 import { ResizableOptions, Uii } from "./types";
+/**
+ * 用于表示一个或多个可改变尺寸元素的定义
+ * > 可用CSS接口
+ * - .uii-resizable-handle
+ * - .uii-resizable-handle-[n/s/e/w/ne/nw/se/sw]
+ * - .uii-resizable-handle-active
+ * @public
+ */
 export declare class Resizable extends Uii {
     constructor(els: string | HTMLElement, opts?: ResizableOptions);
     bindHandle(handle: HTMLElement | SVGElement, dir: string, panel: HTMLElement, opts: ResizableOptions): void;
     initHandle(panel: HTMLElement): void;
 }
+/**
+ * Make els resizable
+ * @param els selector string / html element
+ * @param opts
+ * @returns
+ */
 export declare function newResizable(els: string | HTMLElement, opts?: ResizableOptions): Resizable;

package/rotatable.d.ts

@@ -1,6 +1,19 @@
 import { RotatableOptions, Uii } from "./types";
-import 'myfx';
+/**
+ * 用于表示一个或多个可旋转元素的定义
+ * > 可用CSS接口
+ * - .uii-rotatable
+ * - .uii-rotatable-handle
+ * - .uii-rotatable-active
+ * @public
+ */
 export declare class Rotatable extends Uii {
     constructor(els: string | Element, opts?: RotatableOptions);
 }
+/**
+ * Make els rotatable
+ * @param els selector string / html element
+ * @param opts
+ * @returns
+ */
 export declare function newRotatable(els: string | HTMLElement, opts?: RotatableOptions): Rotatable;

package/selectable.d.ts

@@ -1,8 +1,28 @@
 import { SelectableOptions, Uii } from "./types";
+/**
+ * 用于表示一个元素选择器的定义
+ * > 可用CSS接口
+ * - .uii-selector
+ * - .uii-selecting
+ * - .uii-selected
+ * @public
+ */
 export declare class Selectable extends Uii {
     #private;
     constructor(container: string | HTMLElement, opts?: SelectableOptions);
+    /**
+     *  更新targets
+     */
     updateTargets(): void;
+    /**
+     * @internal
+     */
     onOptionChanged(): void;
 }
+/**
+ * Add a selector into the container
+ * @param container css selector or html element
+ * @param opts
+ * @returns
+ */
 export declare function newSelectable(container: string | HTMLElement, opts?: SelectableOptions): Selectable;

package/sortable.d.ts

@@ -1,9 +1,33 @@
 import { SortableOptions, Uii } from "./types";
+/**
+ * 用于表示一类排序容器的定义
+ * > 可用CSS接口
+ * - .uii-sortable-container
+ * - .uii-sortable-ghost
+ * - .uii-sortable-active
+ * @public
+ */
 export declare class Sortable extends Uii {
     #private;
     constructor(container: string | HTMLElement | Array<HTMLElement>, opts?: SortableOptions);
+    /**
+     * 调用active表示移出策略肯定是true | 'copy'
+     * @internal
+     */
     active(draggingItem: HTMLElement, fromContainer: HTMLElement, toContainers: HTMLElement[], toOpts: SortableOptions): void;
+    /**
+     * @internal
+     */
     deactive(draggingItem: HTMLElement, fromContainer: HTMLElement, toContainers: HTMLElement[], opts: SortableOptions): void;
+    /**
+     * @internal
+     */
     onOptionChanged(): void;
 }
+/**
+ * make elements within the container sortable
+ * @param container css selector or html element（array)
+ * @param opts
+ * @returns
+ */
 export declare function newSortable(container: string | HTMLElement | Array<HTMLElement>, opts?: SortableOptions): Sortable;

package/splittable.d.ts

@@ -1,6 +1,23 @@
 import { SplittableOptions, Uii } from './types';
+/**
+ * 用于表示一个或多个分割器的定义
+ * > 可用CSS接口
+ * - .uii-splittable
+ * - .uii-splittable-handle
+ * - .uii-splittable-handle-ghost
+ * - .uii-splittable-handle-active
+ * - .uii-splittable-v
+ * - .uii-splittable-h
+ * @public
+ */
 export declare class Splittable extends Uii {
     #private;
     constructor(container: string | HTMLElement, opts?: SplittableOptions);
 }
+/**
+ * Add one or more splittors into the container
+ * @param container css selector or html element
+ * @param opts SplittableOptions
+ * @returns
+ */
 export declare function newSplittable(container: string | HTMLElement, opts?: SplittableOptions): Splittable;

package/transform.d.ts

@@ -1,19 +1,46 @@
+/**
+ * Transform APIs
+ * 用于屏蔽svg/html元素的transform差异，如rotate函数兼容问题
+ * @author holyhigh2
+ */
 export declare class UiiTransformer {
     x: number;
     y: number;
     angle: number;
     el: HTMLElement | SVGGraphicsElement;
     constructor(el: HTMLElement | SVGGraphicsElement);
-    normalize(el: HTMLElement | SVGGraphicsElement): this;
+    normalize(el?: HTMLElement | SVGGraphicsElement): this;
     moveTo(x: number, y: number): void;
     moveToX(x: number): void;
     moveToY(y: number): void;
+    rotateTo(deg: number, cx?: number, cy?: number): void;
 }
+/**
+ * 返回一个包装后的变形对象，可执行变形操作
+ * @param el
+ */
 export declare function wrapper(el: HTMLElement | SVGGraphicsElement): UiiTransformer;
+/**
+ * 获取元素当前transform中的位移数据
+ * @param el HTMLElement|SVGGraphicsElement
+ * @returns {x,y}
+ */
 export declare function getTranslate(el: HTMLElement | SVGGraphicsElement): {
     x: number;
     y: number;
 };
+/**
+ * 自动检测HTML元素或SVG元素并设置对应移动属性
+ * @param el HTMLElement|SVGGraphicsElement
+ * @param x value of px
+ * @param y value of px
+ */
 export declare function moveTo(el: HTMLElement | SVGGraphicsElement, x: number, y: number): void;
+/**
+ * 自动检测HTML元素或SVG元素并设置对应移动属性
+ * @param el HTMLElement|SVGGraphicsElement
+ * @param x value of px
+ * @param y value of px
+ */
 export declare function moveBy(el: HTMLElement | SVGGraphicsElement, x: number, y: number): void;
 export declare function rotateTo(el: HTMLElement | SVGGraphicsElement, deg: number, cx?: number, cy?: number): void;