react-responsive-tools 2.5.1 → 2.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.MD +59 -65
- package/dist/breakpoints.config.d.ts +18 -0
- package/dist/breakpoints.config.js +17 -0
- package/dist/components/horizontal.d.ts +33 -4
- package/dist/components/horizontal.js +34 -3
- package/dist/default.config.d.ts +3 -1
- package/dist/default.config.js +2 -1
- package/dist/functions/getBreakpoint.d.ts +1 -1
- package/dist/functions/getBreakpoint.js +1 -1
- package/dist/hooks/useBreakpoint.d.ts +53 -5
- package/dist/hooks/useBreakpoint.js +69 -10
- package/dist/hooks/useBreakpoint.test.d.ts +1 -0
- package/dist/hooks/useBreakpoint.test.js +153 -0
- package/dist/hooks/useVBreakpoint.d.ts +1 -3
- package/dist/hooks/useVBreakpoint.js +1 -7
- package/dist/index.d.ts +4 -2
- package/dist/index.js +4 -2
- package/dist/scripts/createConfig.mjs +1 -1
- package/package.json +10 -4
package/README.MD
CHANGED
|
@@ -8,10 +8,6 @@ The package is based on [react-responsive](https://www.npmjs.com/package/react-r
|
|
|
8
8
|
|
|
9
9
|
To install the project, run the following command:
|
|
10
10
|
|
|
11
|
-
### Установка
|
|
12
|
-
|
|
13
|
-
Пожалуйста, убедитесь, что вы установили следующие зависимости:
|
|
14
|
-
|
|
15
11
|
```sh
|
|
16
12
|
yarn add react-responsive
|
|
17
13
|
```
|
|
@@ -58,6 +54,16 @@ This command will run the `reinit.sh` script, which will recreate the necessary
|
|
|
58
54
|
|
|
59
55
|
The following horizontal and vertical breakpoints are provided by default:
|
|
60
56
|
|
|
57
|
+
### Preferred Adaptive Variant (`PREFERRED_VARIANT`)
|
|
58
|
+
|
|
59
|
+
By default, the library uses the following preferred adaptive variant:
|
|
60
|
+
|
|
61
|
+
```ts
|
|
62
|
+
// DESKTOP_TO_FIRST or MOBILE_TO_FIRST
|
|
63
|
+
// TAdaptiveVariant = Dtf | MtF
|
|
64
|
+
export const PREFERRED_VARIANT: TAdaptiveVariant = 'DtF';
|
|
65
|
+
```
|
|
66
|
+
|
|
61
67
|
#### Horizontal Breakpoints
|
|
62
68
|
|
|
63
69
|
```typescript
|
|
@@ -107,38 +113,29 @@ const MyComponent = () => {
|
|
|
107
113
|
};
|
|
108
114
|
```
|
|
109
115
|
|
|
110
|
-
#### Hook `
|
|
111
|
-
|
|
112
|
-
```typescript
|
|
113
|
-
import { useBreakpointMF } from 'react-responsive-tools';
|
|
116
|
+
#### Hook `useBreakpointBetween`
|
|
114
117
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
const isMedium = useBreakpointMF('md');
|
|
118
|
+
`useBreakpointBetween` is an optimized hook for checking whether the current
|
|
119
|
+
viewport is between two breakpoints (`min` and `max`).
|
|
118
120
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
);
|
|
124
|
-
};
|
|
125
|
-
```
|
|
121
|
+
It is especially useful as a safe replacement for combining `useBreakpoint`
|
|
122
|
+
with both mobile-first (`For`) and desktop-first (`Before`) logic, where
|
|
123
|
+
their ranges would otherwise overlap at the same pixel (for example,
|
|
124
|
+
`min-width: 300px` and `max-width: 300px` both including 300px).
|
|
126
125
|
|
|
127
|
-
|
|
126
|
+
Internally the hook adjusts one of the boundaries by `1px` based on
|
|
127
|
+
the preferred adaptive variant (`PREFERRED_VARIANT`) to ensure that
|
|
128
|
+
a particular pixel falls into only one range.
|
|
128
129
|
|
|
129
130
|
```typescript
|
|
130
|
-
import {
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
const
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
{isLarge && <p>Current breakpoint: Large (lg) for Desktop First</p>}
|
|
139
|
-
</div>
|
|
140
|
-
);
|
|
141
|
-
};
|
|
131
|
+
import { useBreakpointBetween } from 'react-responsive-tools';
|
|
132
|
+
|
|
133
|
+
const MyComponent = () => {
|
|
134
|
+
const isVisible = useBreakpointBetween('sm', 'lg');
|
|
135
|
+
return (
|
|
136
|
+
{isVisible && Visible only between "sm" and "lg" breakpoints}
|
|
137
|
+
);
|
|
138
|
+
};
|
|
142
139
|
```
|
|
143
140
|
|
|
144
141
|
#### Hook `useVBreakpoint`
|
|
@@ -158,40 +155,6 @@ const MyComponent = () => {
|
|
|
158
155
|
};
|
|
159
156
|
```
|
|
160
157
|
|
|
161
|
-
#### Hook `useVBreakpointMF`
|
|
162
|
-
|
|
163
|
-
```typescript
|
|
164
|
-
import { useVBreakpointMF } from 'react-responsive-tools';
|
|
165
|
-
|
|
166
|
-
// Usage Example
|
|
167
|
-
const MyComponent = () => {
|
|
168
|
-
const isMedium = useVBreakpointMF('md');
|
|
169
|
-
|
|
170
|
-
return (
|
|
171
|
-
<div>
|
|
172
|
-
{isMedium && <p>Current vertical breakpoint: Medium (md) for Mobile First</p>}
|
|
173
|
-
</div>
|
|
174
|
-
);
|
|
175
|
-
};
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
#### Hook `useVBreakpointDF`
|
|
179
|
-
|
|
180
|
-
```typescript
|
|
181
|
-
import { useVBreakpointDF } from 'react-responsive-tools';
|
|
182
|
-
|
|
183
|
-
// Usage Example
|
|
184
|
-
const MyComponent = () => {
|
|
185
|
-
const isLarge = useVBreakpointDF('lg');
|
|
186
|
-
|
|
187
|
-
return (
|
|
188
|
-
<div>
|
|
189
|
-
{isLarge && <p>Current vertical breakpoint: Large (lg) for Desktop First</p>}
|
|
190
|
-
</div>
|
|
191
|
-
);
|
|
192
|
-
};
|
|
193
|
-
```
|
|
194
|
-
|
|
195
158
|
### Using Components
|
|
196
159
|
|
|
197
160
|
#### Component `For`
|
|
@@ -232,6 +195,37 @@ const CustomSizeComponent = () => (
|
|
|
232
195
|
);
|
|
233
196
|
```
|
|
234
197
|
|
|
198
|
+
#### Component `Between`
|
|
199
|
+
|
|
200
|
+
`Between` is a convenience component built on top of `useBreakpointBetween`.
|
|
201
|
+
It renders its children only when the viewport width is between `min` and `max`.
|
|
202
|
+
|
|
203
|
+
Compared to combining `For` and `Before`, `Between` automatically applies the
|
|
204
|
+
1px shift logic to avoid overlapping ranges.
|
|
205
|
+
|
|
206
|
+
```tsx
|
|
207
|
+
import React from 'react';
|
|
208
|
+
|
|
209
|
+
import { Between } from 'react-responsive-tools';
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Visible only on tablet widths: from "sm" (576px) up to "lg" (992px)
|
|
213
|
+
* with a safe 1px gap between adjacent ranges.
|
|
214
|
+
*/
|
|
215
|
+
export function TabletOnlyBanner() {
|
|
216
|
+
return (
|
|
217
|
+
<Between min="sm" max="lg">
|
|
218
|
+
<section className="tablet-banner">
|
|
219
|
+
<h2>Tablet-only promo</h2>
|
|
220
|
+
<p>
|
|
221
|
+
This banner is visible only between the <code>sm</code> and <code>lg</code> breakpoints.
|
|
222
|
+
</p>
|
|
223
|
+
</section>
|
|
224
|
+
</Between>
|
|
225
|
+
);
|
|
226
|
+
}
|
|
227
|
+
```
|
|
228
|
+
|
|
235
229
|
### Breakpoint Types
|
|
236
230
|
|
|
237
231
|
```typescript
|
|
@@ -1,3 +1,21 @@
|
|
|
1
|
+
import { TAdaptiveVariant } from "./interfaces/TAdaptiveVariant";
|
|
2
|
+
/**
|
|
3
|
+
* Preferred adaptive layout variant.
|
|
4
|
+
*
|
|
5
|
+
* 'DtF' stands for "Desktop To First" and is used as the default strategy
|
|
6
|
+
* for resolving overlaps between "mobile-first" (`min-width`) and
|
|
7
|
+
* "desktop-first" (`max-width`) breakpoints.
|
|
8
|
+
*
|
|
9
|
+
* When switching between these variants we shift the opposite boundary
|
|
10
|
+
* by 1px to avoid cases when two ranges overlap at the exact same pixel.
|
|
11
|
+
*
|
|
12
|
+
* For example:
|
|
13
|
+
* - `min-width: 300px` includes 300px,
|
|
14
|
+
* - `max-width: 300px` also includes 300px,
|
|
15
|
+
* which causes an overlap. By shifting one of them by 1px we guarantee
|
|
16
|
+
* that a given pixel belongs to only one range.
|
|
17
|
+
*/
|
|
18
|
+
export declare const PREFERRED_VARIANT: TAdaptiveVariant;
|
|
1
19
|
declare const HORIZONTAL_BREAKPOINTS: Record<string, string>;
|
|
2
20
|
declare const VERTICAL_BREAKPOINTS: Record<string, string>;
|
|
3
21
|
export { HORIZONTAL_BREAKPOINTS, VERTICAL_BREAKPOINTS };
|
|
@@ -1,4 +1,21 @@
|
|
|
1
1
|
// src/breakpoints.config.ts
|
|
2
|
+
/**
|
|
3
|
+
* Preferred adaptive layout variant.
|
|
4
|
+
*
|
|
5
|
+
* 'DtF' stands for "Desktop To First" and is used as the default strategy
|
|
6
|
+
* for resolving overlaps between "mobile-first" (`min-width`) and
|
|
7
|
+
* "desktop-first" (`max-width`) breakpoints.
|
|
8
|
+
*
|
|
9
|
+
* When switching between these variants we shift the opposite boundary
|
|
10
|
+
* by 1px to avoid cases when two ranges overlap at the exact same pixel.
|
|
11
|
+
*
|
|
12
|
+
* For example:
|
|
13
|
+
* - `min-width: 300px` includes 300px,
|
|
14
|
+
* - `max-width: 300px` also includes 300px,
|
|
15
|
+
* which causes an overlap. By shifting one of them by 1px we guarantee
|
|
16
|
+
* that a given pixel belongs to only one range.
|
|
17
|
+
*/
|
|
18
|
+
export const PREFERRED_VARIANT = 'DtF'; // DESKTOP_TO_FIRST
|
|
2
19
|
const HORIZONTAL_BREAKPOINTS = {
|
|
3
20
|
"xs": "320px",
|
|
4
21
|
"sm": "576px",
|
|
@@ -5,10 +5,39 @@ import React from "react";
|
|
|
5
5
|
import { TBreakpoint } from '../interfaces/TBreakpoint';
|
|
6
6
|
interface Props {
|
|
7
7
|
children: React.ReactNode;
|
|
8
|
-
}
|
|
9
|
-
interface ForComponentProps extends Props {
|
|
10
8
|
p: TBreakpoint | number;
|
|
11
9
|
}
|
|
12
|
-
|
|
13
|
-
|
|
10
|
+
interface BetweenProps {
|
|
11
|
+
children: React.ReactNode;
|
|
12
|
+
max: TBreakpoint | number;
|
|
13
|
+
min: TBreakpoint | number;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Renders children only when the current viewport matches
|
|
17
|
+
* the given breakpoint using the mobile-first ("MtF") strategy.
|
|
18
|
+
*
|
|
19
|
+
* Internally it uses {@link useBreakpoint} with variant "MtF".
|
|
20
|
+
*/
|
|
21
|
+
export declare function For({ children, p }: Props): import("react/jsx-runtime").JSX.Element | null;
|
|
22
|
+
/**
|
|
23
|
+
* Renders children only when the current viewport matches
|
|
24
|
+
* the given breakpoint using the desktop-first ("DtF") strategy.
|
|
25
|
+
*
|
|
26
|
+
* Internally it uses {@link useBreakpoint} with variant "DtF".
|
|
27
|
+
*/
|
|
28
|
+
export declare function Before({ children, p }: Props): import("react/jsx-runtime").JSX.Element | null;
|
|
29
|
+
/**
|
|
30
|
+
* Renders children only when the current viewport is between
|
|
31
|
+
* two breakpoints (`min` and `max`).
|
|
32
|
+
*
|
|
33
|
+
* This component is an optimized alternative to combining `For`
|
|
34
|
+
* and `Before` when their ranges would overlap at the same pixel
|
|
35
|
+
* (e.g. `min-width: 300px` and `max-width: 300px` both including 300px).
|
|
36
|
+
*
|
|
37
|
+
* Under the hood it uses {@link useBreakpointBetween}, which shifts
|
|
38
|
+
* one of the boundaries by 1px depending on the preferred adaptive
|
|
39
|
+
* variant (see {@link PREFERRED_VARIANT}) to guarantee that a given
|
|
40
|
+
* pixel belongs to only one logical range.
|
|
41
|
+
*/
|
|
42
|
+
export declare function Between({ children, min, max }: BetweenProps): import("react/jsx-runtime").JSX.Element | null;
|
|
14
43
|
export {};
|
|
@@ -3,15 +3,46 @@ import { jsx as _jsx } from "react/jsx-runtime";
|
|
|
3
3
|
* Created by westp on 15.05.2023
|
|
4
4
|
*/
|
|
5
5
|
import { Fragment } from "react";
|
|
6
|
-
import {
|
|
6
|
+
import { useBreakpoint, useBreakpointBetween } from '../hooks/useBreakpoint';
|
|
7
|
+
/**
|
|
8
|
+
* Renders children only when the current viewport matches
|
|
9
|
+
* the given breakpoint using the mobile-first ("MtF") strategy.
|
|
10
|
+
*
|
|
11
|
+
* Internally it uses {@link useBreakpoint} with variant "MtF".
|
|
12
|
+
*/
|
|
7
13
|
export function For({ children, p }) {
|
|
8
|
-
const is =
|
|
14
|
+
const is = useBreakpoint(p, 'MtF');
|
|
9
15
|
if (is)
|
|
10
16
|
return _jsx(Fragment, { children: children });
|
|
11
17
|
return null;
|
|
12
18
|
}
|
|
19
|
+
/**
|
|
20
|
+
* Renders children only when the current viewport matches
|
|
21
|
+
* the given breakpoint using the desktop-first ("DtF") strategy.
|
|
22
|
+
*
|
|
23
|
+
* Internally it uses {@link useBreakpoint} with variant "DtF".
|
|
24
|
+
*/
|
|
13
25
|
export function Before({ children, p }) {
|
|
14
|
-
const is =
|
|
26
|
+
const is = useBreakpoint(p, 'DtF');
|
|
27
|
+
if (is)
|
|
28
|
+
return _jsx(Fragment, { children: children });
|
|
29
|
+
return null;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Renders children only when the current viewport is between
|
|
33
|
+
* two breakpoints (`min` and `max`).
|
|
34
|
+
*
|
|
35
|
+
* This component is an optimized alternative to combining `For`
|
|
36
|
+
* and `Before` when their ranges would overlap at the same pixel
|
|
37
|
+
* (e.g. `min-width: 300px` and `max-width: 300px` both including 300px).
|
|
38
|
+
*
|
|
39
|
+
* Under the hood it uses {@link useBreakpointBetween}, which shifts
|
|
40
|
+
* one of the boundaries by 1px depending on the preferred adaptive
|
|
41
|
+
* variant (see {@link PREFERRED_VARIANT}) to guarantee that a given
|
|
42
|
+
* pixel belongs to only one logical range.
|
|
43
|
+
*/
|
|
44
|
+
export function Between({ children, min, max }) {
|
|
45
|
+
const is = useBreakpointBetween(min, max);
|
|
15
46
|
if (is)
|
|
16
47
|
return _jsx(Fragment, { children: children });
|
|
17
48
|
return null;
|
package/dist/default.config.d.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { TAdaptiveVariant } from "./interfaces/TAdaptiveVariant";
|
|
2
|
+
declare const PREFERRED_VARIANT: TAdaptiveVariant;
|
|
1
3
|
declare const HORIZONTAL_BREAKPOINTS: Record<string, string>;
|
|
2
4
|
declare const VERTICAL_BREAKPOINTS: Record<string, string>;
|
|
3
|
-
export { HORIZONTAL_BREAKPOINTS, VERTICAL_BREAKPOINTS };
|
|
5
|
+
export { HORIZONTAL_BREAKPOINTS, VERTICAL_BREAKPOINTS, PREFERRED_VARIANT };
|
package/dist/default.config.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
// breakpointConfig.js
|
|
2
|
+
const PREFERRED_VARIANT = 'DtF'; // DESKTOP_TO_FIRST
|
|
2
3
|
const HORIZONTAL_BREAKPOINTS = {
|
|
3
4
|
xs: '320px',
|
|
4
5
|
sm: '576px',
|
|
@@ -19,4 +20,4 @@ const VERTICAL_BREAKPOINTS = {
|
|
|
19
20
|
xl: '1600px',
|
|
20
21
|
xxl: '1601px',
|
|
21
22
|
};
|
|
22
|
-
export { HORIZONTAL_BREAKPOINTS, VERTICAL_BREAKPOINTS };
|
|
23
|
+
export { HORIZONTAL_BREAKPOINTS, VERTICAL_BREAKPOINTS, PREFERRED_VARIANT };
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
import { TBreakpoint, TVerticalBreakpoint } from '../interfaces/TBreakpoint.js';
|
|
2
|
-
export
|
|
2
|
+
export declare function getBreakpoint(b: TBreakpoint): string;
|
|
3
3
|
export declare function getVBreakpoint(b: TVerticalBreakpoint): string;
|
|
@@ -1,5 +1,53 @@
|
|
|
1
|
-
import { TBreakpoint } from '../interfaces/TBreakpoint
|
|
2
|
-
import { TAdaptiveVariant } from '../interfaces/TAdaptiveVariant
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
import { TBreakpoint } from '../interfaces/TBreakpoint';
|
|
2
|
+
import { TAdaptiveVariant } from '../interfaces/TAdaptiveVariant';
|
|
3
|
+
/**
|
|
4
|
+
* Low-level hook that checks if the current viewport matches a horizontal breakpoint.
|
|
5
|
+
*
|
|
6
|
+
* It supports:
|
|
7
|
+
* - named breakpoints (e.g. "md", "lg"),
|
|
8
|
+
* - custom numeric pixel values (e.g. 768).
|
|
9
|
+
*
|
|
10
|
+
* The check is performed using `react-responsive` and the current adaptive variant:
|
|
11
|
+
* - for mobile-first (MtF) the hook uses `min-width`,
|
|
12
|
+
* - for desktop-first (DtF) the hook uses `max-width`.
|
|
13
|
+
*
|
|
14
|
+
* To avoid overlap between opposite variants (e.g. `min-width: 300px` and
|
|
15
|
+
* `max-width: 300px` both including 300px), the hook shifts the opposite
|
|
16
|
+
* boundary by 1px when the requested variant differs from `PREFERRED_VARIANT`.
|
|
17
|
+
*
|
|
18
|
+
* @param b Breakpoint name or explicit pixel value.
|
|
19
|
+
* @param variant Adaptive variant: "MtF" (mobile to first) or "DtF" (desktop to first).
|
|
20
|
+
* By default, uses {@link PREFERRED_VARIANT}.
|
|
21
|
+
* @returns `true` if the media query matches, otherwise `false` or `null`
|
|
22
|
+
* (depending on `react-responsive` behavior).
|
|
23
|
+
*/
|
|
24
|
+
export declare function useBreakpoint(b: TBreakpoint | number, variant?: TAdaptiveVariant): boolean | null;
|
|
25
|
+
/**
|
|
26
|
+
* Optimized hook for checking if the current viewport is between two breakpoints.
|
|
27
|
+
*
|
|
28
|
+
* This hook is designed as a safe alternative to using a combination of
|
|
29
|
+
* `For` (mobile-first) and `Before` (desktop-first) when their ranges would
|
|
30
|
+
* otherwise overlap.
|
|
31
|
+
*
|
|
32
|
+
* Example of the overlap problem:
|
|
33
|
+
* - `min-width: 300px` includes 300px,
|
|
34
|
+
* - `max-width: 300px` also includes 300px,
|
|
35
|
+
* so both conditions are `true` at exactly 300px.
|
|
36
|
+
*
|
|
37
|
+
* To prevent this, {@link useBreakpointBetween} automatically shifts the
|
|
38
|
+
* opposite boundary by 1px depending on the adaptive variant:
|
|
39
|
+
*
|
|
40
|
+
* - preferredVariant === "MtF":
|
|
41
|
+
* max = max - 1 (so the upper bound becomes exclusive by 1px),
|
|
42
|
+
* - preferredVariant === "DtF":
|
|
43
|
+
* min = min - 1 (so the lower bound becomes exclusive by 1px),
|
|
44
|
+
*
|
|
45
|
+
* ensuring that a particular pixel belongs to only one logical range.
|
|
46
|
+
*
|
|
47
|
+
* @param min Lower breakpoint (inclusive in the original definition).
|
|
48
|
+
* @param max Upper breakpoint (inclusive in the original definition).
|
|
49
|
+
* @param preferredVariant Adaptive variant used to resolve the 1px overlap.
|
|
50
|
+
* By default, uses {@link PREFERRED_VARIANT}.
|
|
51
|
+
* @returns `true` if the viewport width is within the adjusted [min, max] range.
|
|
52
|
+
*/
|
|
53
|
+
export declare function useBreakpointBetween(min: TBreakpoint | number, max: TBreakpoint | number, preferredVariant?: TAdaptiveVariant): boolean;
|
|
@@ -1,14 +1,73 @@
|
|
|
1
1
|
import { useMediaQuery } from 'react-responsive';
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
import { PREFERRED_VARIANT } from '../breakpoints.config';
|
|
3
|
+
import useVariant from './useVariant';
|
|
4
|
+
import { getBreakpoint } from "../functions/getBreakpoint";
|
|
5
|
+
/**
|
|
6
|
+
* Low-level hook that checks if the current viewport matches a horizontal breakpoint.
|
|
7
|
+
*
|
|
8
|
+
* It supports:
|
|
9
|
+
* - named breakpoints (e.g. "md", "lg"),
|
|
10
|
+
* - custom numeric pixel values (e.g. 768).
|
|
11
|
+
*
|
|
12
|
+
* The check is performed using `react-responsive` and the current adaptive variant:
|
|
13
|
+
* - for mobile-first (MtF) the hook uses `min-width`,
|
|
14
|
+
* - for desktop-first (DtF) the hook uses `max-width`.
|
|
15
|
+
*
|
|
16
|
+
* To avoid overlap between opposite variants (e.g. `min-width: 300px` and
|
|
17
|
+
* `max-width: 300px` both including 300px), the hook shifts the opposite
|
|
18
|
+
* boundary by 1px when the requested variant differs from `PREFERRED_VARIANT`.
|
|
19
|
+
*
|
|
20
|
+
* @param b Breakpoint name or explicit pixel value.
|
|
21
|
+
* @param variant Adaptive variant: "MtF" (mobile to first) or "DtF" (desktop to first).
|
|
22
|
+
* By default, uses {@link PREFERRED_VARIANT}.
|
|
23
|
+
* @returns `true` if the media query matches, otherwise `false` or `null`
|
|
24
|
+
* (depending on `react-responsive` behavior).
|
|
25
|
+
*/
|
|
26
|
+
export function useBreakpoint(b, variant = PREFERRED_VARIANT) {
|
|
27
|
+
let _bp = typeof b === 'number' ? b : +getBreakpoint(b);
|
|
6
28
|
const v = useVariant(variant);
|
|
7
|
-
|
|
29
|
+
if (variant !== PREFERRED_VARIANT)
|
|
30
|
+
_bp = _bp - 1;
|
|
31
|
+
return useMediaQuery({ query: `(${v}-width: ${_bp}px)` });
|
|
8
32
|
}
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
33
|
+
/**
|
|
34
|
+
* Optimized hook for checking if the current viewport is between two breakpoints.
|
|
35
|
+
*
|
|
36
|
+
* This hook is designed as a safe alternative to using a combination of
|
|
37
|
+
* `For` (mobile-first) and `Before` (desktop-first) when their ranges would
|
|
38
|
+
* otherwise overlap.
|
|
39
|
+
*
|
|
40
|
+
* Example of the overlap problem:
|
|
41
|
+
* - `min-width: 300px` includes 300px,
|
|
42
|
+
* - `max-width: 300px` also includes 300px,
|
|
43
|
+
* so both conditions are `true` at exactly 300px.
|
|
44
|
+
*
|
|
45
|
+
* To prevent this, {@link useBreakpointBetween} automatically shifts the
|
|
46
|
+
* opposite boundary by 1px depending on the adaptive variant:
|
|
47
|
+
*
|
|
48
|
+
* - preferredVariant === "MtF":
|
|
49
|
+
* max = max - 1 (so the upper bound becomes exclusive by 1px),
|
|
50
|
+
* - preferredVariant === "DtF":
|
|
51
|
+
* min = min - 1 (so the lower bound becomes exclusive by 1px),
|
|
52
|
+
*
|
|
53
|
+
* ensuring that a particular pixel belongs to only one logical range.
|
|
54
|
+
*
|
|
55
|
+
* @param min Lower breakpoint (inclusive in the original definition).
|
|
56
|
+
* @param max Upper breakpoint (inclusive in the original definition).
|
|
57
|
+
* @param preferredVariant Adaptive variant used to resolve the 1px overlap.
|
|
58
|
+
* By default, uses {@link PREFERRED_VARIANT}.
|
|
59
|
+
* @returns `true` if the viewport width is within the adjusted [min, max] range.
|
|
60
|
+
*/
|
|
61
|
+
export function useBreakpointBetween(min, max, preferredVariant = PREFERRED_VARIANT) {
|
|
62
|
+
let _min = typeof min === 'number' ? min : +getBreakpoint(min);
|
|
63
|
+
let _max = typeof max === 'number' ? max : +getBreakpoint(max);
|
|
64
|
+
switch (preferredVariant) {
|
|
65
|
+
case 'MtF':
|
|
66
|
+
_max = _max - 1;
|
|
67
|
+
break;
|
|
68
|
+
case 'DtF':
|
|
69
|
+
_min = _min - 1;
|
|
70
|
+
break;
|
|
71
|
+
}
|
|
72
|
+
return useMediaQuery({ minWidth: _min, maxWidth: _max });
|
|
14
73
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { render } from '@testing-library/react';
|
|
3
|
+
import { useBreakpoint, useBreakpointBetween } from './useBreakpoint';
|
|
4
|
+
// Mock external dependencies
|
|
5
|
+
jest.mock('react-responsive', () => ({
|
|
6
|
+
useMediaQuery: jest.fn(),
|
|
7
|
+
}));
|
|
8
|
+
jest.mock('./useVariant', () => ({
|
|
9
|
+
__esModule: true,
|
|
10
|
+
default: jest.fn(),
|
|
11
|
+
}));
|
|
12
|
+
jest.mock('../functions/getBreakpoint', () => ({
|
|
13
|
+
__esModule: true,
|
|
14
|
+
getBreakpoint: jest.fn(),
|
|
15
|
+
}));
|
|
16
|
+
jest.mock('../breakpoints.config', () => ({
|
|
17
|
+
__esModule: true,
|
|
18
|
+
PREFERRED_VARIANT: 'MtF', // adjust to your real preferred variant if needed
|
|
19
|
+
}));
|
|
20
|
+
import { useMediaQuery } from 'react-responsive';
|
|
21
|
+
import useVariant from './useVariant';
|
|
22
|
+
import { getBreakpoint } from '../functions/getBreakpoint';
|
|
23
|
+
import { PREFERRED_VARIANT } from '../breakpoints.config';
|
|
24
|
+
const mockedUseMediaQuery = useMediaQuery;
|
|
25
|
+
const mockedUseVariant = useVariant;
|
|
26
|
+
const mockedGetBreakpoint = getBreakpoint;
|
|
27
|
+
// Small test components to use hooks inside React
|
|
28
|
+
function BreakpointTestComponent(props) {
|
|
29
|
+
const value = useBreakpoint(props.b, props.variant);
|
|
30
|
+
return _jsx("div", { "data-testid": "value", children: String(value) });
|
|
31
|
+
}
|
|
32
|
+
function BreakpointBetweenTestComponent(props) {
|
|
33
|
+
const value = useBreakpointBetween(props.min, props.max, props.preferredVariant);
|
|
34
|
+
return _jsx("div", { "data-testid": "value", children: String(value) });
|
|
35
|
+
}
|
|
36
|
+
describe('useBreakpoint', () => {
|
|
37
|
+
beforeEach(() => {
|
|
38
|
+
jest.clearAllMocks();
|
|
39
|
+
mockedUseVariant.mockReturnValue('min');
|
|
40
|
+
});
|
|
41
|
+
it('should call useMediaQuery with numeric breakpoint as-is when variant === PREFERRED_VARIANT', () => {
|
|
42
|
+
mockedUseMediaQuery.mockReturnValue(true);
|
|
43
|
+
const { getByTestId } = render(_jsx(BreakpointTestComponent, { b: 768, variant: PREFERRED_VARIANT }));
|
|
44
|
+
expect(mockedUseVariant).toHaveBeenCalledWith(PREFERRED_VARIANT);
|
|
45
|
+
expect(mockedUseMediaQuery).toHaveBeenCalledWith({
|
|
46
|
+
query: '(min-width: 768px)',
|
|
47
|
+
});
|
|
48
|
+
expect(getByTestId('value').textContent).toBe('true');
|
|
49
|
+
});
|
|
50
|
+
it('should convert named breakpoint using getBreakpoint', () => {
|
|
51
|
+
mockedGetBreakpoint.mockReturnValue('1024');
|
|
52
|
+
mockedUseMediaQuery.mockReturnValue(false);
|
|
53
|
+
const { getByTestId } = render(_jsx(BreakpointTestComponent, { b: 'lg', variant: PREFERRED_VARIANT }));
|
|
54
|
+
expect(mockedGetBreakpoint).toHaveBeenCalledWith('lg');
|
|
55
|
+
expect(mockedUseMediaQuery).toHaveBeenCalledWith({
|
|
56
|
+
query: '(min-width: 1024px)',
|
|
57
|
+
});
|
|
58
|
+
expect(getByTestId('value').textContent).toBe('false');
|
|
59
|
+
});
|
|
60
|
+
it('should decrease breakpoint by 1px when variant !== PREFERRED_VARIANT (numeric)', () => {
|
|
61
|
+
mockedUseVariant.mockReturnValue('max');
|
|
62
|
+
mockedUseMediaQuery.mockReturnValue(true);
|
|
63
|
+
const { getByTestId } = render(_jsx(BreakpointTestComponent, { b: 500, variant: 'DtF' }));
|
|
64
|
+
expect(mockedUseVariant).toHaveBeenCalledWith('DtF');
|
|
65
|
+
expect(mockedUseMediaQuery).toHaveBeenCalledWith({
|
|
66
|
+
query: '(max-width: 499px)',
|
|
67
|
+
});
|
|
68
|
+
expect(getByTestId('value').textContent).toBe('true');
|
|
69
|
+
});
|
|
70
|
+
it('should also decrease named breakpoint by 1px when variant !== PREFERRED_VARIANT', () => {
|
|
71
|
+
mockedGetBreakpoint.mockReturnValue('600');
|
|
72
|
+
mockedUseVariant.mockReturnValue('max');
|
|
73
|
+
mockedUseMediaQuery.mockReturnValue(false);
|
|
74
|
+
const { getByTestId } = render(_jsx(BreakpointTestComponent, { b: 'md', variant: 'DtF' }));
|
|
75
|
+
expect(mockedGetBreakpoint).toHaveBeenCalledWith('md');
|
|
76
|
+
expect(mockedUseMediaQuery).toHaveBeenCalledWith({
|
|
77
|
+
query: '(max-width: 599px)',
|
|
78
|
+
});
|
|
79
|
+
expect(getByTestId('value').textContent).toBe('false');
|
|
80
|
+
});
|
|
81
|
+
});
|
|
82
|
+
describe('useBreakpointBetween', () => {
|
|
83
|
+
beforeEach(() => {
|
|
84
|
+
jest.clearAllMocks();
|
|
85
|
+
});
|
|
86
|
+
it('should use min and max as-is when preferredVariant === PREFERRED_VARIANT (numeric)', () => {
|
|
87
|
+
mockedUseMediaQuery.mockReturnValue(true);
|
|
88
|
+
const { getByTestId } = render(_jsx(BreakpointBetweenTestComponent, { min: 320, max: 768, preferredVariant: PREFERRED_VARIANT }));
|
|
89
|
+
expect(mockedUseMediaQuery).toHaveBeenCalledWith({
|
|
90
|
+
minWidth: 320,
|
|
91
|
+
maxWidth: 767, // 768 - 1 because PREFERRED_VARIANT === 'MtF'
|
|
92
|
+
});
|
|
93
|
+
expect(getByTestId('value').textContent).toBe('true');
|
|
94
|
+
});
|
|
95
|
+
it('should convert named min and max via getBreakpoint when preferredVariant === PREFERRED_VARIANT', () => {
|
|
96
|
+
mockedGetBreakpoint
|
|
97
|
+
.mockReturnValueOnce('320') // for min
|
|
98
|
+
.mockReturnValueOnce('768'); // for max
|
|
99
|
+
mockedUseMediaQuery.mockReturnValue(false);
|
|
100
|
+
const { getByTestId } = render(_jsx(BreakpointBetweenTestComponent, { min: 'sm', max: 'md', preferredVariant: PREFERRED_VARIANT }));
|
|
101
|
+
expect(mockedGetBreakpoint).toHaveBeenNthCalledWith(1, 'sm');
|
|
102
|
+
expect(mockedGetBreakpoint).toHaveBeenNthCalledWith(2, 'md');
|
|
103
|
+
expect(mockedUseMediaQuery).toHaveBeenCalledWith({
|
|
104
|
+
minWidth: 320,
|
|
105
|
+
maxWidth: 767, // 768 - 1 because PREFERRED_VARIANT === 'MtF'
|
|
106
|
+
});
|
|
107
|
+
expect(getByTestId('value').textContent).toBe('false');
|
|
108
|
+
});
|
|
109
|
+
it('for preferredVariant === "MtF" should decrease max by 1px', () => {
|
|
110
|
+
mockedUseMediaQuery.mockReturnValue(true);
|
|
111
|
+
const { getByTestId } = render(_jsx(BreakpointBetweenTestComponent, { min: 320, max: 768, preferredVariant: 'MtF' }));
|
|
112
|
+
expect(mockedUseMediaQuery).toHaveBeenCalledWith({
|
|
113
|
+
minWidth: 320,
|
|
114
|
+
maxWidth: 767,
|
|
115
|
+
});
|
|
116
|
+
expect(getByTestId('value').textContent).toBe('true');
|
|
117
|
+
});
|
|
118
|
+
it('for preferredVariant === "DtF" should decrease min by 1px', () => {
|
|
119
|
+
mockedUseMediaQuery.mockReturnValue(false);
|
|
120
|
+
const { getByTestId } = render(_jsx(BreakpointBetweenTestComponent, { min: 320, max: 768, preferredVariant: 'DtF' }));
|
|
121
|
+
expect(mockedUseMediaQuery).toHaveBeenCalledWith({
|
|
122
|
+
minWidth: 319,
|
|
123
|
+
maxWidth: 768,
|
|
124
|
+
});
|
|
125
|
+
expect(getByTestId('value').textContent).toBe('false');
|
|
126
|
+
});
|
|
127
|
+
it('MtF + named values: should decrease max after getBreakpoint', () => {
|
|
128
|
+
mockedGetBreakpoint
|
|
129
|
+
.mockReturnValueOnce('400') // min
|
|
130
|
+
.mockReturnValueOnce('900'); // max
|
|
131
|
+
mockedUseMediaQuery.mockReturnValue(true);
|
|
132
|
+
const { getByTestId } = render(_jsx(BreakpointBetweenTestComponent, { min: 'sm', max: 'xl', preferredVariant: 'MtF' }));
|
|
133
|
+
expect(mockedGetBreakpoint).toHaveBeenNthCalledWith(1, 'sm');
|
|
134
|
+
expect(mockedGetBreakpoint).toHaveBeenNthCalledWith(2, 'xl');
|
|
135
|
+
expect(mockedUseMediaQuery).toHaveBeenCalledWith({
|
|
136
|
+
minWidth: 400,
|
|
137
|
+
maxWidth: 899,
|
|
138
|
+
});
|
|
139
|
+
expect(getByTestId('value').textContent).toBe('true');
|
|
140
|
+
});
|
|
141
|
+
it('DtF + named values: should decrease min after getBreakpoint', () => {
|
|
142
|
+
mockedGetBreakpoint
|
|
143
|
+
.mockReturnValueOnce('400') // min
|
|
144
|
+
.mockReturnValueOnce('900'); // max
|
|
145
|
+
mockedUseMediaQuery.mockReturnValue(false);
|
|
146
|
+
const { getByTestId } = render(_jsx(BreakpointBetweenTestComponent, { min: 'sm', max: 'xl', preferredVariant: 'DtF' }));
|
|
147
|
+
expect(mockedUseMediaQuery).toHaveBeenCalledWith({
|
|
148
|
+
minWidth: 399,
|
|
149
|
+
maxWidth: 900,
|
|
150
|
+
});
|
|
151
|
+
expect(getByTestId('value').textContent).toBe('false');
|
|
152
|
+
});
|
|
153
|
+
});
|
|
@@ -1,5 +1,3 @@
|
|
|
1
1
|
import { TVerticalBreakpoint } from '../interfaces/TBreakpoint';
|
|
2
2
|
import { TAdaptiveVariant } from '../interfaces/TAdaptiveVariant';
|
|
3
|
-
export
|
|
4
|
-
export declare function useVBreakpointMF(b: TVerticalBreakpoint | number): boolean;
|
|
5
|
-
export declare function useVBreakpointDF(b: TVerticalBreakpoint | number): boolean;
|
|
3
|
+
export declare function useVBreakpoint(b: TVerticalBreakpoint | number, variant?: TAdaptiveVariant): boolean;
|
|
@@ -1,14 +1,8 @@
|
|
|
1
1
|
import { useMediaQuery } from 'react-responsive';
|
|
2
2
|
import useVariant from './useVariant.js';
|
|
3
3
|
import { getVBreakpoint } from "../functions/getBreakpoint.js";
|
|
4
|
-
export
|
|
4
|
+
export function useVBreakpoint(b, variant = 'MtF') {
|
|
5
5
|
const _bp = typeof b === 'number' ? b + 'px' : getVBreakpoint(b);
|
|
6
6
|
const v = useVariant(variant);
|
|
7
7
|
return useMediaQuery({ query: `(${v}-height: ${_bp})` });
|
|
8
8
|
}
|
|
9
|
-
export function useVBreakpointMF(b) {
|
|
10
|
-
return useVBreakpoint(b, 'MtF');
|
|
11
|
-
}
|
|
12
|
-
export function useVBreakpointDF(b) {
|
|
13
|
-
return useVBreakpoint(b, 'DtF');
|
|
14
|
-
}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { TBreakpoint, TVerticalBreakpoint } from './interfaces/TBreakpoint';
|
|
2
2
|
import { TBreakpoints, TVerticalBreakpoints } from './interfaces/TBreakpoints';
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
import { useBreakpointBetween, useBreakpoint } from './hooks/useBreakpoint.js';
|
|
4
|
+
import { useVBreakpoint } from './hooks/useVBreakpoint.js';
|
|
5
|
+
import { getBreakpoint, getVBreakpoint } from './functions/getBreakpoint.js';
|
|
5
6
|
export type { TBreakpoints, TBreakpoint, TVerticalBreakpoint, TVerticalBreakpoints, };
|
|
7
|
+
export { useBreakpointBetween, useBreakpoint, useVBreakpoint, getBreakpoint, getVBreakpoint, };
|
|
6
8
|
export * from './components/horizontal.js';
|
package/dist/index.js
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
import { useBreakpointBetween, useBreakpoint } from './hooks/useBreakpoint.js';
|
|
2
|
+
import { useVBreakpoint } from './hooks/useVBreakpoint.js';
|
|
3
|
+
import { getBreakpoint, getVBreakpoint } from './functions/getBreakpoint.js';
|
|
4
|
+
export { useBreakpointBetween, useBreakpoint, useVBreakpoint, getBreakpoint, getVBreakpoint, };
|
|
3
5
|
export * from './components/horizontal.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import o from"fs";import n from"path";import{fileURLToPath as e}from"url";import{HORIZONTAL_BREAKPOINTS as r,VERTICAL_BREAKPOINTS as i}from"../default.config.js";const
|
|
1
|
+
import o from"fs";import n from"path";import{fileURLToPath as e}from"url";import{HORIZONTAL_BREAKPOINTS as r,VERTICAL_BREAKPOINTS as s,PREFERRED_VARIANT as i}from"../default.config.js";const l=e(import.meta.url),t=n.dirname(l),R=n.resolve(t,"../../../../breakpoints.config.js");(async()=>{let e=r,l=s,a=i;if(o.existsSync(R))try{console.log(`User config file found at: ${R}`);const o=await import(R);console.log(`Loaded user config: ${JSON.stringify(o,null,2)}`),o.HORIZONTAL_BREAKPOINTS?(e=o.HORIZONTAL_BREAKPOINTS,console.log("Using user provided horizontal breakpoints.")):console.log("Using default horizontal breakpoints."),o.VERTICAL_BREAKPOINTS?(l=o.VERTICAL_BREAKPOINTS,console.log("Using user provided vertical breakpoints.")):console.log("Using default vertical breakpoints."),o.PREFERRED_VARIANT?(a=o.PREFERRED_VARIANT,console.log("Using user provided preferred variant.")):console.log("Using default preferred variant.")}catch(o){console.error("Error loading user config:",o)}else console.log(`User config file not found at: ${R}. Using default breakpoints.`);const c=`\n // breakpoints.config.mjs\n const HORIZONTAL_BREAKPOINTS = ${JSON.stringify(e,null,2)};\n\n const VERTICAL_BREAKPOINTS = ${JSON.stringify(l,null,2)};\n\n const PREFERRED_VARIANT = ${JSON.stringify(a)};\n\n export { HORIZONTAL_BREAKPOINTS, VERTICAL_BREAKPOINTS, PREFERRED_VARIANT };\n `;try{o.writeFileSync(n.resolve(t,"../breakpoints.config.js"),c),console.log("Config file has been generated successfully.")}catch(o){console.error("Error writing merged config file:",o)}})();
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "react-responsive-tools",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.6.1",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.js",
|
|
@@ -43,11 +43,13 @@
|
|
|
43
43
|
"@babel/preset-env": "^7.25.4",
|
|
44
44
|
"@babel/preset-react": "^7.24.7",
|
|
45
45
|
"@babel/preset-typescript": "^7.24.7",
|
|
46
|
+
"@testing-library/dom": "^10.4.1",
|
|
46
47
|
"@testing-library/jest-dom": "^6.5.0",
|
|
47
48
|
"@testing-library/react": "^16.0.1",
|
|
48
49
|
"@testing-library/react-hooks": "^8.0.1",
|
|
49
50
|
"@types/jest": "^29.5.12",
|
|
50
51
|
"@types/node": "^22.5.4",
|
|
52
|
+
"@types/react": "^19.1.8",
|
|
51
53
|
"@types/react-dom": "^18.3.0",
|
|
52
54
|
"@typescript-eslint/eslint-plugin": "^8.5.0",
|
|
53
55
|
"@typescript-eslint/parser": "^8.5.0",
|
|
@@ -69,6 +71,7 @@
|
|
|
69
71
|
"glob": "^11.0.0",
|
|
70
72
|
"husky": "^9.1.5",
|
|
71
73
|
"jest": "^29.7.0",
|
|
74
|
+
"jest-environment-jsdom": "^30.2.0",
|
|
72
75
|
"react": "19.1.0",
|
|
73
76
|
"react-dom": "19.1.0",
|
|
74
77
|
"react-responsive": "^10.0.1",
|
|
@@ -83,10 +86,13 @@
|
|
|
83
86
|
"webpack": "^5.94.0",
|
|
84
87
|
"webpack-cli": "^5.1.4"
|
|
85
88
|
},
|
|
89
|
+
"resolutions": {
|
|
90
|
+
"string-width": "4.2.3",
|
|
91
|
+
"string-length": "4.0.2",
|
|
92
|
+
"strip-ansi": "6.0.1",
|
|
93
|
+
"wrap-ansi": "7.0.0"
|
|
94
|
+
},
|
|
86
95
|
"bin": {
|
|
87
96
|
"react-responsive-tools": "bin/react-responsive-tools.mjs"
|
|
88
|
-
},
|
|
89
|
-
"dependencies": {
|
|
90
|
-
"@types/react": "^19.1.8"
|
|
91
97
|
}
|
|
92
98
|
}
|