@campxdev/react-blueprint 3.0.0-alpha.5 → 3.0.0-alpha.6

package/dist/styles.css

@@ -46,6 +46,7 @@
     --color-pink-400: oklch(71.8% 0.202 349.761);
     --color-pink-700: oklch(52.5% 0.223 3.958);
     --color-pink-950: oklch(28.4% 0.109 3.907);
+    --color-gray-50: oklch(98.5% 0.002 247.839);
     --color-gray-200: oklch(92.8% 0.006 264.531);
     --color-gray-300: oklch(87.2% 0.01 258.338);
     --color-gray-500: oklch(55.1% 0.027 264.364);
@@ -334,6 +335,9 @@
   .relative {
     position: relative;
   }
+  .static {
+    position: static;
+  }
   .inset-0 {
     inset: calc(var(--spacing) * 0);
   }
@@ -412,9 +416,6 @@
   .left-\[50\%\] {
     left: 50%;
   }
-  .z-1 {
-    z-index: 1;
-  }
   .z-50 {
     z-index: 50;
   }
@@ -424,12 +425,6 @@
   .z-\[1000\] {
     z-index: 1000;
   }
-  .z-\[1299\] {
-    z-index: 1299;
-  }
-  .z-\[1300\] {
-    z-index: 1300;
-  }
   .z-\[1500\] {
     z-index: 1500;
   }
@@ -804,6 +799,9 @@
   .min-h-\[60px\] {
     min-height: 60px;
   }
+  .min-h-screen {
+    min-height: 100vh;
+  }
   .w-\(--cell-size\) {
     width: var(--cell-size);
   }
@@ -1380,6 +1378,9 @@
   .border-\(--color-border\) {
     border-color: var(--color-border);
   }
+  .border-blue-500 {
+    border-color: var(--color-blue-500);
+  }
   .border-blue-700 {
     border-color: var(--color-blue-700);
   }
@@ -1467,12 +1468,18 @@
   .bg-foreground {
     background-color: var(--foreground);
   }
+  .bg-gray-50 {
+    background-color: var(--color-gray-50);
+  }
   .bg-gray-200 {
     background-color: var(--color-gray-200);
   }
   .bg-green-50 {
     background-color: var(--color-green-50);
   }
+  .bg-green-500 {
+    background-color: var(--color-green-500);
+  }
   .bg-green-background {
     background-color: var(--green-background);
   }
@@ -1542,6 +1549,9 @@
   .bg-transparent {
     background-color: transparent;
   }
+  .bg-white {
+    background-color: var(--color-white);
+  }
   .bg-yellow-50 {
     background-color: var(--color-yellow-50);
   }
@@ -1653,6 +1663,9 @@
   .py-8 {
     padding-block: calc(var(--spacing) * 8);
   }
+  .py-12 {
+    padding-block: calc(var(--spacing) * 12);
+  }
   .py-\[0\.2rem\] {
     padding-block: 0.2rem;
   }
@@ -1896,6 +1909,9 @@
   .text-highlight-yellow {
     color: var(--highlight-yellow);
   }
+  .text-muted {
+    color: var(--muted);
+  }
   .text-muted-foreground {
     color: var(--muted-foreground);
   }
@@ -3673,6 +3689,11 @@
       translate: var(--tw-translate-x) var(--tw-translate-y);
     }
   }
