androidx.xr.glimmer

UI components for building augmented Android XR experiences

Interfaces

ButtonGroupState

A state object that allows querying and controlling the state of a ButtonGroup component.

Classes

`ButtonSize`	ButtonSize represents the different size variants of a `Button`.
`Colors`	A set of named color parameters for a `GlimmerTheme`.
`ComponentSpacingValues`	A set of named component spacing values for `GlimmerTheme`.
`DepthEffect`	The depth effect establishes a sense of hierarchy by using shadows to occlude content underneath.
`DepthEffectLevels`	Jetpack Compose Glimmer components can use `DepthEffect` to establish a sense of hierarchy.
`GlimmerTheme`	Jetpack Compose Glimmer contains different theme subsystems to allow visual customization across an application.
`IconSizes`	A set of named icon sizes.
`IconToggleButtonColors`	Represents the colors used by an `IconToggleButton` in different states.
`Shapes`	Jetpack Compose Glimmer surfaces can use different shapes.
`SurfaceDepthEffect`	Represents the `DepthEffect` used by a `surface` in different states.
`ToggleButtonColors`	Represents the colors used by a `ToggleButton` in different states.
`Typography`	The Jetpack Compose Glimmer type scale includes a range of contrasting styles that support the needs of your product and its content.

Objects

`ButtonDefaults`	Default values used for `Button`.
`ButtonGroupDefaults`	Default values used with `ButtonGroup`.
`CardDefaults`	Default values used for `Card`
`IconButtonDefaults`	Default values used for `IconButton`.
`IconToggleButtonDefaults`	Contains default values used by `IconToggleButton`s.
`ListItemDefaults`	Default values used for `ListItem`
`SurfaceDefaults`	Contains default values used by `surface`.
`TitleChipDefaults`	Default values used for `TitleChip`.
`ToggleButtonDefaults`	Contains default values used by `ToggleButton`s.
`TypographyDefaults`	Contains the default style values used by `Typography`.

Composables

`ActionCard`	ActionCard is a version of a card that contains a primary `action` that is placed inside the card along the bottom edge of the card.
`Button`	Button is a component used for exposing actions to a user.
`ButtonGroup`	A ButtonGroup is a horizontal container for multiple `Button`s, allowing them to scroll if they exceed the size of the viewport.
`Card`	Card is a component used to group related information into a single digestible unit.
`ContainedVoiceInputIndicator`	A voice input indicator with a background container that displays sound activity to the user.
`GlimmerTheme`	Jetpack Compose Glimmer contains different theme subsystems to allow visual customization across an application.
`Icon`	An icon component that draws `bitmap`, with a default size of `LocalIconSize`, and applies a content color tint.
`IconButton`	IconButton is a component used for exposing supplementary actions with a single tap.
`IconToggleButton`	A Jetpack Compose Glimmer icon toggle button that changes its appearance depending on the `checked` value, and offers a single slot for an icon or image.
`ListItem`	ListItem is a component used to represent a single item in a `androidx.xr.glimmer.list.GlimmerLazyColumn`.
`Text`	High level element that displays text and provides semantics / accessibility information.
`TitleChip`	Title Chip is a component used to provide context for associated content, such as a `Card`.
`ToggleButton`	A Jetpack Compose Glimmer toggle button that changes its appearance depending on the `checked` value, used for exposing actions to a user.
`VoiceInputIndicator`	A voice input indicator that displays sound activity to the user.
`rememberButtonGroupState`	Creates and remembers a `ButtonGroupState`.
`surface`	A surface is a fundamental building block in Glimmer.

Modifiers

`contentColorProvider`	Provides `contentColor` for text and iconography to consume.
`depthEffect`	Renders shadows for the provided `depthEffect`.
`onIndirectPointerGesture`	A `Modifier` that detects high-level click and horizontal swipe gestures from an `IndirectPointerEvent` source.

Top-level functions summary

`ButtonGroupState`	`@RememberInComposition ButtonGroupState(initialItemIndex: Int)` Creates a `ButtonGroupState`.
`Color`	`calculateContentColor(backgroundColor: Color)` Calculates the preferred content color for `backgroundColor`.

Top-level properties summary

`ProvidableCompositionLocal<Dp>`	`LocalIconSize` CompositionLocal containing the preferred size of an icon.
`ProvidableCompositionLocal<TextStyle>`	`LocalTextStyle` CompositionLocal containing the preferred `TextStyle` that will be used by `Text` components by default.

Top-level functions

ButtonGroupState

Artifact: androidx.xr.glimmer:glimmer

View Source

Added in 1.0.0-alpha19

@RememberInComposition
fun ButtonGroupState(initialItemIndex: Int = 0): ButtonGroupState

Creates a ButtonGroupState.

Parameters
`initialItemIndex: Int = 0`	item index to be scrolled to when `ButtonGroup` is initialized

See also
`rememberButtonGroupState`
`Saver`

calculateContentColor

Artifact: androidx.xr.glimmer:glimmer

View Source

Added in 1.0.0-alpha19

fun calculateContentColor(backgroundColor: Color): Color

Calculates the preferred content color for backgroundColor. This will return either Color.White or Color.Black, depending on the luminance of the background color.

See also
`surface`
`contentColorProvider`

Top-level properties

LocalIconSize

Artifact: androidx.xr.glimmer:glimmer

View Source

Added in 1.0.0-alpha19

val LocalIconSize: ProvidableCompositionLocal<Dp>

CompositionLocal containing the preferred size of an icon. This value will be used by Icon by default - it can be overridden with a size modifier.

LocalTextStyle

Artifact: androidx.xr.glimmer:glimmer

View Source

Added in 1.0.0-alpha19

val LocalTextStyle: ProvidableCompositionLocal<TextStyle>

CompositionLocal containing the preferred TextStyle that will be used by Text components by default.