Skip to content
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.

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

Add support for mediaMatch in DomWatcher #235

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
28 changes: 24 additions & 4 deletions src/dom/dom-watcher.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import * as bom from '../dom/bom';

type MediaQueryListListener = (this: MediaQueryList, ev: MediaQueryListEventMap[keyof MediaQueryListEventMap]) => any;
type ResizeObserverListener = (a: ResizeObserverEntry[]) => void;
type MutationObserverListener = (a: MutationRecord[]) => void;

export interface DomWatcherConfig {
// https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
// The default event listerner options including passive, once etc.
Expand All @@ -8,7 +12,7 @@ export interface DomWatcherConfig {
/**
* The element to Watch
*/
element: HTMLElement | Window | Document;
element: HTMLElement | Window | Document | MediaQueryList;

/**
* The name of the event to watch.
Expand Down Expand Up @@ -285,23 +289,39 @@ export class DomWatcher {
// Use the resizeObserver if we want to listen to resizing of DOM elements.
else if (config.on === 'resize' && config.element !== window) {
const resizeObserver = new ResizeObserver(entries => {
listener(entries);
(<ResizeObserverListener>listener)(entries);
});
resizeObserver.observe(config.element as HTMLElement);
config.remover = () => {
resizeObserver.unobserve(config.element as HTMLElement);
};
} else if (config.on === 'mutation') {
const mutationObserver = new MutationObserver(mutationsList => {
listener(mutationsList);
(<MutationObserverListener>listener)(mutationsList);
});
mutationObserver.observe(
config.element as HTMLElement,
config.eventOptions
<MutationObserverInit | undefined>config.eventOptions
);
config.remover = () => {
mutationObserver.disconnect();
};
} else if (config.element instanceof MediaQueryList) {
// Add listening.
config.element.addEventListener(
config.on as keyof MediaQueryListEventMap,
<MediaQueryListListener>listener,
<boolean | AddEventListenerOptions>config.eventOptions || {}
);

// Generate the remover.
config.remover = () => {
config.element.removeEventListener(
config.on as keyof MediaQueryListEventMap,
<MediaQueryListListener>listener,
<boolean | EventListenerOptions>config.eventOptions || {}
);
};
} else {
// Add listening.
config.element.addEventListener(
Expand Down