# AppBarScope

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/AppBarDsl.kt+class:androidx.compose.material3.AppBarScope) Common/AllAndroid/JVM
- Cmn

  ```
  sealed interface AppBarScope
  ```
Known direct subclasses [AppBarColumnScope](https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarColumnScope), [AppBarRowScope](https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarRowScope)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarColumnScope` | DSL scope for building the content of an `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarColumn.composable#AppBarColumn(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)`. |
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarRowScope` | DSL scope for building the content of an `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarRow.composable#AppBarRow(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)`. |

*** ** * ** ***

DSL scope for building the content of an `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarRow.composable#AppBarRow(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)` and `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarColumn.composable#AppBarColumn(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)`.

## Summary

| ### Public functions |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarScope#clickableItem(kotlin.Function0,kotlin.Function0,kotlin.String,kotlin.Boolean)( onClick: () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html, icon: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html, label: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` Adds a clickable item to the `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarRow.composable#AppBarRow(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)` or `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarColumn.composable#AppBarColumn(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)`. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarScope#customItem(kotlin.Function0,kotlin.Function1)( appbarContent: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html, menuContent: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable (https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarMenuState) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` Adds a custom item to the `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarRow.composable#AppBarRow(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)` or `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarColumn.composable#AppBarColumn(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)`. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarScope#toggleableItem(kotlin.Boolean,kotlin.Function1,kotlin.Function0,kotlin.String,kotlin.Boolean)( checked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, onCheckedChange: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html, icon: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html, label: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` Adds a toggleable item to the `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarRow.composable#AppBarRow(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)` or `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarColumn.composable#AppBarColumn(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)`. | Cmn |

## Public functions

### clickableItem

Cmn

```
fun clickableItem(
    onClick: () -> Unit,
    icon: @Composable () -> Unit,
    label: String,
    enabled: Boolean = true
): Unit
```

Adds a clickable item to the `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarRow.composable#AppBarRow(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)` or `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarColumn.composable#AppBarColumn(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)`.

| Parameters |
|---|---|
| `onClick: () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | The action to perform when the item is clicked. |
| `icon: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | The composable representing the item's icon. |
| `label: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The text label for the item, used in the overflow menu. |
| `enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether the item is enabled. |

### customItem

Cmn

```
fun customItem(
    appbarContent: @Composable () -> Unit,
    menuContent: @Composable (AppBarMenuState) -> Unit
): Unit
```

Adds a custom item to the `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarRow.composable#AppBarRow(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)` or `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarColumn.composable#AppBarColumn(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)`.

| Parameters |
|---|---|
| `appbarContent: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | The composable to display in the app bar. |
| `menuContent: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable (https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarMenuState) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | The composable to display in the overflow menu. It receives an `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarMenuState` instance. |

### toggleableItem

Cmn

```
fun toggleableItem(
    checked: Boolean,
    onCheckedChange: (Boolean) -> Unit,
    icon: @Composable () -> Unit,
    label: String,
    enabled: Boolean = true
): Unit
```

Adds a toggleable item to the `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarRow.composable#AppBarRow(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)` or `https://developer.android.com/reference/kotlin/androidx/compose/material3/AppBarColumn.composable#AppBarColumn(androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Int,kotlin.Function1)`.

| Parameters |
|---|---|
| `checked: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether the item is currently checked. |
| `onCheckedChange: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | The action to perform when the item's checked state changes. |
| `icon: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | The composable representing the item's icon. |
| `label: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The text label for the item, used in the overflow menu. |
| `enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Whether the item is enabled. |