npm.io
10.1.4 • Published 7 months ago

@near-wallet-selector/sender

Licence
(MIT OR Apache-2.0)
Version
10.1.4
Deps
3
Size
301 kB
Vulns
0
Weekly
0
Stars
181

@near-wallet-selector/sender

This is the Sender package for NEAR Wallet Selector.

Installation and Usage

The easiest way to use this package is to install it from the NPM registry

# Using pnpm
pnpm add -w @near-wallet-selector/sender

# Using NPM.
npm install @near-wallet-selector/sender

Then use it in your dApp:

import { setupWalletSelector } from "@near-wallet-selector/core";
import { setupSender } from "@near-wallet-selector/sender";

// Sender for Wallet Selector can be setup without any params or it can take few optional params, see options below.
const sender = setupSender({
  iconUrl: "https://<Wallet Icon URL Here>" // optional
});

const selector = await setupWalletSelector({
  network: "testnet",
  modules: [sender],
});

Options

  • iconUrl: (string?): Image URL for the icon shown in the modal. This can also be a relative path or base64 encoded image. Defaults to ./assets/sender-icon.png.
  • deprecated: (boolean?): Deprecated is optional. Default is false.

Assets

Assets such as icons can be found in the /assets directory of the package. Below is an example using Webpack:

import { setupSender } from "@near-wallet-selector/sender";
import senderIconUrl from "@near-wallet-selector/sender/assets/sender-icon.png";

const sender = setupSender({
  iconUrl: senderIconUrl
});

License

This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

Keywords