heroui-native-pro 1.0.0-alpha.7 → 1.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +97 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,97 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
<p align="center">
|
|
3
|
+
<a href="https://heroui.pro/"><img alt="HeroUI Native Pro" src="https://heroui-assets.nyc3.cdn.digitaloceanspaces.com/docs/heroui-pro@2x.jpg"></a>
|
|
4
|
+
<a href="https://heroui.pro/" target="_blank">
|
|
5
|
+
<h1 align="center">HeroUI Native Pro</h1>
|
|
6
|
+
<span>Premium React Native components that extend HeroUI Native</span>
|
|
7
|
+
</a>
|
|
8
|
+
</p>
|
|
9
|
+
</div>
|
|
10
|
+
|
|
11
|
+
<br />
|
|
12
|
+
|
|
13
|
+
HeroUI Native Pro is a premium extension of [HeroUI Native OSS](https://heroui.com/docs/native/getting-started) — production-ready, fully composable React Native components that follow the same patterns you already know from HeroUI Native OSS. New components and fixes ship regularly as package updates.
|
|
14
|
+
|
|
15
|
+
For web (46+ components, templates, Theme Builder, and the full Pro suite), see [`@heroui-pro/react`](https://www.npmjs.com/package/@heroui-pro/react) and the [HeroUI Pro introduction](https://heroui.pro/docs/react/getting-started).
|
|
16
|
+
|
|
17
|
+
## What’s included
|
|
18
|
+
|
|
19
|
+
- **React Native components** — Calendar, DatePicker, DateRangePicker, Stepper, SlideButton, ProgressButton, SocialAuthButton, NumberField, NumberStepper, RadioButtonGroup, and more — each with full documentation
|
|
20
|
+
- **Same design system** — Built on the same [Uniwind](https://uniwind.dev/) + [Tailwind CSS v4](https://tailwindcss.com/) theming, color tokens, and styling patterns as HeroUI Native OSS
|
|
21
|
+
- **Smooth animations** — Built on [react-native-reanimated](https://docs.swmansion.com/react-native-reanimated/) with a unified `animation` prop
|
|
22
|
+
- **Figma** — Design files for all Pro components
|
|
23
|
+
- **AI tooling** — MCP server, agent skills, and design taste for AI-assisted development
|
|
24
|
+
- **Priority support** — Fast support, prioritized issues, private Discord, and a VIP badge
|
|
25
|
+
|
|
26
|
+
## Requirements
|
|
27
|
+
|
|
28
|
+
- Bare [React Native](https://reactnative.dev/) or [Expo](https://expo.dev/)
|
|
29
|
+
- [Tailwind CSS v4](https://tailwindcss.com/) via [Uniwind](https://uniwind.dev/)
|
|
30
|
+
- [HeroUI Native OSS](https://heroui.com/docs/native/getting-started) (`heroui-native`)
|
|
31
|
+
|
|
32
|
+
If you have not set up HeroUI Native OSS yet, follow the [HeroUI Native quick start](https://heroui.com/docs/native/getting-started/quick-start) first.
|
|
33
|
+
|
|
34
|
+
## Installation
|
|
35
|
+
|
|
36
|
+
### 1. Log in
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
npx heroui-pro login
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
You can use `bunx heroui-pro login` or `pnpm heroui-pro login` instead.
|
|
43
|
+
|
|
44
|
+
### 2. Install
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
npx heroui-pro install
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The CLI adds **`heroui-native-pro`** (and **`heroui-pro`** as needed), downloads Pro artifacts, installs missing peer dependencies (for example `@internationalized/date` for date components), and can configure **pnpm** / **bun** so postinstall scripts stay trusted.
|
|
51
|
+
|
|
52
|
+
Run `npx heroui-pro` with no arguments for the interactive menu.
|
|
53
|
+
|
|
54
|
+
### 3. Point Tailwind at Pro sources
|
|
55
|
+
|
|
56
|
+
In `global.css`, add a `@source` entry for Pro (paths are relative to that file):
|
|
57
|
+
|
|
58
|
+
```css
|
|
59
|
+
@import 'tailwindcss';
|
|
60
|
+
@import 'uniwind';
|
|
61
|
+
|
|
62
|
+
@import 'heroui-native/styles';
|
|
63
|
+
|
|
64
|
+
@source './node_modules/heroui-native/lib';
|
|
65
|
+
@source './node_modules/heroui-native-pro/lib';
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Adjust the `@source` paths if `global.css` is not at the project root.
|
|
69
|
+
|
|
70
|
+
### 4. CI / automated installs
|
|
71
|
+
|
|
72
|
+
For GitHub Actions, EAS, and similar, set **`HEROUI_AUTH_TOKEN`** from a CI/CD token in the [HeroUI dashboard](https://heroui.pro/dashboard). With that env var set, installs can download Pro artifacts without interactive login.
|
|
73
|
+
|
|
74
|
+
See the full guide: [Installation](https://heroui.pro/docs/native/getting-started/installation).
|
|
75
|
+
|
|
76
|
+
## CLI (quick reference)
|
|
77
|
+
|
|
78
|
+
| Command | Description |
|
|
79
|
+
| ------------------------------ | ----------------------------------------------- |
|
|
80
|
+
| `heroui-pro login` | Log in with GitHub |
|
|
81
|
+
| `heroui-pro install` | Add Pro packages, peers, and PM config |
|
|
82
|
+
| `heroui-pro install --yes` | Non-interactive install |
|
|
83
|
+
| `heroui-pro install --dry-run` | Preview installs |
|
|
84
|
+
| `heroui-pro status` | Login and installed products |
|
|
85
|
+
| `heroui-pro logout` | Sign out |
|
|
86
|
+
| `heroui-pro docs` | Open [heroui.pro/docs](https://heroui.pro/docs) |
|
|
87
|
+
|
|
88
|
+
## Next steps
|
|
89
|
+
|
|
90
|
+
- [Installation & troubleshooting](https://heroui.pro/docs/native/getting-started/installation)
|
|
91
|
+
- [Browse components](https://heroui.pro/docs/native/components)
|
|
92
|
+
- [Agent skills](https://heroui.pro/docs/native/getting-started/agent-skills)
|
|
93
|
+
- [Provider](https://heroui.pro/docs/native/getting-started/provider) — configure the HeroUI Native provider
|
|
94
|
+
|
|
95
|
+
## License
|
|
96
|
+
|
|
97
|
+
See [LICENSE](./LICENSE).
|