Skip to content

Elue-dev/rn-keypad-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧮 React Native Keypad Component CLI

A simple CLI to quickly scaffold and add the React Native Keypad Component into your project.


Watch demo video here: Demo Video

Keypad Demo

📦 Installation

You can run it with bun:

bunx rn-keypad-cli

Or run it with npx:

npx rn-keypad-cli

Or install globally:

npm install -g rn-keypad-cli

🚀 Usage

Inside your React Native project directory, run:

bunx rn-keypad-cli

You'll be prompted to choose your installation directory:

🧮 React Native Keypad Component CLI

This will install the Keypad component into your project...

Where do you want to add the source code? (default: components/Keypad):

You can either:

  • Press Enter to use the default location (components/Keypad)
  • Type a custom path like ./src/ui/Keypad, ./lib/components/Keypad, etc.

Example with default path:

🧮 React Native Keypad Component CLI

This will install the Keypad component into your project...

Where do you want to add the source code? (default: components/Keypad):
✓ Created folder: ./components
✓ Keypad files copied successfully

✅ Keypad component added!
You can now import it using:

import Keypad from './components';

Example with custom path:

🧮 React Native Keypad Component CLI

This will install the Keypad component into your project...

Where do you want to add the source code? (default: components/Keypad): ./src/ui/Keypad
✓ Created folder: ./src/ui/Keypad
✓ Keypad files copied successfully

✅ Keypad component added!
You can now import it using:

import Keypad from './src/ui/Keypad';

The CLI will then:

  • Create the specified folder structure (if it doesn't exist)
  • Copy all keypad component files into the chosen directory
  • Display import instructions for easy usage

🧱 Output

The copied files will be organized like this:

Default installation:

components/
└── Keypad/
    ├── constants.ts
    ├── Keypad.tsx
    └── types.ts

Custom installation example:

src/
└── ui/
    └── Keypad/
        ├── constants.ts
        ├── Keypad.tsx
        └── types.ts

🛠 Customize

After installing the component, feel free to customize styles, layout, or functionality to suit your app.

📚 Original Keypad Component

This CLI uses the official React Native Keypad Component package created by Wisdom Elue

If you prefer, you can install it directly instead of using the CLI:

npm install react-native-keypad-component
# or
yarn add react-native-keypad-component
# or
bun add react-native-keypad-component

🧑‍💻 Author

Wisdom Elue

📄 License

MIT

About

A simple CLI to quickly scaffold and add the React Native Keypad Component source code into your project.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published