# DrawerState

Artifact: [androidx.tv:tv-material](https://developer.android.com/jetpack/androidx/releases/tv) [View Source](https://cs.android.com/search?q=file:androidx/tv/material3/NavigationDrawer.kt+class:androidx.tv.material3.DrawerState) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)


```
class DrawerState
```

<br />

*** ** * ** ***

State of the `https://developer.android.com/reference/kotlin/androidx/tv/material3/NavigationDrawer.composable#NavigationDrawer(kotlin.Function2,androidx.compose.ui.Modifier,androidx.tv.material3.DrawerState,kotlin.Function0)` or `https://developer.android.com/reference/kotlin/androidx/tv/material3/ModalNavigationDrawer.composable#ModalNavigationDrawer(kotlin.Function2,androidx.compose.ui.Modifier,androidx.tv.material3.DrawerState,androidx.compose.ui.graphics.Brush,kotlin.Function0)` composable.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/runtime/saveable/Saver<https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerState, https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerValue>` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerState#Saver()` The `https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerState#Saver()` used by `https://developer.android.com/reference/kotlin/androidx/tv/material3/rememberDrawerState.composable#rememberDrawerState(androidx.tv.material3.DrawerValue)` to record and restore `https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerState` across activity or process recreation. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerState#DrawerState(androidx.tv.material3.DrawerValue)(initialValue: https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerValue)` |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerState#setValue(androidx.tv.material3.DrawerValue)(drawerValue: https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerValue)` Updates the state of the drawer. |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerValue` | `https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerState#currentValue()` |

## Public companion properties

### Saver

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val Saver: Saver<DrawerState, DrawerValue>
```

The `https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerState#Saver()` used by `https://developer.android.com/reference/kotlin/androidx/tv/material3/rememberDrawerState.composable#rememberDrawerState(androidx.tv.material3.DrawerValue)` to record and restore `https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerState` across activity or process recreation.

## Public constructors

### DrawerState

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
DrawerState(initialValue: DrawerValue = DrawerValue.Closed)
```

| Parameters |
|---|---|
| `initialValue: https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerValue = DrawerValue.Closed` | the initial value (`https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerValue#Closed` or `https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerValue#Open`) of the drawer. |

## Public functions

### setValue

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
fun setValue(drawerValue: DrawerValue): Unit
```

Updates the state of the drawer.

| Parameters |
|---|---|
| `drawerValue: https://developer.android.com/reference/kotlin/androidx/tv/material3/DrawerValue` | the value the state of the drawer should be set to. |

## Public properties

### currentValue

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/tv#1.0.0)

```
val currentValue: DrawerValue
```