Skip to content

Commit 9a07b1b

Browse files
shirakabashirakaba
committed
fix: defaults for most EventData
1 parent 8840fef commit 9a07b1b

29 files changed

+119
-104
lines changed

‎packages/core/application/application-interfaces.ts

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,22 @@ export interface CssChangedEventData<T extends Observable = Observable> extends
7171
}
7272

7373
export interface AndroidActivityEventData<T extends Observable = Observable> extends ApplicationEventData<T> {
74-
activity: any /* androidx.appcompat.app.AppCompatActivity */;
75-
object: any /* AndroidApplication */;
74+
/**
75+
* The activity.
76+
* androidx.appcompat.app.AppCompatActivity
77+
*/
78+
activity: any;
79+
80+
/**
81+
* The name of the event.
82+
*/
83+
eventName: string;
84+
85+
/**
86+
* The instance that has raised the event.
87+
* AndroidApplication
88+
*/
89+
object: T;
7690
}
7791

7892
export interface AndroidActivityBundleEventData<T extends Observable = Observable> extends AndroidActivityEventData<T> {

‎packages/core/application/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ export let ios: iOSApplication;
395395
/**
396396
* Data for the Android activity events.
397397
*/
398-
export interface AndroidActivityEventData {
398+
export interface AndroidActivityEventData<T extends Observable = Observable> extends ApplicationEventData<T> {
399399
/**
400400
* The activity.
401401
*/

‎packages/core/ui/button/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ export class Button extends TextBase {
3131
* @param callback - Callback function which will be executed when event is raised.
3232
* @param thisArg - An optional parameter which will be used as `this` context for callback execution.
3333
*/
34-
on<T extends Observable = Observable>(eventNames: string, callback: (data: EventData<T>) => void, thisArg?: any): void;
34+
on<T extends Observable = Button>(eventNames: string, callback: (data: EventData<T>) => void, thisArg?: any): void;
3535

3636
/**
3737
* Raised when a tap event occurs.
3838
*/
39-
on<T extends Observable = Observable>(event: 'tap', callback: (args: EventData<T>) => void, thisArg?: any): void;
39+
on<T extends Observable = Button>(event: 'tap', callback: (args: EventData<T>) => void, thisArg?: any): void;
4040
}

‎packages/core/ui/core/view/index.android.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -335,14 +335,14 @@ export class View extends ViewCommon {
335335
}
336336

337337
// TODO: Implement unobserve that detach the touchListener.
338-
_observe<T extends Observable = Observable>(type: GestureTypes, callback: (args: GestureEventData<T>) => void, thisArg?: any): void {
338+
_observe<T extends Observable = View>(type: GestureTypes, callback: (args: GestureEventData<T>) => void, thisArg?: any): void {
339339
super._observe(type, callback, thisArg);
340340
if (this.isLoaded && !this.touchListenerIsSet) {
341341
this.setOnTouchListener();
342342
}
343343
}
344344

345-
on<T extends Observable = Observable>(eventNames: string, callback: (data: EventData<T>) => void, thisArg?: any) {
345+
on<T extends Observable = View>(eventNames: string, callback: (data: EventData<T>) => void, thisArg?: any) {
346346
super.on(eventNames, callback, thisArg);
347347
const isLayoutEvent = typeof eventNames === 'string' ? eventNames.indexOf(ViewCommon.layoutChangedEvent) !== -1 : false;
348348

@@ -351,7 +351,7 @@ export class View extends ViewCommon {
351351
}
352352
}
353353

354-
off<T extends Observable = Observable>(eventNames: string, callback?: (data: EventData<T>) => void, thisArg?: any) {
354+
off<T extends Observable = View>(eventNames: string, callback?: (data: EventData<T>) => void, thisArg?: any) {
355355
super.off(eventNames, callback, thisArg);
356356
const isLayoutEvent = typeof eventNames === 'string' ? eventNames.indexOf(ViewCommon.layoutChangedEvent) !== -1 : false;
357357

‎packages/core/ui/core/view/index.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ export interface Size {
8383
/**
8484
* Defines the data for the shownModally event.
8585
*/
86-
export interface ShownModallyData<T extends Observable = Observable> extends EventData<T> {
86+
export interface ShownModallyData<T extends Observable = ViewCommon> extends EventData<T> {
8787
/**
8888
* The context (optional, may be undefined) passed to the view when shown modally.
8989
*/
@@ -585,41 +585,41 @@ export abstract class View extends ViewCommon {
585585
* @param callback An optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.
586586
* @param thisArg An optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener.
587587
*/
588-
off<T extends Observable = Observable>(eventNames: string | GestureTypes, callback?: (args: EventData<T>) => void, thisArg?: any);
588+
off<T extends Observable = View>(eventNames: string | GestureTypes, callback?: (args: EventData<T>) => void, thisArg?: any);
589589

590590
/**
591591
* A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
592592
* @param eventNames - String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change") or you can use gesture types.
593593
* @param callback - Callback function which will be executed when event is raised.
594594
* @param thisArg - An optional parameter which will be used as `this` context for callback execution.
595595
*/
596-
on<T extends Observable = Observable>(eventNames: string | GestureTypes, callback: (args: EventData<T>) => void, thisArg?: any);
596+
on<T extends Observable = View>(eventNames: string | GestureTypes, callback: (args: EventData<T>) => void, thisArg?: any);
597597

598598
/**
599599
* Raised when a loaded event occurs.
600600
*/
601-
on<T extends Observable = Observable>(event: 'loaded', callback: (args: EventData<T>) => void, thisArg?: any);
601+
on<T extends Observable = View>(event: 'loaded', callback: (args: EventData<T>) => void, thisArg?: any);
602602

603603
/**
604604
* Raised when an unloaded event occurs.
605605
*/
606-
on<T extends Observable = Observable>(event: 'unloaded', callback: (args: EventData<T>) => void, thisArg?: any);
606+
on<T extends Observable = View>(event: 'unloaded', callback: (args: EventData<T>) => void, thisArg?: any);
607607

608608
/**
609609
* Raised when a back button is pressed.
610610
* This event is raised only for android.
611611
*/
612-
on<T extends Observable = Observable>(event: 'androidBackPressed', callback: (args: EventData<T>) => void, thisArg?: any);
612+
on<T extends Observable = View>(event: 'androidBackPressed', callback: (args: EventData<T>) => void, thisArg?: any);
613613

614614
/**
615615
* Raised before the view is shown as a modal dialog.
616616
*/
617-
on<T extends Observable = Observable>(event: 'showingModally', callback: (args: ShownModallyData<T>) => void, thisArg?: any): void;
617+
on<T extends Observable = View>(event: 'showingModally', callback: (args: ShownModallyData<T>) => void, thisArg?: any): void;
618618

619619
/**
620620
* Raised after the view is shown as a modal dialog.
621621
*/
622-
on<T extends Observable = Observable>(event: 'shownModally', callback: (args: ShownModallyData<T>) => void, thisArg?: any);
622+
on<T extends Observable = View>(event: 'shownModally', callback: (args: ShownModallyData<T>) => void, thisArg?: any);
623623

624624
/**
625625
* Returns the current modal view that this page is showing (is parent of), if any.

‎packages/core/ui/core/view/view-common.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ export abstract class ViewCommon extends ViewBase implements ViewDefinition {
253253
}
254254
}
255255

256-
_observe<T extends Observable = Observable>(type: GestureTypes, callback: (args: GestureEventData<T>) => void, thisArg?: any): void {
256+
_observe<T extends Observable = ViewCommon>(type: GestureTypes, callback: (args: GestureEventData<T>) => void, thisArg?: any): void {
257257
if (!this._gestureObservers[type]) {
258258
this._gestureObservers[type] = [];
259259
}
@@ -265,7 +265,7 @@ export abstract class ViewCommon extends ViewBase implements ViewDefinition {
265265
return this._gestureObservers[type];
266266
}
267267

268-
public addEventListener<T extends Observable = Observable>(arg: string | GestureTypes, callback: (data: EventData<T>) => void, thisArg?: any) {
268+
public addEventListener<T extends Observable = ViewCommon>(arg: string | GestureTypes, callback: (data: EventData<T>) => void, thisArg?: any) {
269269
if (typeof arg === 'string') {
270270
arg = getEventOrGestureName(arg);
271271

@@ -293,7 +293,7 @@ export abstract class ViewCommon extends ViewBase implements ViewDefinition {
293293
}
294294
}
295295

296-
public removeEventListener<T extends Observable = Observable>(arg: string | GestureTypes, callback?: (data: EventData<T>) => void, thisArg?: any) {
296+
public removeEventListener<T extends Observable = ViewCommon>(arg: string | GestureTypes, callback?: (data: EventData<T>) => void, thisArg?: any) {
297297
if (typeof arg === 'string') {
298298
const gesture = gestureFromString(arg);
299299
if (gesture && !this._isEvent(arg)) {

‎packages/core/ui/frame/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { Transition } from '../transition';
66

77
export * from './frame-interfaces';
88

9-
export interface NavigationData<T extends Observable = Observable> extends EventData<T> {
9+
export interface NavigationData<T extends Observable = Frame> extends EventData<T> {
1010
entry?: NavigationEntry;
1111
fromEntry?: NavigationEntry;
1212
isBack?: boolean;
@@ -221,17 +221,17 @@ export class Frame extends FrameBase {
221221
* @param callback - Callback function which will be executed when event is raised.
222222
* @param thisArg - An optional parameter which will be used as `this` context for callback execution.
223223
*/
224-
on<T extends Observable = Observable>(eventNames: string, callback: (args: EventData<T>) => void, thisArg?: any): void;
224+
on<T extends Observable = Frame>(eventNames: string, callback: (args: EventData<T>) => void, thisArg?: any): void;
225225

226226
/**
227227
* Raised when navigation to the page has started.
228228
*/
229-
public on<T extends Observable = Observable>(event: 'navigatingTo', callback: (args: NavigationData<T>) => void, thisArg?: any): void;
229+
public on<T extends Observable = Frame>(event: 'navigatingTo', callback: (args: NavigationData<T>) => void, thisArg?: any): void;
230230

231231
/**
232232
* Raised when navigation to the page has finished.
233233
*/
234-
public on<T extends Observable = Observable>(event: 'navigatedTo', callback: (args: NavigationData<T>) => void, thisArg?: any): void;
234+
public on<T extends Observable = Frame>(event: 'navigatedTo', callback: (args: NavigationData<T>) => void, thisArg?: any): void;
235235
}
236236

237237
/**

‎packages/core/ui/gestures/index.d.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ export namespace TouchAction {
132132
/**
133133
* Provides gesture event data.
134134
*/
135-
export interface GestureEventData<T extends Observable = Observable> extends EventData<T> {
135+
export interface GestureEventData<T extends Observable = View> extends EventData<T> {
136136
/**
137137
* Gets the type of the gesture.
138138
*/
@@ -154,7 +154,7 @@ export interface GestureEventData<T extends Observable = Observable> extends Eve
154154
/**
155155
* Provides gesture event data.
156156
*/
157-
export interface TapGestureEventData<T extends Observable = Observable> extends GestureEventData<T> {
157+
export interface TapGestureEventData<T extends Observable = View> extends GestureEventData<T> {
158158
/**
159159
* Gets the number of pointers in the event.
160160
*/
@@ -172,7 +172,7 @@ export interface TapGestureEventData<T extends Observable = Observable> extends
172172
/**
173173
* Provides gesture event data.
174174
*/
175-
export interface TouchGestureEventData<T extends Observable = Observable> extends TapGestureEventData<T> {
175+
export interface TouchGestureEventData<T extends Observable = View> extends TapGestureEventData<T> {
176176
/**
177177
* Gets action of the touch. Possible values: 'up', 'move', 'down', 'cancel'
178178
*/
@@ -241,14 +241,14 @@ export interface Pointer {
241241
/**
242242
* Provides gesture event data.
243243
*/
244-
export interface GestureEventDataWithState<T extends Observable = Observable> extends GestureEventData<T> {
244+
export interface GestureEventDataWithState<T extends Observable = View> extends GestureEventData<T> {
245245
state: number;
246246
}
247247

248248
/**
249249
* Provides gesture event data for pinch gesture.
250250
*/
251-
export interface PinchGestureEventData<T extends Observable = Observable> extends GestureEventDataWithState<T> {
251+
export interface PinchGestureEventData<T extends Observable = View> extends GestureEventDataWithState<T> {
252252
scale: number;
253253

254254
getFocusX(): number;
@@ -258,29 +258,29 @@ export interface PinchGestureEventData<T extends Observable = Observable> extend
258258
/**
259259
* Provides gesture event data for swipe gesture.
260260
*/
261-
export interface SwipeGestureEventData<T extends Observable = Observable> extends GestureEventData<T> {
261+
export interface SwipeGestureEventData<T extends Observable = View> extends GestureEventData<T> {
262262
direction: SwipeDirection;
263263
}
264264

265265
/**
266266
* Provides gesture event data for pan gesture.
267267
*/
268-
export interface PanGestureEventData<T extends Observable = Observable> extends GestureEventDataWithState<T> {
268+
export interface PanGestureEventData<T extends Observable = View> extends GestureEventDataWithState<T> {
269269
deltaX: number;
270270
deltaY: number;
271271
}
272272

273273
/**
274274
* Provides gesture event data for rotation gesture.
275275
*/
276-
export interface RotationGestureEventData<T extends Observable = Observable> extends GestureEventDataWithState<T> {
276+
export interface RotationGestureEventData<T extends Observable = View> extends GestureEventDataWithState<T> {
277277
rotation: number;
278278
}
279279

280280
/**
281281
* Provides options for the GesturesObserver.
282282
*/
283-
export class GesturesObserver<T extends Observable = Observable> {
283+
export class GesturesObserver<T extends Observable = View> {
284284
/**
285285
* Creates an instance of GesturesObserver class.
286286
* @param target - The view for which the observer is created.
@@ -328,7 +328,7 @@ export class GesturesObserver<T extends Observable = Observable> {
328328
* @param callback - A function that will be executed when a gesture is received.
329329
* @param context - this argument for the callback.
330330
*/
331-
export function observe<T extends Observable = Observable>(target: View, type: GestureTypes, callback: (args: GestureEventData<T>) => void, context?: any): GesturesObserver<T>;
331+
export function observe<T extends Observable = View>(target: View, type: GestureTypes, callback: (args: GestureEventData<T>) => void, context?: any): GesturesObserver<T>;
332332

333333
/**
334334
* Returns a string representation of a gesture type.

‎packages/core/ui/gestures/index.ios.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class UIGestureRecognizerImpl extends NSObject {
5353
private _callback: Function;
5454
private _context: any;
5555

56-
public static initWithOwnerTypeCallback<T extends Observable = Observable>(owner: WeakRef<GesturesObserver>, type: any, callback?: (args: GestureEventData<T>) => void, thisArg?: any): UIGestureRecognizerImpl {
56+
public static initWithOwnerTypeCallback<T extends Observable = View>(owner: WeakRef<GesturesObserver>, type: any, callback?: (args: GestureEventData<T>) => void, thisArg?: any): UIGestureRecognizerImpl {
5757
const handler = <UIGestureRecognizerImpl>UIGestureRecognizerImpl.new();
5858
handler._owner = owner;
5959
handler._type = type;
@@ -320,7 +320,7 @@ export class GesturesObserver extends GesturesObserverBase {
320320
}
321321
}
322322

323-
function _createUIGestureRecognizerTarget<T extends Observable = Observable>(owner: GesturesObserver, type: GestureTypes, callback?: (args: GestureEventData<T>) => void, context?: any): any {
323+
function _createUIGestureRecognizerTarget<T extends Observable = View>(owner: GesturesObserver, type: GestureTypes, callback?: (args: GestureEventData<T>) => void, context?: any): any {
324324
return UIGestureRecognizerImpl.initWithOwnerTypeCallback(new WeakRef(owner), type, callback, context);
325325
}
326326

‎packages/core/ui/image-cache/image-cache-common.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ export class Cache extends Observable implements definition.Cache {
215215
}
216216
}
217217
export interface Cache {
218-
on<T extends Observable = Observable>(eventNames: string, callback: (args: EventData<T>) => void, thisArg?: any): void;
219-
on<T extends Observable = Observable>(event: 'downloaded', callback: (args: definition.DownloadedData<T>) => void, thisArg?: any): void;
220-
on<T extends Observable = Observable>(event: 'downloadError', callback: (args: definition.DownloadError<T>) => void, thisArg?: any): void;
218+
on<T extends Observable = Cache>(eventNames: string, callback: (args: EventData<T>) => void, thisArg?: any): void;
219+
on<T extends Observable = Cache>(event: 'downloaded', callback: (args: definition.DownloadedData<T>) => void, thisArg?: any): void;
220+
on<T extends Observable = Cache>(event: 'downloadError', callback: (args: definition.DownloadError<T>) => void, thisArg?: any): void;
221221
}

‎packages/core/ui/image-cache/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,17 +85,17 @@ export class Cache extends Observable {
8585
* @param callback - Callback function which will be executed when event is raised.
8686
* @param thisArg - An optional parameter which will be used as `this` context for callback execution.
8787
*/
88-
on<T extends Observable = Observable>(eventNames: string, callback: (args: EventData<T>) => void, thisArg?: any): void;
88+
on<T extends Observable = Cache>(eventNames: string, callback: (args: EventData<T>) => void, thisArg?: any): void;
8989

9090
/**
9191
* Raised when the image has been downloaded.
9292
*/
93-
on<T extends Observable = Observable>(event: 'downloaded', callback: (args: DownloadedData<T>) => void, thisArg?: any): void;
93+
on<T extends Observable = Cache>(event: 'downloaded', callback: (args: DownloadedData<T>) => void, thisArg?: any): void;
9494

9595
/**
9696
* Raised if the image download errors.
9797
*/
98-
on<T extends Observable = Observable>(event: 'downloadError', callback: (args: DownloadError<T>) => void, thisArg?: any): void;
98+
on<T extends Observable = Cache>(event: 'downloadError', callback: (args: DownloadError<T>) => void, thisArg?: any): void;
9999

100100
//@private
101101
/**

‎packages/core/ui/list-view/index.d.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -108,31 +108,31 @@ export class ListView extends View {
108108
* @param callback - Callback function which will be executed when event is raised.
109109
* @param thisArg - An optional parameter which will be used as `this` context for callback execution.
110110
*/
111-
on<T extends Observable = Observable>(eventNames: string, callback: (data: EventData<T>) => void, thisArg?: any): void;
111+
on<T extends Observable = ListView>(eventNames: string, callback: (data: EventData<T>) => void, thisArg?: any): void;
112112

113113
/**
114114
* Raised when a View for the data at the specified index should be created.
115115
* The result should be returned trough the view property of the event data.
116116
* Note, that the view property of the event data can be pre-initialized with
117117
* an old instance of a view, so that it can be reused.
118118
*/
119-
on<T extends Observable = Observable>(event: 'itemLoading', callback: (args: ItemEventData<T>) => void, thisArg?: any): void;
119+
on<T extends Observable = ListView>(event: 'itemLoading', callback: (args: ItemEventData<T>) => void, thisArg?: any): void;
120120

121121
/**
122122
* Raised when an item inside the ListView is tapped.
123123
*/
124-
on<T extends Observable = Observable>(event: 'itemTap', callback: (args: ItemEventData<T>) => void, thisArg?: any): void;
124+
on<T extends Observable = ListView>(event: 'itemTap', callback: (args: ItemEventData<T>) => void, thisArg?: any): void;
125125

126126
/**
127127
* Raised when the ListView is scrolled so that its last item is visible.
128128
*/
129-
on<T extends Observable = Observable>(event: 'loadMoreItems', callback: (args: EventData<T>) => void, thisArg?: any): void;
129+
on<T extends Observable = ListView>(event: 'loadMoreItems', callback: (args: EventData<T>) => void, thisArg?: any): void;
130130
}
131131

132132
/**
133133
* Event data containing information for the index and the view associated to a list view item.
134134
*/
135-
export interface ItemEventData<T extends Observable = Observable> extends EventData<T> {
135+
export interface ItemEventData<T extends Observable = ListView> extends EventData<T> {
136136
/**
137137
* The index of the item, for which the event is raised.
138138
*/
@@ -164,8 +164,8 @@ export interface TemplatedItemsView {
164164
itemTemplate: string | Template;
165165
itemTemplates?: string | Array<KeyedTemplate>;
166166
refresh(): void;
167-
on<T extends Observable = Observable>(event: 'itemLoading', callback: (args: ItemEventData<T>) => void, thisArg?: any): void;
168-
off<T extends Observable = Observable>(event: 'itemLoading', callback: (args: EventData<T>) => void, thisArg?: any): void;
167+
on<T extends Observable = ListView>(event: 'itemLoading', callback: (args: ItemEventData<T>) => void, thisArg?: any): void;
168+
off<T extends Observable = ListView>(event: 'itemLoading', callback: (args: EventData<T>) => void, thisArg?: any): void;
169169
}
170170

171171
/**

0 commit comments

Comments
 (0)