@gechiui/compose
Version:
GeChiUI higher-order components (HOCs).
23 lines • 813 B
TypeScript
export default useViewportMatch;
export type GCBreakpoint = "huge" | "wide" | "large" | "medium" | "small" | "mobile";
export type GCViewportOperator = ">=" | "<";
/**
* Returns true if the viewport matches the given query, or false otherwise.
*
* @param {GCBreakpoint} breakpoint Breakpoint size name.
* @param {GCViewportOperator} [operator=">="] Viewport operator.
*
* @example
*
* ```js
* useViewportMatch( 'huge', '<' );
* useViewportMatch( 'medium' );
* ```
*
* @return {boolean} Whether viewport matches query.
*/
declare function useViewportMatch(breakpoint: GCBreakpoint, operator?: GCViewportOperator | undefined): boolean;
declare namespace useViewportMatch {
const __experimentalWidthProvider: import("react").Provider<number | null>;
}
//# sourceMappingURL=index.d.ts.map