@redvars/peacock
v3.1.3
Published
The foundation for beautiful user interfaces
Maintainers
shivajivarmaReadme
Peacock
The foundation for beautiful user interfaces.
Peacock gives you the tools and foundation to build beautiful, usable product interfaces. It’s the system you use to craft your own component library.
What is Peacock?
Peacock is more than just a collection of components; it is an aesthetic philosophy. Like its avian namesake, it provides the core elements (the primitives) that allow the full, vibrant display (the design) to be unveiled.
Opinionated Beauty: We deliver pre-styled, beautiful components that follow modern design trends, significantly reducing the boilerplate needed to achieve a professional look.
Foundation First: Similar to projects like shadcn/ui, Peacock focuses on providing the foundational primitives, ensuring maximum flexibility for customization without sacrificing initial polish.
Seamless Integration: Designed with modern web frameworks in mind (e.g., React, Vue), integrating Peacock into your existing project structure is fast, efficient, and empowering.
Key Features
Vibrant & Consistent Design System: Every component—from buttons and cards to complex data tables—shares a cohesive, high-quality visual language.
Highly Extensible: The component structure is designed for easy overwriting and theme customization, allowing you to quickly adapt the style to your specific brand identity.
Built for Accessibility: Focus on semantic HTML and proper ARIA attributes to ensure that your beautiful interfaces are accessible to all users.
Responsive by Default: Components are built with responsiveness baked in, guaranteeing a graceful display across all screen sizes and devices.
Documentation
Visit https://peacock.redvars.com to view the documentation.
Getting Started
<head>
<!-- Default font : Noto Sans and Noto Sans Mono -->
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Noto+Sans+Mono:[email protected]&family=Noto+Sans:ital,wght@0,100..900;1,100..900&display=swap" rel="stylesheet">
<script type='module'
src='https://cdn.jsdelivr.net/npm/@redvars/[email protected]/dist/peacock-loader.js'></script>
</head>
<p-avatar name="Shivaji Varma"></p-avatar>Components
- 🟢 ready (feature complete for now)
- 🟡 beta (changes possible, not feature complete)
- 🔴 not ready (unstyled / no functions)
- 🔵 planned (created, but empty files)
Input Controls
Input controls are UI design elements that allow users to input information into the system. They are essential for collecting data and enabling user interactions. Some common examples of input controls include text fields, dropdown menus, checkboxes, and radio buttons.
| Name | Component | State | |------------------------------------------------------------|----------------------|-------| | Code editor | p-card-editor | 🟢 | | Color picker | p-color-picker | 🔴 | | Checkbox | p-checkbox | 🟢 | | Date picker | p-date-picker | 🟡 | | Date Time picker | p-datetime-picker | 🔴 | | Form control | p-form-control | 🟡 | | File picker | p-file-picker | 🔴 | | HTML editor | p-html-editor | 🟢 | | Input | p-input | 🟢 | | Input URL | p-input-url | 🟢 | | Month picker | p-month-picker | 🔴 | | Number | p-number | 🟢 | | Select | p-select | 🟢 | | Textarea | p-textarea | 🟢 | | Time picker | p-time-picker | 🟡 | | URL input | p-url-input. | 🔴 | | Week picker | p-week-picker | 🔴 |
Navigation
Navigational components are UI elements that help users move around the app or website. They provide users with a clear and intuitive way to navigate through different sections and pages. Some common examples of navigational components include menus, tabs, and breadcrumbs.
| Name | Component | State | |--------------------------------------------------------|-----------------|-------| | Breadcrumb | p-breadcrumb | 🟢 | | Dropdown | p-dropdown | 🟡 | | Menu | p-menu | 🟡 | | Tabs | p-tabs | 🟢 |
Informational
Informational components are UI elements that provide information to users. They communicate important messages, updates, or instructions within the app or website. Some common examples of informational components include notifications, tooltips, and progress bars.
| Name | Component | State | |----------------------------------------------------------------------------------|---------------------------|-------| | Badge | p-badge | 🟢 | | Progress | p-progress | 🟢 | | Spinner | p-spinner | 🟢 | | Tooltip | p-tooltip | 🟢 | | Notification | p-notification | 🟢 | | Notification Manager | p-notification-manager | 🟢 |
Containers
Containers are UI elements that group similar content together, making it easier for users to navigate and scan through the interface. Examples of common containers include cards, carousels, and accordions, which provide structure and organization to the content.
| Name | Component | State | |------------------------------------------------------|----------------|-------| | Accordion | p-accordion | 🟢 | | Card | p-card | 🟡 |
General
These components are used for general purpose. They include
| Name | Component | State | |----------------------------------------------------------------------------|---------------------------|-------| | Avatar | p-avatar | 🟢 | | Button | p-button | 🟢 | | Button Group | p-button-group | 🟢 | | Calendar | p-calendar | 🟢 | | Card Select | p-cardselect | 🔴 | | Code Highlighter | p-card-highlighter | 🟢 | | Column | p-col | 🔴 | | Empty State | p-empty-state | 🟡 | | Flow Designer | p-flow-designer | 🔵 | | Grid | p-grid | 🔴 | | Group | p-group | 🔴 | | Header | p-header | 🟢 | | Icon | p-icon | 🟢 | | Link | p-link | 🟢 | | Modal | p-modal | 🟢 | | Notification Manager | p-notification-manager | 🟡 | | Observer | p-observer | 🔴 | | Pagination | p-pagination | 🔴 | | Radio Group | p-radiogroup | 🔴 | | Row | p-row | 🔴 | | Slider | p-slider | 🟡 | | Spoiler | p-spoiler | 🔴 | | Stepper | p-stepper | 🔴 | | Table | p-table | 🟡 | | Tag / Chip | p-tag | 🟢 | | Text | p-text | 🟢 | | Tree View | p-tree-view | 🟡 | | Toggle | p-toggle | 🟢 |
Charts
These components are used to display data in a graphical format. They include
| Name | Component | State | |----------------------------------------------------------------|---------------------|-------| | Doughnut Chart | p-chart-doughnut | 🟢 | | Pie Chart | p-chart-pie | 🟢 |
📄 License
Peacock is open-source software licensed under the Apache-2.0 License.
Made with 💖 by shivajivarma.