Gathering detailed insights and metrics for @w11r/use-breakpoint
Installations
npm install @w11r/use-breakpointDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
14.4.0
NPM Version
7.6.3
Score
73.8
Supply Chain
99.4
Quality
76.1
Maintenance
100
Vulnerability
100
License
Releases
14
Contributors
2
Unable to fetch Contributors
Languages
3
TypeScript
SCSS
CSS
TypeScript (84.26%)
SCSS (14.9%)
CSS (0.84%)
validate.email 🚀
Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.
Developer
wintercounter
Download Statistics
Total Downloads
89,091
Last Day
13
Last Week
119
Last Month
272
Last Year
5,925
GitHub Statistics
MIT License
17 Stars
70 Commits
3 Forks
1 Watchers
1 Branches
2 Contributors
Updated on Apr 05, 2023
Bundle Size
4.74 kB
Minified
1.84 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
2.0.0
Package Id
@w11r/use-breakpoint@2.0.0
Unpacked Size
57.43 kB
Size
12.88 kB
File Count
40
NPM Version
7.6.3
Node Version
14.4.0
Total Downloads
Cumulative downloads
Total Downloads
89,091
No dependencies detected.
Intro
React useBreakpoint hook to have different values for a variable
based on a breakpoints.
Demo
https://wintercounter.github.io/use-breakpoint
Install
1npm i @w11r/use-breakpoint
Setup
Add provider
Add BreakpointProvider in your React tree.
1import { BreakpointProvider } from '@w11r/use-breakpoint' 2 3... 4 <BreakpointProvider> 5 ... 6 </BreakpointProvider> 7...
Default breakpoints
The following default breakpoints are being used, including several shorthands.
1const breakpoints = { 2 micro: [0, 375], 3 mi: [0, 375], 4 mobile: [376, 639], 5 m: [376, 639], 6 tablet: [640, 1023], 7 t: [640, 1023], 8 small: [1024, 1439], 9 s: [1024, 1439], 10 medium: [1440, 1919], 11 med: [1440, 1919], 12 large: [1920, 10000], 13 l: [1920, 10000], 14 // Multi range 15 device: [0, 1023], 16 d: [0, 1023], 17 smallDevice: [0, 639], 18 sd: [0, 639] 19}
Override default settings
1import { setup, breakpoints } from '@w11r/use-breakpoint' 2 3setup({ 4 breakpoints: { 5 // Extend default values 6 ...breakpoints, 7 alienDevice: [342, 43534] // from, to 8 } 9})
Usage
With passing values
1useBreakpoint(defaultValue, breakpointValues) 2 3// breakpointValues: array of breakpoint based values 4[ 5 ['mobile', 300], 6 ['tablet', 400] 7] 8 9// In case you have a single breakpoint value, `['mobile', 300]` is enough instead of `[['mobile', 300]]`
Without passing values
In case you don't specify any value to the hook, it'll return a generated object including boolean values for each breakpoint keys that's being defined in options.
It'll return the following object with the basic setup.
{
isLandscape: false,
isPortrait: true,
isHDPI: false,
isMicro: false,
isMobile: true,
isTablet: false,
isSmall: false,
isMedium: false,
isLarge: false,
'is-Micro': false,
'is|Micro': false,
'isMicro+': true,
'is-Micro+': true,
'is|Micro+': true,
'isMicro-': false,
'is-Micro-': false,
'is|Micro-': false,
'is-Mobile': true,
'is|Mobile': true,
'isMobile+': true,
'is-Mobile+': true,
'is|Mobile+': true,
'isMobile-': true,
'is-Mobile-': true,
'is|Mobile-': true,
'is-Tablet': false,
'is|Tablet': false,
'isTablet+': false,
'is-Tablet+': false,
'is|Tablet+': false,
'isTablet-': true,
'is-Tablet-': true,
'is|Tablet-': true,
'is-Small': false,
'is|Small': false,
'isSmall+': false,
'is-Small+': false,
'is|Small+': false,
'isSmall-': true,
'is-Small-': true,
'is|Small-': true,
'is-Medium': false,
'is|Medium': false,
'isMedium+': false,
'is-Medium+': false,
'is|Medium+': false,
'isMedium-': true,
'is-Medium-': true,
'is|Medium-': true,
'is-Large': false,
'is|Large': false,
'isLarge+': false,
'is-Large+': false,
'is|Large+': false,
'isLarge-': true,
'is-Large-': true,
'is|Large-': true
}
Usage
1const { isMobile } = useBreakpoint() 2 3// The above is basically a replacement for 4const isMobile = useBreakpoint(false, ['mobile', true])
You can also access the values with suffix and prefix, but you need to rename the variables because it contains invalid character:
const { 'isMobile+': isMobile } = useBreakpoint()
Component example
1import useBreakpoint from '@w11r/use-breakpoint' 2 3const MyCmp = () => { 4 const columns = useBreakpoint([1,2], ['mobile', [2,1]]) 5 6 return <Grid cols={columns} /> 7} 8 9// Or using inline 10const MyCmp = () => { 11 return <Grid cols={useBreakpoint([1,2], ['mobile', [2,1]])} /> 12}
Rules-of-Hooks are still true in this case as well. Make sure your component will ALWAYS run it without any condition!
Modifiers
All breakpoint names coming with modifiers included.
Orientation prefix
- `` (none): all
-: Landscape|: Portrait
Range suffix
You can also control your value to behave as and up and and down.
- `` (none): all
+:and up-:and down
Examples
['|mobile', 300]: on mobile, on portrait['|mobile+', 300]: on mobile and up, on portrait['mobile+', 300]: on mobile and up, both portrait and landscape['mobile', 300]: on mobile, both portrait and landscape['tablet-', 300]: on tablet and below, both portrait and landscape['mobile-', 300]: on mobile and down, both portrait and landscape
Generate Media Query strings using the same logic
It is useful when you just need simple CSS. For example with styled-components:
1import styled from 'styled-components' 2import { mediaQuery } from '@w11r/use-breakpoint' 3 4const mediaQueryString = mediaQuery( 5 ['mobile-', `width: 100%;`] 6) 7 8const Box = styled.div` 9 ${mediaQuery( 10 ['mobile-', `width: 100%;`] 11 )} 12` 13 14// You can still use multiple queries at once just like with the hook: 15mediaQuery([['mobile-', `width: 100%`], ['medium+', `width: 50%`]])
This utility comes with additional support for shorthands which is configurable through options.
1setup({ 2 shorthands: { 3 foo: '@media (wow: bar) and (hmm: khm)' 4 } 5}) 6 7mediaQuery(['foo', value])
Additionally, it supports dark and light mode prefixes:
(: Light mode): Dark mode
1mediaQuery([')mobile', 'content']) 2// @media screen and (min-width: 376px) and (max-width: 639px) and (prefers-color-scheme: dark) { content } 3 4mediaQuery([')', 'content']) 5// @media screen and (prefers-color-scheme: dark) { content }
FAQ
Is there any best practice suggestion?
Yes! Use as fewer hooks as possible. It's always faster to have a single
isMobile variable and have simple conditions based on it. It's even better
if you can solve your size related cases using pure CSS Media Queries.
Why not using an Object? Why the Array structure?
Object's cannot guarantee the order of the defined keys. It is crucial
to check for values in the correct order because useBreakpoint uses
eager evaluation and mediaQuery must maintain the defined order of
the generated Media Queries.
Which rule is being prioritized?
The hook uses eager evaluation, so the first truthy breakpoint value gets returned.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 2/29 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 3 are checked with a SAST tool
Score
3
/10
Last Scanned on 2025-03-03
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More