androidx.xr.compose.material3

Compose Material3 XR

Interfaces

`XrComponentOverrideEnabler`	Interface that a client can provide to enable/disable XR overrides on a per-component basis.
`XrComponentOverrideEnablerContext`	Information about the current XR environment.

Classes

`HorizontalOrbiterProperties`	XR-specific properties for components that use horizontally-aligned `Orbiter`s.
`VerticalOrbiterProperties`	XR-specific properties for components that use vertically-aligned `Orbiter`s.
`XrComponentOverride`	The set of Material Components that can be overridden on XR.

Objects

SpaceToggleButtonDefaults

Contains the default values used by SpaceToggleButton.

Annotations

ExperimentalMaterial3XrApi

Composables

`BasicAlertDialog`	Basic alert dialog dialog.
`EnableXrComponentOverrides`	Clients can wrap their Compose hierarchy in this function to dynamically enable XR components when in the proper environment.
`HorizontalFloatingToolbar`	A horizontal floating toolbar displays navigation and key actions in a `Row`.
`NavigationBar`	Material Design bottom navigation bar.
`NavigationRail`	Material Design bottom navigation rail.
`NavigationSuiteScaffold`	XR-specific Navigation Suite Scaffold that wraps its content in a `SpatialPanel`.
`ShortNavigationBar`	XR-specific Material Design short navigation bar.
`SpaceToggleButton`	A composable button that toggles between "Full Space" and "Home Space" in an Android XR application.
`ThreePaneScaffold`	A pane scaffold composable that can display up to three panes in the order that `ThreePaneScaffoldHorizontalOrder` specifies, and allocate margins and spacers according to `PaneScaffoldDirective`.
`VerticalFloatingToolbar`	XR-specific Vertical Floating Toolbar that displays content in a `Column` in an end-aligned `VerticalOrbiter`.
`WideNavigationRail`	XR-specific Material design wide navigation rail.

Top-level properties summary

`HorizontalOrbiterProperties`	`DefaultHorizontalFloatingToolbarOrbiterProperties` The default `HorizontalOrbiterProperties` used by `HorizontalFloatingToolbar` if none is specified in `LocalHorizontalFloatingToolbarOrbiterProperties`.
`HorizontalOrbiterProperties`	`@ExperimentalMaterial3XrApi DefaultNavigationBarOrbiterProperties` The default `HorizontalOrbiterProperties` used by `NavigationBar` if none is specified in `LocalNavigationBarOrbiterProperties`.
`VerticalOrbiterProperties`	`@ExperimentalMaterial3XrApi DefaultNavigationRailOrbiterProperties` The default `VerticalOrbiterProperties` used by `NavigationRail` if none is specified in `LocalNavigationRailOrbiterProperties`.
`HorizontalOrbiterProperties`	`@ExperimentalMaterial3XrApi DefaultSingleRowTopAppBarOrbiterProperties` The default `HorizontalOrbiterProperties` used by XR `TopAppBar` if none is specified in `LocalSingleRowTopAppBarOrbiterProperties`.
`HorizontalOrbiterProperties`	`@ExperimentalMaterial3XrApi DefaultTwoRowsTopAppBarOrbiterProperties` The default `HorizontalOrbiterProperties` used by XR `TopAppBar` if none is specified in `LocalTwoRowsTopAppBarOrbiterProperties`.
`VerticalOrbiterProperties`	`DefaultVerticalFloatingToolbarOrbiterProperties` The default `VerticalOrbiterProperties` used by `VerticalFloatingToolbar` if none is specified in `LocalVerticalFloatingToolbarOrbiterProperties`.
`VerticalOrbiterProperties`	`@ExperimentalMaterial3XrApi DefaultWideNavigationRailOrbiterProperties` The default `VerticalOrbiterProperties` used by `WideNavigationRail` if none is specified in `LocalWideNavigationRailOrbiterProperties`.
`ProvidableCompositionLocal<HorizontalOrbiterProperties>`	`LocalHorizontalFloatingToolbarOrbiterProperties` The `HorizontalOrbiterProperties` used by `HorizontalFloatingToolbar`.
`ProvidableCompositionLocal<HorizontalOrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalNavigationBarOrbiterProperties` The `HorizontalOrbiterProperties` used by `NavigationBar`.
`ProvidableCompositionLocal<VerticalOrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalNavigationRailOrbiterProperties` The `VerticalOrbiterProperties` used by `NavigationRail`.
`ProvidableCompositionLocal<HorizontalOrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalShortNavigationBarOrbiterProperties` The `HorizontalOrbiterProperties` used by `ShortNavigationBar`.
`ProvidableCompositionLocal<HorizontalOrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalSingleRowTopAppBarOrbiterProperties` The `HorizontalOrbiterProperties` used by XR `TopAppBar`.
`ProvidableCompositionLocal<HorizontalOrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalTwoRowsTopAppBarOrbiterProperties` The `HorizontalOrbiterProperties` used by XR `TopAppBar`.
`ProvidableCompositionLocal<VerticalOrbiterProperties>`	`LocalVerticalFloatingToolbarOrbiterProperties` The `VerticalOrbiterProperties` used by `VerticalFloatingToolbar`.
`ProvidableCompositionLocal<VerticalOrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalWideNavigationRailOrbiterProperties` The `VerticalOrbiterProperties` used by `WideNavigationRail`.

