npm - @redvars/peacock - Versions diffs - 3.1.0 → 3.1.2 - Mend

@redvars/peacock 3.1.0 → 3.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (187) hide show

package/readme.md ADDED Viewed

@@ -0,0 +1,178 @@
+# Peacock
+**The foundation for beautiful user interfaces.**
+[![Build](https://github.com/redvars/peacock/workflows/Build/badge.svg)](https://github.com/goatui/components/actions?workflow=Build)
+[![GitHub license](https://img.shields.io/github/license/redvars/peacock.svg)](/LICENSE)
+![Version](https://img.shields.io/npm/v/%40redvars%2Fpeacock)
+<div align="center">
+<img alt="Peacock LOGO" src="./logo.png" width="210">
+</div>
+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](https://goatui.com) to view the documentation.
+## Getting Started
+```html
+<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">
+  <script type='module'
+          src='https://cdn.jsdelivr.net/npm/@redvars/peacock@3.1.1/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](https://peacock.redvars.com/components/code-editor)   | p-card-editor     | 🟢    |
+| Color picker                                               | p-color-picker    | 🔴    |
+| [Checkbox](https://peacock.redvars.com/components/checkbox)         | p-checkbox        | 🟢    |
+| [Date picker](https://peacock.redvars.com/components/date-picker)   | p-date-picker     | 🟡    |
+| Date Time picker                                           | p-datetime-picker | 🔴    |
+| [Form control](https://peacock.redvars.com/components/form-control) | p-form-control    | 🟡    |
+| File picker                                                | p-file-picker     | 🔴    |
+| [HTML editor](https://peacock.redvars.com/components/html-editor)   | p-html-editor     | 🟢    |
+| [Input](https://peacock.redvars.com/components/input)               | p-input           | 🟢    |
+| [Input URL](https://peacock.redvars.com/components/input-url)       | p-input-url       | 🟢    |
+| Month picker                                               | p-month-picker    | 🔴    |
+| [Number](https://peacock.redvars.com/components/number)             | p-number          | 🟢    |
+| [Select](https://peacock.redvars.com/components/select)             | p-select          | 🟢    |
+| [Textarea](https://peacock.redvars.com/components/textarea)         | p-textarea        | 🟢    |
+| [Time picker](https://peacock.redvars.com/components/time-picker)   | p-time-picker     | 🟡    |
+| [URL input](https://peacock.redvars.com/components/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](https://peacock.redvars.com/components/breadcrumb) | p-breadcrumb | 🟢    |
+| [Dropdown](https://peacock.redvars.com/components/dropdown)     | p-dropdown   | 🟡    |
+| [Menu](https://peacock.redvars.com/components/menu)             | p-menu       | 🟡    |
+| [Tabs](https://peacock.redvars.com/components/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](https://peacock.redvars.com/components/badge)                                     | p-badge                | 🟢    |
+| [Progress](https://peacock.redvars.com/components/progress)                               | p-progress             | 🟢    |
+| [Spinner](https://peacock.redvars.com/components/spinner)                                 | p-spinner              | 🟢    |
+| [Tooltip](https://peacock.redvars.com/components/tooltip)                                 | p-tooltip              | 🟢    |
+| [Notification](https://peacock.redvars.com/components/notification)                       | p-notification         | 🟢    |
+| [Notification Manager](https://peacock.redvars.com/components/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](https://peacock.redvars.com/components/accordion) | p-accordion | 🟢    |
+| Card                                                 | p-card      | 🟡    |
+## General
+These components are used for general purpose. They include
+| Name                                                                       | Component                 | State |
+|----------------------------------------------------------------------------|---------------------------|-------|
+| [Avatar](https://peacock.redvars.com/components/avatar)                             | p-avatar               | 🟢    |
+| [Button](https://peacock.redvars.com/components/button)                             | p-button               | 🟢    |
+| [Button Group](https://peacock.redvars.com/components/button-group)                 | p-button-group         | 🟢    |
+| [Calendar](https://peacock.redvars.com/components/calendar)                         | p-calendar             | 🟢    |
+| Card Select                                                                | p-cardselect           | 🔴    |
+| [Code Highlighter](https://peacock.redvars.com/components/code-highlighter)         | p-card-highlighter     | 🟢    |
+| Column                                                                     | p-col                  | 🔴    |
+| [Empty State](https://peacock.redvars.com/components/empty-state)                   | p-empty-state          | 🟡    |
+| [Flow Designer ](https://peacock.redvars.com/components/flow-designer)              | p-flow-designer        | 🔵    |
+| Grid                                                                       | p-grid                 | 🔴    |
+| Group                                                                      | p-group                | 🔴    |
+| [Header](https://peacock.redvars.com/components/header)                             | p-header               | 🟢    |
+| [Icon](https://peacock.redvars.com/components/icon)                                 | p-icon                 | 🟢    |
+| [Link](https://peacock.redvars.com/components/link)                                 | p-link                 | 🟢    |
+| [Modal](https://peacock.redvars.com/components/modal)                               | p-modal                | 🟢    |
+| [Notification Manager](https://peacock.redvars.com/components/notification-manager) | p-notification-manager | 🟡    |
+| Observer                                                                   | p-observer             | 🔴    |
+| Pagination                                                                 | p-pagination           | 🔴    |
+| Radio Group                                                                | p-radiogroup           | 🔴    |
+| Row                                                                        | p-row                  | 🔴    |
+| [Slider](https://peacock.redvars.com/components/slider)                             | p-slider               | 🟡    |
+| Spoiler                                                                    | p-spoiler              | 🔴    |
+| Stepper                                                                    | p-stepper              | 🔴    |
+| [Table](https://peacock.redvars.com/components/table)                               | p-table                | 🟡    |
+| [Tag](https://peacock.redvars.com/components/tag) / Chip                            | p-tag                  | 🟢    |
+| [Text](https://peacock.redvars.com/components/text)                                 | p-text                 | 🟢    |
+| [Tree View](https://peacock.redvars.com/components/tree-view)                       | p-tree-view            | 🟡    |
+| [Toggle](https://peacock.redvars.com/components/toggle)                             | p-toggle               | 🟢    |
+## Charts
+These components are used to display data in a graphical format. They include
+| Name                                                           | Component           | State |
+|----------------------------------------------------------------|---------------------|-------|
+| [Doughnut Chart](https://peacock.redvars.com/components/chart-doughnut) | p-chart-doughnut | 🟢    |
+| [Pie Chart ](https://peacock.redvars.com/components/chart-pie)          | p-chart-pie      | 🟢    |
+## 📄 License
+Peacock is open-source software licensed under the [Apache-2.0 License](LICENSE).
+---
+Made with 💖 by [shivajivarma](https://shivajivarma.com).

package/rollup.config.js CHANGED Viewed

@@ -1,39 +1,77 @@
 import typescript from '@rollup/plugin-typescript';
 import { nodeResolve } from '@rollup/plugin-node-resolve';
+import css from 'rollup-plugin-import-css';
 import copy from 'rollup-plugin-copy';
+import { readFile } from 'node:fs/promises';
+import { glob } from 'glob';
-export default [
-  {
-    input: ['src/index.ts', 'src/peacock-loader.ts'], // Your main TypeScript entry file
-    output: {
-      dir: 'dist',
-      format: 'esm', // Output as ES Modules (esm), also supports cjs, umd, etc.
-      sourcemap: true,
+export default async function () {
+  const files = await findLitComponents();
+  return [
+    {
+      input: ['src/index.ts', 'src/peacock-loader.ts', ...files], // Your main TypeScript entry file
+      output: {
+        dir: 'dist',
+        format: 'esm', // Output as ES Modules (esm), also supports cjs, umd, etc.
+        sourcemap: true,
+      },
+      plugins: [
+        typescript(), // The plugin loads options from tsconfig.json by default
+        css(),
+        nodeResolve(),
+        copy({
+          targets: [
+            {
+              src: '../readme.md',
+              dest: './',
+            },
+            {
+              src: './node_modules/@redvars/peacock-design-tokens/dist/tokens.css',
+              dest: './dist/assets/styles/',
+            },
+          ],
+        }),
+      ],
     },
-    plugins: [
-      typescript(), // The plugin loads options from tsconfig.json by default
-      nodeResolve(),
-      copy({
-        targets: [
-          {
-            src: '../design-tokens/dist/**',
-            dest: 'dist/assets/styles/',
-          },
-        ],
-      }),
-    ],
-  },
-  {
-    input: ['src/icon/icon.ts', 'src/avatar/avatar.ts'], // Your main TypeScript entry file
-    output: {
-      dir: `dist`,
-      format: 'esm', // Output as ES Modules (esm), also supports cjs, umd, etc.
-      sourcemap: true,
-      entryFileNames: 'component/[name].js',
-    },
-    plugins: [
-      typescript(), // The plugin loads options from tsconfig.json by default
-      nodeResolve(),
-    ],
-  },
-];
+  ];
+}
+async function findLitComponents(searchDir = 'src') {
+  console.log(`🚀 Scanning for Lit components in "${searchDir}"...\n`);
+  /**
+   * We look for:
+   * 1. Lit imports
+   * 2. Class extensions
+   * 3. Custom element decorators
+   */
+  const LIT_SIGNATURES = [/extends\s+LitElement/];
+  try {
+    // glob() returns a Promise that resolves to an array of file paths
+    // We ignore node_modules and typical build folders
+    const files = await glob(`${searchDir}/**/*.{js,ts,mjs}`, {
+      ignore: ['**/node_modules/**', '**/dist/**', '**/build/**'],
+    });
+    const results = [];
+    for (const file of files) {
+      const content = await readFile(file, 'utf8');
+      // Check if any Lit-specific pattern exists in the file
+      const isLit = LIT_SIGNATURES.some(pattern => pattern.test(content));
+      if (isLit) {
+        results.push(file);
+        console.log(`✅ Found: ${file}`);
+      }
+    }
+    console.log(
+      `\n✨ Search complete. Total Lit components: ${results.length}`,
+    );
+    return results;
+  } catch (error) {
+    console.error('❌ Error during scan:', error);
+  }
+}

package/scratch.mjs ADDED Viewed

File without changes

package/src/avatar/avatar.css.ts CHANGED Viewed

@@ -1,5 +1,5 @@
-import { css, unsafeCSS } from 'lit';
-import { getTypography } from '../utils.js';
+import { css } from 'lit';
+import { getTypography } from '../styleMixins.css.js';
 export const styles = css`
   :host {
@@ -26,7 +26,7 @@ export const styles = css`
     color: var(--avatar-text-color);
     width: var(--avatar-size);
     height: var(--avatar-size);
-    ${unsafeCSS(getTypography('body-large-emphasized'))}
+    ${getTypography('body-large-emphasized')}
     background-color: var(--avatar-background-color);
     font-size: calc(var(--avatar-size) * 0.4);

package/src/avatar/avatar.ts CHANGED Viewed

@@ -4,10 +4,23 @@ import { classMap } from 'lit/directives/class-map.js';
 import { styles } from './avatar.css.js';
 /**
- * @summary Icons are visual symbols used to represent ideas, objects, or actions.
+ * @label Avatar
+ * @tag p-avatar
+ * @rawTag avatar
+ * @summary The Avatar component is used to represent user, and displays the profile picture, initials or fallback icon.
  *
- * @cssprop --icon-color - Controls the color of the icon.
- * @cssprop --icon-size - Controls the size of the icon.
+ * @cssprop --avatar-border-radius - Controls the border radius of the avatar.
+ * @cssprop --avatar-background-color - Controls the color of the avatar.
+ * @cssprop --avatar-size - Controls the size of the avatar.
+ * @cssprop --avatar-text-color - Controls the color of the text inside the avatar.
+ *
+ *
+ * @example
+ * ```html
+ * <p-avatar name="Shivaji Varma" src="https://peacock.redvars.com/assets/img/avatar.webp"></p-avatar>
+ * ```
+ *
+ * @tags display
  */
 export class Avatar extends LitElement {
   static styles = [styles];

package/src/avatar/demo/index.html CHANGED Viewed

@@ -3,7 +3,7 @@
 <head>
   <meta charset='utf-8'>
   <meta name='viewport' content='width=device-width, initial-scale=1.0, viewport-fit=cover' />
-  <link rel='stylesheet' href='/demo/tokens.css' />
+  <link rel='stylesheet' href='/dist/assets/styles/tokens.css' />
   <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">
   <style>
@@ -18,7 +18,7 @@
 <p-avatar name='Shivaji Varma'></p-avatar>
 <script type='module'>
-  import { Avatar } from '/dist/src/index.js';
+  import { Avatar } from '/dist/index.js';
   window.customElements.define('p-avatar', Avatar);
 </script>

package/src/avatar/p-avatar.ts ADDED Viewed

@@ -0,0 +1,5 @@
+import { customElement } from 'lit/decorators.js';
+import { Avatar } from './avatar.js';
+@customElement('p-avatar')
+export class PAvatar extends Avatar {}

package/src/badge/badge.css.ts ADDED Viewed

@@ -0,0 +1,34 @@
+import { css } from 'lit';
+import { getTypography } from '../styleMixins.css.js';
+export const styles = css`
+  :host {
+    display: inline-block;
+    --badge-color: var(--global-badge-color);
+  }
+  .badge {
+    pointer-events: none;
+    z-index: var(--z-index-badge);
+    color: var(--color-white);
+    display: flex;
+    justify-content: center;
+    align-items: center;
+    background-color: var(--badge-color);
+    border-radius: var(--shape-corner-full);
+    box-sizing: border-box;
+    &.slot-has-content {
+      height: 1rem;
+      min-width: 1rem;
+      padding-inline: var(--spacing-050);
+      ${getTypography('label-small')};
+      color: var(--color-on-error);
+    }
+    &:not(.slot-has-content) {
+      height: 0.375rem;
+      width: 0.375rem;
+    }
+  }
+`;

package/src/badge/badge.ts ADDED Viewed

@@ -0,0 +1,51 @@
+import { html, LitElement } from 'lit';
+import { property, state } from 'lit/decorators.js';
+import { classMap } from 'lit/directives/class-map.js';
+import { styles } from './badge.css.js';
+import { observerSlotChangesWithCallback } from '../utils.js';
+/**
+ * @label Badge
+ * @tag p-badge
+ * @rawTag badge
+ * @summary The badge component is used to display a small amount of information to the user.
+ *
+ * @cssprop --badge-color - Controls the color of the badge.
+ *
+ * @example
+ * ```html
+ * <p-badge>1</p-badge>
+ * ```
+ * @tags display
+ */
+export class Badge extends LitElement {
+  static styles = [styles];
+  @property({ type: String, reflect: true }) name: string = '';
+  @property({ type: String, reflect: true }) src?: string;
+  @state()
+  slotHasContent = false;
+  firstUpdated() {
+    observerSlotChangesWithCallback(
+      this.renderRoot.querySelector('slot'),
+      hasContent => {
+        this.slotHasContent = hasContent;
+        this.requestUpdate();
+      },
+    );
+  }
+  render() {
+    return html`<div
+      class=${classMap({
+        badge: true,
+        'slot-has-content': this.slotHasContent,
+      })}
+    >
+      <slot></slot>
+    </div>`;
+  }
+}

package/src/badge/demo/index.html ADDED Viewed

@@ -0,0 +1,62 @@
+<!doctype html>
+<html lang='en-GB'>
+<head>
+  <meta charset='utf-8'>
+  <meta name='viewport' content='width=device-width, initial-scale=1.0, viewport-fit=cover' />
+  <link rel='stylesheet' href='/dist/assets/styles/tokens.css' />
+  <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">
+  <style>
+    body {
+      background: #fafafa;
+    }
+  </style>
+</head>
+<body>
+<style>
+  .badge-wrapper {
+    position: relative;
+    display: inline-flex;
+    width: 1.5rem;
+    height: 1.5rem;
+    align-items: center;
+    justify-content: center;
+  }
+  .badge-anchor-simple {
+    position: absolute;
+    top: 0;
+    right: 0;
+  }
+  .badge-anchor {
+    position: absolute;
+    top: -2px;
+    left: calc(100% - 12px);
+  }
+</style>
+<div class="badge-wrapper">
+  <p-icon name="notifications"></p-icon>
+  <p-badge class="badge-anchor-simple"></p-badge>
+</div>
+<div class="badge-wrapper">
+  <p-icon name="notifications"></p-icon>
+  <p-badge class="badge-anchor">1</p-badge>
+</div>
+<div class="badge-wrapper">
+  <p-icon name="notifications"></p-icon>
+  <p-badge class="badge-anchor">999+</p-badge>
+</div>
+<script type='module'>
+  import { Icon, Badge } from '/dist/index.js';
+  window.customElements.define('p-icon', Icon);
+  window.customElements.define('p-badge', Badge);
+</script>
+</body>
+</html>

package/src/badge/index.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export { Badge } from './badge.js';

package/src/badge/p-badge.ts ADDED Viewed

@@ -0,0 +1,5 @@
+import { customElement } from 'lit/decorators.js';
+import { Badge } from './badge.js';
+@customElement('p-badge')
+export class PBadge extends Badge {}

package/src/clock/clock.css.ts ADDED Viewed

@@ -0,0 +1,12 @@
+import { css } from 'lit';
+import { getTypography } from '../styleMixins.css.js';
+export const styles = css`
+  :host {
+    display: inline-block;
+  }
+  .current-time {
+    ${getTypography('body-medium')}
+  }
+`;

package/src/clock/clock.ts ADDED Viewed

@@ -0,0 +1,57 @@
+import { html, LitElement } from 'lit';
+import { property, state } from 'lit/decorators.js';
+import { styles } from './clock.css.js';
+/**
+ * @label Clock
+ * @tag p-clock
+ * @rawTag clock
+ *
+ * @summary Displays the current time in a given timezone.
+ * @overview
+ *  - Clocks are used to display the current time in a specified timezone.
+ *  - They can be displayed in various formats, including 12-hour and 24-hour time.
+ *
+ * @example
+ * ```html
+ * <p-clock></p-clock>
+ * ```
+ * @tags display
+ */
+export class Clock extends LitElement {
+  static styles = [styles];
+  @property() timezone?: string;
+  // `currentTime` is decorated with `@State()`,
+  // as we need to trigger a rerender when its
+  // value changes to show the latest time
+  @state() currentTime: string = '';
+  private _timerId: any;
+  connectedCallback() {
+    super.connectedCallback();
+    this.__updateCurrentTime();
+    this._timerId = setInterval(() => {
+      this.__updateCurrentTime();
+    }, 1000);
+  }
+  disconnectedCallback() {
+    if (this._timerId) {
+      clearInterval(this._timerId);
+    }
+    super.disconnectedCallback();
+  }
+  __updateCurrentTime() {
+    this.currentTime = new Date().toLocaleTimeString('en-US', {
+      timeZone: this.timezone,
+    });
+  }
+  render() {
+    return html`<div class="current-time">${this.currentTime}</div>`;
+  }
+}

package/src/clock/demo/index.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!doctype html>
+<html lang='en-GB'>
+<head>
+  <meta charset='utf-8'>
+  <meta name='viewport' content='width=device-width, initial-scale=1.0, viewport-fit=cover' />
+  <link rel='stylesheet' href='/dist/assets/styles/tokens.css' />
+  <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">
+  <style>
+    body {
+      background: #fafafa;
+    }
+  </style>
+</head>
+<body>
+<p-clock></p-clock>
+<script type='module'>
+  import { Clock } from '/dist/index.js';
+  window.customElements.define('p-clock', Clock);
+</script>
+</body>
+</html>

package/src/clock/index.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export { Clock } from './clock.js';