跳到主要内容

立即开始

安装#

将库安装为 npm 模块:

npm install @onekeyhq/connect

或者

yarn add @onekeyhq/connect

初始化#

ES6

import OneKeyConnect from '@onekeyhq/connect';

CommonJS

var OneKeyConnect = require('@onekeyhq/connect').default;

API 方法#

处理事件#

运行本地版本(开发模式)#

  • 克隆存储库:git clone git@github.com:OneKeyHQ/connect.git
  • 安装 node_modules 开发依赖 yarnnpm install
  • 运行本地服务器:yarn dev

初始化项目

OneKeyConnect.init({  connectSrc: 'https://localhost:8088/',  lazyLoad: true, // 开启 lazyLoad 会直到调用 OneKeyConnect 方法后才会初始化 iframe.  manifest: {    email: 'hi@onekey.so',    appUrl: 'https://onekey.so',  },});

运行本地版本(自定义分支)#

为了运行未发布到 npm 的分支,并且此分支需要更改(大多数情况是在将新方法添加到 OneKeyConnect 时)

  • git checkout custom-feature-branch
  • yarn build:npm
  • yarn build

使用yarn link#

  • cd ./npm && yarn link
  • 在需要使用的项目中: yarn install @onekeyhq/connect

使用本地文件#

在您的项目中:yarn install @onekeyhq/connect@file:/[local-path-to-repository]