Expand description
High level utilities for running Cranpose applications with minimal boilerplate.
Re-exports§
pub use cranpose_capabilities as capabilities;pub use cranpose_liquid as liquid;
Modules§
- _docs
- Guides for using Cranpose, compiled with the crate so they cannot drift from it. Built only for documentation, so they cost a reader nothing at runtime. Guides for using Cranpose.
- accessibility_
options - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The display options a person set in the system’s accessibility settings: larger text, less motion, less transparency, more contrast, bold text, inverted colors. The framework applies them on its own; an app reads them for what it draws itself.
- accessibility_
state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the platform says about the assistive technology in use, for an app that speaks guidance, slows an automatic step down or drops a gesture-only path while a screen reader is on.
- announce
- Re-export the UI crate so applications can depend on a single crate.
- app_
info - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How the platform packaged this app: the version a user is shown, and the build version a store orders releases by.
- app_
update - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Typed application update discovery, verification, and platform installation.
- async_
io - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Waking a future from another thread.
- audio
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Sound effects and music — the audio analogue of
haptics. - background
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Background execution: ask the OS to keep running briefly after the app is backgrounded, so in-flight work (e.g. draining a recognition queue) can finish instead of being suspended immediately.
- bring_
into_ view - Re-export the UI crate so applications can depend on a single crate. Bring-a-focused-field’s-caret-into-view above the soft keyboard.
- bundled_
assets - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Read-only assets packaged with the application.
- camera
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The live camera: what it is doing, the frames it is producing, and the stills it takes.
- clipboard_
session - Re-export the UI crate so applications can depend on a single crate. Platform clipboard session: an OS clipboard read/write bridge for in-tree UI.
- content
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Streaming content: the single shape every byte source hands the application.
- density
- Re-export the UI crate so applications can depend on a single crate. Integral layout, the way Compose does it.
- desktop
- Desktop runtime for Compose applications.
- device_
info - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the device has, and what this process is using of it.
- draggable
- Re-export the UI crate so applications can depend on a single crate. General drag state, for controls that are dragged but do not scroll.
- file_
picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Native, cross-platform file, folder and document choosers.
- fling_
animation - Re-export the UI crate so applications can depend on a single crate. Fling animation driver for scroll containers.
- focus_
manager - Re-export the UI crate so applications can depend on a single crate.
- focus_
order - Re-export the UI crate so applications can depend on a single crate.
- font_
scale - Re-export the UI crate so applications can depend on a single crate. The system font-size setting, as the curve it is and not the multiplier it looks like.
- github_
release_ updater - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A portable
AppUpdaterthat discovers a newer release from a GitHub repository’s release feed. - haptics
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Haptic feedback — the framework analogue of Jetpack’s
LocalHapticFeedback. - host
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Framework-owned application-host state and controls.
- host_
surface - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The surface the host gives the application, and what the application may ask of it.
- http
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- image_
picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Photo/image picker: choose a single image from the user’s photo library.
- incoming_
share - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Content another application shares into this one.
- launch_
args - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Launch arguments — the typed parameters the app was started with.
- launcher
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Composition-owned launchers for the system choosers.
- layout
- Re-export the UI crate so applications can depend on a single crate.
- layout_
direction - Re-export the UI crate so applications can depend on a single crate. Which way the interface reads.
- lazy_
item - Re-export the UI crate so applications can depend on a single crate. The identity of the lazy-list item currently being composed.
- media
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Media playback: one item at a time, observable rather than polled.
- memory_
pressure - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Memory pressure the platform reports for this process.
- modal
- Re-export the UI crate so applications can depend on a single crate. The stack of modal surfaces that are open right now.
- navigation
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. System “back” navigation requests.
- network_
status - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Network status (connectivity + whether the connection is metered). Apps use it to defer or confirm large transfers on cellular/metered links.
- nine_
patch - Re-export the UI crate so applications can depend on a single crate. Filling a box with an image that is bigger, or smaller, than the box.
- notifier
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Local notifications: ask permission and post user-visible notifications.
- peer
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Local-network peer streaming for Cranpose apps.
- pointer_
icon_ session - Re-export the UI crate so applications can depend on a single crate. The pointer icon the platform should be drawing right now.
- power
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Device power and thermal state: observable, capability-aware, and explicit about what this platform cannot answer.
- preferences
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Small durable key/value storage, and the composition state built on it.
- prelude
- Convenience imports for Cranpose applications.
- purchases
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. In-app purchases: products, prices and owned entitlements.
- recorder
- Input event recorder for generating robot tests from manual interactions.
- round_
scaling_ list - Re-export the UI crate so applications can depend on a single crate. Placing list rows the way a round watch scales them.
- round_
scroll_ indicator - Re-export the UI crate so applications can depend on a single crate. The curved scroll indicator a round watch puts at 3 o’clock.
- safe_
area - Re-export the UI crate so applications can depend on a single crate. Platform safe-area insets exposed to composition.
- scroll
- Re-export the UI crate so applications can depend on a single crate. Scroll state and node implementation for cranpose.
- scrollbar
- Re-export the UI crate so applications can depend on a single crate. Where a scrollbar’s thumb sits and how long it is.
- share_
sheet - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. System share sheet: hand a file (and optional text) to the OS share UI so the user can send it to another app.
- text
- Re-export the UI crate so applications can depend on a single crate.
- text_
field_ focus - Re-export the UI crate so applications can depend on a single crate. Focus manager for text fields.
- text_
input_ session - Re-export the UI crate so applications can depend on a single crate. Platform text-input session: soft-keyboard visibility hooks.
- text_
layout_ result - Re-export the UI crate so applications can depend on a single crate. Text layout result with cached glyph positions.
- text_
selection - Re-export the UI crate so applications can depend on a single crate.
Native-grade text selection primitives for
BasicTextField. - theme
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- uri_
handler - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- widgets
- Re-export the UI crate so applications can depend on a single crate. UI Widget components
- writable_
folder - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Cross-platform access to a user-chosen writable folder.
- zoom
- Re-export the UI crate so applications can depend on a single crate.
Pinch-to-zoom / pan state and the
Modifier::zoomablegesture modifier.
Macros§
- android_
main - Declares this crate’s Android entry point.
- app_
capabilities - Brings in what this crate’s build script declared.
- remember
Scroll State - Re-export the UI crate so applications can depend on a single crate. Creates a remembered ScrollState.
Structs§
- Accessibility
Options - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the person set in the system’s accessibility settings.
- Accessibility
State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the platform reports about the assistive technology in use.
- Alignment
- Re-export the UI crate so applications can depend on a single crate. Alignment across both axes used for positioning content within a box.
- Alpha
Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates alpha nodes.
- Alpha
Node - Re-export the UI crate so applications can depend on a single crate. Node that applies alpha transparency to its content.
- Android
Overlay Window Options - Android floating overlay window configuration.
- Announcement
- Re-export the UI crate so applications can depend on a single crate. Text a screen reader should read out, with no control to move to.
- Announcer
- Re-export the UI crate so applications can depend on a single crate.
Reads text out on a screen reader without moving focus, the way
View.announceForAccessibilitydoes under Compose on Android. - AppLauncher
- Platform-agnostic application launcher.
- AppSettings
- Configuration for application settings.
- AppUpdate
Capabilities - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What an update backend can do on this platform.
- AppUpdate
Observer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registration returned by
observe_app_update_status. - Audio
Clip - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Decoded PCM held in memory, ready to play with no further work.
- Back
Request Observer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A back observer installed by
observe_back_requests. - Background
Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates background nodes.
- Background
Node - Re-export the UI crate so applications can depend on a single crate. Node that draws a background behind its content.
- Background
Work Lease - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A claim that important work needs the host’s background execution allowance. The allowance remains active until every outstanding lease is dropped.
- Basic
Text Field Decoration Scope - Re-export the UI crate so applications can depend on a single crate. Scope passed to a basic text field decoration box.
- Basic
Text Field Options - Re-export the UI crate so applications can depend on a single crate. Options for customizing BasicTextField appearance and behavior.
- Battery
Status - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Current battery level and charging state.
- Blurred
Edge Treatment - Re-export the UI crate so applications can depend on a single crate. Controls blur behavior outside source bounds.
- BoxSpec
- Re-export the UI crate so applications can depend on a single crate. Specification for Box layout behavior.
- BoxWith
Constraints Scope Impl - Re-export the UI crate so applications can depend on a single crate.
Concrete implementation of
BoxWithConstraintsScope. - Bring
Into View Responder - Re-export the UI crate so applications can depend on a single crate. A scroll container’s ability to scroll a target window rect into view.
- Bundled
Asset Entry - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One bundle-relative file in a declarative asset installation.
- Bundled
Asset Install Spec - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A versioned set copied from the application bundle into writable storage.
- Button
Spec - Re-export the UI crate so applications can depend on a single crate.
- Bytes
Body - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A body already in memory, handed out in
CHUNK_LEN-sized pieces. - Bytes
Content - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Content already held in memory: clipboard drops, web
Filepayloads, tests. - Bytes
Source - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
In-memory
ByteSourcebacked by a byte buffer. Handy for small payloads and tests. - Camera
Frame - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One frame from the viewfinder.
- Camera
Lens - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One capture device the application may pick.
- Camera
Lenses - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The devices the application may pick between, and the one in use.
- Camera
Observer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Keeps a camera observer registered until it is dropped.
- Camera
Still - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A full-resolution still photograph as an encoded image.
- Canvas
Semantics Node - Re-export the UI crate so applications can depend on a single crate. A semantics node for content that is drawn rather than laid out.
- Chunk
Channel - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The producing half of a chunked byte stream.
- Chunk
Next - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The future
ChunkStream::nextreturns. - Chunk
Stream - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The consuming half of a chunked byte stream.
- Clickable
Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates clickable nodes.
- Clickable
Node - Re-export the UI crate so applications can depend on a single crate.
- Collection
Info - Re-export the UI crate so applications can depend on a single crate. How far a container has scrolled along one axis and how far it can go.
- Color
- Re-export the UI crate so applications can depend on a single crate.
- Column
Spec - Re-export the UI crate so applications can depend on a single crate. Specification for Column layout behavior.
- Composition
- Re-export the UI crate so applications can depend on a single crate.
- Constraints
- Re-export the UI crate so applications can depend on a single crate. Constraints used during layout measurement.
- Content
Channel - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The producing half of a
ContentStreamfed by a platform callback. - Content
Metadata - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Everything a provider can state about a piece of content without reading it.
- Corner
Radii - Re-export the UI crate so applications can depend on a single crate.
- Corner
Shape Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates corner shape nodes.
- Corner
Shape Node - Re-export the UI crate so applications can depend on a single crate. Node that tracks the latest rounded corner shape.
- Coroutine
Scope - Core runtime helpers commonly used by applications. A cancellation scope for work launched outside the composition pass.
- Custom
Pointer Icon - Re-export the UI crate so applications can depend on a single crate. An application-drawn pointer shape: RGBA pixels plus the hotspot, the pixel inside the image that sits exactly on the pointer’s position.
- Density
- Re-export the UI crate so applications can depend on a single crate. The device pixel grid a layout measures against: how many device pixels a layout point is worth, and how the platform converts a text size.
- Density
Measure Scope - Re-export the UI crate so applications can depend on a single crate.
The production
cranpose_ui_layout::MeasureScope: a grid captured at composition time, carried through measurement. - DevOptions
- Development frame pacing and FPS statistics types. Development options for debugging and performance monitoring.
- Digest
Verifier - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Checks a package as it is read, so a package too large to hold in memory is still checked.
- Disposable
Effect Result - Core runtime helpers commonly used by applications.
- Disposable
Effect Scope - Core runtime helpers commonly used by applications.
- Dp
- Re-export the UI crate so applications can depend on a single crate. Density-independent pixels: a layout length that reads the same on every device regardless of its pixel density.
- DpOffset
- Re-export the UI crate so applications can depend on a single crate. Density-independent offset for shadows.
- Drag
AndDrop Point - Re-export the UI crate so applications can depend on a single crate. Where a transfer is: on the screen when the platform knows window positions, and in the source’s surface always.
- Drag
AndDrop Source - Re-export the UI crate so applications can depend on a single crate. A payload a node offers to be dragged out of it, and what the node wants to hear about the transfer.
- Drag
AndDrop Source Element - Re-export the UI crate so applications can depend on a single crate.
Element that creates and updates
DragAndDropSourceNodes. - Drag
AndDrop Source Node - Re-export the UI crate so applications can depend on a single crate. Node that starts a transfer when a press on it becomes a drag.
- Drag
AndDrop State - Re-export the UI crate so applications can depend on a single crate. The one transfer in flight in an app context, the targets attached in it, and the steps the source recorded since the shell last routed.
- Drag
AndDrop Target - Re-export the UI crate so applications can depend on a single crate. What a node does with a transfer that reaches it. Positions are in the surface that draws the target.
- Drag
AndDrop Target Element - Re-export the UI crate so applications can depend on a single crate.
Element that creates and updates
DragAndDropTargetNodes. - Drag
AndDrop Target Node - Re-export the UI crate so applications can depend on a single crate. Node that registers its layout node as a drop target while attached. It is a pointer target so the shell’s hit test finds it under a transfer; it handles no pointer events itself.
- Draggable
State - Re-export the UI crate so applications can depend on a single crate. Drag position and progress for one control.
- Draw
Cache Builder - Re-export the UI crate so applications can depend on a single crate.
- Durable
Save Registration - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Keeps a durable save registered until it is dropped.
- Edge
Insets - Re-export the UI crate so applications can depend on a single crate. Padding values for each edge of a rectangle.
- Enter
Transition - Re-export the UI crate so applications can depend on a single crate.
Defines how an
AnimatedVisibilitycontent appears. - Equalizer
Band - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One frequency band of a backend’s equalizer.
- Equalizer
Settings - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What an equalizer is set to.
- Exit
Transition - Re-export the UI crate so applications can depend on a single crate.
Defines how an
AnimatedVisibilitycontent disappears. - Fetch
Result - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Result of a
fetch_rangecall. - File
Content - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A file on the local filesystem.
- File
Filter - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A named filter limiting the file types a chooser offers.
- File
Folder - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A directory on the local filesystem.
- File
Picker Options - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Options controlling a chooser request.
- File
Preferences - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The framework’s file-backed store: one line per entry,
key=valuewith the value percent-escaped so newlines and equals signs round-trip. - File
Sink - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A file being written through a temporary sibling, renamed on
ContentSink::finishso a partial write never replaces a good file. - Fill
Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates fill nodes.
- Fill
Node - Re-export the UI crate so applications can depend on a single crate. Node that fills the maximum available space in one or both dimensions.
- Focus
Entry - Re-export the UI crate so applications can depend on a single crate. One focus target, with the bounds layout gave it.
- Focus
Manager - Re-export the UI crate so applications can depend on a single crate.
Moves focus between the focus targets the tree holds, the way
LocalFocusManagerdoes in Jetpack Compose. - Focus
Requester - Re-export the UI crate so applications can depend on a single crate. A handle an app holds to move focus onto a node imperatively.
- Folder
Entry - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Display metadata for one file in a writable folder.
- Font
Scale Curve - Re-export the UI crate so applications can depend on a single crate. The sp → dp conversion the platform performs, sampled from the platform.
- FpsStats
- Development frame pacing and FPS statistics types. Frame statistics snapshot.
- Fractional
Offset Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates fractional offset nodes.
- Fractional
Offset Node - Re-export the UI crate so applications can depend on a single crate. Node that offsets its content by a fraction of its own measured size.
- GitHub
AppUpdater - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Discovers releases through a repository’s public GitHub release feed.
- GitHub
Release Update - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A GitHub release feed used to discover an application package.
- Glass
Material - Re-export the UI crate so applications can depend on a single crate.
Visual parameters for
Modifier::glass_material. - Graphics
Layer - Re-export the UI crate so applications can depend on a single crate.
- Haptic
Pattern - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A vibration waveform: alternating durations with a target amplitude each.
- Headless
Renderer - Re-export the UI crate so applications can depend on a single crate. A lightweight renderer that walks the layout tree and materialises paint commands.
- Host
Surface Observer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Keeps a host-surface observer registered until it is dropped.
- Host
Surface Size - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The size of the host surface, in logical pixels, with the scale the host renders it at.
- Http
Control - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Cancellation and progress shared with an in-flight request.
- Http
Progress - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How much of a transfer has arrived.
- Http
Request - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One request.
- Http
Response - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What a server answered, with its body still to be read.
- Image
Bitmap - Re-export the UI crate so applications can depend on a single crate. Immutable RGBA image data used by UI primitives and render backends.
- ImeEditor
State - Re-export the UI crate so applications can depend on a single crate. Snapshot of the focused text field’s editable state for platform IMEs.
- Incoming
Content - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One item shared into the application.
- Incoming
Content Observer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Keeps an observer registered until it is dropped.
- Inspector
Control - A visible inspector control and its logical hit bounds.
- Inspector
Node - A sanitized platform-projection element for developer inspection.
- Inspector
State - A read-only snapshot of developer UI, separate from application semantics.
- KeyEvent
- Re-export the UI crate so applications can depend on a single crate. A keyboard input event.
- Keyboard
Focus Target - Re-export the UI crate so applications can depend on a single crate. A keyboard navigation destination and whether moving there selects it.
- Launch
Args - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The launch arguments the app was started with.
- Launched
Effect Scope - Core runtime helpers commonly used by applications.
- Layout
Allocation Debug Stats - Re-export the UI crate so applications can depend on a single crate.
- Layout
Box - Re-export the UI crate so applications can depend on a single crate. Layout information for a single node.
- Layout
Measurements - Re-export the UI crate so applications can depend on a single crate. Result of running the measure pass for a Compose layout tree.
- Layout
Node - Re-export the UI crate so applications can depend on a single crate.
- Layout
Node Data - Re-export the UI crate so applications can depend on a single crate. Snapshot of the data required to render a layout node.
- Layout
Tree - Re-export the UI crate so applications can depend on a single crate. Result of running layout for a Compose tree.
- Lazy
Column Spec - Re-export the UI crate so applications can depend on a single crate. Specification for LazyColumn layout behavior.
- Lazy
Items - Re-export the UI crate so applications can depend on a single crate. A run of lazy items: how many, and optionally how they are identified and reused.
- Lazy
List Item Info - Re-export the UI crate so applications can depend on a single crate. Information about a single visible item in a lazy list.
- Lazy
List Layout Info - Re-export the UI crate so applications can depend on a single crate. Information about the currently visible items in a lazy list.
- Lazy
List State - Re-export the UI crate so applications can depend on a single crate. State object for lazy list scroll position tracking.
- Lazy
RowSpec - Re-export the UI crate so applications can depend on a single crate. Specification for LazyRow layout behavior.
- Lifecycle
Event - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A lifecycle transition delivered by the platform host.
- Lifecycle
Observer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. RAII lifecycle observer registration.
- Local
Window State - The window a composable is drawn in.
- Measure
Layout Options - Re-export the UI crate so applications can depend on a single crate.
- Measure
Result - Re-export the UI crate so applications can depend on a single crate. Result of a measurement operation.
- Media
Artwork - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Artwork for the platform media session.
- Media
Capabilities - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What a platform media stack can actually do.
- Media
Item - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One playable item.
- Media
Metadata - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the platform media session shows: the lock screen, the notification, the car head unit.
- Media
Observer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Keeps a media observer registered until it is dropped.
- Media
Samples - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Samples as they are being heard, for a visualiser.
- Media
Source Handle - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A media stream the platform opened, and what it knows about it.
- Memory
Preferences - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. An in-memory store. The web default until a platform backend registers, and what tests use.
- Memory
Pressure Observer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Keeps an observer registered until it is dropped.
- Modal
Registration - Re-export the UI crate so applications can depend on a single crate. Keeps a modal surface on the stack until it is dropped.
- Modifier
- Re-export the UI crate so applications can depend on a single crate. A modifier chain that can be applied to composable elements.
- Modifier
Chain Trace Guard - Re-export the UI crate so applications can depend on a single crate. RAII guard returned when installing a modifier chain trace subscriber.
- Modifier
Local Key - Re-export the UI crate so applications can depend on a single crate. Type-safe key referencing a modifier local value.
- Modifier
Local Read Scope - Re-export the UI crate so applications can depend on a single crate. Lightweight read scope surfaced to modifier local consumers.
- Modifier
Node Slices - Re-export the UI crate so applications can depend on a single crate. Snapshot of modifier node slices that impact draw and pointer subsystems.
- Modifier
Node Slices Debug Stats - Re-export the UI crate so applications can depend on a single crate.
- Modifiers
- Re-export the UI crate so applications can depend on a single crate. Keyboard modifier keys held during an input sample.
- Movable
Content - Core runtime helpers commonly used by applications.
Movable content held as a value. See
rememberMovableContentOf. - Mutable
Interaction Source - Re-export the UI crate so applications can depend on a single crate.
- Mutable
State - Core runtime helpers commonly used by applications. Cheap copyable mutable view of a state cell.
- Network
Status - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A snapshot of the current network state.
- Nine
Patch Insets - Re-export the UI crate so applications can depend on a single crate. How far in from each edge of a source image the stretchable middle starts.
- Node
Capabilities - Re-export the UI crate so applications can depend on a single crate. Capability flags indicating which specialized traits a modifier node implements.
- Node
State - Re-export the UI crate so applications can depend on a single crate.
Runtime state tracked for every
ModifierNode. - Noop
Audio Player - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The player used when no backend is installed.
- Notify
Request - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A local notification to post.
- Offset
Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates offset nodes.
- Offset
Node - Re-export the UI crate so applications can depend on a single crate. Node that offsets its content by a fixed (x, y) amount.
- Open
File Launcher - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Presents the single-file chooser and hands the picked content back.
- Open
Files Launcher - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Presents the multi-file chooser and hands every picked item back.
- Open
Folder Launcher - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Presents the folder chooser and hands the granted folder back.
- Package
Digest - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The digest a downloaded package must match.
- Padding
Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates padding nodes.
- Padding
Node - Re-export the UI crate so applications can depend on a single crate. Node that adds padding around its content.
- Painter
- Re-export the UI crate so applications can depend on a single crate.
- Paragraph
Style - Re-export the UI crate so applications can depend on a single crate.
- Patch
Quad - Re-export the UI crate so applications can depend on a single crate. One image draw: the part of the source to read and the part of the destination to fill.
- Peer
Server - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A running peer server. Dropping it stops accepting new connections.
- Placeable
- Re-export the UI crate so applications can depend on a single crate. Result of running a measurement pass for a single child.
- Placement
- Re-export the UI crate so applications can depend on a single crate. Placement information for a measured child.
- Platform
Directories - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Platform directory roots for application-owned files.
- Platform
Paragraph Style - Re-export the UI crate so applications can depend on a single crate.
- Platform
Span Style - Re-export the UI crate so applications can depend on a single crate.
- Platform
Text Style - Re-export the UI crate so applications can depend on a single crate.
- Playback
Params - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How one voice should sound.
- Playback
Progress - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Where the open item is.
- Point
- Re-export the UI crate so applications can depend on a single crate.
- Pointer
Event - Re-export the UI crate so applications can depend on a single crate. Pointer event with consumption tracking for gesture disambiguation.
- Pointer
Input Scope - Re-export the UI crate so applications can depend on a single crate.
- Power
Capabilities - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What a power backend can answer on this platform.
- Power
Observer Registration - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Keeps a power observer registered until it is dropped.
- Power
State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Everything the platform currently says about power.
- Prepared
Text Layout - Re-export the UI crate so applications can depend on a single crate.
- Press
Interaction Cancel - Re-export the UI crate so applications can depend on a single crate.
- Press
Interaction Press - Re-export the UI crate so applications can depend on a single crate.
- Press
Interaction Release - Re-export the UI crate so applications can depend on a single crate.
- Product
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A product as the store describes it, in the user’s locale and currency.
- Progress
BarRange Info - Re-export the UI crate so applications can depend on a single crate. The value a control holds inside a range, for a slider, a dial or a progress bar.
- Ready
Folder - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A folder whose children are already known.
- Recorded
Render Scene - Re-export the UI crate so applications can depend on a single crate. A collection of render operations for a composed scene.
- Rect
- Re-export the UI crate so applications can depend on a single crate.
- Resolved
Background - Re-export the UI crate so applications can depend on a single crate.
- Resolved
Modifiers - Re-export the UI crate so applications can depend on a single crate.
- Rotary
Input Modifier Node - Re-export the UI crate so applications can depend on a single crate. Modifier node that forwards rotary scroll events to an app handler.
- Rotary
Scroll Event - Re-export the UI crate so applications can depend on a single crate. A rotary scroll event produced by a Wear OS crown or rotating bezel.
- Rounded
Corner Shape - Re-export the UI crate so applications can depend on a single crate.
- RowSpec
- Re-export the UI crate so applications can depend on a single crate. Specification for Row layout behavior.
- Runtime
Shader - Re-export the UI crate so applications can depend on a single crate.
A custom WGSL shader effect, analogous to Android’s
RuntimeShader. - Save
Document Launcher - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Presents the save-document chooser and hands the opened sink back.
- Save
Document Request - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A request for a user-named destination to stream a document into.
- Saver
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Converts a value to and from the string form preferences store.
- Scroll
Axis Range - Re-export the UI crate so applications can depend on a single crate.
This is Compose’s
ScrollAxisRange(verticalScrollAxisRange,horizontalScrollAxisRange). A lazy list has no whole extent to give, so it reports the first visible item as the value and one more than that as the end while it can still scroll; a reader only needs to know whether it can page on. - Scroll
Element - Re-export the UI crate so applications can depend on a single crate. Element for creating a ScrollNode.
- Scroll
Metrics - Re-export the UI crate so applications can depend on a single crate. A scroll position and the extents it is measured against, read together.
- Scroll
Node - Re-export the UI crate so applications can depend on a single crate. ScrollNode layout modifier that physically moves content based on scroll position. This is the component that actually reads ScrollState and applies the visual offset.
- Scroll
State - Re-export the UI crate so applications can depend on a single crate. State object for scroll position tracking.
- Semantics
Callback - Re-export the UI crate so applications can depend on a single crate. Discrete event callback reference produced during semantics extraction.
- Semantics
Configuration - Re-export the UI crate so applications can depend on a single crate. Semantics configuration for accessibility.
- Semantics
Custom Action - Re-export the UI crate so applications can depend on a single crate.
A named accessibility operation, e.g. Compose’s
customActions = listOf(CustomAccessibilityAction("Pause") { … }). - Semantics
Dismiss - Re-export the UI crate so applications can depend on a single crate.
What a control does when a screen reader asks to send it away: a row a
sighted person swipes off, a sheet a sighted person taps outside of.
Compose’s
dismissaction. - Semantics
Expand - Re-export the UI crate so applications can depend on a single crate.
What a control does when a screen reader asks it to open or to close.
Compose’s
expandandcollapseactions. - Semantics
Long Click - Re-export the UI crate so applications can depend on a single crate.
What a control does when a screen reader asks for its long press. This is
Compose’s
SemanticsActions.OnLongClick; the answer says whether the control took the ask. - Semantics
Magic Tap - Re-export the UI crate so applications can depend on a single crate.
What a control does when a VoiceOver user makes the magic tap, the two
finger double tap that starts or stops the main action of a screen. On
the other platforms the action is listed by its label among the control’s
actions. SwiftUI’s
accessibilityAction(.magicTap); the answer says whether the control took the tap. - Semantics
Node - Re-export the UI crate so applications can depend on a single crate. A single node within the semantics tree.
- Semantics
Requester - Re-export the UI crate so applications can depend on a single crate. A handle an app holds to say that what its semantics recorder would report has changed.
- Semantics
Scroll By - Re-export the UI crate so applications can depend on a single crate. What a container does when a screen reader pages it, e.g. TalkBack’s scroll forward action or an accesskit scroll down. The two deltas are in layout pixels; the answer says whether anything moved.
- Semantics
Scroll ToIndex - Re-export the UI crate so applications can depend on a single crate. What a list does when a screen reader asks for the row at an index, e.g. a TalkBack scroll-to-position action.
- Semantics
SetProgress - Re-export the UI crate so applications can depend on a single crate. What a control does when a screen reader moves its value, e.g. a VoiceOver swipe up or a TalkBack set-progress action.
- Semantics
SetSelection - Re-export the UI crate so applications can depend on a single crate.
What a text field does when a screen reader moves its caret or picks a
stretch of its text: the two ends of the new selection, as byte offsets
into the field’s text, the anchor first and the end that moves second. Equal
ends are a caret. This is Compose’s
SemanticsActions.SetSelection; the answer says whether the field took the selection. - Semantics
SetText - Re-export the UI crate so applications can depend on a single crate.
What a text field does when a screen reader or a voice tool hands it new
text. This is Compose’s
SemanticsActions.SetText; the answer says whether the field took the text. - Semantics
Tree - Re-export the UI crate so applications can depend on a single crate. Rooted semantics tree extracted after layout.
- Shadow
- Re-export the UI crate so applications can depend on a single crate. Static shadow configuration.
- Shadow
Scope - Re-export the UI crate so applications can depend on a single crate. Pixel-space shadow scope used by block-based APIs.
- Share
Content - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A single file to share, with an optional accompanying message/subject.
- Signal
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A one-value hand-off between a worker and a future.
- Signal
Wait - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The future
Signal::waitreturns. - Size
- Re-export the UI crate so applications can depend on a single crate.
- Size
Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates size nodes.
- Size
Node - Re-export the UI crate so applications can depend on a single crate. Node that enforces size constraints on its content.
- Slider
Scope - Re-export the UI crate so applications can depend on a single crate. Values available to custom slider track and thumb content.
- Slider
Spec - Re-export the UI crate so applications can depend on a single crate.
Input and geometry policy for a
Slider. - Snapshot
State - Re-export the UI crate so applications can depend on a single crate. Cheap copyable mutable view of a state cell.
- Snapshot
State List - Core runtime helpers commonly used by applications.
- Snapshot
State Map - Core runtime helpers commonly used by applications.
- Software
Text Font Registry - Font registration vocabulary named by
AppLauncher’s font methods: the platform font directoryAppLauncher::with_system_font_familywants, the weight set it registers, and the registry and errorAppLauncher::with_fonts_fromhands out. Parsed app-supplied faces, on their way to aSoftwareTextFontSet. - Sound
Bank - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A set of cues loaded once and kept alive for as long as the composable that remembered it stays in the composition.
- Sound
Bank Entry - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A loaded cue inside a
SoundBank. - Sound
Bank Failure - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A cue that did not load, reported instead of silently vanishing.
- SoundId
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Identifies a decoded clip held by the audio engine.
- Sound
Spec - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
One entry in a
SoundBank: where the bytes come from and how the cue should sit in the mix before per-call parameters are applied. - Span
Style - Re-export the UI crate so applications can depend on a single crate.
- State
- Core runtime helpers commonly used by applications. Cheap copyable read-only view of a state cell.
- Store
Observer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A store observer installed by
observe_store_news. - Store
State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Snapshot of everything known about the store right now.
- Streaming
Asset Reader - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A
BundledAssetReaderover any byte stream. - String
Annotation - Re-export the UI crate so applications can depend on a single crate.
Mirrors Jetpack Compose’s
AnnotatedString.Range<String>— a tag+value annotation covering a byte range. - Stub
Http Client - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. An HTTP client that answers from a function rather than a network.
- Subcompose
Layout Node - Re-export the UI crate so applications can depend on a single crate. Node responsible for orchestrating measure-time subcomposition.
- Subcompose
Measure Scope Impl - Re-export the UI crate so applications can depend on a single crate.
Concrete implementation of
SubcomposeMeasureScope. - SvgPainter
- Re-export the UI crate so applications can depend on a single crate. Parsed SVG image data that rasterizes on demand for the requested draw size.
- Swipe
Dismiss State - Re-export the UI crate so applications can depend on a single crate. A row’s swipe, as the application can see it.
- Swipe
ToDismiss Spec - Re-export the UI crate so applications can depend on a single crate.
Configuration for
SwipeToDismiss. - Test
Applier Guard - Re-export the UI crate so applications can depend on a single crate.
- Test
Composition - Re-export the UI crate so applications can depend on a single crate. In-memory composition helper used by tests.
- Text
Field Buffer - Re-export the UI crate so applications can depend on a single crate. A mutable text buffer that can be edited.
- Text
Field Element - Re-export the UI crate so applications can depend on a single crate.
Element that creates and updates
TextFieldModifierNodeinstances. - Text
Field Modifier Node - Re-export the UI crate so applications can depend on a single crate.
- Text
Field State - Re-export the UI crate so applications can depend on a single crate. Observable state holder for text field content.
- Text
Field Value - Re-export the UI crate so applications can depend on a single crate. Immutable snapshot of text field content.
- Text
Layout Options - Re-export the UI crate so applications can depend on a single crate.
Text layout behavior options matching Compose
BasicTextcontrols. - Text
Layout Result - Re-export the UI crate so applications can depend on a single crate.
- Text
Line Prefix Widths - Re-export the UI crate so applications can depend on a single crate.
- Text
Metrics - Re-export the UI crate so applications can depend on a single crate.
- Text
Modifier Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates TextModifierNode instances.
- Text
Modifier Node - Re-export the UI crate so applications can depend on a single crate. Node that stores text content and handles measurement, drawing, and semantics.
- Text
Options - Re-export the UI crate so applications can depend on a single crate. High-level text widget options for constrained UI text.
- Text
Range - Re-export the UI crate so applications can depend on a single crate. Represents a range in text, used for cursor position and selection.
- Text
Style - Re-export the UI crate so applications can depend on a single crate.
- Thumb
Bounds - Re-export the UI crate so applications can depend on a single crate. How short and how long a thumb may get, as fractions of the track.
- Thumb
Geometry - Re-export the UI crate so applications can depend on a single crate. Thumb length and position, both as fractions of the track.
- Transform
Origin - Re-export the UI crate so applications can depend on a single crate.
- Update
Package - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A package an update would install.
- Upright
Rgba - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A frame’s pixels as tightly packed RGBA8, already the right way up.
- VoiceId
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Identifies one playing voice, so a looping cue can be stopped or retuned while it runs.
- Window
Config - Declarative configuration for an operating-system window.
- Window
Insets - Re-export the UI crate so applications can depend on a single crate. Insets needed to keep content clear of system UI and the on-screen keyboard.
- Window
Root Element - Re-export the UI crate so applications can depend on a single crate. Element that creates and updates window root nodes.
- Window
Root Entry - Re-export the UI crate so applications can depend on a single crate. A window root the registry knows about.
- Window
Root Node - Re-export the UI crate so applications can depend on a single crate. Node that lays its content out into the window’s size. That size is the node’s own, for the window’s scene; the layout pass reports a zero size to the node’s parent.
- Window
Root Registry - Re-export the UI crate so applications can depend on a single crate. The window roots attached in an app context, in attach order, with a revision that changes whenever the set changes.
- Window
State - Mutable position and size state for a declarative OS window, and whether the window has a frame on the screen.
- Writable
Folder Launcher - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Presents the persistent writable-folder chooser and hands the durable handle
back. Store the handle and reopen it with
crate::writable_folder::open_writable_folder. - Zoom
State - Re-export the UI crate so applications can depend on a single crate.
Shared zoom/pan transform state for
Modifier::zoomable.
Enums§
- Android
GpuBackend - Graphics API used by the Android WGPU renderer.
- AppUpdate
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Failure to start an update operation.
- AppUpdate
Status - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Observable state of the application update flow.
- Audio
Bus - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The two mix buses every app gets, so “sound on” and “music on” are one call each rather than bookkeeping over individual voices.
- Audio
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Why an audio call could not be honoured.
- Audio
Focus - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the rest of the device is doing with the output.
- Blend
Mode - Re-export the UI crate so applications can depend on a single crate. Blend mode used for draw primitives.
- Brush
- Re-export the UI crate so applications can depend on a single crate.
- Bundled
Asset Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Error reading an asset from the application bundle.
- Bundled
Asset Install Outcome - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Result of installing a bundled asset set.
- Camera
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Camera
State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the camera session is doing.
- Color
Filter - Re-export the UI crate so applications can depend on a single crate. Simple image color filter model.
- Compositing
Strategy - Re-export the UI crate so applications can depend on a single crate.
- Content
Entry - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
One child of a
ContentFolder. - Content
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Errors produced while reading or writing content.
- Content
Scale - Re-export the UI crate so applications can depend on a single crate.
- Cursor
Icon - Re-export the UI crate so applications can depend on a single crate. Describes the appearance of the (usually mouse) cursor icon.
- Custom
Cursor Size - How big an app’s own cursor images appear when the person has enlarged the system pointer.
- Digest
Algorithm - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How a package’s bytes are checked against what the release promised.
- Drag
AndDrop Event - Re-export the UI crate so applications can depend on a single crate. One step of a transfer the source recorded for the shell to route.
- Drag
AndDrop Outcome - Re-export the UI crate so applications can depend on a single crate. How a transfer ended, as the source hears it.
- Draw
Command - Re-export the UI crate so applications can depend on a single crate.
- Durable
Save Outcome - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What became of the durable saves the host asked for.
- File
Picker Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Errors produced while presenting a chooser.
- Fill
Direction - Re-export the UI crate so applications can depend on a single crate. Direction for fill modifiers (horizontal, vertical, or both).
- Flash
Mode - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the light does when a still is captured.
- Focus
Direction - Re-export the UI crate so applications can depend on a single crate. Focus direction for navigation.
- Focus
Request Error - Re-export the UI crate so applications can depend on a single crate.
Why
FocusRequester::request_focuscould not move focus. - Folder
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Errors produced by writable-folder I/O.
- Font
Load Error - Font registration vocabulary named by
AppLauncher’s font methods: the platform font directoryAppLauncher::with_system_font_familywants, the weight set it registers, and the registry and errorAppLauncher::with_fonts_fromhands out. Why an app-supplied face could not be registered. - Frame
Format - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How a frame’s pixels are laid out.
- Frame
Pacing Mode - Development frame pacing and FPS statistics types.
- Haptic
Effect - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A system-defined vibration primitive.
- Haptic
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Why a haptic pattern could not be built.
- Haptic
Feedback - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A haptic feedback event.
- Horizontal
Alignment - Re-export the UI crate so applications can depend on a single crate. Alignment along the horizontal axis.
- Http
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Http
Method - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The verbs a request can use.
- Image
Picker Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Image
Sampling - Re-export the UI crate so applications can depend on a single crate. Texture sampling mode for image primitives.
- Image
Source - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Where an image comes from.
- Incoming
Source - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Where the bytes of an incoming item live.
- Inspector
Action - An inspector control, independent of the application’s actions.
- Inspector
Mode - The application’s visual presentation while inspecting accessibility.
- Interaction
- Re-export the UI crate so applications can depend on a single crate.
- Intrinsic
Size - Re-export the UI crate so applications can depend on a single crate. Specifies how to size a component based on its intrinsic measurements.
- KeyCode
- Re-export the UI crate so applications can depend on a single crate. Physical key codes for keyboard input.
- KeyEvent
Type - Re-export the UI crate so applications can depend on a single crate. Type of keyboard event.
- Launch
ArgValue - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One launch-argument value, in the type the platform delivered it.
- Launch
Error - Errors that can occur while launching a windowed (desktop or iOS) application.
- Layer
Shape - Re-export the UI crate so applications can depend on a single crate.
- Layout
Direction - Re-export the UI crate so applications can depend on a single crate. Which side of the interface is the start.
- Layout
Node Kind - Re-export the UI crate so applications can depend on a single crate.
Classification of the node captured inside a
LayoutBox. - Lens
Facing - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Which way a capture device points.
- Lifecycle
State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Android-style lifecycle state exposed to composition observers.
- Linear
Arrangement - Re-export the UI crate so applications can depend on a single crate. Arrangement strategy matching Jetpack Compose’s linear arrangements.
- Link
Annotation - Re-export the UI crate so applications can depend on a single crate.
Mirrors Jetpack Compose’s
LinkAnnotationsealed class. - Live
Region Mode - Re-export the UI crate so applications can depend on a single crate. How urgently a screen reader reads a node whose text changed on its own.
- Media
Command - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A button pressed somewhere the application does not draw: a lock screen, a notification, a headset, a car.
- Media
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Memory
Pressure - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How hard the platform asks for memory back.
- Paint
Layer - Re-export the UI crate so applications can depend on a single crate. Layer that a paint operation targets within the rendering pipeline.
- Patch
Fill - Re-export the UI crate so applications can depend on a single crate. How a region larger than its source is filled.
- Peer
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Errors from peer serving or fetching.
- Platform
Directory Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Playback
State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the player is doing.
- Pointer
Event Kind - Re-export the UI crate so applications can depend on a single crate.
- Pointer
Icon - Re-export the UI crate so applications can depend on a single crate. The pointer’s appearance over a region of the UI.
- Pointer
Icon Error - Re-export the UI crate so applications can depend on a single crate.
Errors returned while constructing a
CustomPointerIcon. - Pointer
Source - Re-export the UI crate so applications can depend on a single crate. The kind of physical device that produced a pointer event.
- Power
Reading - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One power reading, or the reason there is no value.
- Preferences
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Errors produced by a preferences backend.
- Press
Interaction - Re-export the UI crate so applications can depend on a single crate.
- Purchase
Event - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A one-shot thing that happened, which a snapshot cannot express.
- Render
Effect - Re-export the UI crate so applications can depend on a single crate. A render effect applied to a graphics layer’s rendered content.
- Render
Op - Re-export the UI crate so applications can depend on a single crate. A rendered operation emitted by the headless renderer.
- Resize
Refused - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Why a resize request was refused.
- Semantics
Action - Re-export the UI crate so applications can depend on a single crate. Semantics action exposed to the input system.
- Semantics
Role - Re-export the UI crate so applications can depend on a single crate. Semantic role describing how a node should participate in accessibility and hit testing. Roles are now derived from SemanticsConfiguration rather than widget types.
- Semantics
Widget Role - Re-export the UI crate so applications can depend on a single crate. What kind of control a node is, as screen readers announce it.
- Share
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Slider
Orientation - Re-export the UI crate so applications can depend on a single crate.
Main axis used by a
Slider. - Store
Phase - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How far along the store connection is.
- SvgPainter
Error - Re-export the UI crate so applications can depend on a single crate. Errors returned while parsing or rasterizing an SVG painter.
- Swipe
Dismiss Direction - Re-export the UI crate so applications can depend on a single crate. Directions accepted by a swipe-dismiss container.
- Swipe
Dismiss Side - Re-export the UI crate so applications can depend on a single crate.
Which edge the dismiss background is revealed on, i.e. the side the row is
being swiped away from. Passed to the
SwipeToDismissSpec::with_backgroundclosure so its label/icon can follow the swipe direction instead of being pinned to one side. - System
Theme - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Text
Draw Style - Re-export the UI crate so applications can depend on a single crate.
- Text
Field Line Limits - Re-export the UI crate so applications can depend on a single crate. Line limit configuration for text fields.
- Text
Overflow - Re-export the UI crate so applications can depend on a single crate. How overflowing text should be handled.
- Text
Shaping - Re-export the UI crate so applications can depend on a single crate.
- Thermal
State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The operating system’s thermal-pressure level.
- UriHandler
Error - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Vertical
Alignment - Re-export the UI crate so applications can depend on a single crate. Alignment along the vertical axis.
- Window
Focus - Whether a window takes keyboard focus when it is created.
- Window
Resize Direction - Edge or corner used by
WindowModifierExt::window_resize_area.
Constants§
- ANDROID_
SYSTEM_ FONT_ DIR - Font registration vocabulary named by
AppLauncher’s font methods: the platform font directoryAppLauncher::with_system_font_familywants, the weight set it registers, and the registry and errorAppLauncher::with_fonts_fromhands out. Directory Android keeps its system font files in. - DEFAULT_
ALPHA - Re-export the UI crate so applications can depend on a single crate.
- DEFAULT_
CHUNK_ LEN - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Chunk size the framework’s own readers hand back per
ContentReader::read_chunk. - DEFAULT_
DURABLE_ SAVE_ DEADLINE - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The budget used when a host does not state one of its own.
- DEFAULT_
SYSTEM_ FAMILY_ WEIGHTS - Font registration vocabulary named by
AppLauncher’s font methods: the platform font directoryAppLauncher::with_system_font_familywants, the weight set it registers, and the registry and errorAppLauncher::with_fonts_fromhands out. The weightsSoftwareTextFontRegistry::register_system_familyregisters when an app does not name its own: Compose’s Regular/Medium/Bold set. - DUCKED_
GAIN - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The gain applied while another app is being heard over this one.
- IMAGE_
EXTENSIONS - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Image extensions offered when the picker falls back to the file picker.
- MAX_
FONT_ SCALE - Re-export the UI crate so applications can depend on a single crate. Largest system font scale honoured. Android’s own accessibility slider tops out at 2.0.
- MAX_
FONT_ SCALE_ KNOTS - Re-export the UI crate so applications can depend on a single crate. How many knots a curve keeps.
- MAX_
PENDING_ CHUNKS - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How many chunks may wait ahead of the consumer before the producer stops reading. Enough to keep a socket busy across one scheduling gap, and far short of holding a download in memory.
- MIN_
FONT_ SCALE - Re-export the UI crate so applications can depend on a single crate. Smallest system font scale honoured; below this, text stops being readable as text.
- OCTAVE_
BAND_ CENTERS_ HZ - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The octave centres a graphic equalizer is built on, in hertz.
Traits§
- AppInfo
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Reports the packaged identity of the running app.
- AppUpdater
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Platform implementation for update discovery and package installation.
- Arrangement
- Re-export the UI crate so applications can depend on a single crate. Trait implemented by arrangement strategies that distribute children on an axis.
- Audio
Player - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Plays sound. Installed by the platform backend; the default is a no-op.
- Background
Activity - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Marks periods of important work so the platform grants background running
time. Implementations are
Send + Sync(the app toggles activity from its worker threads). - BoxScope
- Re-export the UI crate so applications can depend on a single crate.
Marker trait matching Jetpack Compose’s
BoxScopeAPI. - BoxWith
Constraints Scope - Re-export the UI crate so applications can depend on a single crate.
Scope exposed to
BoxWithConstraintscontent. - Bundled
Asset Reader - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Chunked reader over one bundled asset.
- Bundled
Assets - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Access to files packaged in the app bundle.
- Byte
Source - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Random-access source of bytes the app is willing to serve.
- Camera
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A platform capture session.
- Content
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One readable piece of content from any source.
- Content
Folder - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A folder granted by a provider.
- Content
Reader - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A pull reader over one piece of content.
- Content
Resolver - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Turns a provider URI into readable content.
- Content
Sink - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A writable destination for streamed content.
- Content
Stream - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. An asynchronous stream of content.
- Delegatable
Node - Re-export the UI crate so applications can depend on a single crate.
Provides traversal helpers that mirror Jetpack Compose’s
DelegatableNodecontract. - Device
Info - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Provides device and process information.
- File
Picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Presents the system’s file, folder and document choosers.
- Folder
Reader - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Chunked reader over one file in a writable folder.
- Folder
Writer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Chunked writer over one file in a writable folder.
- Haptics
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Performs haptic feedback. Installed by the platform backend; the default is a no-op.
- Host
Controller - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Host operations supplied by the framework platform backend.
- Host
Surface - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What an application may ask of the host’s surface.
- Http
Body - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A response body, read a chunk at a time.
- Http
Client - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A platform’s HTTP.
- Image
Picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Picks or captures a single image and returns its encoded bytes.
- Layout
Engine - Re-export the UI crate so applications can depend on a single crate.
Extension trait that equips
MemoryApplierwith layout computation. - Lazy
List Scope - Re-export the UI crate so applications can depend on a single crate. Receiver scope for lazy list content definition.
- Measurable
- Re-export the UI crate so applications can depend on a single crate. Object capable of measuring a layout child and exposing intrinsic sizes.
- Media
Player - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A platform media stack.
- Media
Source Opener - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Opens a media URI the decoder cannot open for itself.
- Modifier
Node - Re-export the UI crate so applications can depend on a single crate. Core trait implemented by modifier nodes.
- Modifier
Node Element - Re-export the UI crate so applications can depend on a single crate. Strongly typed modifier elements that can create and update nodes while exposing equality/hash/inspector contracts that mirror Jetpack Compose.
- Network
Monitor - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Reports the current network status.
- Notifier
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Posts local notifications. Installed by the platform backend; the default is a no-op.
- Platform
Text Input Handler - Re-export the UI crate so applications can depend on a single crate. Callbacks a platform installs to control its on-screen keyboard.
- Power
Monitor - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Platform power policy.
- Preferences
Store - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Durable key/value storage owned by the application.
- Purchases
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A store backend.
- Share
Sheet - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The OS share sheet. Installed by the platform backend; the default is a
no-op that reports
ShareError::Unsupported. - Subcompose
Layout Scope - Re-export the UI crate so applications can depend on a single crate. Base trait for measurement scopes.
- Subcompose
Measure Scope - Re-export the UI crate so applications can depend on a single crate. Public trait exposed to measure policies for subcomposition.
- Text
Measurer - Re-export the UI crate so applications can depend on a single crate.
- UriHandler
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Window
Modifier Ext - Modifier helpers for composables rendered in OS windows.
- Window
Root Descriptor - Re-export the UI crate so applications can depend on a single crate. What a window root needs from the platform’s description of its window: the logical size to lay the content out into, read on every measure so a resize needs no new modifier, and the description itself for the platform to take back.
- Writable
Folder Store - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Synchronous, thread-safe access to a user-chosen writable folder.
Functions§
- Animated
Visibility - Re-export the UI crate so applications can depend on a single crate.
Animates the appearance and disappearance of its content when
visiblechanges. - Back
Handler - Handles platform back requests on the UI thread while
enabledis true. Nested handlers follow stack order: the innermost active handler receives the request and dropping it restores the handler beneath it. - Basic
Text - Re-export the UI crate so applications can depend on a single crate.
- Basic
Text Field - Re-export the UI crate so applications can depend on a single crate.
- Basic
Text Field Decorated - Re-export the UI crate so applications can depend on a single crate.
Creates an editable field and lets
decoration_boxplace composable labels, placeholders, icons, buttons, prefixes, or suffixes around it. - Basic
Text Field With Options - Re-export the UI crate so applications can depend on a single crate. Creates an editable text field with custom options.
- Basic
Text With Options - Re-export the UI crate so applications can depend on a single crate.
- Bitmap
Painter - Re-export the UI crate so applications can depend on a single crate.
- Bitmap
Region Painter - Re-export the UI crate so applications can depend on a single crate. Creates a painter that draws one region from a bitmap atlas.
- Box
- Re-export the UI crate so applications can depend on a single crate. A layout composable that stacks its children on top of each other.
- BoxWith
Constraints - Re-export the UI crate so applications can depend on a single crate.
- Bundled
Asset Install Effect - Installs a declared bundled-asset set on a worker and returns the outcome on the UI runtime. Work is cancelled with the owning composition.
- Button
- Re-export the UI crate so applications can depend on a single crate. A clickable button with a background and content.
- Canvas
- Re-export the UI crate so applications can depend on a single crate.
A composable that draws custom content using a
DrawScope. - Clickable
Text - Re-export the UI crate so applications can depend on a single crate.
Displays an
AnnotatedStringand callson_clickwith the byte offset of the character under the pointer at the time of the click. - Column
- Re-export the UI crate so applications can depend on a single crate. A layout composable that places its children in a vertical sequence.
- Crossfade
- Re-export the UI crate so applications can depend on a single crate. Crossfade allows switching between two layouts with a crossfade animation.
- Disposable
Effect - Core runtime helpers commonly used by applications.
Runs
effectwhen this call site first enters composition, and again wheneverkeysno longer equals the value it ran with last time; the previous run’sDisposableEffectScope::on_disposecleanup, if any, runs first, and also when the call site leaves composition entirely. - Durable
Save Effect - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
savefor as long as this call stays in the composition. - ForEach
- Re-export the UI crate so applications can depend on a single crate.
- Frame
Effect - Runs
on_frameon every animation frame whilerunningis true. - Image
- Re-export the UI crate so applications can depend on a single crate. Displays a painter with an optional accessible description.
- Keep
Screen On - Keeps the platform display awake while this call remains in composition and
enabledis true. Multiple active callers are reference-counted. - Launched
Effect - Core runtime helpers commonly used by applications.
Runs
effectwhen this call site first enters composition, and again wheneverkeysno longer equals the value it ran with last time. - Launched
Effect Async - Core runtime helpers commonly used by applications.
Like
LaunchedEffect, butmk_futurebuilds the future to drive rather than receiving a scope to call back into synchronously. - Layout
- Re-export the UI crate so applications can depend on a single crate.
- Lazy
Column - Re-export the UI crate so applications can depend on a single crate. A vertically scrolling list that only composes visible items.
- LazyRow
- Re-export the UI crate so applications can depend on a single crate. A horizontally scrolling list that only composes visible items.
- Lifecycle
Effect - Registers a lifecycle observer for the lifetime of the current composition.
- Linked
Text - Re-export the UI crate so applications can depend on a single crate.
Renders an
AnnotatedStringand automatically dispatches link clicks: - Provide
Accessibility Options - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Gives the content below it fixed options, for a preview or a test that wants to see the app with larger text, no motion or more contrast.
- Provide
Accessibility State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Gives the content below it a fixed state, for a preview or a test that wants to see the app as a screen reader user does.
- Provide
Audio - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Provides the installed audio player to
content. - Provide
File Picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Provides the default
FilePickerto descendant composables. - Provide
Haptics - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Provide
Image Picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Provide
Launch Args - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Provides launch arguments to
content. - Provide
Layout Direction - Re-export the UI crate so applications can depend on a single crate.
Runs
contentindirection. - Provide
Lazy Item Key - Re-export the UI crate so applications can depend on a single crate.
Composes
contentas the item identified bykey. - Provide
Lifecycle - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Provides the host’s lifecycle state to descendant composables.
- Provide
Notifier - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Provide
Share Sheet - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Provide
System Theme - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Provide
UriHandler - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Row
- Re-export the UI crate so applications can depend on a single crate. A layout composable that places its children in a horizontal sequence.
- Slider
- Re-export the UI crate so applications can depend on a single crate.
A
0..=1slider whose visuals are ordinary composables supplied bycontent. The framework owns pointer capture, cancellation, rotary input, pressed interactions, value mapping, and completion delivery. - Spacer
- Re-export the UI crate so applications can depend on a single crate. A component that represents an empty space.
- Subcompose
Layout - Re-export the UI crate so applications can depend on a single crate.
- Swipe
ToDismiss - Re-export the UI crate so applications can depend on a single crate.
Wraps
contentso it can be swiped away horizontally. - Swipe
ToDismiss Box - Re-export the UI crate so applications can depend on a single crate. Full-content navigation dismissal. The gesture starts at the leading edge, moves only toward the end edge, and leaves sizing to the navigation owner.
- Text
- Re-export the UI crate so applications can depend on a single crate.
- Text
With Options - Re-export the UI crate so applications can depend on a single crate.
- Unhandled
KeyEvents - Re-export the UI crate so applications can depend on a single crate.
Hands
handlerevery key event no control took: none was focused, a focused control let the key pass, and no text field is taking typing. - acquire_
background_ work - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Acquires background execution for one independent operation.
- active_
focus_ target - Re-export the UI crate so applications can depend on a single crate. Returns the currently active focus target, if any.
- announce
- Re-export the UI crate so applications can depend on a single crate.
Reads
textout politely. Short form ofAnnouncer::announcefor code that sits outside composition. - app_
info - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The active app info: the platform implementation if installed, otherwise the built-in default.
- app_
update_ capabilities - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What this host can do about application updates.
- app_
update_ checks_ supported - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Returns whether this host can discover a newer release.
- app_
update_ status - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Returns the latest update state.
- app_
updates_ supported - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Returns whether this host can install application updates.
- application_
directories - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Returns typed directories for the registered application.
- application_
id - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The registered application id, if a host has published one.
- audio_
focus - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the rest of the device is doing with the output.
- back_
interception_ enabled - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Whether the app asked to intercept the platform back control. Read by the platform input path.
- background_
active - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Whether at least one background-work lease is active.
- background_
activity - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The registered background-activity handler, or
Nonewhere unsupported. - background_
app - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Requests that the host move the app to the background.
- build_
layout_ tree_ from_ applier - Re-export the UI crate so applications can depend on a single crate. Builds a layout snapshot from retained layout state in the live applier tree.
- build_
semantics_ tree_ from_ applier - Re-export the UI crate so applications can depend on a single crate. Builds a semantics snapshot from retained layout state in the live applier tree.
- build_
semantics_ tree_ from_ layout_ tree - Re-export the UI crate so applications can depend on a single crate.
Builds a semantics tree from an existing
LayoutTree. - build_
version - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The build identifier a store orders releases by, if the platform knows one.
- bundled_
assets - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Returns the platform reader, if this host has an application bundle.
- camera
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The installed camera, or
Nonewhere live capture is unsupported — which is when an application falls back to the image picker. - camera_
lenses - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The devices the application may pick between, as the backend last published them.
- camera_
state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the session is doing.
- camera_
supported - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Whether this platform has a live camera at all.
- capture_
camera_ still - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Takes one full-resolution still and resolves with it.
- check_
for_ app_ update - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Starts update discovery and publishes the initial state.
- clean_
slot_ skip_ count - Re-export the UI crate so applications can depend on a single crate.
Number of subcompose measure passes on this thread that reused a retained
slot without a compose walk. Diagnostic surface for tests and telemetry;
see
SubcomposeMeasureScope::subcomposefor when a slot may skip. - clear_
application_ id - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes the registered application id (tests and teardown).
- clear_
focus_ invalidations - Re-export the UI crate so applications can depend on a single crate. Clears all pending focus invalidations without processing them.
- clear_
host_ controller - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes the installed host controller.
- clear_
incoming_ content - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Discards anything waiting for a collector. Used by tests and host teardown.
- clear_
launcher_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Discards every framework-owned launcher record. Used by tests and by host teardown so one composition’s in-flight request never leaks into the next.
- clear_
modals - Re-export the UI crate so applications can depend on a single crate.
Clears every registration in the current [
crate::AppContext]. - clear_
platform_ app_ info - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered platform app info (tests and teardown).
- clear_
platform_ app_ updater - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes the platform updater.
- clear_
platform_ audio - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered platform audio player (tests and teardown).
- clear_
platform_ background_ activity - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered handler (tests/teardown).
- clear_
platform_ bundled_ assets - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes the platform reader.
- clear_
platform_ camera - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes the platform camera and forgets everything the last session published.
- clear_
platform_ content_ resolver - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any installed platform content resolver.
- clear_
platform_ device_ info - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered platform device info (tests and teardown).
- clear_
platform_ file_ picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered platform chooser (used in tests and teardown).
- clear_
platform_ haptics - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered platform haptics (tests and teardown).
- clear_
platform_ host_ surface - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes the installed host surface (tests and teardown).
- clear_
platform_ image_ picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered platform image picker (tests and teardown).
- clear_
platform_ launch_ args - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any platform-reported launch arguments (tests and teardown).
- clear_
platform_ media_ player - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes the platform media player and forgets everything it published.
- clear_
platform_ media_ source_ opener - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes the platform media source opener.
- clear_
platform_ network_ monitor - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered platform network monitor (tests and teardown).
- clear_
platform_ notifier - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- clear_
platform_ power_ monitor - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes the platform power monitor.
- clear_
platform_ preferences - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any installed platform backend (tests and teardown).
- clear_
platform_ purchases - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered purchase backend (tests and teardown).
- clear_
platform_ share_ sheet - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered platform share sheet (tests and teardown).
- clear_
platform_ system_ theme - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any platform-reported theme (tests and teardown).
- clear_
platform_ uri_ handler - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Removes any registered platform URI handler (tests and teardown).
- clear_
pointer_ repasses - Re-export the UI crate so applications can depend on a single crate. Clears all pending pointer repasses without processing them.
- clear_
semantics_ invalidations - Re-export the UI crate so applications can depend on a single crate. Drops every pending semantics invalidation without servicing it.
- collect_
focus_ order - Re-export the UI crate so applications can depend on a single crate.
Walks
treein the order the layout pass placed it and keeps the nodes that registered a focus target and take space on screen. - collect_
focus_ order_ under - Re-export the UI crate so applications can depend on a single crate. The focus targets under one node, in the order layout gave them. An arrow key inside a selectable group moves among these and no others.
- collect_
is_ pressed_ as_ state - Re-export the UI crate so applications can depend on a single crate.
Free-function form of
MutableInteractionSource::collectIsPressedAsState. - collect_
modifier_ slices - Re-export the UI crate so applications can depend on a single crate.
Collects modifier node slices directly from a reconciled
ModifierNodeChain. - collect_
semantics_ from_ modifier - Re-export the UI crate so applications can depend on a single crate.
Collects semantics by instantiating a temporary modifier chain from a
Modifier. - collect_
slices_ from_ modifier - Re-export the UI crate so applications can depend on a single crate.
Collects modifier node slices by instantiating a temporary node chain from a
Modifier. - collect_
stream - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Collects an entire stream. Convenient for tests and small trees; production
collectors consume
ContentStream::nextincrementally. - command_
draw_ scope - Re-export the UI crate so applications can depend on a single crate. The scope every framework-run draw command records into: sized by the consumer, measuring text with the app’s fonts.
- command_
draw_ scope_ reusing - Re-export the UI crate so applications can depend on a single crate.
command_draw_scoperecording into storage the consumer already owns — the retained-recorder path where a command’s buffer keeps its capacity across frames. - content_
delta_ for_ thumb_ drag - Re-export the UI crate so applications can depend on a single crate.
How far the content moves when the thumb is dragged
deltaalong a track oftrack, given the thumb it currently shows. - content_
length - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Returns the total length of a shared handle, via a one-byte range probe.
- current_
density - Re-export the UI crate so applications can depend on a single crate. Returns the current density scale factor (logical px per dp).
- current_
font_ scale - Re-export the UI crate so applications can depend on a single crate.
Returns the system font scale — the multiplier the user chose in the
platform’s font-size setting,
1.0when they left it alone. - current_
font_ scale_ curve - Re-export the UI crate so applications can depend on a single crate.
Returns the conversion the platform performs for a size in
Sp. - current_
lifecycle_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Returns the latest lifecycle state published by the platform host.
- current_
media_ item - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The open item, or
Nonewhen nothing is. - default_
audio - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The installed platform player, or a no-op one.
- default_
file_ picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The default chooser (the platform backend).
- default_
haptics - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- default_
http_ client - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- default_
image_ picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- default_
notifier - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- default_
share_ sheet - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- default_
system_ theme - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- default_
uri_ handler - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- delay
- Core runtime helpers commonly used by applications.
Resolves after
durationhas elapsed. - density
- Re-export the UI crate so applications can depend on a single crate. The device pixel grid in force here.
- device_
info - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The active device info: the platform implementation if installed, otherwise the built-in default.
- dismiss_
top_ popup - Re-export the UI crate so applications can depend on a single crate. Closes the dismissable popup on top of the most recent host, the way an outside tap would, for a screen reader’s escape gesture or an Escape key with no dialog open. Answers whether a popup was there to close.
- dismissable_
popup_ open - Re-export the UI crate so applications can depend on a single crate. Whether a dismissable popup is open on any host. Reading this in a composable subscribes to every host’s revision, so the reader recomposes when a popup opens or closes.
- dispatch_
lifecycle - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes a lifecycle transition from the platform host.
- dispatch_
lifecycle_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes a platform lifecycle state and derives the transition source from the framework’s previous state.
- dispatch_
modal_ back - Re-export the UI crate so applications can depend on a single crate. Asks the innermost modal surface to close.
- dispatch_
unhandled_ key_ event - Re-export the UI crate so applications can depend on a single crate.
Offers
eventto theUnhandledKeyEventshandlers, the one composed last first, and says whether one of them took it. The platform shells call this with each key the focused controls and text fields let pass. - drain_
announcements - Re-export the UI crate so applications can depend on a single crate. Takes the queued announcements. A platform accessibility bridge calls this once a frame and hands each one to the screen reader.
- drain_
reader - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Reads a reader to its end.
- dropped_
camera_ frames - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How many frames were produced while every observer was still busy.
- dropped_
media_ samples - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How many sample blocks were produced while every observer was still busy.
- durable_
save_ deadline - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. How long the installed host will wait for durable saves.
- execute_
draw_ commands - Re-export the UI crate so applications can depend on a single crate.
- exit_
app - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Requests that the host finish the app.
- exit_
requested - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Whether an exit request is outstanding, without consuming it.
- fade_in
- Re-export the UI crate so applications can depend on a single crate.
Fades in the content of an
AnimatedVisibility, from transparent to fully opaque. - fade_
out - Re-export the UI crate so applications can depend on a single crate.
Fades out the content of an
AnimatedVisibility, from fully opaque to transparent. - fetch_
range - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Fetches a byte range of a shared handle from a peer at
base(e.g."192.168.1.20:54123") into memory.len = Nonefetches to the end. - fetch_
to_ writer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Streams a byte range of a shared handle from a peer into
writer, in chunks, without buffering the whole range in memory — use this to spool a track to disk. Returns the total source length (fromContent-Range) when known. - file_
content - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A shared handle to the file at
path. - file_
folder - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A shared handle to the directory at
path. - focus_
order_ len - Re-export the UI crate so applications can depend on a single crate. How many focus targets the last published order holds.
- folder_
files - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Streams every file in
folder’s tree, using the provider’s native stream when it has one and a depth-first walk otherwise. - forget_
movable - Core runtime helpers commonly used by applications.
Releases the state of
movablecontent with identitykeythat no parent is showing. Call it when the item is closed for good, from an event handler or inside composition. Content a parent is still showing is unaffected. Needs a runtime: an active composition or one created on this thread. - format_
layout_ tree - Re-export the UI crate so applications can depend on a single crate. Returns a formatted string representation of the layout tree
- format_
modifier_ chain - Re-export the UI crate so applications can depend on a single crate. Formats the modifier chain using inspector data.
- format_
render_ scene - Re-export the UI crate so applications can depend on a single crate. Returns a formatted string representation of the render scene
- format_
screen_ summary - Re-export the UI crate so applications can depend on a single crate. Returns a compact summary of what’s on screen (counts by type).
- get_
cursor_ x_ for_ offset - Re-export the UI crate so applications can depend on a single crate.
- get_
offset_ for_ position - Re-export the UI crate so applications can depend on a single crate.
- has_
focused_ field - Re-export the UI crate so applications can depend on a single crate. Returns true if any text field currently has focus. Checks weak ref liveness and clears stale focus state.
- has_
pending_ draw_ repasses - Re-export the UI crate so applications can depend on a single crate. Returns true if any draw repasses are pending.
- has_
pending_ focus_ invalidations - Re-export the UI crate so applications can depend on a single crate. Returns true if any focus invalidations are pending.
- has_
pending_ layout_ repasses - Re-export the UI crate so applications can depend on a single crate. Returns true if any layout repasses are pending.
- has_
pending_ measure_ repasses - Re-export the UI crate so applications can depend on a single crate. Returns true if any measure repasses are pending.
- has_
pending_ pointer_ repasses - Re-export the UI crate so applications can depend on a single crate. Returns true if any pointer repasses are pending.
- has_
pending_ semantics_ invalidations - Re-export the UI crate so applications can depend on a single crate. Whether any semantics invalidations are waiting to be serviced.
- host_
controller - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Returns the installed framework host controller.
- host_
density - How many physical pixels this host puts in one logical pixel.
- host_
surface - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The installed host surface, or one that accepts no resize requests.
- host_
surface_ size - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The size the host last reported.
- http_
body_ ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Wraps
bodyin anHttpBodyRef. - install_
app_ update - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Starts package installation and publishes the initial transfer state.
- install_
bundled_ asset_ set - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs a declarative set without exposing bundle APIs or partial-file handling to the application.
- install_
modifier_ chain_ trace - Re-export the UI crate so applications can depend on a single crate. Installs a callback that receives modifier chain snapshots when debugging is enabled.
- interval
- Core runtime helpers commonly used by applications.
Runs
tickeveryperioduntil the returned future is dropped. - isDebuggable
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Whether the OS considers this build debuggable, read from composition.
- isSystem
InDark Theme - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- is_
cursor_ visible - Re-export the UI crate so applications can depend on a single crate. Returns whether the cursor should be visible right now.
- is_
debuggable - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Whether the OS considers this build debuggable — see
LaunchArgs::is_debuggable. - is_
window_ root - Re-export the UI crate so applications can depend on a single crate.
Whether
nodeis a layout node whose modifier chain carries a window root. - key
- Core runtime helpers commonly used by applications.
Scopes composition identity to
keysfor the duration ofcontent. - keyboard_
focus_ target - Re-export the UI crate so applications can depend on a single crate.
Resolves Tab, arrows, Home and End using desktop keyboard conventions.
Tab enters a radio group or tab list at its focused or selected member and
leaves it in one step. Arrows wrap within the group; radio navigation also
selects the destination. Tabs use manual activation with Enter or Space.
Hidden, disabled and background targets outside the top modal are excluded.
Publishes this layout’s focus order in the current [
crate::AppContext] for subsequent programmaticcrate::FocusManagermoves. Unhandled keys returnNoneso a widget can apply its own keyboard behavior. - keyboard_
focus_ visible - Re-export the UI crate so applications can depend on a single crate. Whether the keyboard, and not a pointer, made the last focus move.
- latest_
camera_ frame - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The last frame the session produced, or
Nonebefore the first one. - latest_
media_ samples - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The last block of samples, or
Nonewhen analysis is off or nothing has played yet. Read during draw, so a visualiser never draws a stale block. - launch
Blocking - Core runtime helpers commonly used by applications.
Runs
workoff the UI thread and hands its result toon_uion the UI thread. - launch_
args - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The launch arguments this app was started with.
- launch_
args_ from_ command_ line - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Parses
--name=value(text) and bare--name(true) out of a command line. - layout_
direction - Re-export the UI crate so applications can depend on a single crate. The layout direction in force here.
- layout_
text - Re-export the UI crate so applications can depend on a single crate.
- lazy_
item_ key - Re-export the UI crate so applications can depend on a single crate.
The key of the lazy item being composed, or
Noneoutside a keyed lazy item. - local_
accessibility_ options - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The options a composable reads: what the platform reported, unless a
ProvideAccessibilityOptionsabove it says otherwise. - local_
accessibility_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The state a composable reads: what the platform reported, unless a
ProvideAccessibilityStateabove it says otherwise. - local_
announcer - Re-export the UI crate so applications can depend on a single crate.
CompositionLocal carrying the
Announcer. The same instance comes back on every call. - local_
audio - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The CompositionLocal descendants read to reach the audio player.
- local_
bring_ into_ view_ responder - Re-export the UI crate so applications can depend on a single crate.
CompositionLocal carrying the nearest scroll container’s
BringIntoViewResponder, orNoneoutside any scroll container. - local_
density - Re-export the UI crate so applications can depend on a single crate.
The
CompositionLocalcarrying the device pixel grid. - local_
file_ picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The
CompositionLocalcarrying the activeFilePicker. - local_
focus_ manager - Re-export the UI crate so applications can depend on a single crate.
CompositionLocal carrying the
FocusManager, asLocalFocusManagerdoes in Compose. The same instance comes back on every call. - local_
haptics - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- local_
http_ client - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- local_
image_ picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- local_
ime_ insets - Re-export the UI crate so applications can depend on a single crate.
CompositionLocal carrying the on-screen soft-keyboard (IME) insets in logical
pixels. The
bottomfield is the height the keyboard currently covers at the bottom of the window (zero when it is hidden); the other edges are zero. - local_
launch_ args - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The composition local carrying the launch arguments.
- local_
layout_ direction - Re-export the UI crate so applications can depend on a single crate.
The
CompositionLocalcarrying the current layout direction. - local_
lazy_ item_ key - Re-export the UI crate so applications can depend on a single crate.
The
CompositionLocalcarrying the current lazy item’s key. - local_
lifecycle_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The
CompositionLocalcarrying the host’s current lifecycle state. - local_
modal_ depth - Re-export the UI crate so applications can depend on a single crate. CompositionLocal carrying the modal depth at which content is being composed: zero outside any dialog, or the depth of the innermost dialog that encloses the current composition.
- local_
notifier - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- local_
on_ light_ surface - Re-export the UI crate so applications can depend on a single crate.
CompositionLocal marking the surface the floating glass sits over as
LIGHT. Liquid glass is transparent, so its labels and hairlines must
flip to dark ink over a light backdrop to stay readable — the same
content over a dark app keeps its near-white ink. Defaults to
false(dark surface), preserving the existing look; a light-themed screen providestrue. - local_
safe_ area_ insets - Re-export the UI crate so applications can depend on a single crate. CompositionLocal carrying the platform safe-area insets in logical pixels.
- local_
share_ sheet - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- local_
system_ theme - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- local_
uri_ handler - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- log_
layout_ tree - Re-export the UI crate so applications can depend on a single crate. Logs the current layout tree through the logger with indentation showing hierarchy.
- log_
modifier_ chain - Re-export the UI crate so applications can depend on a single crate. Logs the contents of a modifier node chain including capabilities.
- log_
render_ scene - Re-export the UI crate so applications can depend on a single crate. Logs the current render scene through the logger.
- log_
screen_ summary - Re-export the UI crate so applications can depend on a single crate. Logs a compact summary of what’s on screen (counts by type).
- map_
ordered_ concurrent - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- measure_
layout - Re-export the UI crate so applications can depend on a single crate.
Runs the measure phase for the subtree rooted at
root. - measure_
layout_ with_ options - Re-export the UI crate so applications can depend on a single crate.
- measure_
text - Re-export the UI crate so applications can depend on a single crate.
- measure_
text_ for_ node - Re-export the UI crate so applications can depend on a single crate.
- measure_
text_ with_ options - Re-export the UI crate so applications can depend on a single crate.
- measure_
text_ with_ options_ for_ node - Re-export the UI crate so applications can depend on a single crate.
- media_
capabilities - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
What the installed backend can do, or
MediaCapabilities::default— every capability absent — when there is none. - media_
equalizer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The equalizer setting last applied.
- media_
equalizer_ bands - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The equalizer bands this platform has, in the order gains are given in.
- media_
playback_ supported - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Whether this platform can play media at all.
- media_
player - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The installed media player, or
Nonewhere this platform has none. - media_
volume - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The volume the application asked for, before the audio-focus gain.
- modal_
depth - Re-export the UI crate so applications can depend on a single crate. How many modal surfaces are open. Reading this in a composable subscribes to it, so the reader recomposes when a modal opens or closes.
- movable
- Core runtime helpers commonly used by applications.
Composes
contentunder an identity that iskeyalone, the same at every call site, so the subtree can be emitted from any parent and keep its remembered values, its running effects and its nodes. - movable
Content Of - Core runtime helpers commonly used by applications.
Movable content whose identity is
key, the same at every call site. - mutable
State List - Core runtime helpers commonly used by applications.
- mutable
State List Of - Core runtime helpers commonly used by applications.
- mutable
State Map - Core runtime helpers commonly used by applications.
- mutable
State MapOf - Core runtime helpers commonly used by applications.
- mutable
State Of - Core runtime helpers commonly used by applications.
Creates a new
MutableStateinitialized with the given value. - mutable
State OfNever Equal - Core runtime helpers commonly used by applications.
Like
mutableStateOf, for a value that cannot be compared or whose every write must count as a change. - nearest_
window_ root - Re-export the UI crate so applications can depend on a single crate.
The window root that owns
node: the nearest node,nodeincluded, whose modifier chain carries a window root.Nonewhen the node belongs to the primary root. - network_
monitor - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The active network monitor: the platform one if installed, else the default (online, unmetered).
- network_
status - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Convenience: the current network status.
- next_
cursor_ blink_ time - Re-export the UI crate so applications can depend on a single crate.
Returns the next cursor blink transition time, if any.
Use this for
WaitUntilscheduling in the event loop. - nine_
patch_ quads - Re-export the UI crate so applications can depend on a single crate.
The draws that fill
destinationwithsourceas a nine-patch. - note_
store_ news - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Tells the app that the store has news. Called by a purchase backend.
- observe_
app_ update_ status - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Observes update state changes. The current state is delivered immediately.
- observe_
audio_ focus - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor audio-focus changes. The current focus is delivered at once. - observe_
back_ requests - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Registers a callback run whenever a back request arrives, so an app can be told rather than having to ask.
- observe_
camera_ frames - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor frames. Applications collectrememberCameraFramesinstead of calling this. - observe_
camera_ lenses - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor the lens list. The current list is delivered at once, so a screen composed mid-session shows the devices rather than waiting for the next change. - observe_
camera_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor session state. The current state is delivered at once, so a screen composed mid-session shows what is happening rather than waiting for the next change. - observe_
camera_ stills - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor stills. - observe_
host_ surface_ size - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor host-surface size changes. Applications collectrememberHostSurfaceSizeinstead of calling this. - observe_
incoming_ content - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor incoming content, replaying anything that arrived before there was anywhere to put it. - observe_
lifecycle - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Observes host lifecycle transitions until the returned handle is dropped.
- observe_
media_ commands - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor media-session commands. - observe_
media_ samples - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor analysis samples. - observe_
memory_ pressure - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor pressure reports. - observe_
playback_ progress - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor position updates. The current position is delivered at once. - observe_
playback_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor playback state. The current state is delivered at once, so a screen composed mid-item shows what is happening rather than waiting for the next change. - observe_
power_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Registers
observerfor power-state changes. Applications collectrememberPowerStateinstead of calling this. - observe_
store_ news - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Registers a callback run whenever the store has news, so an app can be told rather than having to ask.
- octave_
equalizer_ bands - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
OCTAVE_BAND_CENTERS_HZas bands, each able to lift or cut byrange_db. - open_
media - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Opens
item, publishingPlaybackState::Loadingbefore the backend is asked so a screen shows the wait rather than a gap. - open_
media_ source - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Opens
urifor decoding. - open_
writable_ folder - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Reopens a writable folder from a stored handle. Synchronous and callable from
any thread; returns
Noneonly when writable folders are unsupported here. - path_
from_ uri - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The path a media URI addresses, or
Nonewhen it addresses something that is not a local file — a stream, a content provider, a browser blob. - pause_
media - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Stops without giving up the position.
- peek_
focus_ invalidation - Re-export the UI crate so applications can depend on a single crate. Returns true if a focus invalidation is pending without clearing it.
- peek_
layout_ invalidation - Re-export the UI crate so applications can depend on a single crate. Returns true if a layout invalidation is pending without clearing it.
- peek_
pointer_ invalidation - Re-export the UI crate so applications can depend on a single crate. Returns true if a pointer invalidation is pending without clearing it.
- peek_
render_ invalidation - Re-export the UI crate so applications can depend on a single crate. Returns true if a render invalidation is pending without clearing it.
- pending_
layout_ repass_ nodes_ snapshot - Re-export the UI crate so applications can depend on a single crate. Returns a stable snapshot of pending layout repass node IDs without consuming them.
- pending_
measure_ repass_ nodes_ snapshot - Re-export the UI crate so applications can depend on a single crate. Returns a stable snapshot of pending measure repass node IDs without consuming them.
- percent_
decode - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Decodes the percent-escapes in a platform content URI, refusing input it cannot decode exactly.
- percent_
decode_ lossy - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Decodes the percent-escapes in a platform content URI for display.
- platform_
accessibility_ options - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the platform last reported.
- platform_
accessibility_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the platform last reported.
- play_
media - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Starts, or resumes, the open item.
- playback_
progress - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Where the open item is.
- playback_
state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the player is doing.
- power_
capabilities - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the installed backend can answer on this platform.
- power_
monitor - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Returns the platform monitor, or one that answers “unsupported”.
- power_
state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The current power state, read from the installed backend.
- preferences
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The active preferences store: the platform backend if one is installed, otherwise the framework’s own file-backed store under the application’s config directory.
- prepare_
text_ layout - Re-export the UI crate so applications can depend on a single crate.
- prepare_
text_ layout_ for_ node - Re-export the UI crate so applications can depend on a single crate.
- probe_
media_ duration - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Reads how long
itemis without playing it. - process_
focus_ invalidations - Re-export the UI crate so applications can depend on a single crate. Processes all pending focus invalidations.
- process_
pointer_ repasses - Re-export the UI crate so applications can depend on a single crate. Processes all pending pointer repasses.
- process_
semantics_ invalidations - Re-export the UI crate so applications can depend on a single crate. Services every pending semantics invalidation.
- produce
State - Core runtime helpers commonly used by applications.
Runs
producerwhenkeychanges and exposes what it publishes as state. - prune_
draw_ observations_ to_ nodes - Re-export the UI crate so applications can depend on a single crate. Removes draw observations whose owners are absent from the retained scene.
- publish_
audio_ focus - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes what the rest of the device is doing with the output, and applies the policy that goes with it.
- publish_
camera_ frame - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes a frame. Backends call this from whichever thread the platform delivers frames on.
- publish_
camera_ lenses - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes the lens list and the device in use. Backends call this when a session opens and when the device changes.
- publish_
camera_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes what the session is doing.
- publish_
camera_ still - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes the answer to a still request.
- publish_
host_ surface_ size - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes a new host-surface size. Platform backends call this whenever the host resizes the surface.
- publish_
incoming_ content - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes content shared into the application. Callable from any thread; the framework moves each item onto the UI thread before a composition sees it.
- publish_
media_ command - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes a button pressed outside the application’s own UI.
- publish_
media_ samples - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes a block of samples as it is heard.
- publish_
memory_ pressure - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes a pressure report. Callable from any thread; the framework moves each report onto the UI thread before a composition sees it.
- publish_
playback_ progress - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes where the open item is. Backends call this as the position moves, which for a local file is a handful of times a second.
- publish_
playback_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes what the player is doing.
- publish_
power_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes a new power state. Platform backends call this whenever the OS reports a thermal or battery change, from whatever thread delivered it.
- purchases
- Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The active backend: the platform one if installed, else the no-store backend.
- push_
back_ request - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Record a system back request (called by the platform backend’s gesture / button handler).
- push_
notification_ deeplink - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Record the deep-link payload of a notification the user just tapped. Called
by the platform backend’s notification delegate; the app drains it via
take_notification_deeplink. - record_
dropped_ camera_ frame - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Records that the platform produced a frame nobody could take.
- record_
dropped_ media_ samples - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Records that the backend produced a block nobody could take.
- register_
durable_ save - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Registers work that must reach durable storage before the host suspends.
- release_
free_ memory - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Asks the allocator to return free pages to the system.
- remember
- Core runtime helpers commonly used by applications.
- remember
AppUpdate State - Remembers observable application update state for the current composition.
- remember
Audio Focus - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the rest of the device is doing with the output, observed for as long as this call stays in the composition.
- remember
Camera Frames - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The frames the session produces, as a stream this composition collects.
- remember
Camera Lenses - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The lens list and the device in use, observed for as long as this call stays in the composition.
- remember
Camera State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the camera session is doing, observed for as long as this call stays in the composition.
- remember
Camera Stills - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The stills the session produces, as a stream this composition collects.
- remember
Coroutine Scope - Core runtime helpers commonly used by applications.
Remembers a
CoroutineScopebound to this position in the composition. - remember
Draggable State - Re-export the UI crate so applications can depend on a single crate.
Remembers a
DraggableStatefor this composition, keeping its delta handler current across recompositions. - remember
Host Surface Size - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The host surface’s size, observed for as long as this call stays in the composition.
- remember
Incoming Content - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Collects content shared into the application for as long as this call stays in the composition.
- remember
Keyed - Core runtime helpers commonly used by applications.
Like
remember, but recomputes wheneverkeychanges. - remember
Lazy List State - Re-export the UI crate so applications can depend on a single crate.
Creates a remembered
LazyListStatewith default initial position. - remember
Lazy List State With Position - Re-export the UI crate so applications can depend on a single crate.
Creates a remembered
LazyListStatewith the specified initial position. - remember
Lifecycle Events - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Host lifecycle transitions as a composition-scoped stream.
- remember
Lifecycle State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The host’s lifecycle state as observable state.
- remember
Media Commands - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Buttons pressed outside the application’s own UI, as a stream this composition collects.
- remember
Media Samples - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Samples as they are heard, as a stream this composition collects.
- remember
Memory Pressure - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Collects pressure reports for as long as this call stays in the composition.
- remember
Movable Content Of - Core runtime helpers commonly used by applications. Content written once that keeps its identity wherever it is shown.
- remember
Mutable Interaction Source - Re-export the UI crate so applications can depend on a single crate.
- remember
Mutable State Of - Core runtime helpers commonly used by applications.
A composable hook that creates and remembers a
MutableState. - remember
Mutable State OfNever Equal - Core runtime helpers commonly used by applications.
- remember
Open File Launcher - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Remembers a single-file launcher under
request_key. - remember
Open Files Launcher - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Remembers a multi-file launcher under
request_key. - remember
Open Folder Launcher - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Remembers a folder launcher under
request_key. - remember
Playback Progress - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Where the open item is, observed for as long as this call stays in the composition.
- remember
Playback State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What the player is doing, observed for as long as this call stays in the composition.
- remember
Power State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The device’s power state, observed for as long as this call stays in the composition.
- remember
Purchase Events - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. One-shot purchase outcomes as a composition-scoped stream.
- remember
Save Document Launcher - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Remembers a save-document launcher under
request_key. - remember
Saveable - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
State that survives host recreation and process death, stored under
key. - remember
Sound Bank - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Loads a set of cues once and keeps them alive across recompositions.
- remember
Store State - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The store’s current state, observed for as long as this call stays in the composition.
- remember
Svg - Re-export the UI crate so applications can depend on a single crate.
- remember
Swipe Dismiss State - Re-export the UI crate so applications can depend on a single crate. Remembers the swipe state for one row.
- remember
Updated State - Core runtime helpers commonly used by applications.
Returns a
MutableStatethat always holds the latest value. - remember
Window State - Remembers native-window position and size across recompositions.
- remember
Window State At - Remembers native-window position and size across recompositions, with the window first placed at the given screen position.
- remember
Writable Folder Launcher - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Remembers a writable-folder launcher under
request_key. - request_
camera_ still - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Asks for a full-resolution still, which arrives through
rememberCameraStills. - request_
current_ draw_ redraw - Re-export the UI crate so applications can depend on a single crate. The draw-phase animation contract: a draw closure that advances its own spring or clock (a Cell no observation can see) must schedule the next frame’s re-record of ITS OWN node — a bare render invalidation only re-presents the retained scene, which would freeze the animation mid-flight. Callable only from inside a recording draw closure; anywhere else it degrades to a plain frame request.
- request_
exit - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Ask the platform to close the app.
- request_
focus_ from_ platform - Re-export the UI crate so applications can depend on a single crate.
Moves focus onto
node_idwhen it holds a focus target. A platform’s accessibility layer calls this when a screen reader lands on a control, so the app’s focus follows the reader’s. - request_
focus_ invalidation - Re-export the UI crate so applications can depend on a single crate. Requests a focus recomposition without affecting layout/draw dirties.
- request_
host_ surface_ size - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Asks the host for a different surface size.
- request_
layout_ invalidation - Re-export the UI crate so applications can depend on a single crate. Requests a global layout re-run.
- request_
pointer_ invalidation - Re-export the UI crate so applications can depend on a single crate. Requests a new pointer-input pass without touching layout or draw dirties.
- request_
render_ invalidation - Re-export the UI crate so applications can depend on a single crate. Requests that the renderer rebuild the current scene.
- reset_
cursor_ blink - Re-export the UI crate so applications can depend on a single crate. Resets cursor to visible and restarts the blink timer. Call this on any input (key press, paste) so cursor stays visible while typing.
- resolve_
content - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Resolves
urithrough the platform resolver, falling back to the local filesystem forfile://URIs and plain paths. - run_
durable_ saves - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Runs every registered durable save, waiting up to
deadline. - run_
test_ composition - Re-export the UI crate so applications can depend on a single crate. Build a composition with a simple in-memory applier and run the provided closure once.
- scale_
sp - Re-export the UI crate so applications can depend on a single crate. A size in scale-independent pixels, in dp, through the running app’s curve.
- schedule_
draw_ repass - Re-export the UI crate so applications can depend on a single crate. Schedules a draw-only repass for a specific node.
- schedule_
focus_ invalidation - Re-export the UI crate so applications can depend on a single crate. Schedules a focus invalidation for the specified node.
- schedule_
layout_ repass - Re-export the UI crate so applications can depend on a single crate. Schedules a layout repass for a specific node.
- schedule_
measure_ repass - Re-export the UI crate so applications can depend on a single crate.
Schedules a scoped re-measure of
node_idon the next frame. - schedule_
pointer_ repass - Re-export the UI crate so applications can depend on a single crate. Schedules a pointer repass for the specified node.
- schedule_
semantics_ invalidation - Re-export the UI crate so applications can depend on a single crate.
Marks
node_id’s semantics for re-collection on the next frame of the app context that is current. - scroll_
delta_ to_ reveal - Re-export the UI crate so applications can depend on a single crate.
The scroll-offset delta needed to bring
caretfully inside the un-obscured part ofviewport. - seek_
media - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Moves the position within the open item.
- seek_
media_ fraction - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Moves the position to a fraction of the item, which is what a seek bar has.
- selectable_
group_ of - Re-export the UI crate so applications can depend on a single crate.
The nearest node above the given one that declares
selectable_group, when there is one. - set_
active_ focus_ target - Re-export the UI crate so applications can depend on a single crate. Sets the currently active focus target.
- set_
app_ update_ status - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Publishes state from a platform updater.
- set_
application_ id - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Registers the id every framework-owned storage path is scoped by.
- set_
back_ interception - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Declare whether the app currently wants the platform’s back control routed
to
push_back_requestinstead of the platform default. Set ittruewhile there is in-app navigation to pop andfalsewhen leaving the app is the right response (mirrors Compose’sBackHandler(enabled)). - set_
density - Re-export the UI crate so applications can depend on a single crate. Updates the current density scale factor.
- set_
focus_ order - Re-export the UI crate so applications can depend on a single crate.
Replaces the focus order a later
crate::FocusManagermove reads. The order belongs to the current [crate::AppContext]. Keyboard navigation publishes the order from the latest layout before choosing a target. - set_
font_ scale - Re-export the UI crate so applications can depend on a single crate. Updates the system font scale, taking it as a plain multiplier.
- set_
font_ scale_ curve - Re-export the UI crate so applications can depend on a single crate. Updates the system font scale and the conversion behind it.
- set_
host_ controller - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the framework host controller.
- set_
keep_ screen_ on - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Enables or disables the host’s keep-screen-on flag.
- set_
keyboard_ focus_ visible - Re-export the UI crate so applications can depend on a single crate.
Records how focus last moved: true after Tab or an arrow key, false after
a pointer press. A
Modifier::focusabledraws its ring only while this is true. Returns whether the value changed, so the caller can ask for a redraw. - set_
media_ analysis_ enabled - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Starts or stops publishing
MediaSamples. Returnsfalsewhere the backend cannot produce them — seeMediaCapabilities::analysis. - set_
media_ equalizer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Applies an equalizer setting, clamped to what the platform’s bands can do.
- set_
media_ looping - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Repeats the open item when it reaches its end.
- set_
media_ metadata - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Updates the metadata shown by the platform media session for the open item.
- set_
media_ speed - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Sets the playback rate,
1.0being as recorded. Returnsfalsewhere the backend has none — seeMediaCapabilities::speed. - set_
media_ volume - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Sets the volume the application asks for,
1.0being the item as recorded. - set_
platform_ accessibility_ options - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs what the platform reports. A backend calls this at start and on every change, and forces a root render when the answer is true, so the theme, the glass and the animations read the new options.
- set_
platform_ accessibility_ state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs what the platform reports. A backend calls this on every check and forces a root render when the answer is true, so composition reads the new state.
- set_
platform_ app_ info - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs a platform app-info implementation, replacing any previous one.
- set_
platform_ app_ updater - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the platform updater.
- set_
platform_ audio - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs a platform audio player, replacing any previous one.
- set_
platform_ background_ activity - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the platform background-activity handler, replacing any previous one.
- set_
platform_ bundled_ assets - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs a platform bundled-assets reader.
- set_
platform_ camera - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the platform camera, replacing any previous one.
- set_
platform_ content_ resolver - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Installs the platform content resolver (Android’s
ContentResolver, the iOS document store, the browser’s blob registry). - set_
platform_ device_ info - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs a platform device-info implementation, replacing any previous one.
- set_
platform_ file_ picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Registers the platform-provided chooser (Android SAF / iOS UIDocumentPicker).
- set_
platform_ haptics - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs a platform haptics implementation, replacing any previous one.
- set_
platform_ host_ surface - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the platform host surface.
- set_
platform_ image_ picker - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs a platform image picker, replacing any previously installed one. The iOS backend registers a photo-library picker here.
- set_
platform_ launch_ args - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the launch arguments reported by the platform, replacing any previous snapshot.
- set_
platform_ media_ player - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the platform media player, replacing any previous one.
- set_
platform_ media_ source_ opener - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the platform media source opener, replacing any previous one.
- set_
platform_ network_ monitor - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs a platform network monitor, replacing any previous one.
- set_
platform_ notifier - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- set_
platform_ power_ monitor - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the platform power monitor.
- set_
platform_ preferences - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the platform preferences backend, replacing any previous one.
- set_
platform_ purchases - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- set_
platform_ share_ sheet - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs a platform share sheet, replacing any previously installed one. Backends with main-thread UIKit / Activity access register here.
- set_
platform_ system_ theme - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs the platform-reported system theme. Platform backends call this at startup and whenever the OS reports a change (then force a root render so composition observes it).
- set_
platform_ uri_ handler - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Installs a platform URI handler, replacing any previously installed one.
- set_
text_ measurer - Re-export the UI crate so applications can depend on a single crate.
- set_
writable_ folder_ store_ factory - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Registers the platform store factory (Android, iOS). Called once at startup. No-op if already set.
- sha256_
hex - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The SHA-256 of
bytes, as lower-case hexadecimal. - slide_
in_ vertically - Re-export the UI crate so applications can depend on a single crate.
Slides in the content vertically from
initial_offset_fractionof its own height (negative values start above the resting position, mirroring Compose’s default of-fullHeight / 2). - slide_
out_ vertically - Re-export the UI crate so applications can depend on a single crate.
Slides out the content vertically towards
target_offset_fractionof its own height. - start_
camera - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Starts the camera, publishing
CameraState::Startingbefore the backend is asked so a screen shows the wait rather than a gap. - start_
cursor_ blink - Re-export the UI crate so applications can depend on a single crate. Starts the active context’s cursor blink animation. Called when a text field gains focus.
- stop_
camera - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Stops the camera and releases the device.
- stop_
cursor_ blink - Re-export the UI crate so applications can depend on a single crate. Stops the active context’s cursor blink animation. Called when no text field is focused.
- stop_
media - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Stops, closes the item and releases the output device.
- store_
available - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Whether a real store backend is installed on this platform.
- store_
state - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Convenience: the current store snapshot.
- system_
font_ directory - Where this platform keeps the font files a system family is drawn from, or
Nonewhen there is no such directory to read. - take_
back_ requests - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Take (and clear) the number of pending back requests. Polled by the app; a burst collapses into a count the app can coalesce.
- take_
draw_ repass_ nodes - Re-export the UI crate so applications can depend on a single crate. Takes all pending draw repass node IDs.
- take_
exit_ request - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Take (and clear) a pending exit request. Drained by the platform backend.
- take_
focus_ invalidation - Re-export the UI crate so applications can depend on a single crate. Returns true if a focus invalidation was pending and clears the flag.
- take_
geometry_ scene_ nodes - Re-export the UI crate so applications can depend on a single crate. Takes the nodes whose geometry the last layout pass actually changed.
- take_
layout_ invalidation - Re-export the UI crate so applications can depend on a single crate. Returns true if a layout invalidation was pending and clears the flag.
- take_
layout_ repass_ nodes - Re-export the UI crate so applications can depend on a single crate. Takes all pending layout repass node IDs.
- take_
measure_ repass_ nodes - Re-export the UI crate so applications can depend on a single crate. Takes all pending measure repass node IDs.
- take_
notification_ deeplink - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Take (and clear) the deep-link payload of the most recently tapped notification, if any. Polled by the app’s deep-link handling.
- take_
pointer_ invalidation - Re-export the UI crate so applications can depend on a single crate. Returns true if a pointer invalidation was pending and clears the flag.
- take_
render_ invalidation - Re-export the UI crate so applications can depend on a single crate. Returns true if a render invalidation was pending and clears the flag.
- thumb_
geometry - Re-export the UI crate so applications can depend on a single crate.
The thumb for a scroll position, or
Nonewhen the content fits and there is nothing to indicate. - tick_
cursor_ blink - Re-export the UI crate so applications can depend on a single crate.
Advances the cursor blink state if needed.
Returns
trueif a redraw is needed. A transition schedules a scoped draw repass on the focused field, so the caller only has to run the ordinary dirty-node paths — no whole-scene work. - tile_
count - Re-export the UI crate so applications can depend on a single crate.
How many tiles
tile_quadswould produce, without building them. - tile_
quads - Re-export the UI crate so applications can depend on a single crate.
The draws that tile
sourceacrossdestinationat the source’s own size. - toggle_
media - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Pauses what is playing and plays what is paused — the one button a headset has, and the space bar.
- tree_
needs_ layout - Re-export the UI crate so applications can depend on a single crate. Check if a node or any of its descendants needs measure (selective measure optimization). This can be used by the app shell to skip layout when the tree is clean.
- tree_
needs_ semantics - Re-export the UI crate so applications can depend on a single crate. Check if the root semantics snapshot is dirty.
- uri_
for_ path - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
The
file:URI for a path, which is whatMediaItemtakes. - verify_
package - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Checks a package held in memory against
digest. - version_
name - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. The version a user is shown, if the platform knows one.
- window_
insets - Re-export the UI crate so applications can depend on a single crate. Returns the framework-owned insets currently visible to the composition.
- window_
roots - Re-export the UI crate so applications can depend on a single crate. The window roots attached in the current app context.
- window_
roots_ revision - Re-export the UI crate so applications can depend on a single crate.
The current app context’s window root revision; see
WindowRootRegistry::revision. - windowless_
command - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A
Commandfor a helper program an application runs behind its window, such asreg,powershellornotify-send. - write_
all - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Writes every byte of
bytesintosinkand commits it.
Type Aliases§
- AppInfo
Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- AppUpdater
Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Shared updater service.
- Audio
Player Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to the installed
AudioPlayer. - Background
Activity Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Bundled
Assets Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Shared bundled-assets service.
- Camera
Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Shared handle to the platform camera.
- Content
Folder Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
ContentFolder. - Content
Future - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. A future produced by a content operation. It borrows the content it reads from, so no implementation has to clone a handle into every call.
- Content
Handle - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
Content. - Content
Reader Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
ContentReader. - Content
Resolver Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
ContentResolver. - Content
Sink Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
ContentSink. - Content
Stream Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
ContentStream. - Device
Info Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Drag
AndDrop Payload - Re-export the UI crate so applications can depend on a single crate. What a transfer carries: any value the source chose, which a target downcasts to the type it expects.
- Drag
Delta Handler - Re-export the UI crate so applications can depend on a single crate.
What a
DraggableStatehands each drag delta to. - Draw
Command Fn - Re-export the UI crate so applications can depend on a single crate. A draw command records into a scope the CONSUMER provides, instead of returning a freshly allocated primitive vector. This is the boundary that lets recording storage live with the command’s stable identity and be reused frame over frame (the retained draw-command recorder), rather than being reallocated, moved, and dropped on every execution.
- File
Picker Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
FilePicker. - Haptics
Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Host
Controller Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Host
Surface Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
HostSurface. - Http
Body Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Shared handle to a response body.
- Http
Client Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Http
Future - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Image
Picker Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Key
- Launch
Args Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
LaunchArgssnapshot. - Launcher
Result - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What a launcher hands back once the chooser resolves.
- Media
Player Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Shared handle to the platform media player.
- Media
Source Opener Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Shared handle to the platform media source opener.
- Network
Monitor Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Notifier
Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Picker
Future - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
A
'staticfuture returned by chooser operations, polled on the UI thread. - Power
Monitor Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. Shared power-monitor service.
- Preferences
Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
PreferencesStore. - Progress
Handler - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate. What a progress report is handed to.
- Purchases
Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to the active
Purchasesbackend. - Scroll
Settle Policy - Re-export the UI crate so applications can depend on a single crate.
Remaps where a scroll comes to rest once the user’s interaction ends — the
UIScrollView targetContentOffsetanalog. Receives the naturally proposed rest offset (the fling’s predicted end, or the current offset for a plain release/wheel idle) and the release velocity in offset units/sec; returns the offset the scroll should settle at. Used e.g. by the liquid nav bar to snap out of the large-title collapse band so the title never rests half-faded. - Semantics
Spec - Re-export the UI crate so applications can depend on a single crate.
One value that says what a screen reader reads for a node, built up with
the methods below and handed to
Modifier::semantics_spec. - Share
Sheet Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Source
Resolver - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Resolves a shared handle to its
ByteSource, orNoneif not shared. - Stub
Answer - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
What a
StubHttpClientanswers a request with. - Text
PanResolver - Re-export the UI crate so applications can depend on a single crate. Resolver that recomputes (and stores) the horizontal pan offset for a text field given the current content viewport width in px.
- UriHandler
Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
- Writable
Folder Store Ref - Re-export framework services (HTTP, URI, etc.) from the dedicated services crate.
Shared handle to a
WritableFolderStore.
Attribute Macros§
- composable
- Re-export the UI crate so applications can depend on a single crate.