# androidx.glance

## Interfaces

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceId` | Opaque object used to describe a glance view. |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier` | An ordered, immutable, collection of modifier element for the Glance library. |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier.Element` | A single element contained within a `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier` chain. |
| `https://developer.android.com/reference/kotlin/androidx/glance/ImageProvider` | Interface representing an Image source which can be used with a Glance `https://developer.android.com/reference/kotlin/androidx/glance/Image.composable#Image(androidx.glance.ImageProvider,kotlin.String,androidx.glance.GlanceModifier,androidx.glance.layout.ContentScale,androidx.glance.ColorFilter)` element. |

## Classes

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/ButtonColors` | Represents the colors used to style a button, prefer this to using the modifier. |
| `https://developer.android.com/reference/kotlin/androidx/glance/ColorFilter` | Effects used to modify the color of an image. |
| `https://developer.android.com/reference/kotlin/androidx/glance/CombinedGlanceModifier` | A node in a `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier` chain. |

## Objects

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/ButtonDefaults` | Contains the default values used by `https://developer.android.com/reference/kotlin/androidx/glance/Button.composable#Button(kotlin.String,androidx.glance.action.Action,androidx.glance.GlanceModifier,kotlin.Boolean,androidx.glance.text.TextStyle,androidx.glance.ButtonColors,kotlin.Int)`. |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier.Companion` | The companion object `Modifier` is the empty, default, or starter `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier` that contains no `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier.Element`. |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceTheme` | Object that provides access to the current theme. |

## Annotations

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/ExperimentalGlanceApi` |   |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceComposable` | An annotation that can be used to mark a composable function as being expected to be use in a composable function that is also marked or inferred to be marked as a `https://developer.android.com/reference/kotlin/androidx/glance/GlanceComposable`. |

## Enums

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/Visibility` | Value of the visibility field for a node in the composition tree. |

## Composables

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/Button.composable` | Adds a button view to the glance view. |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceTheme.composable` | A top level theme for Glance code. |
| `https://developer.android.com/reference/kotlin/androidx/glance/Image.composable` | A composable which lays out and draws the image specified in `https://developer.android.com/reference/kotlin/androidx/glance/package-summary#Image(androidx.glance.ImageProvider,kotlin.String,androidx.glance.GlanceModifier,androidx.glance.layout.ContentScale,androidx.glance.ColorFilter)`. |
| `https://developer.android.com/reference/kotlin/androidx/glance/currentState.composable` | Retrieves the current customizable store for view specific state data as defined by `https://developer.android.com/reference/kotlin/androidx/glance/state/GlanceStateDefinition` in the surface implementation. |

## Top-level functions summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/ImageProvider` | `https://developer.android.com/reference/kotlin/androidx/glance/package-summary#ImageProvider(android.graphics.Bitmap)(bitmap: https://developer.android.com/reference/android/graphics/Bitmap.html)` Image resource from a bitmap. |
| `https://developer.android.com/reference/kotlin/androidx/glance/ImageProvider` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 23) https://developer.android.com/reference/kotlin/androidx/glance/package-summary#ImageProvider(android.graphics.drawable.Icon)(icon: https://developer.android.com/reference/android/graphics/drawable/Icon.html)` Image resource from an icon. |
| `https://developer.android.com/reference/kotlin/androidx/glance/ImageProvider` | `https://developer.android.com/reference/kotlin/androidx/glance/package-summary#ImageProvider(kotlin.Int)(resId: @https://developer.android.com/reference/kotlin/androidx/annotation/DrawableRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Image resource from an Android Drawable resource. |

## Extension functions summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier` | `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier.https://developer.android.com/reference/kotlin/androidx/glance/package-summary#(androidx.glance.GlanceModifier).background(androidx.compose.ui.graphics.Color)(color: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color)` Apply a background color to the element this modifier is attached to. |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier` | `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier.https://developer.android.com/reference/kotlin/androidx/glance/package-summary#(androidx.glance.GlanceModifier).background(kotlin.Int)(color: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Apply a background color to the element this modifier is attached to. |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier` | `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier.https://developer.android.com/reference/kotlin/androidx/glance/package-summary#(androidx.glance.GlanceModifier).background(androidx.glance.unit.ColorProvider)(colorProvider: https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider)` Apply a background color to the element this modifier is attached to. |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier` | `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier.https://developer.android.com/reference/kotlin/androidx/glance/package-summary#(androidx.glance.GlanceModifier).background(androidx.glance.ImageProvider,androidx.glance.layout.ContentScale,androidx.glance.ColorFilter)( imageProvider: https://developer.android.com/reference/kotlin/androidx/glance/ImageProvider, contentScale: https://developer.android.com/reference/kotlin/androidx/glance/layout/ContentScale, colorFilter: https://developer.android.com/reference/kotlin/androidx/glance/ColorFilter? )` Apply a background image to the element this modifier is attached to. |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier` | `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier.https://developer.android.com/reference/kotlin/androidx/glance/package-summary#(androidx.glance.GlanceModifier).background(androidx.glance.ImageProvider,kotlin.Float,androidx.glance.layout.ContentScale,androidx.glance.ColorFilter)( imageProvider: https://developer.android.com/reference/kotlin/androidx/glance/ImageProvider, alpha: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0, to = 1.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, contentScale: https://developer.android.com/reference/kotlin/androidx/glance/layout/ContentScale, colorFilter: https://developer.android.com/reference/kotlin/androidx/glance/ColorFilter? )` Apply a background image to the element this modifier is attached to. |
| `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier` | `https://developer.android.com/reference/kotlin/androidx/glance/GlanceModifier.https://developer.android.com/reference/kotlin/androidx/glance/package-summary#(androidx.glance.GlanceModifier).visibility(androidx.glance.Visibility)(visibility: https://developer.android.com/reference/kotlin/androidx/glance/Visibility)` Change the visibility of the current node. |

