https://github.com/switchtrue/imx-widgets-react
React widgets for Immutable X
https://github.com/switchtrue/imx-widgets-react
Last synced: 19 days ago
JSON representation
React widgets for Immutable X
- Host: GitHub
- URL: https://github.com/switchtrue/imx-widgets-react
- Owner: switchtrue
- Created: 2022-01-11T10:32:37.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-11T12:09:51.000Z (about 4 years ago)
- Last Synced: 2025-09-23T21:34:59.848Z (5 months ago)
- Language: JavaScript
- Size: 440 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# imx-widgets-react
A collection of widgets for use with React apps for displaying data from [Immutable X](https://www.immutable.com/).
# Installation
```
npm install imx-widgets-react
// or
yarn install imx-widgets-react
```
# Widgets
## Link Wallet
Opens the window to link your wallet with IMX.

```jsx
import { IMXLinkWallet } from 'imx-widgets-react';
}
// (optional) React.Component: Component that will be displayed when the wallet is not linked.
unlinkedComponent={}
/>
```
## IMX Balance
Displays the linked wallets IMX balance.
*NOTE: Requires the `IMXLinkWidget` to be used and for a wallet to have been linked before a balance will be displayed.*

```jsx
import { IMXBalance } from 'imx-widgets-react';
```
## IMX Deposit
Displays the linked wallets IMX balance and deposit funds to IMX.
*NOTE: Requires the `IMXLinkWidget` to be used and for a wallet to have been linked before a balance will be displayed and funds can be deposited.*

```jsx
import { IMXDeposit } from 'imx-widgets-react';
```