Component reference

Install any public component with:

npx shadcn@latest add https://ui.satsterminal.com/r/<component-name>.json

Complete application

Component	Purpose	Important props
`borrow-app`	Complete app with built-in UniSat connection, creation, tracking, history, management, repayment, collateral, and wallet withdrawal	`apiKey`; optional `wallet`, `defaultBitcoinAddress`, `defaultEvmAddress`

See Complete Borrow App for the one-command installation path.

Foundation

Component	Purpose	Main installed files
`borrow-core`	Shared reducer state, workflow events, BTC pricing, calculations, and formatters	`lib/borrow-events.ts`, `lib/provider-reducer.ts`, `lib/btc-price.ts` and related utilities
`borrow-provider`	Creates the `BorrowSDK`, restores sessions, and exposes state and actions	`components/borrow-context.tsx`, `hooks/use-borrow-actions.ts`

Most applications install borrow-provider; other registry items install borrow-core transitively when needed.

Origination

Component	Purpose	Important props
`loan-composer`	Borrow amount, LTV slider, live BTC collateral, and quote request	`hideAfterExecution`, `className`
`available-offers`	Protocol offers with APY, chain, LTV, and click-to-execute behavior	`destinationAddress`, `loadingPlaceholderCount`
`borrow-flow`	Deposit QR, mempool link, workflow timeline, and completion state	`loanId`, `startedAt`, `depositWindowSeconds`, `onReset`

Installing borrow-flow also provides ActiveBorrowFlow, which reads the current workflow ID from BorrowProvider automatically.

Account and loan history

Component	Purpose	Important props
`platform-wallet-address`	Compact platform wallet address and copy action	`label`, `className`
`user-loans`	Active, pending, and historical loans with pagination	`defaultFilter`, `pageSize`, `onManageLoan`, `onTrackLoan`
`wallet-withdrawal`	Withdraw supported platform-wallet assets to an EVM address	`defaultEvmAddress`, `pollIntervalMs`, `onComplete`

See Platform wallet withdrawal for destination behavior and status tracking.

Loan management

Component	Purpose	Important props
`loan-management`	Deposit more BTC or borrow more against an active loan	`defaultLoanId`, `className`
`repay-loan`	Full or partial repayment with live debt and wallet balance	`loanId`, `currency`, `chain`, `defaultAmount`, `onComplete`
`withdraw-collateral`	Withdraw BTC using the live maximum and health limits	`loanId`, `defaultBitcoinAddress`, `onComplete`

Install an individual management action:

npx shadcn@latest add https://ui.satsterminal.com/r/loan-management.json
npx shadcn@latest add https://ui.satsterminal.com/r/repay-loan.json
npx shadcn@latest add https://ui.satsterminal.com/r/withdraw-collateral.json

loan-management contains both Deposit More and Borrow More modes. They are not separate registry items. Its deposit transaction link and confirmation progress require @satsterminal-sdk/borrow 1.7.3 or later.

<RepayLoan
  loanId={loan.originalBorrowId}
  currency={loan.currency}
  chain={loan.chain}
/>

<WithdrawCollateral
  loanId={loan.originalBorrowId}
  defaultBitcoinAddress={bitcoinAddress}
/>

All components that call the SDK must be descendants of BorrowProvider.

Overview

Suite

UI Components

Swaps

Borrow

Bridge

Earn

UI Component Reference

Component reference

Complete application

Foundation

Origination

Account and loan history

Loan management

​Component reference

​Complete application

​Foundation

​Origination

​Account and loan history

​Loan management

Component reference

Complete application

Foundation

Origination

Account and loan history

Loan management