@buun_group/brutalist-ui
Version:
A brutalist-styled component library
50 lines (49 loc) • 1.43 kB
TypeScript
/**
* @module Separator
* @description A visual separator component for dividing content sections with customizable styles, orientations, and optional labels. Supports horizontal and vertical layouts with various border styles.
*/
import React from 'react';
/**
* Props for the Separator component
*/
export interface SeparatorProps {
/**
* Orientation of the separator line
* @default 'horizontal'
*/
orientation?: 'horizontal' | 'vertical';
/**
* Thickness variant for the separator line
* @default 'medium'
*/
thickness?: 'thin' | 'medium' | 'thick';
/**
* Visual style variant for the separator line
* @default 'solid'
*/
variant?: 'solid' | 'dashed' | 'dotted' | 'double';
/**
* Additional CSS classes to apply to the separator
*/
className?: string;
/**
* Inline styles to apply to the separator
*/
style?: React.CSSProperties;
/**
* Decorative text or element to display in the middle of the separator (horizontal only)
*/
label?: string | React.ReactNode;
/**
* Position of the label along the separator line
* @default 'center'
*/
labelPosition?: 'start' | 'center' | 'end';
/**
* Accessible label for screen readers
* @default 'Separator'
*/
ariaLabel?: string;
}
export declare const Separator: React.FC<SeparatorProps>;
export default Separator;