npm.io
2.5.0-alpha.6 • Published 11 months ago

@portkey/mobile-provider

Licence
ISC
Version
2.5.0-alpha.6
Deps
0
Size
42 kB
Vulns
0
Weekly
0

@portkey/mobile-provider

This project creates javascript code that will be injected into Portkey Extension's WebView environment, for providing basic functions for DApp developers.

Usage

1. Use @portkey/detect-provider

We recommend to use the @portkey/detect-provider package to detect if Portkey is injected.
Click the link above to learn more.

mobile-provider will be injected to the window or globalThis.window object, providing you a way to detect it directly.
Also, when mobile-provider is injected, an event named portkeyInitEvent will be triggered on the host object (window).

const detectedProvider:MobileProvider = window.portkey;
if(!detectedProvider){
    // Portkey is not injected yet
    window.addEventListener('portkeyInitEvent', ()=>{
      const provider = window.portkey;
      // Do something with the provider
      ...
    });
  }

You can find more details and examples in @portkey/detect-provider 's README doc.