Key features
- 🔧 Plug-and-play React components for Celo apps
- 💼 Wallet connection, payment, swap, NFT, and identity modules
- ⚡ Simple installation and configuration
- ♿ Optimized for accessibility and responsive design
- 📚 Comprehensive documentation and real-world usage examples
Prerequisites
- Node.js (v16 or higher)
- React (v17 or higher)
- A Celo app project
Installation
Install Composer Kit UI using your preferred package manager:Getting started
To use Composer Kit in your React application, you’ll need to configure theComposerKitProvider at the root of your app:
Core components
Composer Kit UI provides several categories of components to accelerate your Celo app development:Wallet components
- Wallet: Connect and display wallet information
- Connect Button: Simplified wallet connection
- Avatar & Name: Display user identity
Payment & transaction components
- Payment: Send payments with built-in dialog and error handling
- Transaction: Execute blockchain transactions with status tracking
- Balance: Display and manage token balances
Token & DeFi components
- Swap: Token exchange interface
- TokenSelect: Search and select from available tokens
- Address: Display Ethereum addresses with copy functionality
NFT components
- NFTCard: Display NFT details
- NFTMint: Mint NFTs with a user-friendly interface
- NFTImage & NFTMeta: NFT display components
Identity components
- Identity: Display user information with social links
- Social Links: Integration with Twitter, GitHub, Farcaster, and more
Quick example
Here’s a simple example of using the Payment component:Component categories
🔗 Address components
Display Ethereum addresses with truncation and copy-to-clipboard functionality.💰 Balance components
Manage and display token balances with precision control and token selection.👤 Identity components
Show user profiles with avatars, names, balances, and social media links.🖼️ NFT components
Display, preview, and mint NFTs with comprehensive metadata support.💸 Payment components
Handle payments with built-in transaction dialogs and error management.🔄 Swap components
Facilitate token swaps with intuitive interfaces and token selection.🪙 Token select components
Search and select tokens from comprehensive token lists.📊 Transaction components
Execute smart contract interactions with status tracking and error handling.👛 Wallet components
Connect wallets and display user information seamlessly.Advanced usage
Composer Kit UI is designed to be modular and composable. You can combine multiple components to create complex interfaces:Styling and customization
All components accept standard HTML attributes includingclassName and style props, making them easy to customize with your preferred CSS framework:
Examples and documentation
For comprehensive examples and detailed API documentation for each component:- 🌐 Official Website: composerkit.xyz - Interactive examples and documentation
- 📚 GitHub Repository: celo-org/composer-kit - Source code and detailed README
- 💻 Live Examples: Explore the interactive examples in the documentation
Support
- 📖 Documentation: Detailed component APIs and examples
- 💬 Discord: Join the Celo Discord server and ask questions in the #general-dev channel
- 🐛 Issues: Report bugs or request features on GitHub
- 🌐 Community: Connect with other developers building on Celo
Next steps
- Get started with Celopedia to build on Celo with your AI coding assistant
- Explore building on MiniPay for mobile-first experiences
- Learn about DeFi integration for financial applications