Interface MediaQueryList

Stores information on a media query applied to a document, and handles sending notifications to listeners when the media query state change (i.e. when the media query test starts or stops evaluating to true).

interface MediaQueryList {
    matches: boolean;
    media: string;
    onchange: null | ((this: MediaQueryList, ev: MediaQueryListEvent) => any);
    addEventListener<K>(type: K, listener: ((this: MediaQueryList, ev: MediaQueryListEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void;
    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
    addListener(callback: null | ((this: MediaQueryList, ev: MediaQueryListEvent) => any)): void;
    dispatchEvent(event: Event): boolean;
    removeEventListener<K>(type: K, listener: ((this: MediaQueryList, ev: MediaQueryListEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
    removeListener(callback: null | ((this: MediaQueryList, ev: MediaQueryListEvent) => any)): void;
}

Hierarchy

  • EventTarget
    • MediaQueryList

Properties

matches media onchange

Methods

addEventListener addListener dispatchEvent removeEventListener removeListener

Properties

Readonlymatches

matches: boolean

Readonlymedia

media: string

onchange

onchange: null | ((this: MediaQueryList, ev: MediaQueryListEvent) => any)

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    Type Parameters

    • K extends "change"

    Parameters

    Returns void

  • addEventListener(type, listener, options?): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    Parameters

    Returns void

addListener

  • addListener(callback): void

  • Parameters

    Returns void

    Deprecated

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    Type Parameters

    • K extends "change"

    Parameters

    Returns void

  • removeEventListener(type, listener, options?): void

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    Parameters

    Returns void

removeListener

  • removeListener(callback): void

  • Parameters

    Returns void

    Deprecated

Settings

Member Visibility

On This Page

Properties
Methods