# rememberAnimatedTextFontRegistry

## Functions summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/AnimatedTextFontRegistry` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 31) https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/rememberAnimatedTextFontRegistry.composable#rememberAnimatedTextFontRegistry(androidx.compose.ui.text.font.FontVariation.Settings,androidx.compose.ui.text.font.FontVariation.Settings,androidx.compose.ui.text.TextStyle,androidx.compose.ui.unit.TextUnit,androidx.compose.ui.unit.TextUnit)( startFontVariationSettings: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontVariation.Settings, endFontVariationSettings: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontVariation.Settings, textStyle: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/TextStyle, startFontSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit, endFontSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit )` Generates an `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/AnimatedTextFontRegistry` to use within composition. |

## Functions

### rememberAnimatedTextFontRegistry

Artifact: [androidx.wear.compose:compose-material3](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/material3/AnimatedText.kt+function:rememberAnimatedTextFontRegistry) Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.6.0)

```
@Composable
@RequiresApi(value = 31)
fun rememberAnimatedTextFontRegistry(
    startFontVariationSettings: FontVariation.Settings,
    endFontVariationSettings: FontVariation.Settings,
    textStyle: TextStyle = LocalTextStyle.current,
    startFontSize: TextUnit = textStyle.fontSize,
    endFontSize: TextUnit = textStyle.fontSize
): AnimatedTextFontRegistry
```

Generates an `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/AnimatedTextFontRegistry` to use within composition.

Start and end of the animation is when the animatable is at 0f and 1f, respectively. This API supports overshooting, so a generated font can be extrapolated outside `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/package-summary#rememberAnimatedTextFontRegistry(androidx.compose.ui.text.font.FontVariation.Settings,androidx.compose.ui.text.font.FontVariation.Settings,androidx.compose.ui.text.TextStyle,androidx.compose.ui.unit.TextUnit,androidx.compose.ui.unit.TextUnit)` and `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/package-summary#rememberAnimatedTextFontRegistry(androidx.compose.ui.text.font.FontVariation.Settings,androidx.compose.ui.text.font.FontVariation.Settings,androidx.compose.ui.text.TextStyle,androidx.compose.ui.unit.TextUnit,androidx.compose.ui.unit.TextUnit)` range, developers need to make sure the given font supports possible font variation settings throughout the animation.

| Parameters |
|---|---|
| `startFontVariationSettings: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontVariation.Settings` | Font variation settings at the start of the animation |
| `endFontVariationSettings: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontVariation.Settings` | Font variation settings at the end of the animation |
| `textStyle: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/TextStyle = LocalTextStyle.current` | Text style to be used for the animation |
| `startFontSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit = textStyle.fontSize` | Font size at the start of the animation |
| `endFontSize: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit = textStyle.fontSize` | Font size at the end of the animation |