Top-level properties

DefaultHorizontalFloatingToolbarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

val DefaultHorizontalFloatingToolbarOrbiterProperties: HorizontalOrbiterProperties

The default HorizontalOrbiterProperties used by HorizontalFloatingToolbar if none is specified in LocalHorizontalFloatingToolbarOrbiterProperties.

DefaultNavigationBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val DefaultNavigationBarOrbiterProperties: HorizontalOrbiterProperties

The default HorizontalOrbiterProperties used by NavigationBar if none is specified in LocalNavigationBarOrbiterProperties.

DefaultNavigationRailOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val DefaultNavigationRailOrbiterProperties: VerticalOrbiterProperties

The default VerticalOrbiterProperties used by NavigationRail if none is specified in LocalNavigationRailOrbiterProperties.

DefaultSingleRowTopAppBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val DefaultSingleRowTopAppBarOrbiterProperties: HorizontalOrbiterProperties

The default HorizontalOrbiterProperties used by XR TopAppBar if none is specified in LocalSingleRowTopAppBarOrbiterProperties.

DefaultTwoRowsTopAppBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val DefaultTwoRowsTopAppBarOrbiterProperties: HorizontalOrbiterProperties

The default HorizontalOrbiterProperties used by XR TopAppBar if none is specified in LocalTwoRowsTopAppBarOrbiterProperties.

DefaultVerticalFloatingToolbarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

val DefaultVerticalFloatingToolbarOrbiterProperties: VerticalOrbiterProperties

The default VerticalOrbiterProperties used by VerticalFloatingToolbar if none is specified in LocalVerticalFloatingToolbarOrbiterProperties.

DefaultWideNavigationRailOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val DefaultWideNavigationRailOrbiterProperties: VerticalOrbiterProperties

The default VerticalOrbiterProperties used by WideNavigationRail if none is specified in LocalWideNavigationRailOrbiterProperties.

LocalHorizontalFloatingToolbarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

val LocalHorizontalFloatingToolbarOrbiterProperties: ProvidableCompositionLocal<HorizontalOrbiterProperties>

The HorizontalOrbiterProperties used by HorizontalFloatingToolbar.

LocalNavigationBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val LocalNavigationBarOrbiterProperties: ProvidableCompositionLocal<HorizontalOrbiterProperties>

The HorizontalOrbiterProperties used by NavigationBar.

LocalNavigationRailOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val LocalNavigationRailOrbiterProperties: ProvidableCompositionLocal<VerticalOrbiterProperties>

The VerticalOrbiterProperties used by NavigationRail.

LocalShortNavigationBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val LocalShortNavigationBarOrbiterProperties: ProvidableCompositionLocal<HorizontalOrbiterProperties>

The HorizontalOrbiterProperties used by ShortNavigationBar.

LocalSingleRowTopAppBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val LocalSingleRowTopAppBarOrbiterProperties: ProvidableCompositionLocal<HorizontalOrbiterProperties>

The HorizontalOrbiterProperties used by XR TopAppBar.

LocalTwoRowsTopAppBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val LocalTwoRowsTopAppBarOrbiterProperties: ProvidableCompositionLocal<HorizontalOrbiterProperties>

The HorizontalOrbiterProperties used by XR TopAppBar.

LocalVerticalFloatingToolbarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

val LocalVerticalFloatingToolbarOrbiterProperties: ProvidableCompositionLocal<VerticalOrbiterProperties>

The VerticalOrbiterProperties used by VerticalFloatingToolbar.

LocalWideNavigationRailOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha16

@ExperimentalMaterial3XrApi
val LocalWideNavigationRailOrbiterProperties: ProvidableCompositionLocal<VerticalOrbiterProperties>

The VerticalOrbiterProperties used by WideNavigationRail.