## Top-level properties summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/runtime/ProvidableCompositionLocal<https://developer.android.com/reference/android/content/Context.html>` | `https://developer.android.com/reference/kotlin/androidx/glance/package-summary#LocalContext()` Context of application when generating the glance view. |
| `https://developer.android.com/reference/kotlin/androidx/compose/runtime/ProvidableCompositionLocal<https://developer.android.com/reference/kotlin/androidx/glance/GlanceId>` | `https://developer.android.com/reference/kotlin/androidx/glance/package-summary#LocalGlanceId()` Unique Id for the glance view being generated by the current composition. |
| `https://developer.android.com/reference/kotlin/androidx/compose/runtime/ProvidableCompositionLocal<https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/DpSize>` | `https://developer.android.com/reference/kotlin/androidx/glance/package-summary#LocalSize()` Size of the glance view being generated. |
| `https://developer.android.com/reference/kotlin/androidx/compose/runtime/ProvidableCompositionLocal<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?>` | `https://developer.android.com/reference/kotlin/androidx/glance/package-summary#LocalState()` Local view state, defined in surface implementation. |

## Top-level functions

### ImageProvider

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/Image.kt+function:ImageProvider) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
fun ImageProvider(bitmap: Bitmap): ImageProvider
```

Image resource from a bitmap.

| Parameters |
|---|---|
| `bitmap: https://developer.android.com/reference/android/graphics/Bitmap.html` | The bitmap to be displayed. |

### ImageProvider

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/Image.kt+function:ImageProvider) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
@RequiresApi(value = 23)
fun ImageProvider(icon: Icon): ImageProvider
```

Image resource from an icon.

| Parameters |
|---|---|
| `icon: https://developer.android.com/reference/android/graphics/drawable/Icon.html` | The icon to be displayed. |

### ImageProvider

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/Image.kt+function:ImageProvider) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
fun ImageProvider(resId: @DrawableRes Int): ImageProvider
```

Image resource from an Android Drawable resource.

| Parameters |
|---|---|
| `resId: @https://developer.android.com/reference/kotlin/androidx/annotation/DrawableRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The resource ID of the Drawable resource to be used. |

## Extension functions

### GlanceModifier.background

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

```
fun GlanceModifier.background(color: Color): GlanceModifier
```

Apply a background color to the element this modifier is attached to. This will cause the element to paint the specified `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` as its background, which will fill the bounds of the element.

| Parameters |
|---|---|
| `color: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color` | The color to set as the background. |

### GlanceModifier.background

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/Background.kt+function:background) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
fun GlanceModifier.background(color: @ColorRes Int): GlanceModifier
```

Apply a background color to the element this modifier is attached to. This will cause the element to paint the specified color resource as its background, which will fill the bounds of the element.

| Parameters |
|---|---|
| `color: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The color resource to set as the background. |

