https://github.com/devlander-software/ui
A universal carousel for react, react native, and react native web.
https://github.com/devlander-software/ui
Last synced: about 1 year ago
JSON representation
A universal carousel for react, react native, and react native web.
- Host: GitHub
- URL: https://github.com/devlander-software/ui
- Owner: Devlander-Software
- Created: 2025-01-15T23:29:21.000Z (over 1 year ago)
- Default Branch: production
- Last Pushed: 2025-01-16T22:40:44.000Z (over 1 year ago)
- Last Synced: 2025-01-31T06:43:03.079Z (over 1 year ago)
- Language: TypeScript
- Size: 494 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# @devlander/ui (Beta)
**`@devlander/ui`** is a comprehensive UI package that provides reliable, customizable, and cross-platform components. Designed to streamline development, it helps you kickstart projects with consistent and reusable elements that work seamlessly across iOS, Android, React Native Web, React Native TV, Next.js, Xbox, and more.
🚨 **Beta Notice**: This package is currently in beta. While it's stable and functional for most use cases, certain features may still be evolving. Feedback and contributions are greatly appreciated to help improve the package.
---
## 🚀 Why Use @devlander/ui?
- **Functionality First**: Reliable, prebuilt components designed to handle core functionality out of the box.
- **Cross-Platform Compatibility**: Works seamlessly across multiple platforms, including mobile, web, and TV.
- **Cohesion Across Projects**: Ensures consistency in UI/UX and functionality across different projects.
- **Customizable Styling**: Fully customizable to match any design system or branding.
This package was born out of the need to avoid repetitive coding of similar components—like form inputs or password fields with toggle functionality—by providing tested, reusable building blocks.
---
## 📦 Installation
Install the package via npm or yarn:
### Using npm:
```bash
npm install @devlander/ui
```
### Using yarn:
```bash
yarn add @devlander/ui
```
---
## đź“š Components
### **Atoms**
- **Inputs**: `Button`, `Checkbox`, `Input`
- **Feedback**: `Spinner`, `Alert`
- **Display**: `Icon`, `Badge`
- **Controls**: `Slider`, `Switch`
### **Molecules**
- `Dropdown`, `AvatarGroup`, `MenuItem`, `Tooltip`, `Divider`
### **Organisms**
- `Carousel` (with subcomponents: `Slide`, `Dot`, `PaginationStatus`)
- `Card`, `Accordion`, `Navbar`, `Form`, `Table`
### **Templates**
- `Breadcrumbs`, `Stepper`
All components are highly customizable to suit your specific needs.
---
## 👨‍💻 Contributing
Contributions are welcome! If you’d like to improve this package, feel free to fork the repository and submit a pull request. Please ensure all tests pass before submitting.
---
## đź“ž Support
For issues or feature requests, please open an [issue](https://github.com/Devlander-Software/ui/issues) or contact us directly.
---
Start building today by installing **`@devlander/ui`**:
```bash
npm install @devlander/ui
```