androidx.xr.compose.material3

Compose Material3 XR

Classes

OrbiterProperties

XR-specific properties for components that use aligned androidx.xr.compose.spatial.Orbiters.

Objects

SpaceToggleButtonDefaults

Contains the default values used by SpaceToggleButton.

Annotations

ExperimentalMaterial3XrApi

Composables

`SpaceToggleButton`	A composable button that toggles between "Full Space" and "Home Space" in an Android XR application.
`SpatialBasicAlertDialog`	Basic alert dialog dialog.
`SpatialHorizontalFloatingToolbar`	A horizontal floating toolbar displays navigation and key actions in a `Row`.
`SpatialListDetailPaneScaffold`	An XR-differentiated version of a three pane layout that follows the Material guidelines, displaying the provided panes in a canonical list-detail layout.
`SpatialNavigationBar`	Material Design bottom navigation bar.
`SpatialNavigationRail`	Material Design bottom navigation rail.
`SpatialShortNavigationBar`	XR-specific Material Design short navigation bar.
`SpatialTopAppBar`	XR-specific SingleRowTopAppBar that displays a single-row top app bar inside a top-aligned `Orbiter`.
`SpatialTwoRowsTopAppBar`	XR-specific TwoRowsTopAppBar that displays a two-rows top app bar inside a top-aligned `Orbiter`.
`SpatialVerticalFloatingToolbar`	XR-specific Vertical Floating Toolbar that displays content in a `Column` in an end-aligned `VerticalOrbiter`.
`SpatialWideNavigationRail`	XR-specific Material design wide navigation rail.

Top-level properties summary

`OrbiterProperties`	`DefaultSpatialHorizontalFloatingToolbarOrbiterProperties` The default `OrbiterProperties` used by `SpatialHorizontalFloatingToolbar` if none is specified in `LocalSpatialHorizontalFloatingToolbarOrbiterProperties`.
`OrbiterProperties`	`@ExperimentalMaterial3XrApi DefaultSpatialNavigationBarOrbiterProperties` The default `OrbiterProperties` used by `SpatialNavigationBar` if none is specified in `LocalSpatialNavigationBarOrbiterProperties`.
`OrbiterProperties`	`@ExperimentalMaterial3XrApi DefaultSpatialNavigationRailOrbiterProperties` The default `OrbiterProperties` used by `SpatialNavigationRail` if none is specified in `LocalSpatialNavigationRailOrbiterProperties`.
`OrbiterProperties`	`@ExperimentalMaterial3XrApi DefaultSpatialTopAppBarOrbiterProperties` The default `OrbiterProperties` used by XR `TopAppBar` if none is specified in `LocalSpatialTopAppBarOrbiterProperties`.
`OrbiterProperties`	`DefaultSpatialVerticalFloatingToolbarOrbiterProperties` The default `OrbiterProperties` used by `SpatialVerticalFloatingToolbar` if none is specified in `LocalSpatialVerticalFloatingToolbarOrbiterProperties`.
`OrbiterProperties`	`@ExperimentalMaterial3XrApi DefaultSpatialWideNavigationRailOrbiterProperties` The default `OrbiterProperties` used by `SpatialWideNavigationRail` if none is specified in `LocalSpatialWideNavigationRailOrbiterProperties`.
`OrbiterProperties`	`@ExperimentalMaterial3XrApi DefaultTwoRowsTopAppBarOrbiterProperties` The default `OrbiterProperties` used by XR `TopAppBar` if none is specified in `LocalTwoRowsTopAppBarOrbiterProperties`.
`ProvidableCompositionLocal<OrbiterProperties>`	`LocalSpatialHorizontalFloatingToolbarOrbiterProperties` The `OrbiterProperties` used by `SpatialHorizontalFloatingToolbar`.
`ProvidableCompositionLocal<OrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalSpatialNavigationBarOrbiterProperties` The `OrbiterProperties` used by `SpatialNavigationBar`.
`ProvidableCompositionLocal<OrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalSpatialNavigationRailOrbiterProperties` The `OrbiterProperties` used by `SpatialNavigationRail`.
`ProvidableCompositionLocal<OrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalSpatialShortNavigationBarOrbiterProperties` The `OrbiterProperties` used by `SpatialShortNavigationBar`.
`ProvidableCompositionLocal<OrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalSpatialTopAppBarOrbiterProperties` The `OrbiterProperties` used by XR `TopAppBar`.
`ProvidableCompositionLocal<OrbiterProperties>`	`LocalSpatialVerticalFloatingToolbarOrbiterProperties` The `OrbiterProperties` used by `SpatialVerticalFloatingToolbar`.
`ProvidableCompositionLocal<OrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalSpatialWideNavigationRailOrbiterProperties` The `OrbiterProperties` used by `SpatialWideNavigationRail`.
`ProvidableCompositionLocal<OrbiterProperties>`	`@ExperimentalMaterial3XrApi LocalTwoRowsTopAppBarOrbiterProperties` The `OrbiterProperties` used by XR `TopAppBar`.

