# SheetValue

Artifact: [androidx.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/compose/material3/SheetDefaults.kt+class:androidx.compose.material3.SheetValue) Common/AllAndroid/JVM
- Cmn

  ```
  @ExperimentalMaterial3Api
  enum SheetValue : Enum<SheetValue>
  ```

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)\<[SheetValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue)\> ||
|   | ↳ | [androidx.compose.material3.SheetValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue) |

*** ** * ** ***

Possible values of `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetState`.

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue#Expanded` | The sheet is visible at full height. |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue#Hidden` | The sheet is not visible. |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue#PartiallyExpanded` | The sheet is partially visible. |

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue#valueOf(kotlin.String)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue>` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue#values()()` Returns an array containing the constants of this enum type, in the order they're declared. | Cmn |

| ### Public properties |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue>` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue#entries()` Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared. | Cmn |

## Enum Values

### Expanded

```
@ExperimentalMaterial3Api
val SheetValue.Expanded: SheetValue
```

The sheet is visible at full height.

### Hidden

```
@ExperimentalMaterial3Api
val SheetValue.Hidden: SheetValue
```

The sheet is not visible.

### PartiallyExpanded

```
@ExperimentalMaterial3Api
val SheetValue.PartiallyExpanded: SheetValue
```

The sheet is partially visible.

## Public functions

### valueOf

Cmn

```
fun valueOf(value: String): SheetValue
```

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

Cmn

```
fun values(): Array<SheetValue>
```

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using `entries` property as a more efficient alternative returning an immutable list of enum entries.

## Public properties

### entries

Cmn

```
val entries: EnumEntries<SheetValue>
```

Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared.