Skip to content

Latest commit

 

History

History
111 lines (86 loc) · 3.89 KB

README.md

File metadata and controls

111 lines (86 loc) · 3.89 KB
Raw

Cardano Connect with Wallet - React

Tests Release conventionalcommits Discord

This repository aims to provide useful hooks and React components to simplify the cardano dapp integration e.g. to connect browser wallets, fetch addresses and provide signing (CIP 8, CIP 30).

🚀 Getting Started

npm i @cardano-foundation/cardano-connect-with-wallet

React

For more detailed information and usage examples, please refer to the storybook playground.

🪝 Hooks

useCardano allows you to interact with wallets supporting CIP 30 and CIP 8. It's a useful wrapper of the window.cardano object and manages state information within the local storage.

import { useCardano } from '@cardano-foundation/cardano-connect-with-wallet';

const YourGreatDApp = (props) => {
    const { 
        isEnabled,
        isConnected,
        enabledWallet,
        stakeAddress,
        signMessage,
        connect,
        disconnect 
    } = useCardano();

    const onConnect = () => alert('Successfully connected!');

    return (
        <>
            { isConnected ?
                <span>{ stakeAddress }</span> :
                <button
                    onClick={() => connect(
                        'wallet_name_with_cip30_support',
                        onConnect
                    )}>Connect</button>
            }
            <NiceOtherComponents>...</NiceOtherComponents>
        </>
    )
}

🎨 Components

This library provides ready to use Components for connecting, disconnect and signing.

import { ConnectWalletList, ConnectWalletButton } from '@cardano-foundation/cardano-connect-with-wallet';


<ConnectWalletList
    borderRadius={15}
    gap={12}
    primaryColor="#0538AF"
    onConnect={onConnectWallet}
    customCSS={`
        font-family: Helvetica Light,sans-serif;
        font-size: 0.875rem;
        font-weight: 700;
        width: 164px;
        & > span { padding: 5px 16px; }
    `}
/>

<ConnectWalletButton
    message="Please sign Augusta Ada King, Countess of Lovelace"
    onSignMessage={onSign}
    onConnect={onConnect}
/>

ℹ️ SSR with Next.js

This library tries to get access to the window object which is not present on the server-side when Next.js pre-renders the page. The solution here is to use dynamic imports. One should use dynamic imports for both the components and hooks.

An example of using the ConnectWalletList with Next.js could look like the following:

const ConnectWalletList = dynamic(
  () =>
    import('@cardano-foundation/cardano-connect-with-wallet').then(
      (mod) => mod.ConnectWalletList
    ),
  {
    ssr: false,
  }
);

💪 Contributing

Please have a look at our contributing infos to become familiar with our guidelines. There is also a short description for our development setup as we use Storybook for testing, playing around and for supporting the development process.