Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 5.1 KB

README.md

File metadata and controls

99 lines (69 loc) · 5.1 KB
Raw
logo



GitHub Workflow Status Codacy coverage npm Codacy grade Licence

Build consistent cross-platform mobile apps at lightning speed


Pearl UI is a user-friendly UI library for React Native, offering ready-to-use components, framer-motion-like animations, dark mode, and responsive design. With its design-first approach and intuitive styling system, Pearl UI greatly enhances developer efficiency, simplifying and accelerating app development.

(Interested in creating your own NPM library? Check out my NPM library template to kickstart your library development with best practices and integrated tools.)

Features

Pearl UI is a comprehensive UI library for React Native projects, offering a wide range of features:

  • Open Source and Free 🆓: Completely open source and free to use.
  • Universal Compatibility 🌐: Write once and run on iOS, Android, and Web, thanks to the power of Expo, React Native, and React Native for Web.
  • Rich Component Library 📚: Growing library of built-in components with the flexibility to create custom components as needed.
  • Theming Control 🎨: Full control over the theme for a highly customizable UI.
  • Animation Support 🎬: Out-of-the-box support for animations using Moti.
  • Dark Mode 🌙: Dark mode support out-of-the-box, to make it easy to cater to user preferences.
  • Responsive Design 📱: Support for responsive design using breakpoints to ensure your application looks great on any device.
  • Fast Development ⚡: Speed up your development process with style props.
  • Accessibility ♿: Accessible by default, adhering to official Android and Apple guidelines.
  • Fully Typed 🦾: Completely types using Typescript to ensure type safety and enhancing developer productivity.
  • Powerful API 💪: Powerful API for creating custom components, providing flexibility and control.

Installation

To install Pearl UI in your React Native/Expo project directory, execute one of the following commands:

npm

$ npm install pearl-ui

yarn

$ yarn add pearl-ui

Documentation

For comprehensive usage instructions and API documentation, please visit the official website.

Contributing

Contributions from the community as encouraged. For instructions on how to set up the repository locally, build, test, and contribute, please refer to our CONTRIBUTING.md guide.

License

Pearl UI is licensed under the MIT License.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Nayan Patel
📖 🐛
Younes
🛡️

This project follows the all-contributors specification. Contributions of any kind welcome!