---
title: "MouseButton"
description: "Representation of a mouse button with its associated [ID][buttonId] for the current platform."
type: "class"
---

<div class='type'>Class</div>


<a id='references'></a>

<div class='sourceset sourceset-common'>Common</div>


```kotlin
expect value class MouseButton(val buttonId: Int)
```


Representation of a mouse button with its associated `ID` for the current platform.


## Companion Object

#### Properties

<div class='sourceset sourceset-common'>Common</div>


```kotlin
val Primary: MouseButton
```


The primary mouse button. Typically the left mouse button.



<div class='sourceset sourceset-common'>Common</div>


```kotlin
val Secondary: MouseButton
```


The secondary mouse button. Typically the right mouse button.



<div class='sourceset sourceset-common'>Common</div>


```kotlin
val Tertiary: MouseButton
```


The tertiary mouse button. Typically the middle mouse button.




<div class='sourceset sourceset-android'>Android</div>


```kotlin
actual value class MouseButton(val buttonId: Int)
```

## Companion Object

#### Properties

<div class='sourceset sourceset-android'>Android</div>


```kotlin
actual val Primary = MouseButton(MotionEvent.BUTTON_PRIMARY)
```


The left mouse button



<div class='sourceset sourceset-android'>Android</div>


```kotlin
actual val Secondary = MouseButton(MotionEvent.BUTTON_SECONDARY)
```


The right mouse button



<div class='sourceset sourceset-android'>Android</div>


```kotlin
actual val Tertiary = MouseButton(MotionEvent.BUTTON_TERTIARY)
```


The middle mouse button





