heroui-native
HeroUI Native component library for React Native (Tailwind v4 via Uniwind). Use when building mobile UIs with HeroUI Native — creating Buttons, Cards, TextFields, Dialogs; installing heroui-native; configuring dark/light themes; or fetching component docs. Keywords: HeroUI Native, heroui-native, Rea
By heroui-inc · 9,764 installs
npx skills add heroui-inc/heroui --skill heroui-native
Source repository · Upstream listing
HeroUI Native Development Guide
HeroUI Native is a component library built on Uniwind (Tailwind CSS for React Native) and React Native , providing accessible, customizable UI components for mobile applications.
Installation
CRITICAL: Native Only Do Not Use Web Patterns
This guide is for HeroUI Native ONLY. Do NOT apply HeroUI React (web) patterns — the package, styling engine, and color format all differ:
Feature React (Web) Native (Mobile)
Styling Tailwind CSS v4 Uniwind (Tailwind for React Native)
Colors oklch format HSL format
Package @heroui/react heroui native
Platform Web browsers iOS & Android
Always fetch Native docs before implementing.
Core Principles
Semantic variants ( primary , secondary , tertiary ) over visual descriptions
Composition over configuration (compound components)
Theme variables with HSL color format
React Native StyleSheet patterns with Uniwind utilities
Accessing Documentation & Component Information
For component details, examples, props, and implementation patterns, always fetch documentation:
Using Scripts
Direct MDX URLs
Component docs: fetch .mdx with a concrete kebab case slug. Run node scripts/list components.mjs when the slug is unknown, and never fetch a URL that still contains a placeholder.
Examples:
Button: https://heroui.com/docs/native/components/button.mdx
Dialog: https://heroui.com/docs/native/components/dialog.mdx
TextField: https://heroui.com/docs/native/components/text field.mdx
Getting started guides: use a concrete topic URL such as https://heroui.com/docs/native/getting started/quick start.mdx .
Important: Always fetch component docs before implementing. The MDX docs include complete examples, props, anatomy, and API references.
Installation Essentials
Quick Install
Framework Setup (Expo Recommended)
1. Install dependencies:
2. Create global.css :
3. Wrap app with providers:
Critical Setup Requirements
1. Uniwind is Required HeroUI Native uses Uniwind (Tailwind CSS for React Native)
2. HeroUINativeProvider Required Wrap your app with HeroUINativeProvider
3. GestureHandlerRootView Required Wrap with GestureHandlerRootView from react native gesture handler
4. Use Compound Components Components use compound structure (e.g., Card.Header , Card.Body )
5. Use onPress, not onClick React Native uses onPress event handlers
6. Platform Specific Code Use Platform.OS for iOS/Android differences
Component Patterns
HeroUI Native uses compound component patterns . Each component has subcomponents accessed via dot notation.
Example Card:
Key Points:
Always use compound structure don't flatten to props
Subcomponents are accessed via dot notation (e.g., Card.Header )
Native Card uses Card.Body (not Card.Content ); Title and Description go inside Body
Fetch component docs for complete anatomy and examples
Semantic Variants
HeroUI uses semantic naming to communicate functional intent:
Variant Purpose Usage
primary Main action to move forward 1 per context
secondary Alternative actions Multiple
tertiary Dismissive actions (cancel, skip) Sparingly
danger Destructive actions When needed
danger soft Soft destructive actions Less prominent
ghost Low emphasis actions Minimal weight
outline Secondary actions Bordered style
Don't use raw colors semantic variants adapt to themes and accessibility.
Theming
HeroUI Native uses CSS variables via Tailwind/Uniwind for theming. Theme colors are defined in global.css :
Get current theme variables:
Access theme colors programmatically:
Theme switching (Light/Dark Mode):
For detailed theming, fetch: https://heroui.com/docs/native/getting started/theming.mdx