/**
* Standard breakpoint values matching common design system breakpoints
*/
export declare const BREAKPOINTS: {
readonly xs: 480;
readonly sm: 640;
readonly md: 768;
readonly lg: 1024;
readonly xl: 1280;
readonly '2xl': 1536;
};
export type Breakpoint = keyof typeof BREAKPOINTS;
/**
* Hook to detect the current responsive breakpoint.
* Returns an object with boolean flags for each breakpoint.
*
* @param customBreakpoints - Optional custom breakpoint values
* @returns Object with boolean flags for each breakpoint
*
* @example
* ```tsx
* function ResponsiveLayout() {
* const { isMobile, isTablet, isDesktop } = useBreakpoint();
*
* if (isMobile) return ;
* if (isTablet) return ;
* return ;
* }
* ```
*
* @example
* ```tsx
* function Navigation() {
* const { xs, sm, md, lg, xl } = useBreakpoint();
*
* return (
*
* );
* }
* ```
*
* @example
* ```tsx
* // Using custom breakpoints
* function CustomBreakpoint() {
* const breakpoints = useBreakpoint({
* mobile: 375,
* tablet: 768,
* desktop: 1440
* });
*
* return
Current breakpoint data: {JSON.stringify(breakpoints)}
;
* }
* ```
*/
export declare function useBreakpoint = typeof BREAKPOINTS>(customBreakpoints?: T): Record & {
isMobile: boolean;
isTablet: boolean;
isDesktop: boolean;
current: keyof T | 'base';
};
/**
* Simple hook to check if viewport is below a specific breakpoint (mobile-first approach).
*
* @param breakpoint - The breakpoint value in pixels (default: 768)
* @returns Whether the viewport is below the breakpoint
*
* @example
* ```tsx
* function Component() {
* const isMobile = useMobileBreakpoint();
* const isSmall = useMobileBreakpoint(640);
*
* return isMobile ? : ;
* }
* ```
*/
export declare function useMobileBreakpoint(breakpoint?: number): boolean;
//# sourceMappingURL=useBreakpoint.d.ts.map