# SpaceToggleButton

## Functions summary

|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/xr/compose/material3/SpaceToggleButton.composable#SpaceToggleButton(androidx.compose.ui.Modifier,androidx.compose.material3.IconToggleButtonColors,kotlin.Function1)( modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier, colors: https://developer.android.com/reference/kotlin/androidx/compose/material3/IconToggleButtonColors, content: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable (isFullSpace: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` A composable button that toggles between "Full Space" and "Home Space" in an Android XR application. |

## Functions

### SpaceToggleButton

Artifact: [androidx.xr.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/xr-compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/xr/compose/material3/SpaceToggleButton.kt+function:SpaceToggleButton)

```
@Composable
fun SpaceToggleButton(
    modifier: Modifier = Modifier,
    colors: IconToggleButtonColors = IconButtonDefaults.iconToggleButtonColors(),
    content: @Composable (isFullSpace: Boolean) -> Unit = { isFullSpace ->
        if (isFullSpace) {
            SpaceToggleButtonDefaults.CollapseIcon()
        } else {
            SpaceToggleButtonDefaults.ExpandIcon()
        }
    }
): Unit
```

A composable button that toggles between "Full Space" and "Home Space" in an Android XR application.

It adapts to the current spatial mode, visually representing it with either a default icon or provided custom content.

| Parameters |
|---|---|
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier = Modifier` | The modifier to be applied to the button layout. |
| `colors: https://developer.android.com/reference/kotlin/androidx/compose/material3/IconToggleButtonColors = IconButtonDefaults.iconToggleButtonColors()` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/IconToggleButtonColors` that will be used to resolve the colors for this button. |
| `content: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable (isFullSpace: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html = { isFullSpace -> if (isFullSpace) { SpaceToggleButtonDefaults.CollapseIcon() } else { SpaceToggleButtonDefaults.ExpandIcon() } }` | The content to be displayed inside the button. |