UNPKG

@ehsaneha/react-media-query

Version:

A custom React hook that returns the current responsive breakpoint index or evaluates media query rules based on the window's width.

14 lines (13 loc) 984 B
import React from "react"; import type { BreakPointNames, MediaQueryIndex, InputableRuleNum, RuleString, MediaQueryRule, MediaQueryContextProps, TRuleBoolean } from "./types"; export { MediaQueryIndex, MediaQueryRule } from "./types"; export declare const BREAKPOINTS: Record<Uppercase<BreakPointNames>, InputableRuleNum>; export declare const MEDIA_QUERRY_RULES: Record<Uppercase<RuleString>, RuleString>; export declare function MediaQueryProvider({ children, ...props }: MediaQueryContextProps & { children?: React.ReactNode; }): React.JSX.Element; export declare function useMediaQueryStateless<TRule extends MediaQueryRule, TResult = TRule extends TRuleBoolean ? boolean : MediaQueryIndex>(onChange: (result: TResult) => void, { rule, immediate }?: { rule?: TRule; immediate?: boolean; }): void; export default function useMediaQuery<TRule extends MediaQueryRule, TResult = TRule extends TRuleBoolean ? boolean : MediaQueryIndex>(rule?: TRule): TResult;