# KeyboardHandler

Defined in: [ui/handler/keyboard.ts:29](<https://github.com/maplibre/maplibre-gl-js/blob/538a7680ab16d5cf5a6564ee0ce72a11be14d142/src/ui/handler/keyboard.ts#L29>)

The `KeyboardHandler` allows the user to zoom, rotate, and pan the map using the following keyboard shortcuts:

- `=` / `+`: Increase the zoom level by 1.
- `Shift-=` / `Shift-+`: Increase the zoom level by 2.
- `-`: Decrease the zoom level by 1.
- `Shift--`: Decrease the zoom level by 2.
- Arrow keys: Pan by 100 pixels.
- `Shift+⇢`: Increase the rotation by 15 degrees.
- `Shift+⇠`: Decrease the rotation by 15 degrees.
- `Shift+⇡`: Increase the pitch by 10 degrees.
- `Shift+⇣`: Decrease the pitch by 10 degrees.

## Implements

- [`Handler`](<https://maplibre.org/maplibre-gl-js/docs/API/interfaces/Handler/index.md>)

## Methods

### disable()

> **disable**(): `void`

Defined in: [ui/handler/keyboard.ts:158](<https://github.com/maplibre/maplibre-gl-js/blob/538a7680ab16d5cf5a6564ee0ce72a11be14d142/src/ui/handler/keyboard.ts#L158>)

Disables the "keyboard rotate and zoom" interaction.

#### Returns

`void`

#### Example

```ts
map.keyboard.disable();
```

#### Implementation of

`Handler.disable`

---

### disableRotation()

> **disableRotation**(): `void`

Defined in: [ui/handler/keyboard.ts:194](<https://github.com/maplibre/maplibre-gl-js/blob/538a7680ab16d5cf5a6564ee0ce72a11be14d142/src/ui/handler/keyboard.ts#L194>)

Disables the "keyboard pan/rotate" interaction, leaving the "keyboard zoom" interaction enabled.

#### Returns

`void`

#### Example

```ts
map.keyboard.disableRotation();
```

---

### enable()

> **enable**(): `void`

Defined in: [ui/handler/keyboard.ts:146](<https://github.com/maplibre/maplibre-gl-js/blob/538a7680ab16d5cf5a6564ee0ce72a11be14d142/src/ui/handler/keyboard.ts#L146>)

Enables the "keyboard rotate and zoom" interaction.

#### Returns

`void`

#### Example

```ts
map.keyboard.enable();
```

#### Implementation of

`Handler.enable`

---

### enableRotation()

> **enableRotation**(): `void`

Defined in: [ui/handler/keyboard.ts:207](<https://github.com/maplibre/maplibre-gl-js/blob/538a7680ab16d5cf5a6564ee0ce72a11be14d142/src/ui/handler/keyboard.ts#L207>)

Enables the "keyboard pan/rotate" interaction.

#### Returns

`void`

#### Example

```ts
map.keyboard.enable();
map.keyboard.enableRotation();
```

---

### isActive()

> **isActive**(): `boolean`

Defined in: [ui/handler/keyboard.ts:181](<https://github.com/maplibre/maplibre-gl-js/blob/538a7680ab16d5cf5a6564ee0ce72a11be14d142/src/ui/handler/keyboard.ts#L181>)

Returns true if the handler is enabled and has detected the start of a zoom/rotate gesture.

#### Returns

`boolean`

`true` if the handler is enabled and has detected the start of a zoom/rotate gesture.

#### Implementation of

[`Handler`](<https://maplibre.org/maplibre-gl-js/docs/API/interfaces/Handler/index.md>).[`isActive`](<https://maplibre.org/maplibre-gl-js/docs/API/interfaces/Handler/#isactive>)

---

### isEnabled()

> **isEnabled**(): `boolean`

Defined in: [ui/handler/keyboard.ts:170](<https://github.com/maplibre/maplibre-gl-js/blob/538a7680ab16d5cf5a6564ee0ce72a11be14d142/src/ui/handler/keyboard.ts#L170>)

Returns a Boolean indicating whether the "keyboard rotate and zoom" interaction is enabled.

#### Returns

`boolean`

`true` if the "keyboard rotate and zoom" interaction is enabled.

#### Implementation of

`Handler.isEnabled`

---

### reset()

> **reset**(): `void`

Defined in: [ui/handler/keyboard.ts:48](<https://github.com/maplibre/maplibre-gl-js/blob/538a7680ab16d5cf5a6564ee0ce72a11be14d142/src/ui/handler/keyboard.ts#L48>)

`reset` can be called by the manager at any time and must reset everything to it's original state

#### Returns

`void`

#### Implementation of

[`Handler`](<https://maplibre.org/maplibre-gl-js/docs/API/interfaces/Handler/index.md>).[`reset`](<https://maplibre.org/maplibre-gl-js/docs/API/interfaces/Handler/#reset>)