---
title: "MaptilerCustomControl | 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.

# Class MaptilerCustomControl`Maptiler`

The MaptilerCustomControl allows any existing element to become a map control.

#### Hierarchy ([View Summary](https://docs.maptiler.com/sdk-js/api-reference/hierarchy/#MaptilerCustomControl))

-   MaptilerCustomControl
    -   [MaptilerExternalControl](https://docs.maptiler.com/sdk-js/api-reference/classes/MaptilerExternalControl/)

#### Implements

-   [IControl](https://docs.maptiler.com/sdk-js/api-reference/interfaces/IControl/)

##### Index

### Constructors[](#constructors)

[constructor](#constructor)

### Methods[](#methods)

[onAdd](#onadd) [onRemove](#onremove)

## Constructors[](#constructors-1)

### `Maptiler`constructor[](#constructor)

-   new MaptilerCustomControl(  
        selectorOrElement: string | [HTMLElement](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.HTMLElement/),  
        onClick?: [MaptilerCustomControlCallback](https://docs.maptiler.com/sdk-js/api-reference/types/MaptilerCustomControlCallback/)<Event\>,  
        onRender?: [MaptilerCustomControlCallback](https://docs.maptiler.com/sdk-js/api-reference/types/MaptilerCustomControlCallback/)<[MapLibreEvent](https://docs.maptiler.com/sdk-js/api-reference/types/MapLibreEvent/)\>,  
    ): MaptilerCustomControl[](#constructormaptilercustomcontrol)
    
    #### Parameters
    
    -   selectorOrElement: string | [HTMLElement](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.HTMLElement/)
        
        Element to be used as control, specified as either reference to element itself or a CSS selector to find the element in DOM
        
    -   `Optional`onClick: [MaptilerCustomControlCallback](https://docs.maptiler.com/sdk-js/api-reference/types/MaptilerCustomControlCallback/)<Event\>
        
        Function called when the element is clicked
        
    -   `Optional`onRender: [MaptilerCustomControlCallback](https://docs.maptiler.com/sdk-js/api-reference/types/MaptilerCustomControlCallback/)<[MapLibreEvent](https://docs.maptiler.com/sdk-js/api-reference/types/MapLibreEvent/)\>
        
        Function called every time the underlying map renders a new state
        
    
    #### Returns MaptilerCustomControl
    

## Methods[](#methods-1)

### `Maptiler`onAdd[](#onadd)

-   onAdd(map: [Map](https://docs.maptiler.com/sdk-js/api-reference/classes/Map/)): [HTMLElement](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.HTMLElement/)[](#onadd-1)
    
    Register a control on the map and give it a chance to register event listeners and resources. This method is called by [Map.addControl](https://docs.maptiler.com/sdk-js/api-reference/classes/Map/#addcontrol) internally.
    
    #### Parameters
    
    -   map: [Map](https://docs.maptiler.com/sdk-js/api-reference/classes/Map/)
        
        the Map this control will be added to
        
    
    #### Returns [HTMLElement](https://docs.maptiler.com/sdk-js/api-reference/interfaces/Externals.HTMLElement/)
    
    The control's container element. This should be created by the control and returned by onAdd without being attached to the DOM: the map will insert the control's element into the DOM as necessary.
    
    Implementation of [IControl](https://docs.maptiler.com/sdk-js/api-reference/interfaces/IControl/).[onAdd](https://docs.maptiler.com/sdk-js/api-reference/interfaces/IControl/#onadd)
    

### `Maptiler`onRemove[](#onremove)

-   onRemove(): void[](#onremove-1)
    
    Unregister a control on the map and give it a chance to detach event listeners and resources. This method is called by [Map.removeControl](https://docs.maptiler.com/sdk-js/api-reference/classes/Map/#removecontrol) internally.
    
    #### Returns void
    
    Implementation of [IControl](https://docs.maptiler.com/sdk-js/api-reference/interfaces/IControl/).[onRemove](https://docs.maptiler.com/sdk-js/api-reference/interfaces/IControl/#onremove)