# HeightSizeClass

Artifact: [androidx.test.espresso:espresso-device](https://developer.android.com/jetpack/androidx/releases/test-espresso) [View Source](https://cs.android.com/search?q=file:androidx/test/espresso/device/sizeclass/HeightSizeClass.kt+class:androidx.test.espresso.device.sizeclass.HeightSizeClass)

*** ** * ** ***


```
class HeightSizeClass
```

<br />

*** ** * ** ***

A class to create buckets for the height of a window.

For details on window size classes, see https://developer.android.com/guide/topics/large-screens/support-different-screen-sizes.

## Summary

| ### Nested types |
|---|
| `object https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass.Companion` |
| `enum https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass.Companion.HeightSizeClassEnum : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html<https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass.Companion.HeightSizeClassEnum>` |

| ### Public companion functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass` | `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass#compute(kotlin.Int)(dpHeight: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns a recommended `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass` for the height of a window given the height in DP. |
| `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass.Companion.HeightSizeClassEnum` | `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass#getEnum(androidx.test.espresso.device.sizeclass.HeightSizeClass)(sizeClass: https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass)` Returns a `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass.Companion.HeightSizeClassEnum` given the `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass#getHeightDpInSizeClass(androidx.test.espresso.device.sizeclass.HeightSizeClass)(sizeClass: https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass)` Returns a recommended height of a window in DP given the `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass`. |

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass` | `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass#COMPACT()` A bucket to represent a compact height. |
| `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass` | `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass#EXPANDED()` A bucket to represent an expanded height window. |
| `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass` | `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass#MEDIUM()` A bucket to represent a medium height. |

## Public companion functions

### compute

```
fun compute(dpHeight: Int): HeightSizeClass
```

Returns a recommended `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass` for the height of a window given the height in DP.

| Parameters |
|---|---|
| `dpHeight: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | the height of the window in DP |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass` | A recommended size class for the height |

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if the height is negative |

### getEnum

```
fun getEnum(sizeClass: HeightSizeClass): HeightSizeClass.Companion.HeightSizeClassEnum
```

Returns a `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass.Companion.HeightSizeClassEnum` given the `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass`.

| Parameters |
|---|---|
| `sizeClass: https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass` | the size class |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass.Companion.HeightSizeClassEnum` | the relevant HeightSizeClassEnum |

### getHeightDpInSizeClass

```
fun getHeightDpInSizeClass(sizeClass: HeightSizeClass): Int
```

Returns a recommended height of a window in DP given the `https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass`.

| Parameters |
|---|---|
| `sizeClass: https://developer.android.com/reference/kotlin/androidx/test/espresso/device/sizeclass/HeightSizeClass` | the size class |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | A recommended height in DP in this size class |

## Public companion properties

### COMPACT

```
val COMPACT: HeightSizeClass
```

A bucket to represent a compact height. One use-case is a phone that is in landscape.

### EXPANDED

```
val EXPANDED: HeightSizeClass
```

A bucket to represent an expanded height window. One use-case is a tablet or a desktop app.

### MEDIUM

```
val MEDIUM: HeightSizeClass
```

A bucket to represent a medium height. One use-case is a phone in portrait or a tablet.