@buun_group/brutalist-ui
Version:
A brutalist-styled component library
52 lines (51 loc) • 1.33 kB
TypeScript
/**
* @module GlitchText
* @description A glitchy, cyberpunk-style text component with digital distortion effects
*/
import { HTMLAttributes } from 'react';
/**
* Props for the GlitchText component
*/
export interface GlitchTextProps extends HTMLAttributes<HTMLDivElement> {
/**
* The text content to display
*/
children: string;
/**
* The size of the text
* @default 'md'
*/
size?: 'sm' | 'md' | 'lg' | 'xl';
/**
* The glitch intensity
* @default 'medium'
*/
intensity?: 'subtle' | 'medium' | 'extreme';
/**
* The color scheme
* @default 'cyber'
*/
color?: 'cyber' | 'vhs' | 'matrix' | 'corrupt' | 'neon';
/**
* Whether to animate the glitch effect
* @default true
*/
animated?: boolean;
/**
* The component element type
* @default 'div'
*/
as?: 'div' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'span' | 'p';
}
/**
* GlitchText component for displaying text with digital glitch effects
*
* @example
* ```tsx
* <GlitchText size="lg" intensity="extreme" color="cyber">
* SYSTEM ERROR
* </GlitchText>
* ```
*/
export declare const GlitchText: import("react").ForwardRefExoticComponent<GlitchTextProps & import("react").RefAttributes<HTMLDivElement>>;
export default GlitchText;