Getting Started

The Torque UI library provides React components to easily integrate Torque functionality into your Solana application.

Requirements

• React 18 or higher

• A Solana wallet adapter implementation

Installation

Install the package:

npm install @torque-labs/torque-ui

yarn add @torque-labs/torque-ui

Basic Setup

1. First, import the required styles in your app's entry point:

import "@torque-labs/torque-ui/index.css";

1. Add the TorqueProvider component to your application. The TorqueProvider must be a child of the WalletProvider component from the Solana wallet adapter library.

"use client";

import { useWallet } from "@solana/wallet-adapter-react";
import type { PropsWithChildren } from "react";
import type { TorqueOptions } from "@torque-labs/torque-ui";
import { TorqueProvider } from "@torque-labs/torque-ui";

export function TorqueWrapper({ children }: PropsWithChildren) {
  const { wallet } = useWallet();

  const torqueOptions: TorqueOptions = {
    publisherHandle: "<your publisher handle>",
  };

  return (
    <TorqueProvider options={torqueOptions} wallet={wallet}>
      {children}
    </TorqueProvider>
  );
}

NOTE: You can get a publisher handle by logging into the Torque application and creating a publisher account.

Props

Prop	Type	Description
options	TorqueOptions	The Torque options for the provider.
wallet	Wallet	The wallet to use for the provider.
autoInit	boolean	Whether to automatically initialize the user with Torque using SIWS when a wallet is detected. Defaults to true.

Quick Start Guide

Here's a simple example of adding a Torque drawer to your application:

import { TorqueDrawer } from "@torque-labs/torque-ui";

function MyApp() {
  return (
    <div>
      <h1>My Solana App</h1>

      <TorqueDrawer />
    </div>
  );
}

The TorqueDrawer component will add a drawer interface that shows available offers and campaigns to your users. A user will be able to:

• View available campaigns

• Track their progress

• Complete requirements

• Claim rewards