npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@custom-react-hooks/use-media-query

v1.5.1

Published

The `useMediaQuery` hook is designed for responsive design in React applications. It enables components to adapt to different screen sizes or respond to media query changes.

Downloads

2,058

Readme

useMediaQuery Hook

The useMediaQuery hook is designed for responsive design in React applications. It enables components to adapt to different screen sizes or respond to media query changes.

Features

  • Dynamic Media Queries: Accepts any valid CSS media query string.
  • SSR Compatibility: Safe for server-side rendering, as it checks for the availability of the window object.
  • Efficient and Optimized: Only updates component state when media query match status changes.

Installation

Installing Only Current Hooks

npm install @custom-react-hooks/use-media-query

or

yarn add @custom-react-hooks/use-media-query

Installing All Hooks

npm install @custom-react-hooks/all

or

yarn add @custom-react-hooks/all

Importing the Hook

The useMediaQuery hook must be imported using a named import as shown below:

Named Import:

import { useMediaQuery } from '@custom-react-hooks/use-media-query';

This approach ensures that the hook integrates seamlessly into your project, maintaining consistency and predictability in how you use our package.

Usage

Import and use the useMediaQuery hook in your React components:

import { useMediaQuery } from '@custom-react-hooks/all';

const MediaQueryComponent = () => {
  const isWide = useMediaQuery('(min-width: 600px)');

  return (
    <div>
      {isWide ? 'Wide viewport detected' : 'Narrow viewport detected'}
      <br />
      <span>
        <i>Resize to see the effect</i>
      </span>
    </div>
  );
};

export default MediaQueryComponent;

API Reference

Parameters

  • query: A string representing the media query to evaluate.

Use Cases

  • Responsive Design: Dynamically adjust the layout or functionality based on viewport size.
  • Dark Mode Toggle: Switch between light and dark themes based on user's system preferences.
  • Adaptive Rendering: Render different components or content based on media query matches.
  • Performance Optimization: Load resources conditionally based on the media query (e.g., images for mobile).

Contributing

Contributions to enhance the useMediaQuery hook are welcome. Feel free to submit issues or pull requests to the repository.