|
1 |
| -interface Breakpoints { |
2 |
| - xs?: 0; |
3 |
| - sm: number; |
4 |
| - md?: number; |
5 |
| - lg: number; |
6 |
| - xl?: number; |
7 |
| -} |
8 |
| -interface BreakpointResults { |
9 |
| - xs?: boolean; |
10 |
| - sm: boolean; |
11 |
| - md?: boolean; |
12 |
| - lg: boolean; |
13 |
| - xl?: boolean; |
14 |
| - only: { |
15 |
| - xs?: boolean; |
16 |
| - sm: boolean; |
17 |
| - md?: boolean; |
18 |
| - lg: boolean; |
19 |
| - xl?: boolean; |
20 |
| - }; |
21 |
| - up: { |
22 |
| - xs?: true; |
23 |
| - sm: boolean; |
24 |
| - md?: boolean; |
25 |
| - lg: boolean; |
26 |
| - xl?: boolean; |
27 |
| - }; |
28 |
| - down: { |
29 |
| - xs?: boolean; |
30 |
| - sm: boolean; |
31 |
| - md?: boolean; |
32 |
| - lg: boolean; |
33 |
| - xl?: true; |
34 |
| - }; |
35 |
| - between: { |
36 |
| - xs?: { |
37 |
| - sm: boolean; |
38 |
| - md?: boolean; |
39 |
| - lg: boolean; |
40 |
| - xl?: true; |
41 |
| - }; |
42 |
| - sm: { |
43 |
| - md?: boolean; |
44 |
| - lg: boolean; |
45 |
| - xl?: boolean; |
46 |
| - }; |
47 |
| - md?: { |
48 |
| - lg: boolean; |
49 |
| - xl?: boolean; |
50 |
| - }; |
51 |
| - lg?: { |
52 |
| - xl: boolean; |
53 |
| - }; |
54 |
| - }; |
55 |
| -} |
56 |
| -/** |
57 |
| - * React hook for using window width breakpoints. |
58 |
| - * @param {Breakpoints} [breakpoints] - Set of window width breakpoints to be used |
59 |
| - * @param {0} [breakpoints.xs] - Lower bound of extra-small window widths, in pixels |
60 |
| - * @param {number} breakpoints.sm - Lower bound of small window widths, in pixels |
61 |
| - * @param {number} [breakpoints.md] - Lower bound of medium window widths, in pixels |
62 |
| - * @param {number} breakpoints.lg - Lower bound of large window widths, in pixels |
63 |
| - * @param {number} [breakpoints.xs] - Lower bound of extra-large window widths, in pixels |
64 |
| - * @returns {BreakpointResults} A full set of breakpoint queries and their boolean values |
65 |
| - */ |
66 |
| -export default function useWindowWidthBreakpoints(breakpoints?: Breakpoints): BreakpointResults; |
67 |
| -export {}; |
| 1 | +interface Breakpoints { |
| 2 | + xs?: 0; |
| 3 | + sm: number; |
| 4 | + md?: number; |
| 5 | + lg: number; |
| 6 | + xl?: number; |
| 7 | +} |
| 8 | +interface BreakpointResults { |
| 9 | + xs?: boolean; |
| 10 | + sm: boolean; |
| 11 | + md?: boolean; |
| 12 | + lg: boolean; |
| 13 | + xl?: boolean; |
| 14 | + only: { |
| 15 | + xs?: boolean; |
| 16 | + sm: boolean; |
| 17 | + md?: boolean; |
| 18 | + lg: boolean; |
| 19 | + xl?: boolean; |
| 20 | + }; |
| 21 | + up: { |
| 22 | + xs?: true; |
| 23 | + sm: boolean; |
| 24 | + md?: boolean; |
| 25 | + lg: boolean; |
| 26 | + xl?: boolean; |
| 27 | + }; |
| 28 | + down: { |
| 29 | + xs?: boolean; |
| 30 | + sm: boolean; |
| 31 | + md?: boolean; |
| 32 | + lg: boolean; |
| 33 | + xl?: true; |
| 34 | + }; |
| 35 | + between: { |
| 36 | + xs?: { |
| 37 | + sm: boolean; |
| 38 | + md?: boolean; |
| 39 | + lg: boolean; |
| 40 | + xl?: true; |
| 41 | + }; |
| 42 | + sm: { |
| 43 | + md?: boolean; |
| 44 | + lg: boolean; |
| 45 | + xl?: boolean; |
| 46 | + }; |
| 47 | + md?: { |
| 48 | + lg: boolean; |
| 49 | + xl?: boolean; |
| 50 | + }; |
| 51 | + lg?: { |
| 52 | + xl: boolean; |
| 53 | + }; |
| 54 | + }; |
| 55 | +} |
| 56 | +/** |
| 57 | + * React hook for using window width breakpoints. |
| 58 | + * @param {Breakpoints} [breakpoints] - Set of window width breakpoints to be used |
| 59 | + * @param {0} [breakpoints.xs] - Lower bound of extra-small window widths, in pixels |
| 60 | + * @param {number} breakpoints.sm - Lower bound of small window widths, in pixels |
| 61 | + * @param {number} [breakpoints.md] - Lower bound of medium window widths, in pixels |
| 62 | + * @param {number} breakpoints.lg - Lower bound of large window widths, in pixels |
| 63 | + * @param {number} [breakpoints.xs] - Lower bound of extra-large window widths, in pixels |
| 64 | + * @returns {BreakpointResults} A full set of breakpoint queries and their boolean values |
| 65 | + */ |
| 66 | +export default function useWindowWidthBreakpoints(breakpoints?: Breakpoints): BreakpointResults; |
| 67 | +export {}; |
0 commit comments