Skip to content

Adds scrollsnapchange and scrollsnapchanging event support #4946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rschristian merged 4 commits into from
Oct 30, 2025
Merged

Adds scrollsnapchange and scrollsnapchanging event support #4946

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8605130
add scrollsnap events
argyleink Oct 29, 2025
729c0e7
add scrollsnap event test
argyleink Oct 29, 2025
07e5a81
Revert "add scrollsnap event test"
argyleink Oct 30, 2025
00fd3ea
types: Correct event type & backport SnapEvent DOM type
rschristian Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions src/dom.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,22 @@ interface CommandEventInit extends EventInit {
command: string;
}

/** [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/SnapEvent) */
interface SnapEvent extends Event {
readonly snapTargetBlock: Element | null;
readonly snapTargetInline: Element | null;
}

declare var SnapEvent: {
prototype: SnapEvent;
new (type: string, eventInitDict?: SnapEventInit): SnapEvent;
}

interface SnapEventInit extends EventInit {
snapTargetBlock?: Element | null;
snapTargetInline?: Element | null;
}

type Booleanish = boolean | 'true' | 'false';

export interface SignalLike<T> {
Expand Down Expand Up @@ -494,6 +510,10 @@ export type TargetedPointerEvent<Target extends EventTarget> = TargetedEvent<
Target,
PointerEvent
>;
export type TargetedSnapEvent<Target extends EventTarget> = TargetedEvent<
Target,
SnapEvent
>;
export type TargetedSubmitEvent<Target extends EventTarget> = TargetedEvent<
Target,
SubmitEvent
Expand Down Expand Up @@ -561,6 +581,9 @@ export type MouseEventHandler<Target extends EventTarget> = EventHandler<
export type PointerEventHandler<Target extends EventTarget> = EventHandler<
TargetedPointerEvent<Target>
>;
export type SnapEventHandler<Target extends EventTarget> = EventHandler<
TargetedSnapEvent<Target>
>;
export type SubmitEventHandler<Target extends EventTarget> = EventHandler<
TargetedSubmitEvent<Target>
>;
Expand Down Expand Up @@ -777,6 +800,10 @@ export interface DOMAttributes<Target extends EventTarget>
onScrollCapture?: GenericEventHandler<Target> | undefined;
onScrollEnd?: GenericEventHandler<Target> | undefined;
onScrollEndCapture?: GenericEventHandler<Target> | undefined;
onScrollSnapChange?: SnapEventHandler<Target> | undefined;
onScrollSnapChangeCapture?: SnapEventHandler<Target> | undefined;
onScrollSnapChanging?: SnapEventHandler<Target> | undefined;
onScrollSnapChangingCapture?: SnapEventHandler<Target> | undefined;

// Wheel Events
onWheel?: WheelEventHandler<Target> | undefined;
Expand Down
Loading