@buun_group/brutalist-ui
Version:
A brutalist-styled component library
47 lines (46 loc) • 1.23 kB
TypeScript
/**
* @module ComicText
* @description A bold, comic book-style text component with halftone dot pattern and brutalist aesthetics
*/
import React, { HTMLAttributes } from 'react';
/**
* Props for the ComicText component
*/
export interface ComicTextProps extends HTMLAttributes<HTMLDivElement> {
/**
* The text content to display
*/
children: string;
/**
* The size of the text in rem units
* @default 5
*/
fontSize?: number;
/**
* The visual style variant
* @default 'default'
*/
variant?: 'default' | 'brutal' | 'outline' | 'shadow';
/**
* The color scheme
* @default 'yellow'
*/
color?: 'yellow' | 'red' | 'blue' | 'green' | 'purple' | 'orange';
/**
* The component element type
* @default 'div'
*/
as?: 'div' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'span' | 'p';
}
/**
* ComicText component for displaying bold, comic book-style text with brutalist design
*
* @example
* ```tsx
* <ComicText fontSize={6} color="red">
* POW!
* </ComicText>
* ```
*/
export declare const ComicText: React.ForwardRefExoticComponent<ComicTextProps & React.RefAttributes<HTMLDivElement>>;
export default ComicText;