@fluent-windows/hooks
Version:
Fluent-Windows React hooks.
34 lines (33 loc) • 807 B
TypeScript
/**
* Tracks state of a CSS media query.
*
* Demo
* import { useMedia } from '@fluent-windows/hooks'
*
* const isWide = useMedia('(min-width: 600px)')
*
* <div>
* Screen is wide: {isWide ? 'Yes' : 'No'}
* </div>
*
* // or you can use breakpoints
*
* const isWide = useMedia('sm')
* <div>
* Screen is wide: {isWide ? 'Yes' : 'No'}
* </div>
*/
import * as json2mq_ from 'json2mq';
declare type AllBreakpoints = 'sm' | 'md' | 'lg' | 'xl';
export declare type MediaQuery = json2mq_.QueryObject | json2mq_.QueryObject[] | AllBreakpoints | string;
interface Breakpoints {
sm: number;
md: number;
lg: number;
xl: number;
}
interface Option {
breakpoints: Breakpoints;
}
declare function useMedia(mediaQuery: MediaQuery, option?: Option): boolean;
export default useMedia;