1.4.5 • Published 8 months ago

@aioha/react-ui v1.4.5

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

Aioha React UI

Opinionated React modal UI for Hive logins through Aioha, styled using Tailwind CSS. This provides a quick and easy way to bootstrap a React web app with ready to use Aioha-powered modal component.

Installation

pnpm i @aioha/react-ui @aioha/aioha

Usage

  1. Initialize Aioha and setup the provider at the root of your application. This may be in index.jsx, index.tsx or App.tsx depending on the framework you use.
import { initAioha } from '@aioha/aioha'
import { AiohaProvider } from '@aioha/react-ui'

// See options: https://aioha.dev/docs/core/usage#instantiation
const aioha = initAioha()

const App = () => {
  return (
    <AiohaProvider aioha={aioha}>
      <TheRestOfYourApplication />
    </AiohaProvider>
  )
}
  1. Use the modal component and the useAioha() hook anywhere within AiohaProvider.

If your application is primarily styled using Tailwind CSS, it is not required to import @aioha/react-ui/dist/build.css.

import { useState } from 'react'
import { useAioha, AiohaModal } from '@aioha/react-ui'
import { KeyTypes } from '@aioha/aioha'
import { Button, useColorMode } from '@chakra-ui/react'
import '@aioha/react-ui/dist/build.css'

export const AiohaPage = () => {
  const { colorMode } = useColorMode()
  const [modalDisplayed, setModalDisplayed] = useState(false)
  const { user } = useAioha()
  return (
    <>
      <Button onClick={() => setModalDisplayed(true)}>
        {user ?? 'Connect Wallet'}
      </Button>
      <div className={colorMode}>
        <AiohaModal
          displayed={modalDisplayed}
          loginOptions={{
            msg: 'Login',
            keyType: KeyTypes.Posting
          }}
          onLogin={console.log}
          onClose={setModalDisplayed}
        />
      </div>
    </>
  )
}

AiohaModal component

PropertyRequired?DescriptionDefault
displayedBoolean of whether the modal is displayed.false
loginTitleLogin title to be displayed.Connect Wallet
loginHelpUrlHelp URL to be linked under provider selection view, if any.undefined
loginOptionsAioha login options. See available configuration here.
onLoginCallback function to be called upon successful login, if any. Parameter contains login result as defined here.
onCloseFunction to be called to close the modal.
imageServerImage server URL for user avatar.https://images.hive.blog
explorerUrlHive block explorer URL.https://hivehub.dev

ℹ️ Note: hiveauth.cbWait in loginOptions will be overriden as AiohaModal will handle the presentation of HiveAuth QR codes.

1.4.5

8 months ago

1.4.4

10 months ago

1.4.3

10 months ago

1.4.1

11 months ago

1.4.0

11 months ago

1.0.0

12 months ago

0.1.0

12 months ago