UNPKG

@buun_group/brutalist-ui

Version:
47 lines (46 loc) 1.45 kB
/** * @module Container * @description A responsive container component that provides consistent max-width constraints and padding. Essential for creating well-structured page layouts with proper content alignment. */ import { HTMLAttributes, CSSProperties } from 'react'; /** * Props for the Container component */ export interface ContainerProps extends HTMLAttributes<HTMLDivElement> { /** * The maximum width size of the container * @default 'lg' */ size?: 'sm' | 'md' | 'lg' | 'xl' | 'full'; /** * Whether the container should be horizontally centered * @default true */ centered?: boolean; /** * The amount of padding inside the container * @default 'md' */ padding?: 'none' | 'sm' | 'md' | 'lg'; /** * Additional CSS class name for styling */ className?: string; /** * Custom CSS styles (supports utility classes) */ style?: CSSProperties; } /** * A responsive container that constrains content width and provides consistent padding. * Commonly used as a top-level wrapper for page content to ensure proper layout on different screen sizes. * * @example * ```tsx * <Container size="lg" padding="lg"> * <h1>Page Title</h1> * <p>Your content goes here...</p> * </Container> * ``` */ export declare const Container: import("react").ForwardRefExoticComponent<ContainerProps & import("react").RefAttributes<HTMLDivElement>>;