heroui

License npm downloads

Beautiful, fast and modern React Native UI library

v1.0.0-beta.10

## Getting Started Visit https://v3.heroui.com/docs/native/getting-started/quick-start to get started with HeroUI Native. ## Documentation Visit [https://v3.heroui.com/docs/native/getting-started](https://v3.heroui.com/docs/native/getting-started) to view the full documentation. ## Preview App Experience HeroUI Native components in action with our preview app! You can explore all components and their variants directly on your device. ### Prerequisites Make sure you have the latest version of [Expo Go](https://expo.dev/go) installed on your mobile device ### How to Access Choose one of the following methods to access the preview app: #### Option 1: Scan the QR Code Use your device's camera or Expo Go app to scan:

Expo Go QR Code

> **Note for Android users:** If scanning the QR code with your device's camera or other scanner apps redirects to a browser and shows a 404 error, open Expo Go first and use its built-in QR scanner instead. #### Option 2: Click the Link **[📱 Open Demo App in Expo Go](https://link.heroui.com/native-demo)** This will automatically open the app in Expo Go if it's installed on your device. ## Quick Start with Example App Want to start building with HeroUI Native immediately? We provide a standalone example app that's fully configured and ready to use: **[🚀 HeroUI Native Example App](https://github.com/heroui-inc/heroui-native-example)** This repository contains a pre-configured React Native app with HeroUI Native already set up, including: - All necessary dependencies installed - Uniwind configuration ready - Example components showcasing best practices - Perfect for quickly prototyping or starting a new project Simply clone, install, and start building! ## Changelog See [CHANGELOG.md](./CHANGELOG.md) for a history of changes to this library. ## Roadmap See [Roadmap](https://herouinative.featurebase.app/roadmap) to see what we're working on. ## Community We're excited to see the community adopt HeroUI, raise issues, and provide feedback. Whether it's a feature request, bug report, or a project to showcase, please get involved! - [Discord](https://discord.gg/9b6yyZKmH4) - [X](https://x.com/hero_ui) - [GitHub Discussions](https://github.com/heroui-inc/heroui/discussions) ## Contributing Contributions are always welcome! We appreciate your help in making HeroUI Native better. ### How to Contribute - **Bug Fixes**: Check our [GitHub Issues](https://github.com/heroui-inc/heroui-native/issues) for bugs that need fixing - **New Components**: Only core team can add new components. Check our [Roadmap](https://herouinative.featurebase.app/roadmap) to see what's planned - **Feature Proposals**: Start a discussion in [GitHub Discussions](https://github.com/heroui-inc/heroui/discussions) before implementing **Important:** Please do not add new components or variants, change existing designs, or modify component behavior without prior discussion. We follow a strict design system based on our Figma designs and roadmap. For detailed guidelines, see [CONTRIBUTING.md](https://github.com/heroui-inc/heroui-native/blob/main/CONTRIBUTING.md). Please adhere to this project's [CODE_OF_CONDUCT](https://github.com/heroui-inc/heroui-native/blob/main/CODE_OF_CONDUCT.md). ## License [MIT](./LICENSE)