# Scaffold

## 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/glance/appwidget/components/Scaffold.composable#Scaffold(androidx.glance.GlanceModifier,kotlin.Function0,androidx.glance.unit.ColorProvider,androidx.compose.ui.unit.Dp,kotlin.Function0)( modifier: https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier, titleBar: (@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)?, backgroundColor: https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider, horizontalPadding: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp, content: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` A simple slot api component for displaying widget UI with a `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/components/TitleBar.composable#TitleBar(androidx.glance.ImageProvider,kotlin.String,androidx.glance.unit.ColorProvider,androidx.glance.unit.ColorProvider,androidx.glance.GlanceModifier,androidx.glance.text.FontFamily,kotlin.Function1)`. |

## Functions

### Scaffold

Artifact: [androidx.glance:glance-appwidget](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/appwidget/components/Scaffold.kt+function:Scaffold) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/glance#1.2.0)

```
@Composable
fun Scaffold(
    modifier: GlanceModifier = GlanceModifier,
    titleBar: (@Composable () -> Unit)? = null,
    backgroundColor: ColorProvider = GlanceTheme.colors.widgetBackground,
    horizontalPadding: Dp = 12.dp,
    content: @Composable () -> Unit
): Unit
```

A simple slot api component for displaying widget UI with a `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/components/TitleBar.composable#TitleBar(androidx.glance.ImageProvider,kotlin.String,androidx.glance.unit.ColorProvider,androidx.glance.unit.ColorProvider,androidx.glance.GlanceModifier,androidx.glance.text.FontFamily,kotlin.Function1)`. Sets the background color to `GlanceTheme.colors.surface` and applies padding. This is intended to be used as a top level component.

| Parameters |
|---|---|
| `modifier: https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier = GlanceModifier` | a modifier |
| `titleBar: (@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)? = null` | A composable that creates the `https://developer.android.com/reference/kotlin/androidx/glance/appwidget/components/TitleBar.composable#TitleBar(androidx.glance.ImageProvider,kotlin.String,androidx.glance.unit.ColorProvider,androidx.glance.unit.ColorProvider,androidx.glance.GlanceModifier,androidx.glance.text.FontFamily,kotlin.Function1)`. Optional parameter. |
| `backgroundColor: https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider = GlanceTheme.colors.widgetBackground` | the background color for the layout. |
| `horizontalPadding: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp = 12.dp` | Scaffold provides a default padding which should work for most use cases. However, it can be overridden. |
| `content: @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable () -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | The main content of the widget. |