/**
* A reusable text component that displays content with flexible styles.
* It supports configuration for size, weight, dark mode, and custom class names.
*
* @component
* @example
* // Basic usage of the Text component
*
* This is a large, medium-weight text in dark mode.
*
*
* @example
* // Usage with a custom class
*
* This is a text with a custom class.
*
*/
import { FC } from 'react';
export interface TextProps {
/**
* The content to be rendered inside the text component.
* Can be a React node or a string of text.
*/
children: React.ReactNode | string;
/**
* Additional CSS class to be applied to customize the component's styling.
* If not provided, no additional class is applied.
*/
className?: string;
/**
* Enable dark mode (changes the color palette of the component).
* Defaults to `false` if not provided.
*/
darkMode?: boolean;
/**
* Defines the size of the text. It can be one of the following:
* - "lg" for large size
* - "md" for medium size (default value)
* - "sm" for small size
* - "xs" for extra small size
*
* The default value is 'md'.
*/
type?: 'lg' | 'md' | 'sm' | 'xs';
/**
* Defines the font weight. It can be one of the following:
* - "regular" for normal weight
* - "medium" for medium weight
*
* The default value is 'regular'.
*/
weight?: 'regular' | 'medium';
}
declare const Text: FC;
export default Text;