# ToggleFloatingActionButtonDefaults

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

  ```
  object ToggleFloatingActionButtonDefaults
  ```

*** ** * ** ***

Contains the default values used by `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButton.composable#ToggleFloatingActionButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Function1,androidx.compose.ui.Alignment,kotlin.Function1,kotlin.Function1,kotlin.Function1)`

## Summary

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#(androidx.compose.ui.Modifier).animateIcon(kotlin.Function0,kotlin.Function1,kotlin.Function1)( checkedProgress: () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, color: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, size: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp )` Modifier for animating the color and size of an icon within `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButton.composable#ToggleFloatingActionButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Function1,androidx.compose.ui.Alignment,kotlin.Function1,kotlin.Function1,kotlin.Function1)` based on a progress value. | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#containerColor(androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)(initialColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, finalColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color)` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#containerCornerRadius()()` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#containerCornerRadius(androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp)(initialSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp, finalSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp)` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#containerCornerRadiusLarge()()` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#containerCornerRadiusMedium()()` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#containerSize()()` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#containerSize(androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp)(initialSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp, finalSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp)` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#containerSizeLarge()()` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#containerSizeMedium()()` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#iconColor(androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color)(initialColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color, finalColor: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color)` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#iconSize()()` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#iconSize(androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp)(initialSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp, finalSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp)` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#iconSizeLarge()()` | Cmn |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButtonDefaults#iconSizeMedium()()` | Cmn |

## Public functions

### Modifier.animateIcon

Cmn 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/FloatingActionButtonMenu.kt+function:animateIcon)

```
@Composable
fun Modifier.animateIcon(
    checkedProgress: () -> Float,
    color: (Float) -> Color = iconColor(),
    size: (Float) -> Dp = iconSize()
): Modifier
```

Modifier for animating the color and size of an icon within `https://developer.android.com/reference/kotlin/androidx/compose/material3/ToggleFloatingActionButton.composable#ToggleFloatingActionButton(kotlin.Boolean,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Function1,androidx.compose.ui.Alignment,kotlin.Function1,kotlin.Function1,kotlin.Function1)` based on a progress value.

| Parameters |
|---|---|
| `checkedProgress: () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | callback that provides the progress value for the icon animation |
| `color: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color = iconColor()` | the color of the icon, based on the checked progress value from 0-1 |
| `size: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) -> https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp = iconSize()` | the size of the icon, based on the checked progress value from 0-1 |

### containerColor

Cmn

```
@Composable
fun containerColor(
    initialColor: Color = MaterialTheme.colorScheme.primaryContainer,
    finalColor: Color = MaterialTheme.colorScheme.primary
): (Float) -> Color
```

### containerCornerRadius

Cmn

```
fun containerCornerRadius(): (Float) -> Dp
```

### containerCornerRadius

Cmn

```
fun containerCornerRadius(initialSize: Dp, finalSize: Dp = FabFinalCornerRadius): (Float) -> Dp
```

### containerCornerRadiusLarge

Cmn

```
fun containerCornerRadiusLarge(): (Float) -> Dp
```

### containerCornerRadiusMedium

Cmn

```
fun containerCornerRadiusMedium(): (Float) -> Dp
```

### containerSize

Cmn

```
fun containerSize(): (Float) -> Dp
```

### containerSize

Cmn

```
fun containerSize(initialSize: Dp, finalSize: Dp = FabFinalSize): (Float) -> Dp
```

### containerSizeLarge

Cmn

```
fun containerSizeLarge(): (Float) -> Dp
```

### containerSizeMedium

Cmn

```
fun containerSizeMedium(): (Float) -> Dp
```

### iconColor

Cmn

```
@Composable
fun iconColor(
    initialColor: Color = MaterialTheme.colorScheme.onPrimaryContainer,
    finalColor: Color = MaterialTheme.colorScheme.onPrimary
): (Float) -> Color
```

### iconSize

Cmn

```
fun iconSize(): (Float) -> Dp
```

### iconSize

Cmn

```
fun iconSize(initialSize: Dp, finalSize: Dp = FabFinalIconSize): (Float) -> Dp
```

### iconSizeLarge

Cmn

```
fun iconSizeLarge(): (Float) -> Dp
```

### iconSizeMedium

Cmn

```
fun iconSizeMedium(): (Float) -> Dp
```