svelte-gestures - npm Package Compare versions

Comparing version 1.3.7 to 1.3.8

CHANGELOG.md

 # Changelog
 
+## 1.3.8
+
+Documentation added for how to use JSX types (used by language tools to recognize return types of functions returned by svelte HTML markup (on:action etc))
+
 ## 1.3.7
@@ -4,0 +8,0 @@

package.json

@@ -6,3 +6,3 @@ {
   "license": "MIT",
-  "version": "1.3.7",
+  "version": "1.3.8",
   "main": "dist/index.js",
@@ -9,0 +9,0 @@ "module": "dist/index.esm.js",

README.md

@@ -9,2 +9,15 @@ # svelte-gestures
 
+### Language tools types installation (optional)
+
+If you use Svelte language tools (Svelte for VS Code for instance) and you would appreciate seeing return types from svelte-gestures actions `<div on:swipe={fn} >` in your markup, add following line to your `global.d.ts` :
+
+`/// <reference types="svelte-gestures" />`
+
+if you use svelte kit, you already have a `global.d.ts` in `src` folder. Just add this line after
+`/// <reference types="@sveltejs/kit" />`
+
+It must be done this way as language tools use global types and regular npm package cannot expose global types as long as it is used by other package.
+
+## About
+
 It contains the most popular gestures: `pan`, `pinch`, `press`, `rotate`, `swipe`, `tap`. It also exposes generic event handling core, which can be extended for your own specific gesture implementation (see sourcecode how gestures are implemented).
@@ -11,0 +24,0 @@

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

Improved metrics

Total package byte prevSize

42619

increased by1.89%

Number of lines in readme file

313

increased by4.33%

No dependency changes