https://github.com/komlev/tiny-use-media

Small (0.5 Kb) react hook for getting media breakpoints state info in runtime
https://github.com/komlev/tiny-use-media

breakpoints hooks media usemedia

Last synced: about 2 months ago
JSON representation

Small (0.5 Kb) react hook for getting media breakpoints state info in runtime

• Host: GitHub
• URL: https://github.com/komlev/tiny-use-media
• Owner: komlev
• Created: 2022-02-01T17:17:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-06-10T15:10:05.000Z (over 2 years ago)
• Last Synced: 2024-07-14T01:24:29.522Z (2 months ago)
• Topics: breakpoints, hooks, media, usemedia
• Language: JavaScript
• Homepage:
• Size: 36.1 KB
• Stars: 53
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# tiny-use-media

Small (0.5 Kb) react hook for getting media breakpoints state info in runtime

## Usage

```

npm i tiny-use-media --save

```

Adn in your react code

```js

import { useMedia } from "tiny-use-media";

// ...

const { current, md, lg } = useMedia({

  sm: 640,

  md: 768,

  lg: 1024,

  xl: 1280,

});

console.log({ current, md, lg });

/*

  if you current screen size is 900px

  it will print:

  { current: 'md', md: true, lg: false }

*/

```

## API

Input:

```js

// object with breakpoints names/values

const breakpointsConfig = {

  mobile: 320, // min-width for mobile

  tablet: 640, // min-width for tablet

  desktop: 1024, // min-width for desktop

};

useMedia(breakpointsConfig);

```

Output:

```js

const output = useMedia(breakpointsConfig);

```

Output contains "**current**" field which corresponds to a current breakpoint.

It also contains boolean values for each provided breakpoint.

E.g. output for screen size of 900px

```js

{

    current: "tablet",

    mobile: true,

    tablet: true,

    desktop: false

}

```

## License

MIT