---
title: "MediaQueryList | JavaScript maps SDK"
description: "Documentation for MapTiler SDK"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# Interface MediaQueryList

A **`MediaQueryList`** object stores information on a media query applied to a document, with support for both immediate and event-driven matching against the state of the document.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/MediaQueryList)

interface MediaQueryList {  
    [matches](#matches): boolean;  
    [media](#media): string;  
    [onchange](#onchange): ((this: MediaQueryList, ev: [MediaQueryListEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEvent/)) \=> any) | null;  
    [addEventListener](#addeventlistener-1)<[K](#addeventlistenerk) extends "change"\>(  
        type: [K](#addeventlistenerk),  
        listener: (this: MediaQueryList, ev: [MediaQueryListEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEventMap/)\[[K](#addeventlistenerk)\]) \=> any,  
        options?: boolean | AddEventListenerOptions,  
    ): void;  
    [addEventListener](#addeventlistener-2)(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | AddEventListenerOptions,  
    ): void;  
    [addListener](#addlistener-1)(  
        callback:  
            | ((this: MediaQueryList, ev: [MediaQueryListEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEvent/)) \=> any)  
            | null,  
    ): void;  
    [dispatchEvent](#dispatchevent-1)(event: Event): boolean;  
    [removeEventListener](#removeeventlistener-1)<[K](#removeeventlistenerk) extends "change"\>(  
        type: [K](#removeeventlistenerk),  
        listener: (this: MediaQueryList, ev: [MediaQueryListEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEventMap/)\[[K](#removeeventlistenerk)\]) \=> any,  
        options?: boolean | EventListenerOptions,  
    ): void;  
    [removeEventListener](#removeeventlistener-2)(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | EventListenerOptions,  
    ): void;  
    [removeListener](#removelistener-1)(  
        callback:  
            | ((this: MediaQueryList, ev: [MediaQueryListEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEvent/)) \=> any)  
            | null,  
    ): void;  
}

#### Hierarchy

-   EventTarget
    -   MediaQueryList

##### Index

### Properties[](#properties)

[matches](#matches) [media](#media) [onchange](#onchange)

### Methods[](#methods)

[addEventListener](#addeventlistener) [addListener](#addlistener) [dispatchEvent](#dispatchevent) [removeEventListener](#removeeventlistener) [removeListener](#removelistener)

## Properties[](#properties-1)

### `Readonly`matches[](#matches)

matches: boolean

The **`matches`** read-only property of the MediaQueryList interface is a boolean value that returns true if the document currently matches the media query list, or false if not.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/MediaQueryList/matches)

### `Readonly`media[](#media)

media: string

The **`media`** read-only property of the MediaQueryList interface is a string representing a serialized media query.

[MDN Reference](https://developer.mozilla.org/docs/Web/API/MediaQueryList/media)

### onchange[](#onchange)

onchange: ((this: MediaQueryList, ev: [MediaQueryListEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEvent/)) \=> any) | null

[MDN Reference](https://developer.mozilla.org/docs/Web/API/MediaQueryList/change_event)

## Methods[](#methods-1)

### addEventListener[](#addeventlistener)

-   addEventListener<[K](#addeventlistenerk) extends "change"\>(  
        type: [K](#addeventlistenerk),  
        listener: (this: MediaQueryList, ev: [MediaQueryListEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEventMap/)\[[K](#addeventlistenerk)\]) \=> any,  
        options?: boolean | AddEventListenerOptions,  
    ): void[](#addeventlistener-1)
    
    The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
    
    #### Type Parameters
    
    -   K extends "change"
    
    #### Parameters
    
    -   type: [K](#addeventlistenerk)
    -   listener: (this: MediaQueryList, ev: [MediaQueryListEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEventMap/)\[[K](#addeventlistenerk)\]) \=> any
    -   `Optional`options: boolean | AddEventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.addEventListener
    
-   addEventListener(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | AddEventListenerOptions,  
    ): void[](#addeventlistener-2)
    
    The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
    
    #### Parameters
    
    -   type: string
    -   listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/)
    -   `Optional`options: boolean | AddEventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.addEventListener
    

### addListener[](#addlistener)

-   addListener(  
        callback:  
            | ((this: MediaQueryList, ev: [MediaQueryListEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEvent/)) \=> any)  
            | null,  
    ): void[](#addlistener-1)
    
    The deprecated **`addListener()`** method of the MediaQueryList interface adds a listener to the MediaQueryListener that will run a custom callback function in response to the media query status changing.
    
    #### Parameters
    
    -   callback: ((this: MediaQueryList, ev: [MediaQueryListEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEvent/)) \=> any) | null
    
    #### Returns void
    
    #### Deprecated[](#deprecated)
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/MediaQueryList/addListener)
    

### dispatchEvent[](#dispatchevent)

-   dispatchEvent(event: Event): boolean[](#dispatchevent-1)
    
    The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
    
    #### Parameters
    
    -   event: Event
    
    #### Returns boolean
    
    Inherited from EventTarget.dispatchEvent
    

### removeEventListener[](#removeeventlistener)

-   removeEventListener<[K](#removeeventlistenerk) extends "change"\>(  
        type: [K](#removeeventlistenerk),  
        listener: (this: MediaQueryList, ev: [MediaQueryListEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEventMap/)\[[K](#removeeventlistenerk)\]) \=> any,  
        options?: boolean | EventListenerOptions,  
    ): void[](#removeeventlistener-1)
    
    The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
    
    #### Type Parameters
    
    -   K extends "change"
    
    #### Parameters
    
    -   type: [K](#removeeventlistenerk)
    -   listener: (this: MediaQueryList, ev: [MediaQueryListEventMap](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEventMap/)\[[K](#removeeventlistenerk)\]) \=> any
    -   `Optional`options: boolean | EventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.removeEventListener
    
-   removeEventListener(  
        type: string,  
        listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/),  
        options?: boolean | EventListenerOptions,  
    ): void[](#removeeventlistener-2)
    
    The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
    
    #### Parameters
    
    -   type: string
    -   listener: [EventListenerOrEventListenerObject](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.EventListenerOrEventListenerObject/)
    -   `Optional`options: boolean | EventListenerOptions
    
    #### Returns void
    
    Overrides EventTarget.removeEventListener
    

### removeListener[](#removelistener)

-   removeListener(  
        callback:  
            | ((this: MediaQueryList, ev: [MediaQueryListEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEvent/)) \=> any)  
            | null,  
    ): void[](#removelistener-1)
    
    The **`removeListener()`** method of the MediaQueryList interface removes a listener from the MediaQueryListener.
    
    #### Parameters
    
    -   callback: ((this: MediaQueryList, ev: [MediaQueryListEvent](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.MediaQueryListEvent/)) \=> any) | null
    
    #### Returns void
    
    #### Deprecated[](#deprecated-1)
    
    [MDN Reference](https://developer.mozilla.org/docs/Web/API/MediaQueryList/removeListener)