@quintenkasteel/useresize - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

 {
   "name": "@quintenkasteel/useresize",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "main": "./lib/index.js",
@@ -5,0 +5,0 @@ "scripts": {

README.md

 # Getting Started with UseSwipe
-A simple to use library that provides useSwipe hook for React that enables swipe gestures for touch screens.
+A simple to use library that provides useResize hook for React that returns the width and height of the screen and viewport.
 
 ## Usage
-  `import useSwipe from '@quintenkasteel/useswipe'`
+  `import useSwipe from '@quintenkasteel/useresize'`
 
-example without element
- `const swipe = useSwipe({})`
+ `const reSize = useResize()`
 
-example with element
- `const swipe = useSwipe(".header", true)`
 
 
-
-## Props
-    element: String
-  DOM element where the swipe is enabled. default value is body.
-
-    preventDefault: Bool
-  Prevent all default events when moving. for example scrolling.
-
-    onStart: () => {}
-  function that will be fired on start of moving. (not yet in)
-
-    onMove: () => {}
-  function that will be fired on every move. (not yet in)
-
-    onEnd: () => {}
-  function that will be fired on end of moving. (not yet in)
-
-    onCancel: () => {}
-  function that will be fired on cancel of moving. (not yet in)
-
 ## Return Values
-    direction: String
-  Get the current swiping direction in uppercase.   
-  one of: "RIGHT" | "LEFT" | "DOWN" | "UP" 
+    width: String
+  Get the width of the viewport in pixels.
 
-    distance: Number
-  Get the swiped amount in pixels.
+    height: Number
+  Get the height of the viewport in pixels.
 
-    startX: Number
-  Get the starting X position in pixels.
+    screenWidth: Number
+  Get the width of the screen. 
 
-    startY: Number
-  Get the starting Y position in pixels.
+    screenHeight: Number
+  Get the height of the screen. 
 
-    endX: Number
-  Get the end X position in pixels.
-
-    endY: Number
-  Get the end Y position in pixels.
-
-    startTime: Date
-  Get the date at the beginning of the swipe. 
-
-    elapsedTime: Number
-  Get the duration of the swipe in seconds. 
-
-    speed: Number
-  Get the speed of the swipe
-
-    isSwiping: Bool 
-  True when swiping. 

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

4592

decreased by-17.71%

Number of lines in readme file

24

decreased by-63.08%

No dependency changes