@xyo-network/react-event 7.5.6 → 7.5.7
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.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useCustomEvent.d.ts","sourceRoot":"","sources":["../../../src/hooks/useCustomEvent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAGtC,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,OAAO,GAAG,IAAI,CAAA;AAEpG,eAAO,MAAM,cAAc,GAAI,QAAQ,SAAS,WAAW,EAAE,OAAO,GAAG,OAAO,EAC5E,MAAM,MAAM,EACZ,WAAW,mBAAmB,CAAC,OAAO,CAAC,EACvC,YAAY,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC,KACrC,CAAC,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC,EAAE,mBAAmB,CAAC,OAAO,CAAC,
|
|
1
|
+
{"version":3,"file":"useCustomEvent.d.ts","sourceRoot":"","sources":["../../../src/hooks/useCustomEvent.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAGtC,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,OAAO,GAAG,IAAI,CAAA;AAEpG,eAAO,MAAM,cAAc,GAAI,QAAQ,SAAS,WAAW,EAAE,OAAO,GAAG,OAAO,EAC5E,MAAM,MAAM,EACZ,WAAW,mBAAmB,CAAC,OAAO,CAAC,EACvC,YAAY,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC,KACrC,CAAC,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAqC3D,CAAA"}
|
|
@@ -5,8 +5,9 @@ export type EventVerb = 'click' | 'favorite';
|
|
|
5
5
|
export interface Event<TNoun = ExtendEventNoun, TVerb = EventVerb, TData = string> {
|
|
6
6
|
data?: TData;
|
|
7
7
|
noun: TNoun;
|
|
8
|
+
originalEvent?: Event;
|
|
8
9
|
verb: TVerb;
|
|
9
10
|
}
|
|
10
|
-
export type EventDispatch<TNoun = ExtendEventNoun, TVerb = EventVerb, TData = string> = (noun: TNoun, verb: TVerb, data?: TData,
|
|
11
|
+
export type EventDispatch<TNoun = ExtendEventNoun, TVerb = EventVerb, TData = string> = (noun: TNoun, verb: TVerb, data?: TData, originalEvent?: Event) => boolean | void;
|
|
11
12
|
export declare const useEvent: <T extends HTMLElement, TNoun = ExtendEventNoun, TVerb = EventVerb, TData = string>(listener?: EventDispatch<TNoun, TVerb, TData>, sharableRef?: RefObject<T | null>) => [RefObject<T | null>, EventDispatch<TNoun, TVerb, TData>];
|
|
12
13
|
//# sourceMappingURL=useEvent.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useEvent.d.ts","sourceRoot":"","sources":["../../../src/hooks/useEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAItC,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAA;AAChG,MAAM,MAAM,eAAe,CAAC,SAAS,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,SAAS,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,CAAA;AAEtH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,UAAU,CAAA;AAE5C,MAAM,WAAW,KAAK,CAAC,KAAK,GAAG,eAAe,EAAE,KAAK,GAAG,SAAS,EAAE,KAAK,GAAG,MAAM;IAC/E,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ,IAAI,EAAE,KAAK,CAAA;IACX,IAAI,EAAE,KAAK,CAAA;CACZ;AAED,MAAM,MAAM,aAAa,CAAC,KAAK,GAAG,eAAe,EAAE,KAAK,GAAG,SAAS,EAAE,KAAK,GAAG,MAAM,IAAI,CACtF,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,KAAK,EACX,IAAI,CAAC,EAAE,KAAK,EACZ,
|
|
1
|
+
{"version":3,"file":"useEvent.d.ts","sourceRoot":"","sources":["../../../src/hooks/useEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAItC,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAA;AAChG,MAAM,MAAM,eAAe,CAAC,SAAS,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,SAAS,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,CAAA;AAEtH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,UAAU,CAAA;AAE5C,MAAM,WAAW,KAAK,CAAC,KAAK,GAAG,eAAe,EAAE,KAAK,GAAG,SAAS,EAAE,KAAK,GAAG,MAAM;IAC/E,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ,IAAI,EAAE,KAAK,CAAA;IACX,aAAa,CAAC,EAAE,KAAK,CAAA;IACrB,IAAI,EAAE,KAAK,CAAA;CACZ;AAED,MAAM,MAAM,aAAa,CAAC,KAAK,GAAG,eAAe,EAAE,KAAK,GAAG,SAAS,EAAE,KAAK,GAAG,MAAM,IAAI,CACtF,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,KAAK,EACX,IAAI,CAAC,EAAE,KAAK,EACZ,aAAa,CAAC,EAAE,KAAK,KAClB,OAAO,GAAG,IAAI,CAAA;AAEnB,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,WAAW,EAAE,KAAK,GAAG,eAAe,EAAE,KAAK,GAAG,SAAS,EAAE,KAAK,GAAG,MAAM,EACxG,WAAW,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAC7C,cAAc,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC,KAChC,CAAC,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAiB1D,CAAA"}
|
package/dist/browser/index.mjs
CHANGED
|
@@ -3,9 +3,10 @@ var __name = (target, value) => __defProp(target, "name", { value, configurable:
|
|
|
3
3
|
|
|
4
4
|
// src/hooks/useCustomEvent.ts
|
|
5
5
|
import { assertEx } from "@xylabs/sdk-js";
|
|
6
|
-
import {
|
|
6
|
+
import { useEffect, useRef } from "react";
|
|
7
7
|
var useCustomEvent = /* @__PURE__ */ __name((type, listener, customRef) => {
|
|
8
|
-
const
|
|
8
|
+
const newRef = useRef(null);
|
|
9
|
+
const ref = customRef ?? newRef;
|
|
9
10
|
useEffect(() => {
|
|
10
11
|
const element = ref?.current;
|
|
11
12
|
const currentListener = listener;
|
|
@@ -43,13 +44,14 @@ var useCustomEvent = /* @__PURE__ */ __name((type, listener, customRef) => {
|
|
|
43
44
|
|
|
44
45
|
// src/hooks/useEvent.ts
|
|
45
46
|
var useEvent = /* @__PURE__ */ __name((listener, sharableRef) => {
|
|
46
|
-
const [ref, customDispatch] = useCustomEvent("xyo", listener ? (detail
|
|
47
|
-
return listener(detail.noun, detail.verb, detail.data,
|
|
47
|
+
const [ref, customDispatch] = useCustomEvent("xyo", listener ? (detail) => {
|
|
48
|
+
return listener(detail.noun, detail.verb, detail.data, detail.originalEvent);
|
|
48
49
|
} : void 0, sharableRef);
|
|
49
|
-
const dispatch = /* @__PURE__ */ __name((noun, verb, data) => {
|
|
50
|
+
const dispatch = /* @__PURE__ */ __name((noun, verb, data, originalEvent) => {
|
|
50
51
|
return customDispatch({
|
|
51
52
|
data,
|
|
52
53
|
noun,
|
|
54
|
+
originalEvent,
|
|
53
55
|
verb
|
|
54
56
|
});
|
|
55
57
|
}, "dispatch");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/hooks/useCustomEvent.ts","../../src/hooks/useEvent.ts"],"sourcesContent":["import { assertEx } from '@xylabs/sdk-js'\nimport type { RefObject } from 'react'\nimport {
|
|
1
|
+
{"version":3,"sources":["../../src/hooks/useCustomEvent.ts","../../src/hooks/useEvent.ts"],"sourcesContent":["import { assertEx } from '@xylabs/sdk-js'\nimport type { RefObject } from 'react'\nimport { useEffect, useRef } from 'react'\n\nexport type CustomEventListener<T = unknown> = (detail: T, event?: CustomEvent<T>) => boolean | void\n\nexport const useCustomEvent = <TElement extends HTMLElement, TDetail = unknown>(\n type: string,\n listener?: CustomEventListener<TDetail>,\n customRef?: RefObject<TElement | null>,\n): [RefObject<TElement | null>, CustomEventListener<TDetail>] => {\n const newRef = useRef<TElement>(null)\n const ref = customRef ?? newRef\n useEffect(() => {\n const element = ref?.current\n const currentListener = listener\n const handler\n = currentListener\n ? (event: Event) => {\n const customEvent = event as CustomEvent<TDetail>\n const detail = assertEx(customEvent.detail, () => 'Event missing detail')\n const stop = currentListener(detail, customEvent)\n if (stop) {\n event.stopPropagation()\n }\n }\n : undefined\n\n if (handler && element) {\n element?.addEventListener(type, handler)\n }\n return () => {\n if (handler && element) {\n element?.removeEventListener(type, handler)\n }\n }\n })\n const dispatch: CustomEventListener<TDetail> = (detail?: TDetail) => {\n const event = new CustomEvent<TDetail>(type, {\n bubbles: true,\n cancelable: true,\n composed: true,\n detail,\n })\n ref.current?.dispatchEvent(event)\n }\n return [ref, dispatch]\n}\n","import type { RefObject } from 'react'\n\nimport { useCustomEvent } from './useCustomEvent.ts'\n\nexport type EventNoun = 'payload' | 'boundwitness' | 'address' | 'hash' | 'signature' | 'schema'\nexport type ExtendEventNoun<Extension extends string | void = void> = Extension extends string ? Extension : EventNoun\n\nexport type EventVerb = 'click' | 'favorite'\n\nexport interface Event<TNoun = ExtendEventNoun, TVerb = EventVerb, TData = string> {\n data?: TData\n noun: TNoun\n originalEvent?: Event\n verb: TVerb\n}\n\nexport type EventDispatch<TNoun = ExtendEventNoun, TVerb = EventVerb, TData = string> = (\n noun: TNoun,\n verb: TVerb,\n data?: TData,\n originalEvent?: Event,\n) => boolean | void\n\nexport const useEvent = <T extends HTMLElement, TNoun = ExtendEventNoun, TVerb = EventVerb, TData = string>(\n listener?: EventDispatch<TNoun, TVerb, TData>,\n sharableRef?: RefObject<T | null>,\n): [RefObject<T | null>, EventDispatch<TNoun, TVerb, TData>] => {\n const [ref, customDispatch] = useCustomEvent<T, Event<TNoun, TVerb, TData>>(\n 'xyo',\n listener\n ? (detail: Event<TNoun, TVerb, TData>) => {\n return listener(detail.noun, detail.verb, detail.data, detail.originalEvent)\n }\n : undefined,\n sharableRef,\n )\n\n const dispatch: EventDispatch<TNoun, TVerb, TData> = (noun: TNoun, verb: TVerb, data?: TData, originalEvent?: Event) => {\n return customDispatch({\n data, noun, originalEvent, verb,\n })\n }\n return [ref, dispatch]\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AAEzB,SAASC,WAAWC,cAAc;AAI3B,IAAMC,iBAAiB,wBAC5BC,MACAC,UACAC,cAAAA;AAEA,QAAMC,SAASC,OAAiB,IAAA;AAChC,QAAMC,MAAMH,aAAaC;AACzBG,YAAU,MAAA;AACR,UAAMC,UAAUF,KAAKG;AACrB,UAAMC,kBAAkBR;AACxB,UAAMS,UACFD,kBACE,CAACE,UAAAA;AACC,YAAMC,cAAcD;AACpB,YAAME,SAASC,SAASF,YAAYC,QAAQ,MAAM,sBAAA;AAClD,YAAME,OAAON,gBAAgBI,QAAQD,WAAAA;AACrC,UAAIG,MAAM;AACRJ,cAAMK,gBAAe;MACvB;IACF,IACAC;AAEN,QAAIP,WAAWH,SAAS;AACtBA,eAASW,iBAAiBlB,MAAMU,OAAAA;IAClC;AACA,WAAO,MAAA;AACL,UAAIA,WAAWH,SAAS;AACtBA,iBAASY,oBAAoBnB,MAAMU,OAAAA;MACrC;IACF;EACF,CAAA;AACA,QAAMU,WAAyC,wBAACP,WAAAA;AAC9C,UAAMF,QAAQ,IAAIU,YAAqBrB,MAAM;MAC3CsB,SAAS;MACTC,YAAY;MACZC,UAAU;MACVX;IACF,CAAA;AACAR,QAAIG,SAASiB,cAAcd,KAAAA;EAC7B,GAR+C;AAS/C,SAAO;IAACN;IAAKe;;AACf,GAzC8B;;;ACiBvB,IAAMM,WAAW,wBACtBC,UACAC,gBAAAA;AAEA,QAAM,CAACC,KAAKC,cAAAA,IAAkBC,eAC5B,OACAJ,WACI,CAACK,WAAAA;AACC,WAAOL,SAASK,OAAOC,MAAMD,OAAOE,MAAMF,OAAOG,MAAMH,OAAOI,aAAa;EAC7E,IACAC,QACJT,WAAAA;AAGF,QAAMU,WAA+C,wBAACL,MAAaC,MAAaC,MAAcC,kBAAAA;AAC5F,WAAON,eAAe;MACpBK;MAAMF;MAAMG;MAAeF;IAC7B,CAAA;EACF,GAJqD;AAKrD,SAAO;IAACL;IAAKS;;AACf,GApBwB;","names":["assertEx","useEffect","useRef","useCustomEvent","type","listener","customRef","newRef","useRef","ref","useEffect","element","current","currentListener","handler","event","customEvent","detail","assertEx","stop","stopPropagation","undefined","addEventListener","removeEventListener","dispatch","CustomEvent","bubbles","cancelable","composed","dispatchEvent","useEvent","listener","sharableRef","ref","customDispatch","useCustomEvent","detail","noun","verb","data","originalEvent","undefined","dispatch"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/react-event",
|
|
3
|
-
"version": "7.5.
|
|
3
|
+
"version": "7.5.7",
|
|
4
4
|
"description": "Common React library for all XYO projects that use React",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"xyo",
|
|
@@ -46,6 +46,7 @@
|
|
|
46
46
|
"@xylabs/sdk-js": "~5.0.90"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
+
"@xylabs/ts-scripts-common": "~7.5.6",
|
|
49
50
|
"@xylabs/ts-scripts-yarn3": "~7.5.6",
|
|
50
51
|
"typescript": "^5.9.3"
|
|
51
52
|
},
|
package/src/hooks/useEvent.ts
CHANGED
|
@@ -10,6 +10,7 @@ export type EventVerb = 'click' | 'favorite'
|
|
|
10
10
|
export interface Event<TNoun = ExtendEventNoun, TVerb = EventVerb, TData = string> {
|
|
11
11
|
data?: TData
|
|
12
12
|
noun: TNoun
|
|
13
|
+
originalEvent?: Event
|
|
13
14
|
verb: TVerb
|
|
14
15
|
}
|
|
15
16
|
|
|
@@ -17,7 +18,7 @@ export type EventDispatch<TNoun = ExtendEventNoun, TVerb = EventVerb, TData = st
|
|
|
17
18
|
noun: TNoun,
|
|
18
19
|
verb: TVerb,
|
|
19
20
|
data?: TData,
|
|
20
|
-
|
|
21
|
+
originalEvent?: Event,
|
|
21
22
|
) => boolean | void
|
|
22
23
|
|
|
23
24
|
export const useEvent = <T extends HTMLElement, TNoun = ExtendEventNoun, TVerb = EventVerb, TData = string>(
|
|
@@ -27,16 +28,16 @@ export const useEvent = <T extends HTMLElement, TNoun = ExtendEventNoun, TVerb =
|
|
|
27
28
|
const [ref, customDispatch] = useCustomEvent<T, Event<TNoun, TVerb, TData>>(
|
|
28
29
|
'xyo',
|
|
29
30
|
listener
|
|
30
|
-
? (detail: Event<TNoun, TVerb, TData
|
|
31
|
-
return listener(detail.noun, detail.verb, detail.data,
|
|
31
|
+
? (detail: Event<TNoun, TVerb, TData>) => {
|
|
32
|
+
return listener(detail.noun, detail.verb, detail.data, detail.originalEvent)
|
|
32
33
|
}
|
|
33
34
|
: undefined,
|
|
34
35
|
sharableRef,
|
|
35
36
|
)
|
|
36
37
|
|
|
37
|
-
const dispatch: EventDispatch<TNoun, TVerb, TData> = (noun: TNoun, verb: TVerb, data?: TData) => {
|
|
38
|
+
const dispatch: EventDispatch<TNoun, TVerb, TData> = (noun: TNoun, verb: TVerb, data?: TData, originalEvent?: Event) => {
|
|
38
39
|
return customDispatch({
|
|
39
|
-
data, noun, verb,
|
|
40
|
+
data, noun, originalEvent, verb,
|
|
40
41
|
})
|
|
41
42
|
}
|
|
42
43
|
return [ref, dispatch]
|