Prerequisites

Your React Native (or Expo) project must have NativeWind installed and setup. If you don't have it, you can refer to the official documentation (opens in a new tab).

CLI Commands

NativeCN provides a convenient CLI to help you get started quickly:

Installation

npm install @nativecn/cli

init

npx @nativecn/cli init

The init command:

• Detects whether you have NativeWind installed
• Creates a theme preset file (nativecn-preset.js)
• Sets up required directory structure
• Installs essential dependencies
• Creates utility functions for theming

add

npx @nativecn/cli add button card input

The add command:

• Copies component code into your project
• Automatically handles component dependencies
• Installs any required npm packages
• Creates an index file for easy importing
• Works with options like --dir for custom location and --overwrite to replace existing components

Documentation

Explore the documentation to learn more about available components, theming options, and how to integrate NativeCN into your projects.