Skip to content

Latest commit

 

History

History
106 lines (71 loc) · 4.28 KB

README.md

File metadata and controls

106 lines (71 loc) · 4.28 KB

AlienUI 👽

AlienUI is an open-source UI component library built on Nativewind for React Native apps. It leverages native tags for seamless integration and maintains zero to minimal dependencies, enabling high-performance, and stunning interfaces with ease.

aui

Features

1. Zero Dependencies

  • No external dependencies required.
  • Fully functional with just React Native and NativeWind installed.
  • Simplifies integration into any project.

2. Native Tags for Components

  • Built entirely on native React Native components like View, Text, TouchableOpacity, Pressable, Animated etc.
  • Ensures compatibility with all React Native environments.

3. Lightweight and Performant

  • Minimal overhead for faster app performance.
  • Ideal for MVPs, small-scale projects, or large apps requiring lightweight components.

4. Customization-Friendly

  • Provides fully customizable components.
  • Works seamlessly with styling libraries like NativeWind.

5. Plug-and-Play

  • No setup or configuration required.
  • Just import the components and start building.

6. Comprehensive Documentation

  • Easy-to-follow documentation to help you get started quickly.
  • Includes usage examples, code snippets, and preview.

7. Ready-to-Use Component Variants

  • Pre-designed components with multiple variants for buttons, inputs, and more.
  • Examples include:
    • Galaxy and Earth Button
    • Nebulon and Earth Input

8. Developer-Friendly

  • Fully open-source and free to use.
  • Encourages collaboration and contributions from the community.

9. Compatible with Popular Tools

  • Designed to work seamlessly with tools like Expo, NativeWind, and React Navigation.
  • Easy to integrate with animation libraries and other React Native tools.

10. Self-Hosted and Independent

  • No reliance on third-party servers or APIs.
  • Gives developers full control over the library and its components.

Getting started

There is no installation, if you have a bare React Native project setup with NativeWind, you can copy the code and paste it into your project.

Usage

Browse the website for the components you need, copy the code and paste it into your project. Some components will have TypeScript support.

  1. Browse the website for a component you like.
  2. Click on the 'Copy' button to copy the source code.
  3. Paste the copied code into your project.

Components

AlienUI has a wide range of freely available components. These components include:

Contributing

Contributors can contribute by adding new components, fixing bugs or improving the documentation. Please create an issue before starting any work. Once you get approval on your issue, you can create a new branch and submit your changes in a PR. Please note that all PRs need to be reviewed.

A detailed contribution guide is found in CONTRIBUTION.md

License

AlienUI is an open source project licensed under the MIT LICENSE