@buun_group/brutalist-ui
Version:
A brutalist-styled component library
60 lines (59 loc) • 1.36 kB
TypeScript
/**
* @module BrutalGrid
* @description A brutalist grid pattern background component with thick lines and bold aesthetics
*/
import React, { SVGProps } from 'react';
/**
* Props for the BrutalGrid component
*/
export interface BrutalGridProps extends SVGProps<SVGSVGElement> {
/**
* The width of grid cells
* @default 40
*/
cellWidth?: number;
/**
* The height of grid cells
* @default 40
*/
cellHeight?: number;
/**
* The thickness of grid lines
* @default 3
*/
strokeWidth?: number;
/**
* The pattern style
* @default 'solid'
*/
variant?: 'solid' | 'dashed' | 'double' | 'offset';
/**
* The color scheme
* @default 'black'
*/
color?: 'black' | 'white' | 'accent' | 'red' | 'blue' | 'yellow';
/**
* Whether to animate the grid
* @default false
*/
animated?: boolean;
/**
* Additional className
*/
className?: string;
}
/**
* BrutalGrid component for creating brutalist grid pattern backgrounds
*
* @example
* ```tsx
* <BrutalGrid
* cellWidth={50}
* strokeWidth={4}
* variant="dashed"
* color="accent"
* />
* ```
*/
export declare const BrutalGrid: React.ForwardRefExoticComponent<Omit<BrutalGridProps, "ref"> & React.RefAttributes<SVGSVGElement>>;
export default BrutalGrid;