Getting Started

Installation coming-soon

Installation coming-soon

Installation coming-soon

Breeze UI Library

Docs

Introduction

Introduction

Breeze UI is a set of beautifully-designed, accessible components and a code distribution platform. Works with your favorite frameworks and AI models. Open Source. Open Code


About Breeze UI

Breeze-UI is designed specifically for apps, wallets, bots, and platforms integrating Breeze.

When you integrate Breeze into your app via our API and SDK, your users’ idle assets begin earning risk-managed yield — instantly and non-custodially. But how you present that to your users is just as important as how it works behind the scenes.

That’s where Breeze UI comes in. It gives you:

  • Pre-built, fully-composable UI components for onboarding users into yield, showing balances, APYs, and earnings, and managing deposits & withdrawals.
  • Source-code-level access to tailor everything to your app’s brand and UX.
  • Built-in awareness of Breeze’s risk engine, fund structures, and share-based accounting model.
  • Flexible output formats — React components, schema files, JSON — to fit your stack.

Whether you’re building a swap interface with yield overlays, a portfolio dashboard with real-time APYs, or a mobile wallet that auto-stakes idle balances, Breeze UI is how you deliver Breeze to your users elegantly and confidently.


Core Principles

  • Built for Breeze Integration - Every component is designed to work seamlessly with Breeze’s SDK and API. From fetching fund data, to displaying share-based yield, to routing deposits and withdrawals — Breeze UI understands how Breeze works under the hood.
  • Open Code, Fully Customizable Get full source code for every component. Modify how components interact with Breeze data, how they look, and how they behave — without fighting hidden defaults or constraints.
  • Brand-Ready Breeze UI is designed to make your brand shine. Swap in your palette, typography, icons, and motion patterns easily — or go deeper to create completely custom layouts.
  • Composable & Protocol-Aware Components follow a consistent API and are aware of concepts like Breeze funds, share prices, routing status, and APY streams. You don’t need to rebuild the logic to display meaningful financial data — it’s already here.
  • Flexible Formats Use React components directly, export flat JSON schemas, or work with TypeScript definitions — ideal for apps that generate UI dynamically or use AI tooling to maintain or extend interfaces.
  • DeFi Defaults, AI-Ready Components ship with accessible, minimal, and financial-grade UX defaults. And because the code is transparent and structured, it’s easy for AI tools to help you extend and document your UI layer.

How Breeze UI Fits Into Breeze

Here’s how developers typically integrate Breeze + Breeze UI:

🧷 Backend Integration

Use the Breeze SDK or API to wire up your app to Breeze’s yield engine.

  • Handle deposits, withdrawals, fund tracking, and real-time APY streams.
  • Set risk profiles, fund strategies, and customize how yield is routed behind the scenes.

🎨 Frontend Integration (with Breeze UI)

Drop Breeze UI components into your app, and connect them to your backend integration.

  • Display user balances, earnings, and APY.
  • Let users opt in/out of yield directly from your UI.

Breeze UI removes the need to design & build your own components from scratch while giving you full control to make them truly yours.


Why Use Breeze UI?

While you could integrate Breeze and build your UI layer yourself, we’ve seen apps struggle to maintain:

  • Consistency in how they present yield and risk to users.
  • Accuracy in displaying asset growth over time and APY rates.
  • A clean UX that feels native to their brand and product.

Breeze UI solves this from day one — letting you move fast, stay on-brand, and ensure users understand and trust the yield experience you’re delivering.

Whether you’re launching a mobile wallet, a payments app or a trading bot, Breeze UI gives you the foundation to deliver a seamless, intuitive, and fully-integrated yield UX.