@dtinsight/dt-utils/lib/copy/index.js

袋鼠云前端常用工具库

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 };
    }
};
import createFakeElement from './createFakeElement';
/**
 * 浏览器剪贴板复制工具函数。
 *
 * @category Utils
 * @description
 * 提供一个一致且可靠的方式来在不同浏览器中复制文本到剪贴板。
 * 它优先使用现代的 Clipboard API，当不可用时会降级使用 execCommand('copy') 方法来支持旧版浏览器。
 *
 * @param {string} text - 要复制的文本内容
 * @returns {Promise<boolean>} 复制操作结果
 *   - 复制成功时返回 true
 *   - 复制失败时返回 false
 *
 * @example
 * ```typescript
 * import { copy } from 'dt-utils';
 *
 * // 简单复制
 * const text = "Hello, clipboard!";
 * const success = await copy(text);
 * console.log(success ? "Copied!" : "Copy failed");
 *
 * // 带错误处理的复制
 * try {
 *   const text = "Sensitive data";
 *   if (await copy(text)) {
 *     showSuccessToast("Content copied!");
 *   } else {
 *     showErrorToast("Copy failed");
 *   }
 * } catch (error) {
 *   handleError(error);
 * }
 *
 * // 在按钮点击处理程序中复制
 * button.addEventListener('click', async () => {
 *   const success = await copy('Click to copy text');
 *   button.textContent = success ? 'Copied!' : 'Try again';
 *   setTimeout(() => {
 *     button.textContent = 'Copy';
 *   }, 2000);
 * });
 * ```
 */
function copy(text) {
    return __awaiter(this, void 0, void 0, function () {
        var err_1, fakeElement, succeeded;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    if (!(navigator.clipboard && window.isSecureContext)) return [3 /*break*/, 4];
                    _a.label = 1;
                case 1:
                    _a.trys.push([1, 3, , 4]);
                    return [4 /*yield*/, navigator.clipboard.writeText(text)];
                case 2:
                    _a.sent();
                    return [2 /*return*/, true];
                case 3:
                    err_1 = _a.sent();
                    console.warn('copy error!', err_1);
                    return [3 /*break*/, 4];
                case 4:
                    fakeElement = createFakeElement(text);
                    document.body.appendChild(fakeElement);
                    try {
                        fakeElement.focus();
                        fakeElement.select();
                        succeeded = document.execCommand('copy');
                        fakeElement.remove();
                        return [2 /*return*/, succeeded];
                    }
                    catch (err) {
                        console.warn('copy error!', err);
                        fakeElement.remove();
                        return [2 /*return*/, false];
                    }
                    return [2 /*return*/];
            }
        });
    });
}
export default copy;