Skip to content

Latest commit

 

History

History
100 lines (74 loc) · 2.56 KB

README.md

File metadata and controls

100 lines (74 loc) · 2.56 KB
Raw

@near-wallet-selector/modal-ui

This is the Modal UI package for NEAR Wallet Selector.

Installation and Usage

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

# Using Yarn
yarn add @near-wallet-selector/modal-ui

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

Then use it in your dApp:

import { setupWalletSelector } from "@near-wallet-selector/core";
import { setupModal } from "@near-wallet-selector/modal-ui";
import { setupMyNearWallet } from "@near-wallet-selector/my-near-wallet";

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

const modal = setupModal(selector, {
  contractId: "test.testnet",
});

modal.show();

Options

  • contractId (string): Account ID of the Smart Contract used for sign in and signing transactions.
  • methodNames (Array<string>?): Specify limited access to particular methods on the Smart Contract.
  • theme (Theme?): Specify light/dark theme for UI. Defaults to the browser configuration when omitted or set to 'auto'. This can be either light, dark or auto.
  • description (string?): Define a custom description in the UI.

Styles & Customizing CSS

Import modal css styles:

Angular

/* Add import in the main css file */
@import "~@near-wallet-selector/modal-ui/styles.css";

React & Vue

// Add import in the main component
import "@near-wallet-selector/modal-ui/styles.css";

These are the available css variables:

--wallet-selector-backdrop-bg
--wallet-selector-heading-color
--wallet-selector-text-color
--wallet-selector-sidebar-border-color
--wallet-selector-selected-wallet-bg
--wallet-selector-selected-wallet-bg-hover
--wallet-selector-wallet-option-border-color
--wallet-selector-wallet-option-bg-hover
--wallet-selector-content-bg
--wallet-selector-change-path-bg
--wallet-selector-home-button-bg
--wallet-selector-confirm-button-bg
--confirm-button-bg-hover
--wallet-selector-error
--wallet-selector-close-button-bg-color
--wallet-selector-close-button-fill-icon-colo
--wallet-selector-spinner-color
--wallet-selector-bottom-section
--wallet-selector-mobile-text
--wallet-selector-connected-green

Customizing css is done simply by updating the value of a variable in the root of your css file.

:root {
  --wallet-selector-backdrop-bg: #26262630;
}

API Reference

You can find the entire API reference for Modal UI here.

License

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