@os-design/use-prevent-default-event 1.0.0

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/LICENCE.md ADDED
@@ -0,0 +1 @@
1
+ Copyright (c) 2019-present, Ilya Ordin, all rights reserved
package/README.md ADDED
@@ -0,0 +1,15 @@
1
+ # @os-design/use-prevent-default-event [![NPM version](https://img.shields.io/npm/v/@os-design/use-prevent-default-event)](https://yarnpkg.com/package/@os-design/use-prevent-default-event) [![BundlePhobia](https://img.shields.io/bundlephobia/minzip/@os-design/use-prevent-default-event)](https://bundlephobia.com/result?p=@os-design/use-prevent-default-event)
2
+
3
+ Prevents the default action of the specified event.
4
+
5
+ ## Installation
6
+
7
+ Install the package using the following command:
8
+
9
+ ```
10
+ yarn add @os-design/use-prevent-default-event
11
+ ```
12
+
13
+ ---
14
+
15
+ See all the features in the [Storybook](https://os-team.gitlab.io/libs/os-design/).
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+
8
+ var _react = require("react");
9
+
10
+ var _useEvent = _interopRequireDefault(require("@os-design/use-event"));
11
+
12
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
13
+
14
+ function usePreventDefaultEvent(target, type) {
15
+ var enabled = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
16
+ var enabledRef = (0, _react.useRef)(enabled);
17
+ (0, _react.useEffect)(function () {
18
+ enabledRef.current = enabled;
19
+ }, [enabled]);
20
+ var prevent = (0, _react.useCallback)(function (e) {
21
+ if (!enabledRef.current) return;
22
+ e.preventDefault();
23
+ }, []);
24
+ (0, _useEvent["default"])(target, type, prevent, {
25
+ passive: false
26
+ });
27
+ }
28
+
29
+ var _default = usePreventDefaultEvent;
30
+ exports["default"] = _default;
31
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/index.ts"],"names":["usePreventDefaultEvent","target","type","enabled","enabledRef","current","prevent","e","preventDefault","passive"],"mappings":";;;;;;;AAAA;;AACA;;;;AAEA,SAASA,sBAAT,CACEC,MADF,EAEEC,IAFF,EAIE;AAAA,MADAC,OACA,uEADU,IACV;AACA,MAAMC,UAAU,GAAG,mBAAOD,OAAP,CAAnB;AACA,wBAAU,YAAM;AACdC,IAAAA,UAAU,CAACC,OAAX,GAAqBF,OAArB;AACD,GAFD,EAEG,CAACA,OAAD,CAFH;AAIA,MAAMG,OAAO,GAAG,wBAAY,UAACC,CAAD,EAAc;AACxC,QAAI,CAACH,UAAU,CAACC,OAAhB,EAAyB;AACzBE,IAAAA,CAAC,CAACC,cAAF;AACD,GAHe,EAGb,EAHa,CAAhB;AAKA,4BAASP,MAAT,EAAiBC,IAAjB,EAAuBI,OAAvB,EAAgC;AAAEG,IAAAA,OAAO,EAAE;AAAX,GAAhC;AACD;;eAEcT,sB","sourcesContent":["import { RefObject, useCallback, useEffect, useRef } from 'react';\nimport useEvent from '@os-design/use-event';\n\nfunction usePreventDefaultEvent<K extends keyof HTMLElementEventMap>(\n target: EventTarget | RefObject<EventTarget>,\n type: K,\n enabled = true\n) {\n const enabledRef = useRef(enabled);\n useEffect(() => {\n enabledRef.current = enabled;\n }, [enabled]);\n\n const prevent = useCallback((e: Event) => {\n if (!enabledRef.current) return;\n e.preventDefault();\n }, []);\n\n useEvent(target, type, prevent, { passive: false });\n}\n\nexport default usePreventDefaultEvent;\n"],"file":"index.js"}
@@ -0,0 +1,19 @@
1
+ import { useCallback, useEffect, useRef } from 'react';
2
+ import useEvent from '@os-design/use-event';
3
+
4
+ function usePreventDefaultEvent(target, type, enabled = true) {
5
+ const enabledRef = useRef(enabled);
6
+ useEffect(() => {
7
+ enabledRef.current = enabled;
8
+ }, [enabled]);
9
+ const prevent = useCallback(e => {
10
+ if (!enabledRef.current) return;
11
+ e.preventDefault();
12
+ }, []);
13
+ useEvent(target, type, prevent, {
14
+ passive: false
15
+ });
16
+ }
17
+
18
+ export default usePreventDefaultEvent;
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/index.ts"],"names":["useCallback","useEffect","useRef","useEvent","usePreventDefaultEvent","target","type","enabled","enabledRef","current","prevent","e","preventDefault","passive"],"mappings":"AAAA,SAAoBA,WAApB,EAAiCC,SAAjC,EAA4CC,MAA5C,QAA0D,OAA1D;AACA,OAAOC,QAAP,MAAqB,sBAArB;;AAEA,SAASC,sBAAT,CACEC,MADF,EAEEC,IAFF,EAGEC,OAAO,GAAG,IAHZ,EAIE;AACA,QAAMC,UAAU,GAAGN,MAAM,CAACK,OAAD,CAAzB;AACAN,EAAAA,SAAS,CAAC,MAAM;AACdO,IAAAA,UAAU,CAACC,OAAX,GAAqBF,OAArB;AACD,GAFQ,EAEN,CAACA,OAAD,CAFM,CAAT;AAIA,QAAMG,OAAO,GAAGV,WAAW,CAAEW,CAAD,IAAc;AACxC,QAAI,CAACH,UAAU,CAACC,OAAhB,EAAyB;AACzBE,IAAAA,CAAC,CAACC,cAAF;AACD,GAH0B,EAGxB,EAHwB,CAA3B;AAKAT,EAAAA,QAAQ,CAACE,MAAD,EAASC,IAAT,EAAeI,OAAf,EAAwB;AAAEG,IAAAA,OAAO,EAAE;AAAX,GAAxB,CAAR;AACD;;AAED,eAAeT,sBAAf","sourcesContent":["import { RefObject, useCallback, useEffect, useRef } from 'react';\nimport useEvent from '@os-design/use-event';\n\nfunction usePreventDefaultEvent<K extends keyof HTMLElementEventMap>(\n target: EventTarget | RefObject<EventTarget>,\n type: K,\n enabled = true\n) {\n const enabledRef = useRef(enabled);\n useEffect(() => {\n enabledRef.current = enabled;\n }, [enabled]);\n\n const prevent = useCallback((e: Event) => {\n if (!enabledRef.current) return;\n e.preventDefault();\n }, []);\n\n useEvent(target, type, prevent, { passive: false });\n}\n\nexport default usePreventDefaultEvent;\n"],"file":"index.js"}
@@ -0,0 +1,4 @@
1
+ import { RefObject } from 'react';
2
+ declare function usePreventDefaultEvent<K extends keyof HTMLElementEventMap>(target: EventTarget | RefObject<EventTarget>, type: K, enabled?: boolean): void;
3
+ export default usePreventDefaultEvent;
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAkC,MAAM,OAAO,CAAC;AAGlE,iBAAS,sBAAsB,CAAC,CAAC,SAAS,MAAM,mBAAmB,EACjE,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC,EAC5C,IAAI,EAAE,CAAC,EACP,OAAO,UAAO,QAaf;AAED,eAAe,sBAAsB,CAAC"}
package/package.json ADDED
@@ -0,0 +1,37 @@
1
+ {
2
+ "name": "@os-design/use-prevent-default-event",
3
+ "version": "1.0.0",
4
+ "license": "UNLICENSED",
5
+ "repository": "git@gitlab.com:os-team/libs/os-design.git",
6
+ "main": "dist/cjs/index.js",
7
+ "module": "dist/esm/index.js",
8
+ "types": "dist/types/index.d.ts",
9
+ "exports": {
10
+ ".": {
11
+ "require": "./dist/cjs/index.js",
12
+ "default": "./dist/esm/index.js"
13
+ }
14
+ },
15
+ "files": [
16
+ "dist"
17
+ ],
18
+ "sideEffects": false,
19
+ "scripts": {
20
+ "clean": "rimraf dist",
21
+ "build:esm": "cross-env BABEL_ENV=esm babel src --root-mode upward --extensions .ts,.tsx --out-dir dist/esm --source-maps",
22
+ "build:cjs": "cross-env BABEL_ENV=cjs babel src --root-mode upward --extensions .ts,.tsx --out-dir dist/cjs --source-maps",
23
+ "build:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist/types",
24
+ "build": "yarn clean && npm-run-all build:*",
25
+ "ncu": "ncu -u"
26
+ },
27
+ "publishConfig": {
28
+ "access": "public"
29
+ },
30
+ "dependencies": {
31
+ "@os-design/use-event": "^1.0.5"
32
+ },
33
+ "peerDependencies": {
34
+ "react": ">=17"
35
+ },
36
+ "gitHead": "4f41a962d4c0afb57d65e8c3e104215794d3c6a7"
37
+ }