townesquare-connectauth v1.1.6

TownesquareConnect

TownesquareConnect is a web library designed to simplify user authentication by offering multiple login options, such as external wallets and email. The component provides a sleek, customizable modal interface where users can easily select their preferred login method.

Installation

Install TownesquareConnect using npm:

npm install townesquare-connectauth

or with yarn:

yarn add townesquare-connectauth

Usage

To use the TownesquareConnect component in your React application, simply import it and include it within your component tree. You can configure the component with various props to control the login options and modal behavior.

import React from 'react';
import { TownesquareConnect } from 'townesquare-connectauth';

const App = () => {
  return (
    <TownesquareConnect
      loginOption={['externalwalletLogin','emailLogin']}
      displayErrorsOnModal={true}            
      showModal={true}                      
      emailLoginFunction={() => console.log('Email login')}     
      metaMaskLoginFunction={() => console.log('MetaMask login')}  
      phantomLoginFunction={() => console.log('Phantom login')}    
      onClose={() => console.log('Close modal')}                
    />
  );
};

export default App;

Props

• loginOption: An array of login methods to display in the modal ('externalwalletLogin' or 'emailLogin').
• displayErrorsOnModal: Boolean to control whether errors are shown in the modal.
• showModal: Boolean to control the visibility of the login modal.
• emailLoginFunction: Function to execute when the email login option is selected.
• metaMaskLoginFunction: Function to execute when the MetaMask wallet login option is selected.
• phantomLoginFunction: Function to execute when the Phantom wallet login option is selected.
• onClose: Function to execute when the modal is closed.