greenole-design-system 1.1.10 → 1.1.12

package/README.md

@@ -1,124 +1,124 @@
-# Greenole Design System
-
-[![Figma Design](https://img.shields.io/badge/Figma-Design_System-blue)](https://www.figma.com/design/Zwkbh8XGfVt2At4ln7p1WE/DS-Greenole?node-id=1017-15&p=f&t=Mjdfp67Q8ADWcm9v-0)
-
-The **Greenole Design System** is a React component library designed to create consistent and scalable user interfaces.  
-The library is constantly evolving, with new components and improvements being added over time.
-
-## Table of Contents
-
-- [Introduction](#introduction)
-- [Installation](#installation)
-- [Usage](#usage)
-- [Development](#development)
-- [Build & Publication](#build--publication)
-- [Contributing](#contributing)
-- [License](#license)
-
-## Introduction
-
-**Greenole Design System** gathers reusable components that follow a consistent visual identity.  
-It helps teams maintain design and usability standards across their React projects.
-
-> **Note:**  
-> This library is in constant evolution. Existing components may be updated and new ones added over time.
-
-## Installation
-
-To install the library in your React project, run:
-
-```bash
-npm install greenole-design-system
-```
-
-> **Note:**  
-> The library declares `react` and `react-dom` as peer dependencies, so ensure your project already has these installed.
-
-## Usage
-
-After installation, you need to import both the CSS styles and the components:
-
-### 1. Import the CSS styles
-
-First, import the CSS file in your main application file (usually `main.jsx`, `App.jsx`, or `index.js`):
-
-```jsx
-import 'greenole-design-system/dist/greenole.css';
-```
-
-### 2. Import and use components
-
-Then you can import and use the library's components:
-
-```jsx
-import React from 'react';
-import { Typography } from 'greenole-design-system';
-
-function App() {
-  return (
-    <div>
-      <Typography variant="h1">
-        The quick brown fox jumps over the lazy dog.
-      </Typography>
-      {/* Additional components will be added in the future */}
-    </div>
-  );
-}
-
-export default App;
-```
-
-## Development
-
-To contribute to or test the library locally:
-
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/your-username/greenole-design-system.git
-   cd greenole-design-system
-   ```
-2. Install dependencies:
-   ```bash
-   npm install
-   ```
-3. Start the development environment using Vite:
-   ```bash
-   npm run dev
-   ```
-4. To view the documentation and components, we use **Storybook**:
-   ```bash
-   npm run storybook
-   ```
-   Storybook serves as the documentation and demo environment for the library's components.
-
-## Build & Publication
-
-To generate the library bundle:
-
-1. Run the build command:
-   ```bash
-   npm run build
-   ```
-   This will create the `dist` folder with both CommonJS and ESModule files, as well as type declarations (if configured).
-
-2. To test locally in another project, use `npm link`:
-   ```bash
-   cd greenole-design-system
-   npm link
-   cd ../your-consumer-project
-   npm link greenole-design-system
-   ```
-3. When ready to publish:
-   ```bash
-   npm login
-   npm publish --access public
-   ```
-
-## Contributing
-
-Contributions are welcome! If you would like to help evolve the **Greenole Design System**, follow these steps:
-
-1. Fork the repository.
-2. Create a branch for your feature (`git checkout -b my-feature`).
-3. Commit your changes.
+# Greenole Design System
+
+[![Figma Design](https://img.shields.io/badge/Figma-Design_System-blue)](https://www.figma.com/design/Zwkbh8XGfVt2At4ln7p1WE/DS-Greenole?node-id=1017-15&p=f&t=Mjdfp67Q8ADWcm9v-0)
+
+The **Greenole Design System** is a React component library designed to create consistent and scalable user interfaces.  
+The library is constantly evolving, with new components and improvements being added over time.
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Development](#development)
+- [Build & Publication](#build--publication)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Introduction
+
+**Greenole Design System** gathers reusable components that follow a consistent visual identity.  
+It helps teams maintain design and usability standards across their React projects.
+
+> **Note:**  
+> This library is in constant evolution. Existing components may be updated and new ones added over time.
+
+## Installation
+
+To install the library in your React project, run:
+
+```bash
+npm install greenole-design-system
+```
+
+> **Note:**  
+> The library declares `react` and `react-dom` as peer dependencies, so ensure your project already has these installed.
+
+## Usage
+
+After installation, you need to import both the CSS styles and the components:
+
+### 1. Import the CSS styles
+
+First, import the CSS file in your main application file (usually `main.jsx`, `App.jsx`, or `index.js`):
+
+```jsx
+import 'greenole-design-system/dist/greenole.css';
+```
+
+### 2. Import and use components
+
+Then you can import and use the library's components:
+
+```jsx
+import React from 'react';
+import { Typography } from 'greenole-design-system';
+
+function App() {
+  return (
+    <div>
+      <Typography variant="h1">
+        The quick brown fox jumps over the lazy dog.
+      </Typography>
+      {/* Additional components will be added in the future */}
+    </div>
+  );
+}
+
+export default App;
+```
+
+## Development
+
+To contribute to or test the library locally:
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/your-username/greenole-design-system.git
+   cd greenole-design-system
+   ```
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Start the development environment using Vite:
+   ```bash
+   npm run dev
+   ```
+4. To view the documentation and components, we use **Storybook**:
+   ```bash
+   npm run storybook
+   ```
+   Storybook serves as the documentation and demo environment for the library's components.
+
+## Build & Publication
+
+To generate the library bundle:
+
+1. Run the build command:
+   ```bash
+   npm run build
+   ```
+   This will create the `dist` folder with both CommonJS and ESModule files, as well as type declarations (if configured).
+
+2. To test locally in another project, use `npm link`:
+   ```bash
+   cd greenole-design-system
+   npm link
+   cd ../your-consumer-project
+   npm link greenole-design-system
+   ```
+3. When ready to publish:
+   ```bash
+   npm login
+   npm publish --access public
+   ```
+
+## Contributing
+
+Contributions are welcome! If you would like to help evolve the **Greenole Design System**, follow these steps:
+
+1. Fork the repository.
+2. Create a branch for your feature (`git checkout -b my-feature`).
+3. Commit your changes.
 4. Open a pull request for review.

package/dist/base-components/Avatar/Avatar.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { AvatarProps } from './Avatar.types';
+export declare const Avatar: React.FC<AvatarProps>;
+export default Avatar;

package/dist/base-components/Avatar/Avatar.stories.d.ts

@@ -0,0 +1,11 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { default as Avatar } from './Avatar';
+declare const avatarMeta: Meta<typeof Avatar>;
+export default avatarMeta;
+type Story = StoryObj<typeof Avatar>;
+export declare const WithTextFallback: Story;
+export declare const WithIconOnly: Story;
+export declare const TransparentBackground: Story;
+export declare const WithStarIcon: Story;
+export declare const ImageExample: Story;
+export declare const ClickableAvatar: Story;

package/dist/base-components/Avatar/Avatar.types.d.ts

@@ -0,0 +1,13 @@
+export type AvatarSize = "xs" | "sm" | "md" | "lg" | "xl";
+export declare const avatarSizes: Record<AvatarSize, string>;
+export interface AvatarProps {
+    src?: string;
+    alt?: string;
+    size?: AvatarSize;
+    shape?: "circle" | "rounded";
+    icon?: React.ReactNode;
+    fallbackText?: string;
+    className?: string;
+    bgColor?: "bg-[var(--neutral-soft)]" | "bg-[var(--neutral-medium)]" | "bg-[var(--brandcolor-softest)]" | "bg-[var(--green-500)]" | "bg-[var(--red-500)]" | "bg-[var(--blue-400)]" | "bg-transparent";
+    onClick?: () => void;
+}

package/dist/base-components/Pills/Pills.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { PillsProps } from './Pills.types';
+export declare const Pills: React.FC<PillsProps>;
+export default Pills;

package/dist/base-components/Pills/Pills.stories.d.ts

@@ -0,0 +1,15 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { default as Pills } from './Pills';
+declare const meta: Meta<typeof Pills>;
+export default meta;
+type Story = StoryObj<typeof Pills>;
+export declare const Playground: Story;
+export declare const Primary: Story;
+export declare const Success: Story;
+export declare const Danger: Story;
+export declare const Warning: Story;
+export declare const Infor: Story;
+export declare const Neutral: Story;
+export declare const WithIcons: Story;
+export declare const CustomTypography: Story;
+export declare const CustomPadding: Story;

package/dist/base-components/Pills/Pills.types.d.ts

@@ -0,0 +1,11 @@
+import { TypographyVariant } from '../../components/Typography/Typography';
+export type PillsVariant = 'neutral' | 'success' | 'danger' | 'warning' | 'info' | 'primary';
+export interface PillsProps {
+    label: string;
+    variant?: PillsVariant;
+    typography?: TypographyVariant;
+    padding?: string;
+    iconLeft?: React.ReactNode;
+    iconRight?: React.ReactNode;
+    className?: string;
+}

package/dist/base-components/ProgressBar/ProgressBar.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { ProgressBarProps } from './ProgressBar.types';
+export declare const ProgressBar: React.FC<ProgressBarProps>;
+export default ProgressBar;

package/dist/base-components/ProgressBar/ProgressBar.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { default as ProgressBar } from './ProgressBar';
+declare const meta: Meta<typeof ProgressBar>;
+export default meta;
+type Story = StoryObj<typeof ProgressBar>;
+export declare const Playground: Story;
+export declare const PercentProgress: Story;
+export declare const CustomColorHex: Story;
+export declare const WithoutText: Story;

package/dist/base-components/ProgressBar/ProgressBar.types.d.ts

@@ -0,0 +1,19 @@
+export type ProgressBarType = "percent" | "file";
+export type ProgressBarHeight = "sm" | "md" | "lg";
+export interface ProgressBarProps {
+    type?: ProgressBarType;
+    value: number;
+    max?: number;
+    height?: ProgressBarHeight;
+    color?: keyof typeof colorMap | string;
+    showText?: boolean;
+    className?: string;
+}
+export declare const progressHeights: Record<ProgressBarHeight, string>;
+export declare const colorMap: {
+    brand: string;
+    green: string;
+    red: string;
+    blue: string;
+    neutral: string;
+};

package/dist/base-components/Space/Space.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { SpaceProps } from './Space.types';
+export declare const Space: React.FC<SpaceProps>;
+export default Space;

package/dist/base-components/Space/Space.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { default as Space } from './Space';
+declare const meta: Meta<typeof Space>;
+export default meta;
+type Story = StoryObj<typeof Space>;
+export declare const Playground: Story;
+export declare const AllSpacings: Story;
+export declare const CustomColorHex: Story;
+export declare const CustomWidth: Story;

package/dist/base-components/Space/Space.types.d.ts

@@ -0,0 +1,9 @@
+export type SpaceHeight = "spacing-1" | "spacing-2" | "spacing-4" | "spacing-8" | "spacing-12" | "spacing-16" | "spacing-24" | "spacing-32" | "spacing-40" | "spacing-48" | "spacing-56" | "spacing-64" | "spacing-72" | "spacing-80" | "spacing-104";
+export declare const spaceHeights: Record<SpaceHeight, string>;
+export interface SpaceProps {
+    height?: SpaceHeight;
+    color?: string;
+    width?: string;
+    className?: string;
+    showLabel?: boolean;
+}

package/dist/base-components/TextField/TextField.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { TextFieldProps } from './TextField.types';
+export declare const TextField: React.FC<TextFieldProps>;
+export default TextField;

package/dist/base-components/TextField/TextField.stories.d.ts

@@ -0,0 +1,8 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { default as TextField } from './TextField';
+declare const meta: Meta<typeof TextField>;
+export default meta;
+type Story = StoryObj<typeof TextField>;
+export declare const Playground: Story;
+export declare const ValidationExamples: Story;
+export declare const States: Story;

package/dist/base-components/TextField/TextField.types.d.ts

@@ -0,0 +1,27 @@
+import { TypographyVariant } from '../../components/Typography/Typography';
+export type TextFieldTheme = "light" | "dark";
+export type ValidationType = "text" | "email" | "number" | "password" | "tel" | "url";
+export type InputType = React.HTMLInputTypeAttribute;
+export interface TextFieldProps extends React.InputHTMLAttributes<HTMLInputElement> {
+    label?: string;
+    labelSize?: TypographyVariant;
+    subtitle?: string;
+    subtitleIcon?: React.ReactNode;
+    error?: string;
+    valid?: boolean;
+    iconLeft?: React.ReactNode;
+    iconRight?: React.ReactNode;
+    fullWidth?: boolean;
+    theme?: TextFieldTheme;
+    disabled?: boolean;
+    validationType?: ValidationType;
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    min?: number;
+    max?: number;
+    pattern?: string;
+    validateOnBlur?: boolean;
+    onValidation?: (isValid: boolean) => void;
+    type?: InputType;
+}

package/dist/base-components/Tooltip/Tooltip.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+import { TooltipProps } from './Tooltip.types';
+declare const Tooltip: React.FC<TooltipProps>;
+export default Tooltip;

package/dist/base-components/Tooltip/Tooltip.stories.d.ts

@@ -0,0 +1,6 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { default as Tooltip } from './Tooltip';
+declare const meta: Meta<typeof Tooltip>;
+export default meta;
+type Story = StoryObj<typeof Tooltip>;
+export declare const Default: Story;

package/dist/base-components/Tooltip/Tooltip.types.d.ts

@@ -0,0 +1,13 @@
+import { TypographyVariant } from '../../components/Typography/Typography';
+export type TooltipPosition = "top" | "bottom" | "left" | "right";
+export type TooltipTheme = "light" | "dark";
+export interface TooltipProps {
+    children: React.ReactNode;
+    text: string;
+    position?: TooltipPosition;
+    variant?: TypographyVariant;
+    bgColor?: string;
+    textColor?: string;
+    darkMode?: boolean;
+    className?: string;
+}

package/dist/components/Icons/Avatar.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+interface AvatarIconProps {
+    className?: string;
+}
+export default function AvatarIcon({ className }: AvatarIconProps): React.JSX.Element;
+export {};