fix(core): missing parameter for once event listeners (#10715)

CatchABus · web-flow · commit 852011c4f90e · 2025-03-03T06:54:52.000-08:00
diff --git a/packages/core/data/observable/index.ts b/packages/core/data/observable/index.ts
@@ -197,6 +197,7 @@ export class Observable {
 	 * @param eventName Name of the event to attach to.
 	 * @param callback A function to be called when some of the specified event(s) is raised.
 	 * @param thisArg An optional parameter which when set will be used as "this" in callback method call.
+	 * @param once An optional parameter which when set will cause the event listener to fire once.
 	 */
 	public addEventListener(eventName: string, callback: (data: EventData) => void, thisArg?: any, once?: boolean): void {
 		once = once || undefined;
diff --git a/packages/core/media-query-list/index.ts b/packages/core/media-query-list/index.ts
@@ -118,13 +118,13 @@ class MediaQueryListImpl extends Observable implements MediaQueryList {
 	}
 
 	// @ts-ignore
-	public addEventListener(eventName: string, callback: (data: EventData) => void, thisArg?: any): void {
+	public addEventListener(eventName: string, callback: (data: EventData) => void, thisArg?: any, once?: boolean): void {
 		this._throwInvocationError?.();
 
 		const hasChangeListeners = this.hasListeners(MediaQueryListImpl.changeEvent);
 
 		// Call super method first since it throws in the case of bad parameters
-		super.addEventListener(eventName, callback, thisArg);
+		super.addEventListener(eventName, callback, thisArg, once);
 
 		if (eventName === MediaQueryListImpl.changeEvent && !hasChangeListeners) {
 			mediaQueryLists.push(this);
diff --git a/packages/core/ui/core/view/index.android.ts b/packages/core/ui/core/view/index.android.ts
@@ -335,8 +335,8 @@ export class View extends ViewCommon {
 		}
 	}
 
-	addEventListener(eventNames: string, callback: (data: EventData) => void, thisArg?: any) {
-		super.addEventListener(eventNames, callback, thisArg);
+	addEventListener(eventNames: string, callback: (data: EventData) => void, thisArg?: any, once?: boolean) {
+		super.addEventListener(eventNames, callback, thisArg, once);
 		const isLayoutEvent = typeof eventNames === 'string' ? eventNames.indexOf(ViewCommon.layoutChangedEvent) !== -1 : false;
 
 		if (this.isLoaded && !this.layoutChangeListenerIsSet && isLayoutEvent) {
diff --git a/packages/core/ui/core/view/view-common.ts b/packages/core/ui/core/view/view-common.ts
@@ -303,7 +303,7 @@ export abstract class ViewCommon extends ViewBase implements ViewDefinition {
 		return this._gestureObservers[type];
 	}
 
-	public addEventListener(eventNames: string, callback: (data: EventData) => void, thisArg?: any) {
+	public addEventListener(eventNames: string, callback: (data: EventData) => void, thisArg?: any, once?: boolean) {
 		thisArg = thisArg || undefined;
 
 		// TODO: Remove this once we fully switch to the new event system
@@ -330,7 +330,7 @@ export abstract class ViewCommon extends ViewBase implements ViewDefinition {
 			return;
 		}
 
-		super.addEventListener(normalizedName, callback, thisArg);
+		super.addEventListener(normalizedName, callback, thisArg, once);
 	}
 
 	public removeEventListener(eventNames: string, callback?: (data: EventData) => void, thisArg?: any) {
diff --git a/packages/core/ui/scroll-view/scroll-view-common.ts b/packages/core/ui/scroll-view/scroll-view-common.ts
@@ -17,10 +17,10 @@ export abstract class ScrollViewBase extends ContentView implements ScrollViewDe
 
 	private _addedScrollEvent = false;
 
-	public addEventListener(arg: string, callback: (data: EventData) => void, thisArg?: any): void {
+	public addEventListener(arg: string, callback: (data: EventData) => void, thisArg?: any, once?: boolean): void {
 		const hasExistingScrollListeners: boolean = this.hasListeners(ScrollViewBase.scrollEvent);
 
-		super.addEventListener(arg, callback, thisArg);
+		super.addEventListener(arg, callback, thisArg, once);
 
 		// This indicates that a scroll listener was added for first time
 		if (!hasExistingScrollListeners && this.hasListeners(ScrollViewBase.scrollEvent)) {
diff --git a/packages/core/ui/text-base/span.ts b/packages/core/ui/text-base/span.ts
@@ -113,8 +113,8 @@ export class Span extends ViewBase implements SpanDefinition {
 		return this._tappable;
 	}
 
-	addEventListener(arg: string, callback: (data: EventData) => void, thisArg?: any): void {
-		super.addEventListener(arg, callback, thisArg);
+	addEventListener(arg: string, callback: (data: EventData) => void, thisArg?: any, once?: boolean): void {
+		super.addEventListener(arg, callback, thisArg, once);
 		this._setTappable(this.hasListeners(Span.linkTapEvent));
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -335,8 +335,8 @@ export class View extends ViewCommon {`
`335`	`335`	`}`
`336`	`336`	`}`
`337`	`337`
`338`		`- addEventListener(eventNames: string, callback: (data: EventData) => void, thisArg?: any) {`
`339`		`- super.addEventListener(eventNames, callback, thisArg);`
	`338`	`+ addEventListener(eventNames: string, callback: (data: EventData) => void, thisArg?: any, once?: boolean) {`
	`339`	`+ super.addEventListener(eventNames, callback, thisArg, once);`
`340`	`340`	`const isLayoutEvent = typeof eventNames === 'string' ? eventNames.indexOf(ViewCommon.layoutChangedEvent) !== -1 : false;`
`341`	`341`
`342`	`342`	`if (this.isLoaded && !this.layoutChangeListenerIsSet && isLayoutEvent) {`
Original file line number	Diff line number	Diff line change
`@@ -303,7 +303,7 @@ export abstract class ViewCommon extends ViewBase implements ViewDefinition {`
`303`	`303`	`return this._gestureObservers[type];`
`304`	`304`	`}`
`305`	`305`
`306`		`- public addEventListener(eventNames: string, callback: (data: EventData) => void, thisArg?: any) {`
	`306`	`+ public addEventListener(eventNames: string, callback: (data: EventData) => void, thisArg?: any, once?: boolean) {`
`307`	`307`	`thisArg = thisArg \|\| undefined;`
`308`	`308`
`309`	`309`	`// TODO: Remove this once we fully switch to the new event system`
`@@ -330,7 +330,7 @@ export abstract class ViewCommon extends ViewBase implements ViewDefinition {`
`330`	`330`	`return;`
`331`	`331`	`}`
`332`	`332`
`333`		`- super.addEventListener(normalizedName, callback, thisArg);`
	`333`	`+ super.addEventListener(normalizedName, callback, thisArg, once);`
`334`	`334`	`}`
`335`	`335`
`336`	`336`	`public removeEventListener(eventNames: string, callback?: (data: EventData) => void, thisArg?: any) {`
Original file line number	Diff line number	Diff line change
`@@ -113,8 +113,8 @@ export class Span extends ViewBase implements SpanDefinition {`
`113`	`113`	`return this._tappable;`
`114`	`114`	`}`
`115`	`115`
`116`		`- addEventListener(arg: string, callback: (data: EventData) => void, thisArg?: any): void {`
`117`		`- super.addEventListener(arg, callback, thisArg);`
	`116`	`+ addEventListener(arg: string, callback: (data: EventData) => void, thisArg?: any, once?: boolean): void {`
	`117`	`+ super.addEventListener(arg, callback, thisArg, once);`
`118`	`118`	`this._setTappable(this.hasListeners(Span.linkTapEvent));`
`119`	`119`	`}`
`120`	`120`