Socket
Book a DemoInstallSign in
Socket
Book a DemoInstallSign in

@nash-io/ramp-widget-sdk

Package Overview
Dependencies
Maintainers
3
Versions
8
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@nash-io/ramp-widget-sdk

[![NPM](https://img.shields.io/npm/v/@nash-io/ramp-widget-sdk.svg)](https://www.npmjs.com/package/@nash-io/ramp-widget-sdk)

latest
npmnpm
Version
0.4.2
Version published
Maintainers
3
Created
Source

ramp-widget-sdk

NPM

A JavaScript library to allow third-parties to include a Nash fiat ramp widget in any webpage.

Nash Ramp Widget

Getting started

Examples

npm module

Install

# npm
npm install @nash-io/ramp-widget-sdk

# yarn
yarn add @nash-io/ramp-widget-sdk

Embed

Your page must contain an HTML element with the following data attribute: data-nash-fiat-ramp-widget:

<div data-nash-fiat-ramp-widget />

Once initializing the widget like below, an iframe pointing to the widget deployment will be loaded within your HTML element:

// import the module
import NashRamp from "@nash-io/ramp-widget-sdk";

// initialize the widget
const nashWidget = new NashRamp();

nashWidget.init({
  width: 496,
  height: 576,
});

With React

The pattern above can be reproduced in a simple React component:

import React, { useEffect } from "react";
import NashRamp from "@nash-io/ramp-widget-sdk";

const NashRampWidget = () => {
  useEffect(() => {
    const nash = new NashRamp();
    nash.init({
      width: 496,
      height: 576,
    });
  }, []);
  return <div data-nash-fiat-ramp-widget />;
};

export default NashRampWidget;

And then used anywhere:

export default () => <NashRampWidget />;

Browser (UMD module)

<!-- embed the script -->
<script
  src="https://unpkg.com/@nash-io/ramp-widget-sdk@latest/dist/ramp-widget-sdk.umd.js"
  async
></script>

<body>
  <!-- initialize -->
  <script>
    function initializeNash() {
      const nash = new NashRamp();
      nash.init({
        width: "496px",
        height: "576px",
      });
    }
    window.onload = function () {
      initializeNash();
    };
  </script>
  <!-- HTML target -->
  <div data-nash-fiat-ramp-widget />
</body>

API

new NashRamp({ ...options })

PropertyDescriptionTypeRequiredDefault
baseThe symbol of the fiat currency to be used in the purchase.stringNon/a
envPoints to the environment where the widget is deployed.'LOCAL' | 'PREVIEW'| 'PRODUCTION'No'PRODUCTION'
referrerYour service name (used by Nash for tracking).stringNowindow.location.hostname
targetThe symbol of the crypto currency to be purchased.stringNon/a
blockchainThe symbol of the network to be used.'BTC' | 'ETH' | 'NEO' | 'NEO3' | 'POLYGON' | 'AVAXC' | 'ARBITRUM'Non/a

NashRamp.init({ ...options })

PropertyDescriptionTypeRequired
widthWidget width — use 100% for responsivenessstring | numberYes
heightWidget height — minimum 576pxstring | numberYes
modeInitializes the widget on Buy or Sell mode.BUY|SELLNo
baseAmountInitializes the widget with a fixed base amount.numberNo
targetAmountInitializes the widget with a fixed target amount — will take precedence if used with baseAmount.numberNo

FAQs

Package last updated on 13 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Two Malicious Rust Crates Impersonate Popular Logger to Steal Wallet Keys

Research

Two Malicious Rust Crates Impersonate Popular Logger to Steal Wallet Keys

Socket uncovers malicious Rust crates impersonating fast_log to steal Solana and Ethereum wallet keys from source code.

By Kirill Boychenko  -  Sep 24, 2025