@d-matrix/utils 1.1.2 → 1.2.0

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@d-matrix/utils",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "A dozen of utils for Front-End Development",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
-    "clean": "tsc --build --clean",
+    "prebuild": "npm run clean",
+    "clean": "rimraf dist",
     "prepublish": "npm run clean && npm run build",
-    "publish": "npm publish --access public"
+    "cy:open": "cypress open",
+    "cy:run": "cypress run"
   },
   "engines": {
     "node": ">=16.20.0"
@@ -32,5 +34,11 @@
     "react": "^16.8.0 || ^17.0.0",
     "react-dom": "^16.9.0",
     "typescript": "~4.3.2"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-react": "^4.2.1",
+    "cypress": "^13.6.6",
+    "rimraf": "^5.0.5",
+    "vite": "^4.5.2"
   }
 }

package/readme.md

@@ -1,4 +1,7 @@
-# dm-utils
+# @d-matrix/utils
+
+![NPM Downloads](https://img.shields.io/npm/dw/%40d-matrix%2Futils)
+![npm bundle size](https://img.shields.io/bundlephobia/min/%40d-matrix%2Futils)
 
 A dozen of utils for Front-End Development
 
@@ -6,23 +9,81 @@ A dozen of utils for Front-End Development
 
 - [clipboard](#clipboard)
 - [react](#react)
+- [dom](#dom)
+- [date](#date)
 
 ### clipboard
 
-`clipboard.writeImage(element: HTMLImageElement): void`
+- `clipboard.writeImage(element: HTMLImageElement): void`
 
 复制图片到剪贴板。
 
 ### react
 
-`render<P>(element: ReactElement<P>): Promise<string>`
+- `render<P>(element: ReactElement<P>): Promise<string>`
 
 渲染`React`组件，返回HTML字符串。
 
-`cleanup(): void`
+- `cleanup(): void`
 
 清理函数，需要在调用`render()`函数后调用。
 
+- `useDisableContextMenu(target: ContextMenuTarget = defaultContextMenuTarget): void`
+
+在`target`函数返回的元素上禁用右键菜单，默认的`target`是`() => document`
+
+例1：在`id`是`test`的元素上禁用右键菜单
+
+```tsx
+import { react } from '@d-matrix/utils';
+
+const TestComp = () => {
+  react.useDisableContextMenu(() => document.getElementById('test'));
+
+  return (
+    <div>
+      <div id='test'>此元素的右键菜单被禁用</div>
+    </div>
+  )
+}
+```
+
+例2：在`document`上禁用右键菜单
+
+```tsx
+const TestComp = () => {
+  react.useDisableContextMenu();
+
+  return <div>内容</div>
+}
+```
+
+### dom
+
+- `scrollToTop(element: Element | null | undefined): void`
+
+元素滚动条滚动到顶部，对老旧浏览器做了兼容，见[浏览器兼容性](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollTop#browser_compatibility)。
+
+### date
+
+- `rangeOfYears(start: number, end: number = new Date().getFullYear()): number[]`
+
+创建`start`和`end`之间的年份数组。
+
+## 测试
+
+运行全部组件测试
+
+```bash
+npm run cy:run -- --component
+```
+
+运行单个组件测试
+
+```bash
+npm run cy:run -- --component --spec tests/date.cy.ts
+```
+
 ## 注意事项
 
 - [Before Publishing: Make Sure Your Package Installs and Works](https://docs.npmjs.com/cli/v10/using-npm/developers/#before-publishing-make-sure-your-package-installs-and-works)

package/dist/clipboard.d.ts

@@ -1 +0,0 @@
-export declare function writeImage(element: HTMLImageElement): Promise<unknown>;

package/dist/clipboard.js

@@ -1,82 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeImage = void 0;
-function writeImage(element) {
-    return __awaiter(this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            return [2 /*return*/, new Promise(function (resolve, reject) {
-                    var testImg = element;
-                    var canvas = document.createElement('canvas');
-                    var ctx = canvas.getContext('2d');
-                    if (ctx === null) {
-                        reject('canvas 2d context初始化失败');
-                        return;
-                    }
-                    var img = new Image();
-                    //创建一个画布，赋予画布宽高为图片的原始宽高
-                    canvas.width = testImg.naturalWidth;
-                    canvas.height = testImg.naturalHeight;
-                    //浏览器在加载图像时要使用匿名身份验证，以允许跨域资源共享（CORS）。
-                    img.crossOrigin = 'Anonymous';
-                    img.src = testImg.src;
-                    img.onload = function () {
-                        //防止有缓存，绘制之前先清除画布
-                        ctx.clearRect(0, 0, ctx.canvas.width, ctx.canvas.height);
-                        ctx.drawImage(img, 0, 0);
-                        //将canvas转为blob
-                        canvas.toBlob(function (blob) {
-                            var _a;
-                            if (blob === null) {
-                                reject('canvas to blob失败');
-                                return;
-                            }
-                            navigator.clipboard
-                                .write([
-                                new ClipboardItem((_a = {},
-                                    _a[blob.type] = blob,
-                                    _a)),
-                            ])
-                                .then(resolve, reject);
-                        });
-                    };
-                })];
-        });
-    });
-}
-exports.writeImage = writeImage;

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export * as clipboard from './clipboard';
-export * as react from './react';

package/dist/index.js

@@ -1,24 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.react = exports.clipboard = void 0;
-exports.clipboard = __importStar(require("./clipboard"));
-exports.react = __importStar(require("./react"));

package/dist/react.d.ts

@@ -1,3 +0,0 @@
-import { ReactElement } from 'react';
-export declare const render: <P>(element: ReactElement<P, string | import("react").JSXElementConstructor<any>>) => Promise<unknown>;
-export declare const cleanup: () => void;

package/dist/react.js

@@ -1,38 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanup = exports.render = void 0;
-var react_dom_1 = __importDefault(require("react-dom"));
-var container;
-var render = function (element) {
-    return new Promise(function (resolve, reject) {
-        if (document === undefined) {
-            return reject('只支持浏览器环境');
-        }
-        container = document.createElement('div');
-        container.id = 'template-container';
-        container.style.cssText = 'position: absolute; left: -9999px;';
-        document.body.appendChild(container);
-        react_dom_1.default.render(element, container, function () {
-            if (container) {
-                resolve(container.innerHTML);
-            }
-            else {
-                reject('组件容器不存在');
-            }
-        });
-    });
-};
-exports.render = render;
-var cleanup = function () {
-    if (container === null)
-        return;
-    var isUnmounted = react_dom_1.default.unmountComponentAtNode(container);
-    if (isUnmounted) {
-        document.body.removeChild(container);
-        container = null;
-    }
-};
-exports.cleanup = cleanup;