+  .\[\&\>button\]\:hidden {
+    &>button {
+      display: none;
+    }
+  }
   .\[\&\>div\]\:\!aspect-auto {
     &>div {
       aspect-ratio: auto !important;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@campxdev/react-blueprint",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.6",
   "description": "React UI component library for CampX applications",
   "author": "CampX",
   "license": "MIT",

package/src/components/Assets/ErrorPages/ComingSoon.tsx

@@ -8,6 +8,30 @@ interface NoItemFoundProps {
   description: ReactNode;
 }
 
+/**
+ * ComingSoon component displays a "Coming Soon" placeholder page.
+ *
+ * This component renders a centered container with an SVG illustration,
+ * a title, and a description message to inform users that a feature or page
+ * is not yet available.
+ *
+ * @component
+ * @param {Object} props - The component props
+ * @param {string} [props.title='Coming Soon'] - The title text to display. Defaults to "Coming Soon"
+ * @param {ReactNode} props.description - The description or message to display below the title
+ * @returns {React.ReactElement} A centered layout with SVG, title, and description
+ *
+ * @example
+ * // Basic usage
+ * <ComingSoon description="This feature will be available soon!" />
+ *
+ * @example
+ * // With custom title
+ * <ComingSoon
+ *   title="New Dashboard"
+ *   description="We're working hard to bring you an improved dashboard experience."
+ * />
+ */
 export const ComingSoon = ({
   title = 'Coming Soon',
   description,

package/src/components/Assets/ErrorPages/InternalServerError.tsx

@@ -2,6 +2,26 @@ import { Svgs } from '../../../assets/images/svg';
 import { Typography } from '../../DataDisplay/Typography/Typography';
 import { Button } from '../../Input/Button/Button';
 
+/**
+ * InternalServerError component displays a 500 server error page.
+ *
+ * This component renders a centered error page with an SVG illustration,
+ * error message, and a "Try Again" button that triggers the error boundary reset.
+ * Typically used within an error boundary to handle unexpected server errors.
+ *
+ * @component
+ * @param {Object} props - The component props
+ * @param {Function} props.resetBoundary - Callback function to reset the error boundary and retry the operation
+ * @returns {React.ReactElement} A centered error page with icon, message, and retry button
+ *
+ * @example
+ * // Usage within an error boundary
+ * <InternalServerError resetBoundary={() => window.location.reload()} />
+ *
+ * @example
+ * // Usage with custom reset logic
+ * <InternalServerError resetBoundary={handleRetry} />
+ */
 export const InternalServerError = ({ resetBoundary }: any) => {
   return (
     <div className="flex w-full flex-col items-center justify-center">

package/src/components/Assets/ErrorPages/NoInternetConnection.tsx

@@ -2,6 +2,26 @@ import { Svgs } from '../../../assets/images/svg';
 import { Typography } from '../../DataDisplay/Typography/Typography';
 import { Button } from '../../Input/Button/Button';
 
+/**
+ * NoInterneConnection component displays a "No Internet Connection" error page.
+ *
+ * This component renders a centered error page with an SVG illustration,
+ * a message informing the user of a lost internet connection, and a "Try Again" button.
+ * Useful for displaying when the application detects no network connectivity.
+ *
+ * @component
+ * @param {Object} props - The component props
+ * @param {Function} props.resetBoundary - Callback function to retry the connection or operation
+ * @returns {React.ReactElement} A centered offline error page with icon, message, and retry button
+ *
+ * @example
+ * // Display when network connection is lost
+ * <NoInterneConnection resetBoundary={handleRetry} />
+ *
+ * @example
+ * // With navigation reset
+ * <NoInterneConnection resetBoundary={() => window.location.reload()} />
+ */
 export const NoInterneConnection = ({ resetBoundary }: any) => {
   return (
     <div className="flex w-full flex-col items-center justify-center">

package/src/components/Assets/ErrorPages/NoItemFound.tsx

@@ -10,6 +10,34 @@ interface NoItemFoundProps {
   width?: string | number;
 }
 
+/**
+ * NoItemFound component displays a "No Items Found" placeholder page.
+ *
+ * This component renders a centered container with an empty state SVG illustration,
+ * a title, and a description. The SVG size can be customized with height and width props.
+ * Commonly used to indicate when a list, search results, or data collection is empty.
+ *
+ * @component
+ * @param {Object} props - The component props
+ * @param {string} [props.title='No Items Found'] - The title text to display. Defaults to "No Items Found"
+ * @param {ReactNode} props.description - The description or message to display below the title
+ * @param {string | number} [props.height] - The height of the SVG illustration
+ * @param {string | number} [props.width] - The width of the SVG illustration
+ * @returns {React.ReactElement} A centered layout with SVG, title, and description
+ *
+ * @example
+ * // Basic usage
+ * <NoItemFound description="Try adjusting your search criteria." />
+ *
+ * @example
+ * // With custom title and SVG dimensions
+ * <NoItemFound
+ *   title="No Results"
+ *   description="Your search didn't return any results."
+ *   width={200}
+ *   height={200}
+ * />
+ */
 export const NoItemFound = ({
   title = 'No Items Found',
   description,

package/src/components/Assets/ErrorPages/PageNotFound.tsx

@@ -1,6 +1,27 @@
 import { Svgs } from '../../../assets/images/svg';
 import { Typography } from '../../DataDisplay/Typography/Typography';
 
+/**
+ * PageNotFound component displays a 404 "Page Not Found" error page.
+ *
+ * This component renders a centered error page with an SVG illustration
+ * and informative messages to indicate that the requested page does not exist.
+ * Typically used as a fallback for invalid or missing routes.
+ *
+ * @component
+ * @returns {React.ReactElement} A centered 404 error page with icon and messages
+ *
+ * @example
+ * // Basic usage in routing
+ * <Route path="*" element={<PageNotFound />} />
+ *
+ * @example
+ * // As a fallback route
+ * <Routes>
+ *   <Route path="/" element={<Home />} />
+ *   <Route path="*" element={<PageNotFound />} />
+ * </Routes>
+ */
 export const PageNotFound = () => {
   return (
     <div className="flex w-full flex-col items-center justify-center">

package/src/components/Assets/ErrorPages/ResourceNotFound.tsx

@@ -1,6 +1,27 @@
 import { Svgs } from '../../../assets/images/svg';
 import { Typography } from '../../DataDisplay/Typography/Typography';
 
+/**
+ * ResourceNotFound component displays a "Resource Not Found" error page.
+ *
+ * This component renders a centered error page with an SVG illustration
+ * and a custom message. Typically used when a specific resource (e.g., user, post, item)
+ * cannot be found in the system.
+ *
+ * @component
+ * @param {any} message - The error message or description to display. Can be any ReactNode type
+ * @returns {React.ReactElement} A centered error page with icon and custom message
+ *
+ * @example
+ * // Basic usage
+ * <ResourceNotFound message="The user profile you're looking for does not exist." />
+ *
+ * @example
+ * // With JSX message
+ * <ResourceNotFound
+ *   message={<span>The requested <strong>item</strong> was not found in the database.</span>}
+ * />
+ */
 export const ResourceNotFound = (message: any) => {
   return (
     <div className="flex w-full flex-col items-center justify-center">

package/src/components/Assets/ErrorPages/UnAuthorized.tsx

@@ -2,6 +2,37 @@ import { ReactNode } from 'react';
 import { Svgs } from '../../../assets/images/svg';
 import { Typography } from '../../DataDisplay/Typography/Typography';
 
+/**
+ * UnAuthorized component displays an "Unauthorized Access" error page.
+ *
+ * This component renders a centered error page with an SVG illustration,
+ * a message indicating the user must be logged in, and an optional login component.
+ * Typically used to protect routes that require authentication.
+ *
+ * @component
+ * @param {Object} props - The component props
+ * @param {ReactNode} [props.component] - Optional React element to render below the messages (e.g., a login form or button)
+ * @returns {React.ReactElement} A centered authorization error page with icon, messages, and optional component
+ *
+ * @example
+ * // Basic usage without additional component
+ * <UnAuthorized />
+ *
+ * @example
+ * // With a login button
+ * <UnAuthorized component={<LoginButton />} />
+ *
+ * @example
+ * // With a full login form
+ * <UnAuthorized
+ *   component={
+ *     <form>
+ *       <input type="email" placeholder="Email" />
+ *       <button>Sign In</button>
+ *     </form>
+ *   }
+ * />
+ */
 export const UnAuthorized = ({ component }: { component?: ReactNode }) => {
   return (
     <div className="flex w-full flex-col items-center justify-center">

package/src/components/Assets/Icons/Icons.tsx

@@ -2,6 +2,20 @@ import { FC, MouseEvent } from 'react';
 import { CampxFullLogoIcon } from './IconComponents/CampxFullLogoIcon';
 import { CampxIcon } from './IconComponents/CampxIcon';
 
+/**
+ * IconProps interface defines common properties for icon components.
+ *
+ * Provides a standardized set of props for customizing icon appearance
+ * and behavior across the application.
+ *
+ * @interface IconProps
+ * @property {number} [size] - The size of the icon in pixels
+ * @property {string} [color] - The color of the icon (CSS color value)
+ * @property {boolean} [disabled] - Whether the icon is in a disabled state
+ * @property {string} [hoverColor] - The color of the icon on hover (CSS color value)
+ * @property {string} [backgroundColor] - The background color behind the icon (CSS color value)
+ * @property {Function} [onClick] - Callback function triggered when the icon is clicked
+ */
 export interface IconProps {
   size?: number;
   color?: string;
@@ -11,13 +25,53 @@ export interface IconProps {
   onClick?: (event: MouseEvent<Element>) => void;
 }
 
+/**
+ * IconComponent type represents a React functional component that accepts IconProps.
+ *
+ * Used as the base type for icon components throughout the application.
+ *
+ * @typedef {FC<IconProps>} IconComponent
+ */
 export type IconComponent = FC<IconProps>;
-// Type for the entire Icons object
+
+/**
+ * IconsType interface defines the shape of the Icons object.
+ *
+ * Maps icon names to their corresponding component implementations.
+ *
+ * @interface IconsType
+ * @property {IconComponent} CampxFullLogoIcon - The full Campx logo with text icon component
+ * @property {IconComponent} CampxIcon - The Campx logo mark icon component
+ */
 export type IconsType = {
   CampxFullLogoIcon: IconComponent;
   CampxIcon: IconComponent;
 };
 
+/**
+ * Icons object exports all available icon components.
+ *
+ * Provides a centralized registry of all icon components used throughout the application.
+ * Each icon can be accessed as a property of this object and used as a React component.
+ *
+ * @constant
+ * @type {IconsType}
+ *
+ * @example
+ * // Use individual icons
+ * <Icons.CampxIcon size={24} />
+ * <Icons.CampxFullLogoIcon />
+ *
+ * @example
+ * // Use in a component
+ * const MyComponent = () => {
+ *   return (
+ *     <div>
+ *       <Icons.CampxIcon size={32} color="#E43341" />
+ *     </div>
+ *   );
+ * };
+ */
 export const Icons: IconsType = {
   CampxFullLogoIcon,
   CampxIcon,

package/src/components/Charts/BarChart/BarChart.tsx

@@ -12,6 +12,13 @@ export type BarChartVariant = 'vertical' | 'horizontal';
 
 export type BarChartData = HorizontalBarChartData | VerticalBarChartData;
 
+/**
+ * Props for the BarChart component
+ * Combines props from both VerticalBarChart and HorizontalBarChart
+ * @typedef {Object} BarChartProps
+ * @property {BarChartData[]} data - Array of data objects to display in the chart
+ * @property {BarChartVariant} [variant='vertical'] - Orientation of the bars ('vertical' or 'horizontal')
+ */
 export interface BarChartProps
   extends Omit<VerticalBarChartProps, 'data'>,
     Omit<HorizontalBarChartProps, 'data' | keyof VerticalBarChartProps> {
@@ -19,6 +26,37 @@ export interface BarChartProps
   variant?: BarChartVariant;
 }
 
+/**
+ * BarChart Component
+ * A flexible bar chart component that supports both vertical and horizontal orientations.
+ * Delegates rendering to either VerticalBarChart or HorizontalBarChart based on the variant prop.
+ *
+ * @component
+ * @param {BarChartProps} props - The props object
+ * @param {BarChartData[]} props.data - Array of data objects containing chart values
+ * @param {BarChartVariant} [props.variant='vertical'] - Chart orientation: 'vertical' for vertical bars or 'horizontal' for horizontal bars
+ * @returns {React.ReactElement} Rendered bar chart component
+ *
+ * @example
+ * const data = [
+ *   { month: 'January', sales: 400, revenue: 2400 },
+ *   { month: 'February', sales: 300, revenue: 1398 }
+ * ];
+ * const config = {
+ *   sales: { label: 'Sales', color: '#2563eb' },
+ *   revenue: { label: 'Revenue', color: '#7c3aed' }
+ * };
+ *
+ * return (
+ *   <BarChart
+ *     data={data}
+ *     variant="vertical"
+ *     dataKeys={['sales', 'revenue']}
+ *     xAxisKey="month"
+ *     config={config}
+ *   />
+ * );
+ */
 const BarChart: React.FC<BarChartProps> = ({
   variant = 'vertical',
   ...props

package/src/components/Charts/BarChart/HorizontalBarChart.tsx

@@ -16,10 +16,47 @@ import type {
   TitleProps,
 } from '../types/types';
 
+/**
+ * Data object for HorizontalBarChart
+ * @typedef {Object} HorizontalBarChartData
+ * @property {string|number} [key] - Dynamic data properties
+ */
 export interface HorizontalBarChartData {
   [key: string]: string | number;
 }
 
+/**
+ * Props for the HorizontalBarChart component
+ * @typedef {Object} HorizontalBarChartProps
+ * @property {HorizontalBarChartData[]} data - Array of data objects to display
+ * @property {string[]} dataKeys - Array of keys from data objects to visualize as bars
+ * @property {string} xAxisKey - The key to use for Y-axis (category) labels
+ * @property {ChartConfig} config - Chart configuration with color mappings for data keys
+ * @property {number} [height] - Chart height in pixels (auto-calculated if not provided)
+ * @property {MarginProps} [margin={top: 20, right: 30, bottom: 20, left: -20}] - Chart margins
+ * @property {number} [barSize=32] - Height of each bar in pixels
+ * @property {number|number[]} [radius=5] - Border radius for bars (single value or [top-left, top-right, bottom-right, bottom-left])
+ * @property {string} [stackId] - ID for stacking multiple bars together
+ * @property {boolean} [hideXAxis=false] - Whether to hide the X-axis
+ * @property {number} [yAxisWidth=100] - Width allocated for Y-axis labels
+ * @property {Function} [yAxisTickFormatter] - Function to format Y-axis tick labels
+ * @property {Function} [xAxisTickFormatter] - Function to format X-axis tick labels
+ * @property {boolean} [showTooltip=true] - Whether to show tooltip on hover
+ * @property {boolean|object} [tooltipCursor=false] - Tooltip cursor appearance
+ * @property {boolean} [hideTooltipLabel=true] - Whether to hide the label in tooltip
+ * @property {'line'|'dot'|'dashed'} [tooltipIndicator='line'] - Tooltip indicator style
+ * @property {LegendProps} [legend] - Legend configuration props
+ * @property {boolean} [showLegend=false] - Whether to display the legend
+ * @property {string} [title] - Chart title text
+ * @property {TitleProps} [titleProps={variant: 'h3', className: ''}] - Title styling props
+ * @property {string} [subtitle] - Chart subtitle text
+ * @property {SubTitleProps} [subtitleProps={variant: 'muted', className: ''}] - Subtitle styling props
+ * @property {string} [className] - CSS class for the container
+ * @property {Function} [onBarClick] - Callback function when a bar is clicked
+ * @property {number} [animationDuration=750] - Duration of animations in milliseconds
+ * @property {'ease'|'ease-in'|'ease-out'|'ease-in-out'|'linear'} [animationEasing='ease-in-out'] - Easing function for animations
+ * @property {boolean} [accessibilityLayer=true] - Enable accessibility features
+ */
 export interface HorizontalBarChartProps {
   // Core data
   data: HorizontalBarChartData[];
@@ -74,6 +111,62 @@ export interface HorizontalBarChartProps {
   accessibilityLayer?: boolean;
 }
 
+/**
+ * HorizontalBarChart Component
+ * Displays data as horizontal bars with full customization support for axes, tooltips, legends, and animations.
+ * The chart dynamically calculates height based on data length if height is not provided.
+ *
+ * @component
+ * @param {HorizontalBarChartProps} props - The component props
+ * @param {HorizontalBarChartData[]} props.data - Array of data objects to display
+ * @param {string[]} props.dataKeys - Keys from data objects to visualize
+ * @param {string} props.xAxisKey - The key for Y-axis category labels
+ * @param {ChartConfig} props.config - Chart color and display configuration
+ * @param {number} [props.height] - Chart height; auto-calculated if not provided
+ * @param {MarginProps} [props.margin] - Chart margin spacing
+ * @param {number} [props.barSize] - Height of each bar in pixels
+ * @param {number|number[]} [props.radius] - Border radius for bar corners
+ * @param {string} [props.stackId] - ID for stacked bars
+ * @param {boolean} [props.hideXAxis] - Hide/show the X-axis
+ * @param {number} [props.yAxisWidth] - Width of Y-axis label area
+ * @param {Function} [props.yAxisTickFormatter] - Custom Y-axis label formatter
+ * @param {Function} [props.xAxisTickFormatter] - Custom X-axis label formatter
+ * @param {boolean} [props.showTooltip] - Show/hide tooltip
+ * @param {boolean|object} [props.tooltipCursor] - Tooltip cursor style
+ * @param {boolean} [props.hideTooltipLabel] - Hide/show tooltip label
+ * @param {'line'|'dot'|'dashed'} [props.tooltipIndicator] - Tooltip indicator style
+ * @param {LegendProps} [props.legend] - Legend configuration
+ * @param {boolean} [props.showLegend] - Show/hide legend
+ * @param {string} [props.title] - Chart title
+ * @param {TitleProps} [props.titleProps] - Title styling
+ * @param {string} [props.subtitle] - Chart subtitle
+ * @param {SubTitleProps} [props.subtitleProps] - Subtitle styling
+ * @param {string} [props.className] - Container CSS class
+ * @param {Function} [props.onBarClick] - Click handler callback
+ * @param {number} [props.animationDuration] - Animation duration in ms
+ * @param {'ease'|'ease-in'|'ease-out'|'ease-in-out'|'linear'} [props.animationEasing] - Animation easing
+ * @param {boolean} [props.accessibilityLayer] - Enable accessibility features
+ * @returns {React.ReactElement} Rendered horizontal bar chart
+ *
+ * @example
+ * const data = [
+ *   { category: 'Category A', value: 120 },
+ *   { category: 'Category B', value: 200 }
+ * ];
+ * const config = {
+ *   value: { label: 'Value', color: '#3b82f6' }
+ * };
+ *
+ * return (
+ *   <HorizontalBarChart
+ *     data={data}
+ *     dataKeys={['value']}
+ *     xAxisKey="category"
+ *     config={config}
+ *     title="Sales by Category"
+ *   />
+ * );
+ */
 const HorizontalBarChart: React.FC<HorizontalBarChartProps> = ({
   data,
   dataKeys,