@airmoney-degn/react-ui
v10.0.1
Published
Air Money React UI Library
Readme
Air Money React UI Library
A comprehensive React UI library built with TypeScript, providing reusable components, hooks, and utilities for the Air Money application ecosystem.
📚 User Guide
For detailed usage instructions, component documentation, and examples, please refer to our User Guide (coming soon).
🛠️ Development
Prerequisites
- Node.js 18+
- Yarn 1.22.22+
- TypeScript 5.8+
Setup
- Clone the repository
- Install dependencies:
yarn install
Available Scripts
yarn dev- Start development server with hot reloadyarn build- Build the library for productionyarn check-types- Run TypeScript type checkingyarn lint- Run ESLint and fix issuesyarn preview- Preview the built libraryyarn watch:css- Watch and compile CSS changesyarn release- Build and publish to npmyarn version- Update version using changesetsyarn bump- Create changeset and update versionyarn changeset- Create a new changesetyarn push- Publish to yalc for local testing
Building
The library is built using Vite with the following configuration:
- Entry point:
src/index.ts - Output formats: ES modules and CommonJS
- TypeScript: Full type definitions generated
- CSS: Tailwind CSS with custom
am-prefix - External dependencies: React, React DOM, Controller SDK
Development Workflow
- Make changes to components, hooks, or utilities
- Run type checking:
yarn check-types - Lint code:
yarn lint - Test locally:
yarn devoryarn pushfor yalc testing - Build:
yarn build - Create changeset:
yarn changeset(for version changes)
Code Style
- ESLint: Configured with Air Money's custom config
- Prettier: Code formatting with custom config
- TypeScript: Strict mode enabled
- Import sorting: Automatic import organization
Publishing
- Create a changeset:
yarn changeset - Update version:
yarn version - Build and publish:
yarn release
Testing Locally
Use yalc to test the library in other projects:
# Publish to yalc
yarn push
# In your test project
yalc add @airmoney-degn/react-uiDependencies
- React 19.1.0+ - UI framework
- TypeScript 5.8+ - Type safety
- Tailwind CSS 3.4+ - Styling
- Radix UI - Accessible components
- Controller SDK 7.2+ - Device integration
🤝 Contributing
This library is maintained by the Air Money team. For issues and feature requests, please contact the development team.
📄 License
This project is proprietary and confidential. All rights reserved.
🔗 Related Packages
@airmoney-degn/controller-sdk- Core SDK for Air Money devices@airmoney-degn/eslint-config- ESLint configuration@airmoney-degn/prettier-config- Prettier configuration
📞 Support
For technical support and questions, please contact the Air Money development team.