### GlanceModifier.background

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/Background.kt+function:background) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
fun GlanceModifier.background(colorProvider: ColorProvider): GlanceModifier
```

Apply a background color to the element this modifier is attached to. This will cause the element to paint the specified `https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider` as its background, which will fill the bounds of the element.

| Parameters |
|---|---|
| `colorProvider: https://developer.android.com/reference/kotlin/androidx/glance/unit/ColorProvider` | The color to set as the background |

### GlanceModifier.background

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

```
fun GlanceModifier.background(
    imageProvider: ImageProvider,
    contentScale: ContentScale = ContentScale.FillBounds,
    colorFilter: ColorFilter? = null
): GlanceModifier
```

Apply a background image to the element this modifier is attached to.

| Parameters |
|---|---|
| `imageProvider: https://developer.android.com/reference/kotlin/androidx/glance/ImageProvider` | The content to set as the background |
| `contentScale: https://developer.android.com/reference/kotlin/androidx/glance/layout/ContentScale = ContentScale.FillBounds` | scaling to apply to the imageProvider. |
| `colorFilter: https://developer.android.com/reference/kotlin/androidx/glance/ColorFilter? = null` | Optional color filter to apply to `https://developer.android.com/reference/kotlin/androidx/glance/package-summary#(androidx.glance.GlanceModifier).background(androidx.glance.ImageProvider,androidx.glance.layout.ContentScale,androidx.glance.ColorFilter)`, such as tint. |

### GlanceModifier.background

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

```
fun GlanceModifier.background(
    imageProvider: ImageProvider,
    alpha: @FloatRange(from = 0.0, to = 1.0) Float,
    contentScale: ContentScale = ContentScale.FillBounds,
    colorFilter: ColorFilter? = null
): GlanceModifier
```

Apply a background image to the element this modifier is attached to.

| Parameters |
|---|---|
| `imageProvider: https://developer.android.com/reference/kotlin/androidx/glance/ImageProvider` | The content to set as the background |
| `alpha: @https://developer.android.com/reference/kotlin/androidx/annotation/FloatRange(from = 0.0, to = 1.0) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | Opacity (0f to 1f) to apply to the background image. |
| `contentScale: https://developer.android.com/reference/kotlin/androidx/glance/layout/ContentScale = ContentScale.FillBounds` | scaling to apply to the imageProvider. |
| `colorFilter: https://developer.android.com/reference/kotlin/androidx/glance/ColorFilter? = null` | Optional color filter to apply to `https://developer.android.com/reference/kotlin/androidx/glance/package-summary#(androidx.glance.GlanceModifier).background(androidx.glance.ImageProvider,kotlin.Float,androidx.glance.layout.ContentScale,androidx.glance.ColorFilter)`, such as tint. |

### GlanceModifier.visibility

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/Visibility.kt+function:visibility) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
fun GlanceModifier.visibility(visibility: Visibility): GlanceModifier
```

Change the visibility of the current node.

| Parameters |
|---|---|
| `visibility: https://developer.android.com/reference/kotlin/androidx/glance/Visibility` | New visibility of the node. |

## Top-level properties

### LocalContext

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/CompositionLocals.kt+symbol:LocalContext) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
val LocalContext: ProvidableCompositionLocal<Context>
```

Context of application when generating the glance view.

### LocalGlanceId

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/CompositionLocals.kt+symbol:LocalGlanceId) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
val LocalGlanceId: ProvidableCompositionLocal<GlanceId>
```

Unique Id for the glance view being generated by the current composition.

### LocalSize

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/CompositionLocals.kt+symbol:LocalSize) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
val LocalSize: ProvidableCompositionLocal<DpSize>
```

Size of the glance view being generated.

The glance view will have at least that much space to be displayed. The exact meaning may changed depending on the surface and how it is configured.

### LocalState

Artifact: [androidx.glance:glance](https://developer.android.com/jetpack/androidx/releases/glance) [View Source](https://cs.android.com/search?q=file:androidx/glance/CompositionLocals.kt+symbol:LocalState) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/glance#1.0.0)

```
val LocalState: ProvidableCompositionLocal<Any?>
```

Local view state, defined in surface implementation. A customizable store for view specific state data.