Top-level properties

DefaultSpatialHorizontalFloatingToolbarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

val DefaultSpatialHorizontalFloatingToolbarOrbiterProperties: OrbiterProperties

The default OrbiterProperties used by SpatialHorizontalFloatingToolbar if none is specified in LocalSpatialHorizontalFloatingToolbarOrbiterProperties.

DefaultSpatialNavigationBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val DefaultSpatialNavigationBarOrbiterProperties: OrbiterProperties

The default OrbiterProperties used by SpatialNavigationBar if none is specified in LocalSpatialNavigationBarOrbiterProperties.

DefaultSpatialNavigationRailOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val DefaultSpatialNavigationRailOrbiterProperties: OrbiterProperties

The default OrbiterProperties used by SpatialNavigationRail if none is specified in LocalSpatialNavigationRailOrbiterProperties.

DefaultSpatialTopAppBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val DefaultSpatialTopAppBarOrbiterProperties: OrbiterProperties

The default OrbiterProperties used by XR TopAppBar if none is specified in LocalSpatialTopAppBarOrbiterProperties.

DefaultSpatialVerticalFloatingToolbarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

val DefaultSpatialVerticalFloatingToolbarOrbiterProperties: OrbiterProperties

The default OrbiterProperties used by SpatialVerticalFloatingToolbar if none is specified in LocalSpatialVerticalFloatingToolbarOrbiterProperties.

DefaultSpatialWideNavigationRailOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val DefaultSpatialWideNavigationRailOrbiterProperties: OrbiterProperties

The default OrbiterProperties used by SpatialWideNavigationRail if none is specified in LocalSpatialWideNavigationRailOrbiterProperties.

DefaultTwoRowsTopAppBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val DefaultTwoRowsTopAppBarOrbiterProperties: OrbiterProperties

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

LocalSpatialHorizontalFloatingToolbarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

val LocalSpatialHorizontalFloatingToolbarOrbiterProperties: ProvidableCompositionLocal<OrbiterProperties>

The OrbiterProperties used by SpatialHorizontalFloatingToolbar.

LocalSpatialNavigationBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val LocalSpatialNavigationBarOrbiterProperties: ProvidableCompositionLocal<OrbiterProperties>

The OrbiterProperties used by SpatialNavigationBar.

LocalSpatialNavigationRailOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val LocalSpatialNavigationRailOrbiterProperties: ProvidableCompositionLocal<OrbiterProperties>

The OrbiterProperties used by SpatialNavigationRail.

LocalSpatialShortNavigationBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val LocalSpatialShortNavigationBarOrbiterProperties: ProvidableCompositionLocal<OrbiterProperties>

The OrbiterProperties used by SpatialShortNavigationBar.

LocalSpatialTopAppBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val LocalSpatialTopAppBarOrbiterProperties: ProvidableCompositionLocal<OrbiterProperties>

The OrbiterProperties used by XR TopAppBar.

LocalSpatialVerticalFloatingToolbarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

val LocalSpatialVerticalFloatingToolbarOrbiterProperties: ProvidableCompositionLocal<OrbiterProperties>

The OrbiterProperties used by SpatialVerticalFloatingToolbar.

LocalSpatialWideNavigationRailOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val LocalSpatialWideNavigationRailOrbiterProperties: ProvidableCompositionLocal<OrbiterProperties>

The OrbiterProperties used by SpatialWideNavigationRail.

LocalTwoRowsTopAppBarOrbiterProperties

Artifact: androidx.xr.compose.material3:material3

View Source

Added in 1.0.0-alpha17

@ExperimentalMaterial3XrApi
val LocalTwoRowsTopAppBarOrbiterProperties: ProvidableCompositionLocal<OrbiterProperties>

The OrbiterProperties used by XR TopAppBar.