Skip to content

redvars/peacock

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1,121 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Peacock

The foundation for beautiful user interfaces.

Build GitHub license Version

Peacock LOGO

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:wght@100..900&family=Noto+Sans:ital,wght@0,100..900;1,100..900&display=swap" rel="stylesheet">

  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@redvars/peacock@3.5.1/dist/assets/styles.css"></link>
  <script type='module'
          src='https://cdn.jsdelivr.net/npm/@redvars/peacock@3.5.1/dist/peacock-loader.js'></script>
</head>

<wc-button>Button</wc-button>

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
Checkbox wc-checkbox 🟒
Code editor wc-code-editor 🟒
Color picker color-picker πŸ”΄
Date picker wc-date-picker 🟑
Date time picker datetime-picker πŸ”΄
Field / Form control wc-field 🟑
File picker file-picker πŸ”΄
HTML editor html-editor πŸ”΄
Input wc-input 🟒
Input URL input-url πŸ”΄
Month picker month-picker πŸ”΄
Number field wc-number-field 🟒
Radio wc-radio 🟒
Search wc-search 🟑
Select wc-select 🟒
Textarea wc-textarea 🟒
Time picker wc-time-picker 🟑
Week picker 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 wc-breadcrumb 🟒
Dropdown wc-dropdown πŸ”΄
Menu wc-menu 🟑
Tabs wc-tabs 🟒
Toolbar wc-toolbar 🟑

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 wc-badge 🟒
Banner wc-banner 🟑
Circular Progress wc-circular-progress 🟒
Linear Progress wc-linear-progress 🟒
Notification wc-notification 🟒
Skeleton wc-skeleton 🟒
Snackbar wc-snackbar 🟑
Spinner wc-spinner 🟒
Tooltip wc-tooltip 🟒

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 wc-accordion 🟒
Bottom Sheet wc-bottom-sheet 🟑
Card wc-card 🟒
Container wc-container 🟑
Side Sheet wc-side-sheet 🟑

General

These components are used for general purpose. They include

Name Component State
Avatar wc-avatar 🟒
Button wc-button 🟒
Button Group wc-button-group 🟒
Calendar calendar πŸ”΄
Card Select card-select πŸ”΄
Chip wc-chip 🟒
Clock wc-clock 🟑
Code Highlighter wc-code-highlighter 🟒
Divider wc-divider 🟒
Empty State wc-empty-state 🟑
FAB wc-fab 🟒
Flow Designer flow-designer πŸ”΅
Header header πŸ”΄
Icon wc-icon 🟒
Icon Button wc-icon-button 🟒
Image wc-image 🟑
Link wc-link 🟒
Modal modal πŸ”΄
Number Counter wc-number-counter 🟑
Pagination wc-pagination 🟑
Segmented Button wc-segmented-button 🟑
Slider wc-slider 🟑
Switch wc-switch 🟒
Table wc-table 🟑
Tag wc-tag 🟒
Text text πŸ”΄
Sidebar Menu wc-sidebar-menu 🟑

Charts

These components are used to display data in a graphical format. They include

Name Component State
Bar Chart wc-chart-bar 🟒
Doughnut Chart wc-chart-doughnut 🟒
Pie Chart wc-chart-pie 🟒
Stacked Bar Chart wc-chart-stacked-bar 🟒

πŸ“„ License

Peacock is open-source software licensed under the Apache-2.0 License.


Made with πŸ’– by shivajivarma.

About

The foundation for beautiful user interfaces.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

 

Contributors