Skip to content

Commit 3ba5df8

Browse files
committed
0.5.0-b.1; improve d.ts & bump react peerdep
closes #17
1 parent 75f7ef2 commit 3ba5df8

File tree

3 files changed

+33
-14
lines changed

3 files changed

+33
-14
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# use-viewport-sizes #
22

3-
![npm](https://img.shields.io/npm/v/use-viewport-sizes.svg?color=blue) ![David](https://img.shields.io/david/rob2d/use-viewport-sizes.svg) ![npm](https://img.shields.io/npm/dw/use-viewport-sizes.svg?color=red) ![GitHub issues](https://img.shields.io/github/issues-raw/rob2d/use-viewport-sizes.svg) ![NPM](https://img.shields.io/npm/l/use-viewport-sizes.svg)
3+
![npm](https://img.shields.io/npm/v/use-viewport-sizes.svg?color=blue) ![npm](https://img.shields.io/npm/dw/use-viewport-sizes.svg?color=red) ![GitHub issues](https://img.shields.io/github/issues-raw/rob2d/use-viewport-sizes.svg) ![NPM](https://img.shields.io/npm/l/use-viewport-sizes.svg)
44

5-
a tiny React hook which allows you to track visible window viewport size in your components w/ an optional debounce and
6-
other flexible options for optimal usage.
5+
a tiny TS-compatible React hook which allows you to track visible window viewport size in your components w/ an optional debounce and other flexible options for optimal usage.
76

87
## Installation ##
98

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "use-viewport-sizes",
3-
"version": "0.4.0-beta.1",
3+
"version": "0.5.0-beta.1",
44
"description": "a tiny React hook which allows you to track visible window viewport size in your components w/ an optional debounce or custom memo function for updates for optimal rendering.",
55
"main": "./build/index.js",
66
"types": "./build/index.d.ts",
@@ -10,8 +10,8 @@
1010
"dev": "webpack-dev-server --env testServer --mode development --open",
1111
"prepublishOnly": "npm run build"
1212
},
13-
"peer Dependencies": {
14-
"react": "^16.8.6"
13+
"peerDependencies": {
14+
"react": "^16.8.6 || ^17.0.0 || ^18.0.0"
1515
},
1616
"devDependencies": {
1717
"@babel/cli": "^7.4.3",

src/index.d.ts

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,38 @@
11
declare module 'use-viewport-sizes' {
2-
export type VPSizesHasher = ({ vpW: number, vpH: number }) => String;
2+
export type VPSizesHasher = ({ vpW, vpH }: { vpW: number, vpH: number}) => String;
33
export type VPSizesOptions ={
44
debounceTimeout?: number,
55
hasher?: VPSizesHasher,
6-
dimension?: 'w'|'h'|'both' = 'both'
6+
dimension: 'both' | undefined
77
};
88

9+
export type VPSizeOptions ={
10+
debounceTimeout?: number,
11+
hasher?: VPSizesHasher,
12+
dimension?: 'w'|'h'
13+
};
14+
15+
/**
16+
* Hook which observes viewport dimensions. Returns [width, height] of
17+
* current visible viewport of app, or the specific dimension
18+
*/
19+
export default function(input:number|VPSizesOptions):([vpW: number, vpH: number, triggerResize: Function]);
20+
21+
/**
22+
* Hook which observes viewport dimensions. Returns [width, height] of
23+
* current visible viewport of app, or the specific dimension
24+
*/
25+
export default function(input: VPSizeOptions):([dimension: number, triggerResize:Function]);
26+
27+
/**
28+
* Hook which observes viewport dimensions. Returns [width, height] of
29+
* current visible viewport of app, or the specific dimension
30+
*/
31+
export default function(input:VPSizesHasher):([vpW: number, vpH: number, triggerResize: Function]);
32+
933
/**
1034
* Hook which observes viewport dimensions. Returns [width, height] of
1135
* current visible viewport of app, or the specific dimension
1236
*/
13-
export default function(
14-
input:number | VPSizesHasher | VPSizesOptions
15-
):([vpW: number, vpH: number, triggerResize: Function] |
16-
[dimension: number, triggerResize:Function]
17-
);
18-
}
37+
export default function():([vpW: number, vpH: number, triggerResize: Function]);
38+
}

0 commit comments

Comments
 (0)