rsuite/esm/useBreakpointValue/useBreakpointValue.d.ts

A suite of react components

import { Query } from '../useMediaQuery';
interface UseBreakpointValueOptions<T = any> {
    /**
     * The default value to return if no screen size matches.
     */
    defaultValue?: T;
    /**
     * Whether to enable the media query, defaults to true
     */
    enabled?: boolean;
}
/**
 * A React Hook that returns different values based on different screen sizes in responsive design.
 * @version 5.64.0
 * @unstable Please note that this API is not stable and may change in the future.
 * @see https://rsuitejs.com/components/use-breakpoint-value
 *
 * @example
 * ```ts
 * const fontSize = useBreakpointValue({ sm: "14px", lg: "24px" }, { defaultValue: "16px" });
 * const direction = useBreakpointValue({ sm: 'row' }, { defaultValue:'column' });
 * ```
 *
 */
export declare function useBreakpointValue<T = any>(breakpoints: Record<Query, T>, options?: UseBreakpointValueOptions<T>): T | undefined;
export default useBreakpointValue;