UNPKG

young-call-app

Version:
52 lines 3.76 kB
{ "name": "young-call-app", "version": "0.2.0", "description": "try call app", "main": "./dist/index.cjs.js", "module": "./dist/index.es.js", "types": "./dist/index.d.ts", "exports": { ".": { "require": "./dist/index.cjs.js", "import": "./dist/index.es.js", "types": "./dist/index.d.ts" } }, "keywords": [ "call-app", "scheme" ], "author": "BluesYoung-web", "repository": { "type": "git", "url": "git+ssh://git@github.com/BluesYoung-web/young-call-app.git" }, "bugs": { "url": "https://github.com/BluesYoung-web/young-call-app/issues" }, "homepage": "https://github.com/BluesYoung-web/young-call-app#readme", "unpkg": "dist/index.umd.js", "jsdelivr": "dist/index.umd.js", "files": [ "dist" ], "license": "MIT", "devDependencies": { "@swc/core": "^1.2.173", "@types/node": "16", "bumpp": "^7.1.1", "happy-dom": "^3.1.0", "tsup": "^5.12.6", "typescript": "^4.6.3", "vite": "^2.9.6", "vitest": "^0.10.0" }, "scripts": { "dev": "vitest -u", "test": "vitest", "build": "vite build && tsup", "play": "vite playground --host", "release": "pnpm build && bumpp --commit --tag --push && pnpm publish" }, "readme": "# 浏览器唤端\n\n目前只实现了基于 `window.location.href` 的唤端\n\n## 使用\n\n[vue demo](./playground/src/App.vue)\n\n### 使用包管理器\n\n```bash\n# 选择一个你喜欢的包管理器\n# NPM\n$ npm install young-call-app --save\n\n# Yarn\n$ yarn add young-call-app\n\n# pnpm\n$ pnpm add young-call-app\n```\n\n```html\n<script setup lang=\"ts\">\nimport YoungCallApp from 'young-call-app';\n/**\n * 极简形态\n */\nconst callApp = new YoungCallApp({\n android_shceme: 'com.test.app',\n ios_shceme: 'com.test-ios.app',\n download: {\n ios: 'https://apps.apple.com/cn/app/xxx'\n },\n params: {\n key1: '111',\n key2: '222',\n key3: '333'\n },\n landpage: 'https://default.download.com'\n});\n\n/**\n * 完全形态\n */\nconst callApp = new YoungCallApp({\n android_shceme: 'com.test.app',\n ios_shceme: 'com.test-apple.app',\n download: {\n // 以下所有配置可选,若不配置则会使用兜底的落地页\n ios: '此处配置Apple应用商店中的地址',\n android: '此处配置安卓的下载链接',\n yyb: '此处配置应用宝的地址'\n },\n landpage: '兜底的落地页',\n path: 'scheme 的路径部分,可选',\n // 需要携带的参数\n params: {\n key1: 'value1',\n key2: 'value2',\n // ...\n }\n}, {\n /* 可选配置 */\n // 唤端时间,默认 2.5 s\n timeout: 2500,\n startCall: () => console.log('---开始唤端---'),\n callFail: () => console.log('---唤端失败---'),\n // 受限环境中的处理函数\n mask: {\n wechat: () => {\n window.alert('目前处于微信内置浏览器中,不会执行常规的唤端操作')\n }\n }\n});\n\nconst openHandler = () => callApp.call()\n</script>\n\n<template>\n <button @click=\"openHandler\">启动APP</button>\n</template>\n```\n\n### 浏览器直接引入\n\n```html\n<!-- 国内推荐使用 jsdelivr -->\n<script src=\"//cdn.jsdelivr.net/npm/young-call-app\"></script>\n<!-- or -->\n<script src=\"//unpkg/young-call-app\"></script>\n\n<script>\nconst callApp = new window.YoungCallApp(config, options);\n\ncallApp.call();\n</script>\n```\n\n## 开发环境\n\n```bash\nnode: 16.13.1\npnpm: 6.26.1\n```\n\n## 开发\n\n```bash\n# 基于 vitest 的 TDD\npnpm dev\n# 执行单元测试\npnpm test\n\n# 基于 vite/rollup 打包\n# tsup 打出来的包在部分环境下无法正常使用,所以目前只是用来生成 dts 文件\npnpm build\n```\n\n## 打包\n\n```bash\n# 产出所有格式的包\npnpm build\n```" }