Haven1
  • Get started
    • 🧑‍🚀Welcome Havenauts!
    • 📄Haven1 Litepaper
    • 🧮H1 Tokenomics
  • Foundations of Haven1
    • 📐Architecture & network design
    • 🔐Network-level security
    • 📚Haven1 Core protocols
    • 💱Best in class liquidity
    • 👮Network Guardians: Firewall on Haven1
    • 🌉hBridge: Intro to Haven1 Bridge
  • Learn
    • 💵What does Haven1 solve?
    • 💡Haven1: Use Cases
    • 📚Understanding GoQuorum
    • 🔤Haven1 Blockchain basics
    • 🛂KYC policies on Haven1 blockchain
    • Security at Haven1
    • 🔓What is esH1?
    • ⚖️Dispute resolution mechanism
    • 🛣️Haven1 Roadmap
    • 🖥️Haven1 is EVM compatible
  • Products
    • 🔃hSwap - Spot DEX on Haven1
    • 📍hsETH on Haven1
    • Earn on Haven1
    • 🛡️2FA Wallet Shield
    • 🧊Haven1 block explorer
    • 🏛️Governance & veH1
    • 🆔hPassport - Key to Haven1
      • Advantages of having ID verification at a network level
      • Understanding the ID Verification Process
    • 💼Vesting esH1 - Converting esH1 to H1
    • 📍Staking H1 & esH1 - Earning rewards on your H1 holdings
      • Flexible Staking
      • Locked Staking
  • hPerpetuals - Perps DEX on Haven1
  • Haven1 Guides
    • 🔗Quick links
    • ✅Haven1 onboarding Guide
      • 🪪KYC Guide
      • Business KYC(KYB) Guide
    • Adding multiple wallets to a hPassport
    • 🌉Simple Bridging Guide on Haven1 network
    • 🏠Haven1 Portal - Your Gateway into Haven1
    • 🔑2FA Set up Guide
    • 🤑Haven1 Airdrop: Claim Process and Strategies
    • Claim Process Walkthrough on Team Finance
    • 📄Contract Addresses
  • Build
    • 📖Getting started
    • 🌐Haven1 Network information
    • 🍦Novel developer benefits on Haven1
    • 📑High level guide for secure deployment
    • ⚙️Detailed deployment Guide
    • 🧰Developer tools
      • 👛Haven1 Gnosis Safe wallet
      • 🛠️Haven1 SDK
        • 🔌@haven1/sdk-api-client
          • Class: Haven1SDK
          • Class: AuthModule
          • Class: SdkModule
        • ⛓️@haven1/blockchain-sdk
          • Contracts
        • 🧰@haven1/wagmi-sdk
          • Constant Module
            • Variable: haven1Devnet
            • Variable: haven1Testnet
            • Variable: H1
          • Contract Module
            • ProofOfIdentity
            • ProofOfIdentityV2
            • NativeAppFee
          • Utility Module
            • bigIntMax
            • formatBigint
            • bigintFromDecimals
          • Hook Module
            • useWatch
            • useBalance
            • useApproveERC20
            • useContractWrite
        • ⚛️@haven1/react-sdk
          • useHaven1SDK
          • useAuth
          • useIdentity
          • useNotifications
          • useOTP
          • useSignIn
        • 📜Use cases & Examples
          • Adding the Notification Component to Your React UI
          • Check Proof of Identity (POI) Status
      • Oracles on Haven1
      • Subgraph on Haven1
      • Haven1 block explorer
      • Web3 libraries and tools
    • Development frameworks
    • 🔐Using hPassport in Your dApps
      • Integrating hPassport into Your dApp
      • Implementing Identity Checks in Smart Contracts
        • Country codes
      • Sample Application - Country ID
      • Sample Application - Composable verification level
      • Sample Application - User type
      • Repository Information
    • ⛽Application fees
      • FeeContract.sol
      • Example FeeContract Interactions
      • Case Studies
    • 👷Builders grants program
  • Additional resources
    • 📚Haven1 terminology
  • Quick Links
    • Website
    • Twitter
    • Blog
    • Telegram
    • Customer Support
Powered by GitBook
On this page
  • Key Features
  • Storybook Documentation
  • Installation
  • Dependencies
  • Interfaces
  • Type Aliases
  • Functions
  1. Build
  2. Developer tools
  3. Haven1 SDK

@haven1/react-sdk

The @haven1/react-sdk package provides a comprehensive library of ready-to-use React components, icons, and hooks to accelerate development with Haven1. Designed for flexibility and customization, it

PrevioususeContractWriteNextuseHaven1SDK

Last updated 4 months ago

Key Features

1. Ready-to-Use React Components

  • UI Elements: A library of generic components such as buttons, modals, and input fields designed for quick implementation.

  • Fully Functional Components: Advanced components like notifications, 2FA dialogs, and more, pre-configured for Haven1 integration.

  • Design System: All components follow the Haven1 design system, ensuring consistent aesthetics and user experience across projects.

  • Customization: Built with Tailwind CSS, allowing you to easily customize styles to match your project’s needs.

2. Icon Assets

  • A comprehensive set of icons representing Haven1 products and features.

  • Designed to seamlessly integrate into your UI.

3. React Hooks with React Query

  • API Integration Hooks: Simplify connecting your React project to Haven1 APIs using @tanstack/react-query.

  • Efficiency: Automatically manage caching, loading states, and error handling for API requests.

  • Type-Safe: Fully typed responses ensure reliability in your code.

Storybook Documentation

Explore all components and their usage in our Storybook:

Installation

npm install @haven1/react-sdk
yarn add @haven1/react-sdk
pnpm add @haven1/react-sdk

Dependencies

This package requires the following peer dependencies:

  • React

  • @tanstack/react-query: For managing API data and caching.

  • @haven1/sdk-api-client: To connect your React project to Haven1 APIs.

Install these dependencies if not already included in your project:

Before using the UI components from this package, ensure you have installed the necessary dependencies. Then, apply the styles to your project's global CSS file.

@import '@haven1/react-sdk/css';

Interfaces

  • ButtonColorStyles

  • ButtonSizeProps

  • CircularLoadingProps

  • EmptyNotificationProps

  • GoldIconProps

  • H1IconProps

  • LoadingDotsProps

  • NotificationBellProps

  • NotificationComponentProps

  • NotificationDialogProps

  • NotificationItemListProps

  • NotificationItemProps

  • NotificationPopoverProps

  • NotificationProps

  • NotificationSignInProps

  • OtpModalProps

  • PlatinumIconProps

  • SilverIconProps

  • WH1IconProps

Type Aliases

  • ButtonColor

  • ButtonProps

  • NotificationItemType

  • SubmitOtpParams

  • ValidateAuthParams

  • VerifyAuthParams

Functions

  • Button

  • CircularLoading

  • EmptyNotification

  • ESH1Icon

  • GoldIcon

  • H1Icon

  • Haven1SDKProvider

  • LoadingDots

  • Notification

  • NotificationBell

  • NotificationComponent

  • NotificationDialog

  • NotificationItem

  • NotificationItemList

  • NotificationPopover

  • NotificationSignIn

  • OtpModal

  • PlatinumIcon

  • SilverIcon

  • useAuth

  • useHaven1SDK

  • useIdentity

  • useNotifications

  • useOTP

  • useSignIn

  • WH1Icon

  • withHaven1Tag

🧰
🛠️
⚛️
Storybook for @haven1/react-sdk