Crate kael

Expand description

§kael

The GPU-accelerated application framework at the center of Kael. It is designed for substantial desktop and browser products that need to stay responsive while their data, surfaces, background work, and platform integrations grow.

kael provides the application runtime and low-level UI primitives: retained rendering, layout, text, elements, state, windows, input, accessibility, animation, async work, and native platform services. It does not depend on the optional kael_ui component library, so applications can build and brand their own component system directly on these primitives.

[dependencies]
kael = "0.4"

WebView support is opt-in, so ordinary native applications do not pull Wry, GTK, or WebKit. Enable it only when the application embeds web content:

[dependencies]
kael = { version = "0.4", features = ["webview"] }

use kael::prelude::*;
use kael::{Application, Window, WindowOptions, div};

struct Hello;

impl Render for Hello {
    fn render(&mut self, _: &mut Window, _: &mut Context<Self>) -> impl IntoElement {
        div().size_full().flex().items_center().justify_center().child("Hello, Kael!")
    }
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    Application::try_new()?.run(|cx| {
        if let Err(error) = cx.open_window(WindowOptions::default(), |_, cx| {
            cx.new(|_| Hello)
        }) {
            eprintln!("failed to open the application window: {error}");
            cx.quit();
        }
    });
    Ok(())
}

Kael targets macOS (Metal), Windows (DirectX 11), Linux X11/Wayland (Vulkan through Blade), and browsers (WebAssembly/WebGL2). OS and browser integrations differ by host; use CapabilityReport::current() when a product requires a specific service.

§Start here

§Optional features

Feature	Purpose
`browser`	WebAssembly runtime, WebGL2 Scene renderer, and sandboxed iframe WebView islands
`portable-services`	Build-portable product batteries for one-source native/browser applications; consult capability reports for sandboxed runtime operations
`browser-full`	`browser` plus the complete `portable-services` consumer graph used by release CI
`game-input`	Frame-synchronized native/browser controllers plus portable browser/native pointer lock and relative motion
`http-client`	Bundled Reqwest transport; the transport trait remains available without it
`auto-update`	Signed feeds, verified downloads, and platform installers
`lottie`	Native Lottie and dotLottie playback
`webview`	Explicit hosted web surfaces
`media`	Native media playback integration
`storage`, `document`, `audio`, `pdf`	Product data and content services
`icons`	Compact embedded SVG catalog with application-asset overrides
`diagnostics`, `notifications-full`, `share`	Optional diagnostics plus portable native/browser notification and sharing batteries
`screen-capture`	Screen-capture backend support
`image-avif`, `image-exr`	Opt-in AVIF (libdav1d) and OpenEXR decoding
`agent-tools`	Structured capability-planning metadata
`runtime_shaders`	Runtime shader compilation for development

The minimum supported Rust version is 1.97.1. The crate uses Rust 2024.

The optional agent-tools feature is disabled by default and is not required to build applications.

For a suite-class application, keep the Rust source identical and select the backend in the manifest:

[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
kael = { version = "0.4", features = ["portable-services"] }

[target.'cfg(target_arch = "wasm32")'.dependencies]
kael = { version = "0.4", default-features = false, features = ["browser-full"] }

This guarantees that the same optional API graph compiles on both targets. It does not weaken browser security boundaries: use CapabilityReport and the operation-level WebView, notification, sharing, capture, and update reports to select the appropriate hosted fallback.

Kael began as a fork of GPUI, created by Zed Industries. It is an independent project and is not affiliated with or endorsed by Zed Industries.

Licensed under Apache-2.0. See LICENSE-APACHE in this package.

Re-exports§

pub use command_registry::CommandDescriptor;
pub use command_registry::CommandIpcHandoff;
pub use command_registry::CommandIpcHandoffBuilder;
pub use command_registry::CommandIpcNextAction;
pub use command_registry::CommandIpcRequest;
pub use command_registry::CommandPalette;
pub use command_registry::PaletteCommandId;
pub use crate::animation::Animation;
pub use crate::animation::AnimationSequence;
pub use crate::animation::Easing;
pub use crate::animation::Keyframes;
pub use crate::animation::Repeat;
pub use crate::animation::StyledKeyframe;
pub use crate::animation::keyframes;
pub use http_client;
pub use kael_net as net;
pub use accessibility::*;
pub use app_runtime::*;
pub use background_jobs::*;
pub use benchmark::*;
pub use computed::*;
pub use dev_tools::*;
pub use crate::animation::easing::*;
pub use extension_host::*;
pub use extension_rpc::*;
pub use game_input::*;
pub use gesture::*;
pub use gpu::*;
pub use graphics_capabilities::*;
pub use headless_render::*;
pub use ipc_transport::*;
pub use media_capture::*;
pub use panels::*;
pub use platform_caps::*;
pub use plugin::*;
pub use portable_scene::*;
pub use process_model::*;
pub use runtime::*;
pub use scene_graph::*;
pub use security::*;
pub use split_pane::*;
pub use status_bar::*;
pub use supervisor::*;
pub use text_engine::*;
pub use theme::*;
pub use video_color::*;
pub use virtual_data::*;
pub use worker_api::*;
pub use workspace::*;

Modules§

_ownership_and_data_flow: In GPUI, every model or view in the application is actually owned by a single top-level object called the App. When a new entity or view is created (referred to collectively as entities), the application is given ownership of their state to enable their participation in a variety of app services and interaction with other entities.
accessibility: Shared accessibility model and semantic role system for GPUI.
animation: Explicit animation primitives and keyframe builders.
app_runtime: Higher-level app-runtime primitives for common desktop product patterns.
background_jobs: Background job orchestration with worker-pool integration.
benchmark: Product-level benchmark workloads and harness for GPUI.
colors: The default colors used by GPUI.
command_registry: Command registry for registering named commands invokable from menus, keybindings, and a command palette.
computed: Memoized values with automatic entity-dependency tracking.
dev_tools: Developer tools for observability, diagnostics, and runtime inspection.
extension_host: Extension host runtime managing the full lifecycle of extensions.
extension_rpc: Extension RPC contract and typed transport wrappers.
game_input: Portable pointer-lock and game-controller input. Portable, frame-synchronized input for games and other interactive canvases.
gesture: Gesture recognizers and higher-level pointer interaction types.
golden: GPU memory budgeting and eviction. Golden-image pixel-diff comparison for the headless render pipeline. Golden-image pixel-diff comparison for the headless render pipeline (P0-J).
gpu: GPU memory budgeting and eviction.
graphics_capabilities: Capability reporting for native graphics and visual escape hatches. Capability reporting for Kael’s graphics escape hatches.
headless_render: Headless off-screen rendering for benchmarks and golden-image tests. Headless off-screen rendering for benchmarks and golden-image tests.
inspector_reflection: Provides definitions used by #[derive_inspector_reflection].
interpolate: The canonical interpolation vocabulary shared across the framework. The canonical interpolation vocabulary shared across the framework.
ipc_transport: Cross-platform IPC transport for the GPUI process-isolation model.
media_capture: Cross-platform media and capture infrastructure for GPUI.
panels: Pre-built panel implementations for common dock areas.
platform_caps: Platform capability detection and feature-level support reporting.
plugin: Plugin and extension architecture for GPUI.
portable_scene: Bounded retained 2D commands shared by native and browser renderers. Bounded retained 2D drawing commands shared by native and browser renderers.
prelude: The GPUI prelude is a collection of traits and types that are widely used throughout the library. It is recommended to import this prelude into your application to avoid having to import each trait individually.
process_model: Process-isolation model and typed IPC for GPUI.
runtime: Runtime worker support. Runtime worker support for background task execution.
scene_graph: Scene graph primitives for canvas and creative applications. Scene graph primitives for canvas and creative applications.
scroll_bar: Scroll bar primitives bound to scroll handles.
scroll_elasticity: Rubber-band scroll elasticity: the canonical overscroll feel shared across the framework.
security: Security boundary: capability model and permission broker for GPUI.
single_instance: Cross-platform single instance enforcement using Unix domain sockets and Windows named mutexes.
split_pane: Split-pane and tab model for IDE-style workspace layouts.
status_bar: Status bar for displaying contextual information in large applications.
styled_reflection: Implements function reflection
supervisor: Process supervisor for the GPUI process-isolation model.
tab_manager: Cross-platform window tab manager for Windows and Linux backends.
text_engine: Text and document editing engine for IDEs, notes apps, and chat composers.
theme: Application themes with JSON or TOML loading and file hot-reload support.
video_color: Video color: YCbCr→RGB matrices and transfer functions. Video color: YCbCr→RGB matrices and transfer functions.
virtual_data: Virtualized data models for lists, tables, and trees.
window_positioner: Pure Rust utility for computing window bounds from a semantic WindowPosition.
worker_api: Worker API for runtime tasks.
workspace: Workspace and panel layout management with JSON persistence.

Macros§

actions: Defines and registers unit structs that can be used as actions. For more complex data types, derive Action.
border_style_methods: Generates methods for border styles.
box_shadow_style_methods: Generates methods for box shadow styles.
cursor_style_methods: Generates methods for cursor styles.
include_lottie: Embed a Lottie asset directly into the binary at compile time.
margin_style_methods: Generates methods for margin styles.
overflow_style_methods: Generates methods for overflow styles.
padding_style_methods: Generates methods for padding styles.
position_style_methods: Generates methods for position styles.
register_action: Registers an action with the Kael runtime when you manually implement the Action trait. Typically you should use the Action derive macro or actions! macro instead.
visibility_style_methods: Generates methods for visibility styles.

Structs§

AccessibilityAnnouncementBuilder: Builder for checked assistive-technology announcements.
AccessibilityFocusBuilder: Builder for checked accessibility focus changes.
AdvancedInputHandoff: Checked native-first handoff for advanced input surfaces.
AdvancedInputHandoffBuilder: Builder for checked native-first advanced input handoffs.
AlreadyRunning: Error returned when another instance of the application is already running.
AltEnter: Apply the Alt+Enter behavior for the configured key policy.
Anchored: An anchored element that can be used to display UI that will avoid overflowing the window bounds.
AnchoredState: The state that the anchored element element uses to track its children.
AnimationElement: A GPUI element that applies an animation to another element
AnimationHandle: A handle that can be used to cancel an in-flight animation.
AnimationTimelineBuilder: Builder for checked native animation timelines and keyframe authoring.
AnimationTimelinePlan: Checked authoring plan for native animation timelines and keyframe intent.
AnimationTimelineStep: One checked animation step in a native animation timeline.
AnyDrag: Contains state associated with an active drag operation, started by dragging an element within the window or by dragging into the app from the underlying platform.
AnyElement: A dynamically typed element that can be used to store any element type.
AnyEntity: A dynamically typed reference to a entity, which can be downcast into a Entity<T>.
AnyImageCache: A dynamically typed image cache, which can be used to store any image cache
AnyTooltip: Contains state associated with a tooltip. You’ll only need this struct if you’re implementing tooltip behavior on a custom element. Otherwise, use Div::tooltip.
AnyView: A dynamically-typed handle to a view, which can be downcast to a Entity for a specific type.
AnyWeakEntity: A type erased, weak reference to a entity.
AnyWeakView: A weak, dynamically-typed view handle that does not prevent the view from being released.
AnyWindowHandle: A handle to a window with any root view type, which can be downcast to a window with a specific root view type.
App: Contains the state of the full application, and passed as a reference to a variety of callbacks. Other Context derefs to this type. You need a reference to an App to access the state of a Entity.
AppChromeSurfaceHandoff: Checked descriptor for native app chrome, component surfaces, and hosted UI fallback.
AppChromeSurfaceHandoffBuilder: Builder for checked native app-chrome workflow handoffs.
AppDistributionPlan: Checked distribution target plan for release scripts and agents.
AppDistributionPlanBuilder: Builder for distribution target plans.
AppDistributionTarget: One checked distribution artifact target.
AppDistributionTargetBuilder: Builder for one distribution target.
AppHttpClientDescriptor: Descriptor returned after validating an app-wide HTTP client.
AppHttpClientInstallBuilder: Builder for installing an app-wide HTTP client with checked metadata.
AppIconAsset: One checked icon asset declaration.
AppIconAssetBuilder: Builder for one checked icon asset declaration.
AppIconCoverageSummary: Purpose-level coverage for a checked app icon set.
AppIconSet: Checked app icon asset set.
AppIconSetBuilder: Builder for grouped app icon assets.
AppIdentityMetadataHandoff: Checked native-first app identity handoff for metadata, packaging, handlers, windows, and badges.
AppIdentityMetadataHandoffBuilder: Builder for checked app identity metadata handoffs.
AppLifecycleCommand: Checked app-level lifecycle command for native desktop app control.
AppLifecycleCommandPlan: Checked lifecycle-command readiness plan for native desktop app control.
AppLifecyclePolicy: Validated app lifecycle configuration.
AppLifecyclePolicyBuilder: Builder for configuring app lifetime and bounded quit cleanup.
AppLifecycleStartupHandoff: Checked lifecycle/startup handoff for generated desktop app flows.
AppLifecycleStartupHandoffBuilder: Builder for a checked lifecycle/startup handoff.
AppMetadata: Validated application identity metadata for About, diagnostics, and support UI.
AppMetadataBuilder: Builder for app identity metadata used by About panels and diagnostics.
AppMetadataSummary: Compact coverage summary for app identity metadata.
AppPackageManifest: Checked packaging metadata for bundlers, installers, and generated docs.
AppPackageManifestBuilder: Builder for checked package metadata that composes identity, URL schemes, and file associations.
AppPackageReadinessBuilder: Builder for package readiness checks.
AppPackageReadinessIssue: One package readiness finding.
AppPackageReadinessReport: Package readiness report for generated apps, release scripts, and agents.
AppPathBuilder: Builder for resolving common app-owned filesystem locations.
AppPathSet: Resolved application paths for a validated app identifier.
AppPrivacyManifest: Checked privacy permission manifest.
AppPrivacyManifestBuilder: Builder for grouped privacy permission declarations.
AppPrivacyPermission: One checked privacy permission declaration.
AppPrivacyPermissionBuilder: Builder for one privacy permission declaration.
AppResourceBudget: Validated resource budget for a lightweight Kael app runtime.
AppResourceBudgetBuilder: Builder for checked resource budgets over current app process state.
AppResourceBudgetEvaluation: Result of evaluating a resource budget against current app state.
AppResourceBudgetIssue: A single resource budget issue.
AppRuntimeSnapshot: Read-only snapshot of app runtime state for startup gates and agent audits.
AppRuntimeSnapshotQueryBuilder: Builder for checked app runtime snapshot queries.
AppSigningPlan: Checked signing plan for release scripts and platform bundlers.
AppSigningPlanBuilder: Builder for grouped signing declarations.
AppSigningTarget: Signing/notarization declaration for one distribution platform.
AppSigningTargetBuilder: Builder for one signing/notarization declaration.
AppStorageEntry: One checked app-owned storage location.
AppStorageEntryBuilder: Builder for one app storage entry.
AppStoragePlan: Checked plan for app-owned settings, databases, caches, logs, and temp data.
AppStoragePlanBuilder: Builder for checked app-owned storage plans.
AppStorageSessionHandoff: A checked app storage/session handoff.
AppStorageSessionHandoffBuilder: Builder-facing handoff for app storage, migrations, cleanup, and hosted browser profile storage.
AppUpdateOfferDecision: Checked decision for one update release under app policy.
AppUpdateOfferPolicy: Checked app-facing update policy for channel, signing, download, and rollout.
AppUpdateOfferPolicyBuilder: Builder for checked app update offer policy.
AppUpdateRelease: Metadata for an app update discovered by a feed, service, or custom backend.
AppUpdateReleaseBuilder: Builder for checked update release metadata.
AppUpdateState: Checked update state for menus, settings pages, notifications, and agents.
AppUpdateStateBuilder: Builder for checked app update state.
AppUpdateStateSummary: Compact summary of update UI state for menus, settings, notifications, and agents.
AppWindowCaptureRequest: Checked app-window visual capture request for tests, diagnostics, and agents.
AppWindowCaptureRequestBuilder: Builder for checked app-window visual capture requests.
Application: A reference to a GPUI application, typically constructed in the main function of your app. You won’t interact with this type much outside of initial configuration and startup.
ArenaClearNeeded: Returned when the element arena has been used and so must be cleared before the next draw.
AsyncApp: An async-friendly version of App with a static lifetime so it can be held across await points in async code. You’re provided with an instance when calling App::spawn, and you can also create one with App::to_async. Internally, this holds a weak reference to an App, so its methods are fallible to protect against cases where the App is dropped.
AsyncWindowContext: A cloneable, owned handle to the application context, composed with the window associated with the current task.
AudioPermissionPreflightBuilder: Permission preflight descriptor for native audio recording workflows.
AudioPlaybackSourceBuilder: Builder for checked audio playback source descriptors.
AudioWorkflowHandoff: Checked native-first audio workflow handoff.
AudioWorkflowHandoffBuilder: Builder for checked native-first audio workflow handoffs.
AutoLaunchBuilder: Builder for launch-at-login settings.
AutoLaunchPlan: Checked launch-at-login configuration before platform mutation.
AutoLaunchStatus: Result returned after configuring launch-at-login.
AutoUpdater: The auto-updater.
AutoUpdaterConfig: Configuration for the auto-updater.
AutoUpdaterConfigBuilder: Builder for auto-updater configuration.
AuxiliaryExecutable: Resolved app-owned helper executable path.
AuxiliaryExecutableBuilder: Builder for checked app-owned helper executable lookup.
Background: A background color, which can be a solid color, linear gradient, radial gradient, or conic gradient.
BackgroundExecutor: A pointer to the executor that is currently running, for spawning background tasks.
Backspace: Delete the current selection or the grapheme before the caret.
BindingIndex: Index of a binding within a keymap.
BiometricAuthBuilder: Builder for a biometric authentication prompt.
BiometricAuthRequest: Snapshot returned when requesting a biometric prompt.
Boundary: A boundary between two lines of text.
Bounds: Represents a rectangular area in a 2D space with an origin point and a size.
BoundsRefinement: A partial-update type for [#ident].
BoxShadow: The possible values of the box-shadow property
BrowserProfileStorageBridgeItem: One browser-profile storage item and its replacement route.
BrowserProfileStorageBridgeItemBuilder: Builder for one browser-profile storage bridge item.
BrowserProfileStorageBridgePlan: Checked browser-profile storage replacement plan.
BrowserProfileStorageBridgePlanBuilder: Builder for browser-profile storage replacement plans.
BrowserWebViewPolicy: Security and capability policy for iframe-backed WebViews in browser builds.
Button: A focusable button primitive backed by div click semantics.
ButtonRenderState: Snapshot of button state passed to a custom renderer.
Cached: A cache wrapper that replays a previously rendered child subtree when its dependencies are unchanged.
Cancel: Cancel the current field interaction.
Canvas: A canvas element, meant for accessing the low level paint API without defining a whole custom element
CanvasDraw: A canvas element backed by an immediate-mode DrawContext.
Capslock: The state of the capslock key at some point in time
Cascade: A cascade of refinements that can be merged in priority order.
CascadeSlot: A handle to a specific slot in a cascade.
Checkbox: A controlled checkbox form control.
CheckboxRenderState: Snapshot of checkbox state passed to a custom renderer.
ClipPathElement: A wrapper element that clips its child to a ClipShape. Created by clip_path.
ClipboardClearBuilder: Checked request for clearing the platform clipboard.
ClipboardEditingHandoff: A checked clipboard or edit-command handoff.
ClipboardEditingHandoffBuilder: Builder-facing handoff for clipboard and edit-command flows.
ClipboardHtmlMetadata: Metadata attached to an HTML clipboard string.
ClipboardItem: A clipboard item that should be copied to the clipboard
ClipboardItemBuilder: Builder for rich clipboard payloads containing text, metadata, and images.
ClipboardReadRequest: Checked request for reading user-visible clipboard contents.
ClipboardReadRequestBuilder: Builder for checked clipboard reads.
ClipboardString: A clipboard item that should be copied to the clipboard
ColorFilter: A color filter applied to an element’s painted output, composing across a subtree.
ContentMask: Indicates which region of the window is visible. Content falling outside of this mask will not be rendered. Currently, only rectangular content masks are supported, but we give the mask its own type to leave room to support more complex shapes in the future.
Context: The app context, with specialized behavior for the given entity.
ContextEntry: An entry in a KeyContext
ContextMenu: A builder for structured in-window context menus.
Copy: Copy the selected text to the clipboard.
Corners: Represents the corners of a box in a 2D space, such as border radius.
CornersRefinement: A partial-update type for [#ident].
CrashReport: Information collected for a crash report.
CrashReporter: A crash reporter that captures Rust panics, persists them to disk, and attempts to submit them on the next launch.
CrashReporterBuilder: Builder for CrashReporter.
CrashReportingHandoff: Checked crash-reporting handoff for hooks, uploads, diagnostics, and gaps.
CrashReportingHandoffBuilder: Builder for checked crash-reporting workflow handoffs.
CredentialBuilder: Builder for writing one credential entry to the platform keychain.
CredentialServiceBuilder: Builder for a validated credential service key.
CredentialWriteRequest: A validated credential entry stored in the platform keychain.
CssTokenMigrationBuilder: Builder for checked CSS-custom-property to native-theme-token migrations.
CssTokenMigrationEntry: A CSS custom property mapped into Kael’s native theme-token vocabulary.
CssTokenMigrationPlan: Checked plan for migrating CSS custom properties into native theme tokens.
CustomProtocolFileResolver: A checked resolver that maps app-owned custom protocol URLs to files under a root directory.
CustomProtocolFileResolverBuilder: Builder for safe custom-protocol file serving.
CustomProtocolRequest: A typed request for an app-owned custom protocol URL such as app://assets/logo.svg.
CustomProtocolResponse: A validated response returned by a custom protocol handler.
CustomProtocolResponseBuilder: Builder for custom protocol responses.
CustomProtocolRoute: A registered app-owned custom protocol route.
CustomProtocolRouterBuilder: Builder for grouped custom protocol routes.
Cut: Cut the selected text to the clipboard.
DataTransferDropIntakePlan: Checked intake decision for browser-style DataTransfer drops.
DataTransferDropIntakePlanBuilder: Builder for checked DataTransfer-style incoming drop intake.
DatePicker: A controlled date picker with a popup month grid.
DatePickerDayRenderState: Snapshot of a calendar day cell passed to a custom renderer.
DatePickerHeaderRenderState: Snapshot of the calendar header passed to a custom renderer.
DatePickerNavButtonRenderState: Snapshot of a month navigation button passed to a custom renderer.
DatePickerPopupRenderState: Snapshot of date picker popup state passed to a custom renderer.
DatePickerRenderState: Snapshot of date picker trigger state passed to a custom renderer.
DatePickerWeekdayRenderState: Snapshot of a weekday label passed to a custom renderer.
DebugBelow: Use this struct for interfacing with the ‘debug_below’ styling from your own elements. If a parent element has this style set on it, then this struct will be set as a global in GPUI.
DecorationRun: Set the text decoration for a run of text.
DeepLinkRoute: A callback for URLs matching one deep-link scheme.
DeepLinkRouterBuilder: Builder for grouped deep-link routes.
DeepLinkSetupPlan: Checked relationship between runtime deep-link routes and OS setup declarations.
DefaultHandlerPlan: Checked intent for making this app a default handler for schemes or documents.
DefaultHandlerPlanBuilder: Builder for checked default-handler registration intent.
Deferred: An element which delays the painting of its child until after all of its ancestors, while keeping its layout as part of the current element tree.
DeferredScrollToItem
Delete: Delete the current selection or the grapheme after the caret.
DeleteWordBackward: Delete from the caret to the previous word boundary.
DeleteWordForward: Delete from the caret to the next word boundary.
DesktopShellChromeHandoff: Checked native desktop shell/chrome handoff for tray, badge, progress, attention, and placement.
DesktopShellChromeHandoffBuilder: Builder for checked native shell/chrome handoffs.
DeveloperObservabilityHandoff: Checked handoff for native developer diagnostics and hosted debug bridges.
DeveloperObservabilityHandoffBuilder: Builder for checked developer tools and observability handoffs.
DeviceAccessRequest: A checked native device access request descriptor.
DeviceAccessRequestBuilder: Builder for checked native device access requests.
DevicePixels: Represents physical pixels on the display.
DialogOptions: Options for displaying a native dialog.
Disclosure: A controlled disclosure primitive with caller-owned trigger visuals and panel content.
DisclosureRenderState: Snapshot of disclosure trigger state passed to a custom renderer.
DismissEvent: Emitted by implementers of ManagedView to indicate the view should be dismissed, such as when a view is presented as a modal.
DispatchEventResult: Outcome of dispatching a PlatformInput through Window::dispatch_event.
DisplayId: An opaque identifier for a hardware display
DisplayQueryBuilder: Builder for browser-runtime screen-style display queries.
DisplayQueryResult: Resolved display query result.
DisplaySnapshot: Immutable display information for screen-aware app logic.
DisplayTopologyHandoff: Checked native-first screen/display topology handoff for Electron screen parity.
DisplayTopologyHandoffBuilder: Builder for checked native-first screen/display topology handoffs.
DisplayTopologySummary: Compact display topology for browser-runtime screen-style setup decisions.
Div: A Div element, the all-in-one element for building complex UIs in GPUI
DivFrameState: A frame state for a Div element, which contains layout IDs for its children.
DivInspectorState: Interactivity state displayed an manipulated in the inspector.
DivPrepaintState: Prepaint state for a div.
DockBadgeBuilder: Builder for a dock/taskbar badge label.
DockMenuActionBuilder: Builder for dispatching an installed dock/taskbar menu action by index.
DockMenuBuilder: Builder for the app icon dock/taskbar context menu.
DocumentOutputHandoff: A checked document output handoff for native print/export and hosted WebView print/export flows.
DocumentOutputHandoffBuilder: Builder-facing print/export handoff that validates the output lane before native or WebView work is dispatched.
DownloadBatch: A checked group of app-owned downloads that can be queued together.
DownloadBatchBuilder: Builder for checked app-owned download batches.
DownloadDestinationPlan: Checked destination-selection plan for app-owned downloads.
DownloadDestinationPlanBuilder: Builder for Save As / destination-selection download flows.
DownloadExecutionPlan: Checked execution policy for a native app-owned download queue.
DownloadExecutionPlanBuilder: Builder for native app-owned download queue execution policy.
DownloadHandoff: One-object handoff for native app-owned downloads.
DownloadHandoffBuilder: Builder for native app-owned download handoffs.
DownloadProgress: Progress information during an update download.
DownloadRequest: A checked descriptor for an app-owned download.
DownloadRequestBuilder: Builder for checked app-owned downloads.
DragDropTransferHandoff: A checked drag/drop transfer handoff.
DragDropTransferHandoffBuilder: Builder-facing handoff for incoming drops, file-export drags, internal drag routing, and hosted DOM DataTransfer islands.
DragMoveEvent: An event for when a drag is moving over this element, with the given state type.
DrawContext: Immediate-mode drawing context used by canvas(size, draw).
Drawable: A wrapper around an implementer of Element that allows it to be drawn in a window.
DummyKeyboardMapper: A dummy implementation of the platform keyboard mapper
DuplicateLaunchHandoff: Duplicate-launch routing handoff for existing-instance activation.
DuplicateLaunchPayload: Redacted payload that can be forwarded from a duplicate app launch.
Edges: Represents the edges of a box in a 2D space, such as padding or margin.
EdgesRefinement: A partial-update type for [#ident].
EditCommandStateSnapshot: Runtime state for active-window edit commands.
EffectLayer: A wrapper element that applies a content blur and/or drop shadow to a cached child subtree.
ElementClickedState: Whether or not the element or a group that contains it is clicked by the mouse.
ElementInputHandler: The canonical implementation of PlatformInputHandler. Call Window::handle_input with an instance during your element’s paint.
EmbeddedHostedViewHandoff: Checked descriptor for native pane composition and explicit hosted-view islands.
EmbeddedHostedViewHandoffBuilder: Builder for checked embedded-hosted-view workflow handoffs.
Empty: The empty element, which renders nothing.
EmptyView: A view that renders nothing
Entity: A strong, well-typed reference to a struct which is managed by GPUI
EntityId: A unique identifier for a entity across the application.
ExternalDropData: Data dragged from outside the app, such as browser-style file, text, or URL payloads.
ExternalFile: An external file whose bytes are already available to the application.
ExternalPaths: A collection of paths from the platform, such as from a file drop.
FallbackPromptRenderer: The default GPUI fallback for rendering prompts, when the platform doesn’t support it.
FileAssociation: One checked file association declaration for packaging/installers.
FileAssociationBuilder: Builder for one file association declaration.
FileAssociationSet: Checked app file-association declaration set.
FileAssociationSetBuilder: Builder for app-level file association declarations.
FileDialogFilter: A named file-extension filter for native file dialogs.
FileDialogHandoff: Checked descriptor for open/save/path/hosted file dialog routing.
FileDialogHandoffBuilder: Builder for checked file-dialog workflow handoffs.
FileDropFilter: Builder for accepting dropped files by count and extension.
FileDropIntent: Checked file-drop intent for imports, project opens, and media drops.
FileDropIntentBuilder: Builder for validating native file drops before app-owned import/open work.
FileDropMatch: Accepted and rejected paths from a file drop.
FileExportDragIntent: Checked outbound file drag/export descriptor.
FileExportDragIntentBuilder: Builder for checked outbound file drags and file promises.
FileHandlingSetupPlan: Checked setup coverage between runtime file intake and OS/package document metadata.
FileIconRequest: Checked request for a native icon representing a file, folder, or planned path.
FileIconRequestBuilder: Builder for checked native file icon requests.
FileIntakeEntry: One classified file-intake path.
FileIntakePlan: Checked file-intake classification result.
FileIntakePlanBuilder: Builder for classifying app-owned paths from dialogs, drops, recent docs, or deep links.
FileOperationHandoff: Checked handoff for app-owned file read/write/copy/move/delete workflows.
FileOperationHandoffBuilder: Builder for checked app-owned file operation handoffs.
FileOperationRequest: Checked app-owned file operation descriptor.
FileOperationRequestBuilder: Builder for checked app-owned file operation descriptors.
FileWatchOptions: Options that control how a path is watched.
FileWatchOptionsBuilder: Builder for file-system watch options.
FileWatchSet: A validated group of file-system paths to watch with shared options.
FileWatchSetBuilder: Builder for registering multiple file-system watch roots together.
FileWatcher: Cross-platform file-system watcher backed by the notify crate.
FillOptions: Parameters for the fill tessellator.
FindZoomHandoff: Checked handoff for native document find, result navigation, zoom, and hosted fallback.
FindZoomHandoffBuilder: Builder for checked find/zoom handoffs.
FocusHandle: A handle which can be used to track and manipulate the focused element in a window.
FocusId: A globally unique identifier for a focusable element.
FocusOutEvent: This is provided when subscribing for Context::on_focus_out events.
FocusTraversalPlan: Checked focus traversal plan for native forms, editors, menus, and overlays.
FocusTraversalPlanBuilder: Builder for checked focus traversal plans.
FocusTraversalStop: One checked focus target in an app-owned traversal plan.
FocusTraversalStopBuilder: Builder for one focus traversal stop.
FocusedWindowInfo: Information about the currently focused window from any application.
FocusedWindowQuery: A checked filter for querying the currently focused external window.
FocusedWindowQueryBuilder: Builder for checked focused-window queries.
Font: The configuration details for identifying a specific font.
FontFallbacks: The fallback fonts that can be configured for a given font. Fallback fonts family names are stored here.
FontFamilyId: An opaque identifier for a specific font family.
FontFeature: A single OpenType font feature tag with its value.
FontFeatures: The OpenType features that can be configured for a given font.
FontId: An opaque identifier for a specific font.
FontMetrics: A struct for storing font metrics. It is used to define the measurements of a typeface.
FontRun: A run of text with a single font.
FontWeight: The degree of blackness or stroke thickness of a font. This value ranges from 100.0 to 900.0, with 400.0 as normal.
ForegroundExecutor: A pointer to the executor that is currently running, for spawning tasks on the main thread.
FormFieldDescriptor: Checked summary of one native form field without exposing field values.
FormFieldDescriptorBuilder: Builder for checked native form field descriptors.
FormValidationHandoff: Checked handoff for native forms, validation, autofill policy, and hosted fallback.
FormValidationHandoffBuilder: Builder for checked form-validation handoffs.
FrameSkip: Whole-frame damage tracking: the coarse “early-out” half of dirty-region rendering.
GestureInputPolicy: Checked gesture-input policy for an app-owned native surface.
GestureInputPolicyBuilder: Builder for checked gesture-input policy.
GlobalElementId: A globally unique identifier for an element, used to track state across frames.
GlobalHotkey: A global hotkey registration with an application-owned identifier.
GlobalHotkeyBuilder: Builder for global hotkey registrations.
GlobalHotkeySet: A collection of global hotkeys ready to register.
GlobalHotkeyUnregistration: Checked global hotkey unregistration request.
GlobalRemovalBuilder: Builder for checked app-global removal.
GlyphId: An identifier for a specific glyph, as returned by WindowTextSystem::layout_line.
GpuSpecs: Information about the GPU GPUI is running on.
GpuiBorrow: A mutable reference to an entity owned by GPUI
GraphicsCanvasHandoff: Checked native-first graphics/canvas handoff for generated visual apps.
GraphicsCanvasHandoffBuilder: Builder for checked graphics/canvas handoffs.
GridLocation: A location in a grid layout.
GroupStyle: The styling information for a given group.
HardwareDeviceHandoff: Checked native-first hardware-device handoff for WebUSB/WebHID/Web Serial/Web Bluetooth parity.
HardwareDeviceHandoffBuilder: Builder for checked hardware-device handoffs.
HighlightStyle: A highlight style to apply, similar to a TextStyle except for a single font, uniformly sized and spaced text.
Hitbox: A rectangular region that potentially blocks hitboxes inserted prior. See Window::insert_hitbox for more details.
HitboxId: An identifier for a Hitbox which also includes HitboxBehavior.
HostedVisualCaptureDescriptor: Scoped hosted visual capture descriptor.
Hsla: An HSLA color
Icon: An icon element backed by the generated build-time icon atlas.
Image: An image, with a format and certain bytes
ImageCacheElement: An image cache element.
ImageFormatIter: An iterator over the variants of ImageFormat
ImageIconAssetHandoff: Checked native-first handoff for app icons, file icons, tray icons, and image payloads.
ImageIconAssetHandoffBuilder: Builder for checked native-first image/icon asset handoffs.
ImageId: A unique identifier for the image cache
ImageStyle: The style of an image element.
Img: An image element.
ImgLayoutState: The image layout state between frames
InsertNewline: Insert a newline in multiline mode or submit in single-line mode.
Inspector: Manages inspector state - which element is currently selected and whether the inspector is in picking mode.
InspectorElementId: A unique identifier for an element that can be inspected.
InspectorElementPath: GlobalElementId qualified by source location of element construction.
InteractiveElementState: The per-frame state of an interactive element. Used for tracking stateful interactions like clicks and scroll offsets.
InteractiveText: A text element that can be interacted with.
Interactivity: The interactivity struct. Powers all of the general-purpose interactivity in the Div element.
InvalidCascadeSlot: Error returned when a slot does not belong to the target cascade.
InvalidKeystrokeError: Error type for Keystroke::parse. This is used instead of anyhow::Error so that Kael can use markdown to display it.
ItemSize: The size of the item and its contents.
JumpListBuilder: Builder for Windows jump-list tasks and recent workspace entries.
JumpListPlan: Checked plan for Windows jump-list tasks and recent workspace entries.
KeyBinding: A keybinding and its associated metadata, from the keymap.
KeyBindingClearBuilder: Builder for checked app keybinding cleanup.
KeyBindingMetaIndex: A unique identifier for retrieval of metadata associated with a key binding. Intended to be used as an index or key into a user-defined store of metadata associated with the binding, such as the source of the binding.
KeyBindingSetBuilder: Builder for checked app keybindings / native desktop accelerators.
KeyBindingSetPlan: Checked, inspectable plan for app-local keybindings.
KeyContext: A datastructure for resolving whether an action should be dispatched at this point in the element tree. Contains a set of identifiers and/or key value pairs representing the current context for the keymap.
KeyDownEvent: The key down event equivalent for the platform.
KeyUpEvent: The key up event equivalent for the platform.
KeybindingKeystroke: Represents a keystroke that can be used in keybindings and displayed to the user.
KeyboardClickEvent: A click event that was generated by a keyboard button being pressed and released.
KeyboardLayoutSnapshot: Snapshot of the active platform keyboard layout for shortcut and hotkey UI.
KeyboardLayoutSnapshotBuilder: Builder for checked keyboard-layout snapshots.
Keymap: A collection of key bindings for the user’s application.
KeymapVersion: An opaque identifier of which version of the keymap is currently active. The keymap’s version is changed whenever bindings are added or removed.
Keystroke: A keystroke and associated metadata generated by the platform
KeystrokeEvent: A keystroke event, and potentially the associated action
Label: A text label primitive that can forward focus to another control when clicked.
LaunchArgumentPolicy: Checked policy for classifying startup arguments without exposing their text.
LaunchArgumentPolicyBuilder: Builder for LaunchArgumentPolicy.
LaunchArgumentReport: Content-safe classification of startup arguments.
LaunchContextBuilder: Builder for capturing startup context without exposing arbitrary environment data.
LaunchContextSnapshot: Startup context captured from the current process.
LaunchEnvironmentAllowlist: Environment allowlist and redaction policy for startup diagnostics.
LaunchEnvironmentAllowlistBuilder: Builder for LaunchEnvironmentAllowlist.
LaunchEnvironmentHandoff: Checked native-first handoff for startup arguments, environment, duplicate launches, and diagnostics.
LaunchEnvironmentHandoffBuilder: Builder for checked launch/environment handoffs.
LaunchEnvironmentSnapshot: Content-safe summary of allowlisted environment state.
LayerAnchor: Anchored placement configuration for a layer.
LayerId: A stable identifier for a layer managed by LayerStack.
LayerOptions: Options that control how a layer behaves inside a LayerStack.
LayerStack: A stack of in-window layers such as modals and popovers.
LayoutId: A unique identifier for a layout node, generated when requesting a layout from Taffy
LayoutStylingHandoff: Checked descriptor for native layout, styling, animation, and explicit CSS islands.
LayoutStylingHandoffBuilder: Builder for checked layout/styling/animation workflow handoffs.
LineLayout: A laid out and styled line of text
LineWrapper: The GPUI line wrapper, used to wrap lines of text to a given width.
LineWrapperHandle: A handle into the text system, which can be used to compute the wrapped layout of text
LinearColorStop: A color stop in a linear gradient.
Link: A focusable hyperlink primitive with built-in external URL support.
LinuxInstaller: Linux installer: handles AppImage delta updates, Flatpak, and Snap update channels.
List: A list element
ListOffset: An offset into the list’s items, in terms of the item index and the number of pixels off the top left of the item.
ListPrepaintState: Frame state used by the List element after layout.
ListScrollEvent: A scroll event that has been converted to be in terms of the list’s items.
ListState: The list state that views must hold on behalf of the list element.
LocaleSnapshot: Runtime locale and preferred-language snapshot.
LocaleSnapshotBuilder: Builder for native locale and preferred-language snapshots.
LocalizationTextHandoff: Checked localization/text handoff for locale, editor, capability, and fallback work.
LocalizationTextHandoffBuilder: Builder for checked localization/text workflow handoffs.
LocationRequest: A checked native location request descriptor.
LocationRequestBuilder: Builder for checked native geolocation requests.
Lottie: A Lottie animation element.
LottieAnimation: Parsed Lottie animation metadata and source bytes.
LottiePlayer: Playback controller for a decoded Lottie animation.
LruImageCache: An ImageCache that retains at most max_images decoded images, evicting the least-recently-used entries (releasing their GPU textures via drop_image) once the cap is exceeded. Use this for churning or unbounded image working sets — an infinite feed, gallery, or map — where RetainAllImageCache would grow without bound.
LruImageCacheProvider: A provider struct for creating a bounded LRU image cache inline.
MacOsDocumentTypeDeclaration: macOS document metadata shaped like one CFBundleDocumentTypes entry.
MacOsUrlTypeDeclaration: macOS URL scheme metadata shaped like one CFBundleURLTypes entry.
MacOsUsageDescription: macOS Info.plist usage-description entry.
MagnifyEvent: A magnification gesture event from the platform.
Menu: A menu of the application, either a main menu or a submenu
MenuBarBuilder: Builder for an application menu bar.
MenuBarPlan: Checked, inspectable plan for installing an application menu bar.
MenuBuilder: Builder for an application menu.
MenuButton: A popup-backed menu button with caller-owned trigger and item visuals.
MenuButtonItem: A single popup menu item.
MenuButtonItemRenderState: Snapshot of a popup menu item row passed to a custom renderer.
MenuButtonTriggerRenderState: Snapshot of menu button trigger state passed to a custom renderer.
MenuCommandHandoff: Checked descriptor for app menus, context menus, and edit-command routing.
MenuCommandHandoffBuilder: Builder for checked menu/command workflow handoffs.
MenuEntry: A focusable menu item primitive with caller-owned visuals.
MessageDialogBuilder: Builder for native message/confirmation dialogs.
MessageDialogHandoff: Checked native message-dialog and prompt handoff for builders and agents.
MessageDialogHandoffBuilder: Builder for checked native message-dialog and prompt handoffs.
MessageDialogPlan: Checked, inspectable plan for a native message/confirmation dialog.
Modal: A controlled modal primitive with caller-owned dialog visuals.
ModalRenderState: Snapshot of modal state passed to a custom renderer.
Modifiers: The state of the modifier keys at some point in time
ModifiersChangedEvent: The modifiers changed event equivalent for the platform.
MouseClickEvent: A click event, generated when a mouse button is pressed and released.
MouseDownEvent: A mouse down event from the platform
MouseExitEvent: A mouse exit event from the platform, generated when the mouse leaves the window.
MouseMoveEvent: A mouse move event from the platform
MouseUpEvent: A mouse up event from the platform
MoveDown: Move the caret to the closest position on the next visual line.
MoveLeft: Move the caret one grapheme to the left.
MoveRight: Move the caret one grapheme to the right.
MoveToEnd: Move the caret to the end of the field.
MoveToStart: Move the caret to the beginning of the field.
MoveUp: Move the caret to the closest position on the previous visual line.
MoveWordLeft: Move the caret to the previous word boundary.
MoveWordRight: Move the caret to the next word boundary.
NativeContextMenuBuilder: Builder for a native context menu.
NativeFormSchema: Checked native form schema for generated app-owned forms and wizards.
NativeFormSchemaBuilder: Builder for checked native form schemas and simple wizard scaffolds.
NativeFormSchemaStep: One step in a higher-level native form schema or wizard.
NativeThemeSnapshot: Snapshot of native theme and accessibility signals for app UI decisions.
NavigationHandoff: Checked handoff for native navigation, history, routing, restore, and hosted fallback.
NavigationHandoffBuilder: Builder for checked navigation handoffs.
NavigationRouteDescriptor: Checked summary of one app-owned navigation route.
NavigationRouteDescriptorBuilder: Builder for checked route descriptors.
Navigator: A renderable navigation stack that supports animated route transitions.
NetworkStatusMonitor: Installed network-status monitor snapshot.
NetworkStatusMonitorBuilder: Builder for monitoring online/offline network status changes.
NoAction: Action with special handling which unbinds the keybinding this is associated with, if it is the highest precedence match.
NotificationAction: A notification action button.
NotificationActionFollowUpBuilder: Builder for checked notification action callback routing.
NotificationActionFollowUpPlan: Checked notification action callback routing plan.
NotificationBuilder: Builder for an OS-level notification.
NotificationDeliveryPlan: Checked notification delivery plan against a known backend support profile.
NotificationFeatureSupport: Platform/backend notification feature support.
NotificationFlowHandoff: One-object handoff for notification, action, shell-followup, and attention flows.
NotificationFlowHandoffBuilder: Builder for checked OS notification flows.
OpenDialogBuilder: Builder for native open-file/open-directory dialogs.
OpenDialogPlan: Checked, inspectable plan for a native open-file/open-directory dialog.
OpenRequest: A typed request from the operating system to open a URL, deep link, or file.
OpenRequestRoutePlan: Checked intake plan for platform open requests before mutating navigation state.
OpenRequestRoutePlanBuilder: Builder for checked platform open-request routing.
OsInfo: Information about the operating system.
OsMenu: OS menus are menus that are recognized by the operating system This allows the operating system to provide specialized items for these menus
OwnedMenu: A menu of the application, either a main menu or a submenu
OwnedOsMenu: OS menus are menus that are recognized by the operating system This allows the operating system to provide specialized items for these menus
PackagingUpdateHandoff: Checked native-first handoff for release packaging, signing, updater, restart, and crash diagnostics.
PackagingUpdateHandoffBuilder: Builder for checked packaging/update handoffs.
PaintQuad: A rectangle to be rendered in the window at the given position and size. Passed as an argument Window::paint_quad.
Paste: Paste clipboard text into the field.
Path: A line made up of a series of vertices and control points.
PathBuilder: A Path builder.
PathPromptOptions: The options that can be configured for a file dialog prompt
Percentage: A type representing a percentage value.
PerformanceEvidenceHandoff: Checked handoff for lightweight-runtime performance evidence.
PerformanceEvidenceHandoffBuilder: Builder for checked performance and resource-evidence handoffs.
PermissionBrokerInstallBuilder: Builder for installing an app capability broker with checked grants.
PermissionBrokerInstallReport: Report returned after installing an app capability broker.
PermissionPreflightPlan: Checked relationship between runtime permission preflight and packaged privacy rationale.
PermissionRequestBuilder: Builder for checking and requesting common OS permissions together.
PermissionRequestDenial: A requested permission that is currently denied or restricted.
PermissionRequestResult: Status snapshot returned by App::request_permissions.
PermissionRequestStatus: A requested permission with its current OS status.
PixelSnapPolicy: Consistent pixel-snapping helper for fills, strokes, clips, and text baselines.
Pixels: Represents a length in pixels, the base unit of measurement in the UI framework.
Point: Describes a location in a 2D cartesian space.
PointRefinement: A partial-update type for [#ident].
PointerButtons: Simultaneously pressed pointer buttons.
PointerId: Stable identifier for one active pointer.
PointerInputEvent: A device-independent, high-fidelity pointer event.
PointerInputPolicy: Checked pointer-input policy for an app-owned native surface.
PointerInputPolicyBuilder: Builder for checked pointer-input policy.
PointerSample: One high-frequency sample contained in a coalesced pointer move.
Popover: A controlled anchored popover with caller-owned anchor and popup visuals.
PopoverAnchorRenderState: Snapshot of popover anchor state passed to a custom renderer.
PopoverPopupRenderState: Snapshot of popover popup state passed to a custom renderer.
PowerSaveBlockerBuilder: Builder for starting a power-save blocker with app-level intent.
PowerSaveBlockerHandle: Active power-save blocker returned by App::start_power_save_blocker_with.
PowerSaveBlockerPlan: Checked, side-effect-free power-save blocker intent.
PowerSaveBlockerStopBuilder: Checked request for stopping a previously started power-save blocker by id.
PowerThemeIdleHandoff: Checked handoff for sleep prevention, power monitoring, native theme, idle policy, and hosted fallback.
PowerThemeIdleHandoffBuilder: Builder for checked power/theme/idle handoffs.
PrimaryEnter: Apply the primary Enter behavior for the configured key policy.
PrintContext: A recording context for one printed page.
PrintImageStyle: Image layout settings for print image commands.
PrintJob: A print job that can be sent directly to the platform printer or shown in a native print dialog.
PrintPage: A single page in a print job.
PrintStroke: Stroke settings for line drawing commands.
PrintTextStyle: Text styling for print text commands.
ProcessContextBuilder: Builder for checked process-context switches used by capability checks.
ProcessContextSwitchReport: Report returned after switching the app’s active capability process context.
ProcessMemoryMetrics: Best-effort memory information for the current Kael process.
ProcessMetricsSnapshot: Runtime metrics for the current Kael application process.
Progress: A styled progress indicator with caller-owned rendering.
ProgressIndicator: Checked progress indicator plan for jobs, downloads, exports, installs, and sync.
ProgressIndicatorBuilder: Builder for checked progress indicators.
ProgressRenderState: Snapshot of progress state passed to a custom renderer.
PromptHandle: A handle to a prompt that can be used to interact with it.
PromptResponse: The event emitted when a prompt’s option is selected. The usize is the index of the selected option, from the actions passed to the prompt.
Radians: Represents an angle in Radians
RadioGroup: A controlled radio group form control.
RadioItemRenderState: Snapshot of a single radio option passed to a custom renderer.
RadioOption: A single labeled option in a radio group.
RecentDocumentsBuilder: Builder for adding one or more documents to the OS recent-documents list.
RecentDocumentsClearBuilder: Checked request for clearing this app’s OS recent-documents list.
RecentDocumentsPlan: Checked plan for adding documents to the OS recent-documents list.
RecyclingList: A keyed heterogeneous list that recycles layout state across frames.
RecyclingListFrameState: Frame state used by a RecyclingList between prepaint and paint.
RecyclingListRequestLayoutState: Frame state used by a RecyclingList between layout and prepaint.
Redo: Reapply the next edit snapshot.
Rems: Represents a length in rems, a unit based on the font-size of the window, which can be assigned with Window::set_rem_size.
RenderImage: A cached and processed image, in BGRA format
RenderablePromptHandle: A prompt handle capable of being rendered in a window.
Reservation: Returned by Context::reserve_entity to later be passed to Context::insert_entity. Allows you to obtain the EntityId for a entity before it is created.
ResizeEvent: An event that fires when an element’s bounds change size.
ResponsiveLayoutBreakpoint: One checked native responsive-layout breakpoint.
ResponsiveLayoutPlan: Checked descriptor for native responsive-layout authoring.
ResponsiveLayoutPlanBuilder: Builder for checked responsive-layout plans.
RestartPathBuilder: Builder for a restart binary path.
RetainAllImageCache: An ImageCache that retains every decoded image for the lifetime of the cache (no eviction). Images are released together when the cache entity is dropped or RetainAllImageCache::clear is called. Use this when the working set of images is bounded; for unbounded or churning image sets, scope the cache to a smaller subtree (a shorter-lived element id) so it is dropped and reclaimed more often.
RetainAllImageCacheProvider: A provider struct for creating a retain-all image cache inline
Rgba: An RGBA color
RichText: A builder-backed rich text element for styled content, entities, and inline children.
RichTextLayout: A tracked layout handle for rich text geometry and selection queries.
Route: A route rendered by a Navigator.
RouteChangeEvent: An event emitted whenever the active route changes.
SaveDialogBuilder: Builder for native save dialogs.
SaveDialogPlan: Checked, inspectable plan for a native save dialog.
ScaledPixels: Represents scaled pixels that take into account the device’s scale factor.
Scope: Scope manages a set of tasks that are enqueued and waited on together. See BackgroundExecutor::scoped.
ScreenCaptureFrame: A frame of video captured from a screen.
ScrollAnchor: Represents an element that can be scrolled to in its parent element. Contrary to ScrollHandle::scroll_to_active_item, an anchored element does not have to be an immediate child of the parent.
ScrollBar: A focusable scroll bar primitive bound to a scrollable container.
ScrollBarRenderState: Snapshot of scroll bar state passed to a custom renderer.
ScrollHandle: A handle to the scrollable aspects of an element. Used for accessing scroll state, like the current scroll offset, and for mutating the scroll state, like scrolling to a specific child.
ScrollWheelEvent: A mouse wheel event from the platform
SecureCredentialHandoff: Checked native-first handoff for keychain writes, reads, deletes, diagnostics, and auth fallback.
SecureCredentialHandoffBuilder: Builder for checked secure credential handoffs.
SecurityPermissionHandoff: Checked handoff for security and permission policy setup before mutation.
SecurityPermissionHandoffBuilder: Builder for checked security and permission policy handoffs.
Select: A controlled popup-backed combo box.
SelectAll: Select all text in the field.
SelectDown: Extend the selection to the closest position on the next visual line.
SelectLeft: Extend the selection one grapheme to the left.
SelectOption: A single labeled option in a select control.
SelectOptionRenderState: Snapshot of a popup option row passed to a custom renderer.
SelectPopupRenderState: Snapshot of select popup state passed to a custom popup renderer.
SelectRenderState: Snapshot of select trigger state passed to a custom renderer.
SelectRight: Extend the selection one grapheme to the right.
SelectSearchRenderState: Snapshot of the in-popup search field passed to a custom renderer.
SelectToEnd: Extend the selection to the end of the field.
SelectToStart: Extend the selection to the beginning of the field.
SelectUp: Extend the selection to the closest position on the previous visual line.
SelectWordLeft: Extend the selection to the previous word boundary.
SelectWordRight: Extend the selection to the next word boundary.
SemanticVersion: A semantic version number.
SessionRestoreResult: Window-state restore output with a content-safe relocation summary.
SessionSnapshot: A persisted snapshot of the entire session.
SessionSnapshotBuilder: Builder for composing a persisted SessionSnapshot.
SessionStore: Persistent storage for application session state.
ShapedGlyph: A single glyph, ready to paint.
ShapedLine: A line of text that has been shaped and decorated.
ShapedRun: A run of text that has been shaped .
SharedString: A shared string is an immutable string that can be cheaply cloned in GPUI tasks. Essentially an abstraction over an Arc<str> and &'static str,
SharedUri: A SharedString containing a URI.
ShellTargetsBuilder: Builder for opening or revealing multiple platform shell targets.
ShellTargetsPlan: Checked, inspectable plan for ordered shell open/reveal workflows.
ShiftEnter: Apply the Shift+Enter behavior for the configured key policy.
ShortcutInputHandoff: Checked native-first shortcut/input handoff for app accelerators and global shortcuts.
ShortcutInputHandoffBuilder: Builder for checked native-first shortcut/input handoffs.
SingleInstance: A guard that enforces single-instance behavior for an application.
SingleInstanceBuilder: Builder for native desktop single-instance startup handling.
Size: A structure representing a two-dimensional size with width and height in a given unit.
SizeRefinement: A partial-update type for [#ident].
Slider: A controlled slider form control.
SliderRenderState: Snapshot of slider state passed to a custom renderer.
SortableList: A low-level, delegate-driven list that supports reordering its own items via drag and drop.
SortableReorderPlan: Content-safe reorder plan for a sortable-list drop.
SourceMetadata: Metadata for a given ScreenCaptureSource
Splitter: A controlled splitter primitive with caller-owned visuals.
SplitterRenderState: Snapshot of splitter state passed to a custom renderer.
StartupDiagnosticBuilder: Builder for content-safe startup diagnostics.
StartupDiagnosticReport: Content-safe startup diagnostics for logs, support bundles, and agents.
Stateful: A wrapper around an element that can store state, produced after assigning an ElementId.
StorageCleanupPlan: Checked app-scoped storage cleanup plan.
StorageCleanupPlanBuilder: Builder for checked app-scoped storage cleanup plans.
StorageCleanupTarget: One checked app-scoped storage cleanup target.
StorageCleanupTargetBuilder: Builder for one app-scoped storage cleanup target.
StorageMigrationPlan: Checked app-scoped storage migration plan.
StorageMigrationPlanBuilder: Builder for checked app-scoped storage migration plans.
StorageMigrationStep: One checked app-scoped storage migration step.
StorageMigrationStepBuilder: Builder for one app-scoped storage migration step.
StoredCredential: A credential read from the platform keychain.
StrikethroughStyle: The properties that can be applied to a strikethrough.
StrikethroughStyleRefinement: A partial-update type for [#ident].
Stroke: Stroke styling for immediate-mode canvas drawing.
StrokeDash: Stroke dash settings for canvas stroke operations.
StrokeOptions: Parameters for the tessellator.
Style: The CSS styling that can be applied to an element via the Styled trait
StyleRefinement: A partial-update type for [#ident].
StyledText: Renders text with runs of different styles.
Submit: Submit the current field value.
Subscription: A handle to a subscription created by GPUI. When dropped, the subscription is cancelled and the callback will no longer be invoked.
SupportDiagnosticsBuilder: Builder for support diagnostics that are safe to copy into bug reports.
SupportDiagnosticsSnapshot: Privacy-aware support diagnostics collected from native app state.
Surface: A surface element.
Svg: An SVG element.
SystemIdlePolicy: A checked policy for deciding when the system has been idle long enough.
SystemIdlePolicyBuilder: Builder for checked system-idle policies.
SystemPowerMonitor: Active system-power monitor returned by App::watch_system_power.
SystemPowerMonitorBuilder: Builder for monitoring system power, idle, and motion-preference changes.
SystemPowerMonitorDescriptor: Cloneable, side-effect-free summary of a checked system power monitor setup.
SystemPowerSnapshot: Snapshot of system state relevant to adaptive rendering and background work.
SystemPowerSourceQueryBuilder: Builder for checked system power-source queries.
SystemPowerSourceSnapshot: Snapshot of the current battery/external-power source.
SystemWindowTabController: A controller for managing window tabs.
TabBackward: Apply the backward Tab behavior for the configured key policy.
TabForward: Apply the forward Tab behavior for the configured key policy.
TabItem: A single tab item with a label and panel body.
TabRenderState: Snapshot of a tab trigger passed to a custom renderer.
Tabs: A controlled tabs primitive with caller-owned tab bodies and panels.
Task: Task is a primitive that allows work to happen in the background.
TaskLabel: A task label is an opaque identifier that you can use to refer to a task in tests.
TextCheckingRequest: Text checking features requested for an editable text region.
TextCheckingRequestBuilder: Builder for checked spellcheck/grammar/autocorrect requests.
TextInput: A controlled editable text field.
TextInputController: External control handle for a canvas-hosted text input.
TextInputEnd: Offer a plain End key to an embedded editor before caret fallback.
TextInputHome: Offer a plain Home key to an embedded editor before caret fallback.
TextInputKeyEvent: A structured canvas-editor command emitted by a text input.
TextInputNavigationEvent: A typed text-input caret or selection navigation request.
TextInputRenderLine: A single shaped line and its paint origin for a custom text input renderer.
TextInputRenderState: Snapshot of text input paint state passed to a custom renderer.
TextInputSelection: A bounded UTF-8 selection snapshot emitted by a canvas text input.
TextLayout: The Layout for TextElement. This can be used to map indices to pixels and vice versa.
TextRun: A styled run of text, for use in crate::TextLayout.
TextShadow: A shadow effect applied to text, rendered by painting glyphs twice.
TextStyle: The properties that can be used to style text in GPUI
TextStyleRefinement: A partial-update type for [#ident].
TextSystem: The GPUI text rendering sub system.
Tiling: A type to describe which sides of the window are currently tiled in some way
Timeout: Error returned by with_timeout when the timeout duration elapsed before the future resolved
Timer: A future or stream that emits timed events.
TitlebarOptions: The options that can be configured for a window’s titlebar
Toast: Configuration for a single toast notification.
ToastStack: A stack of toast notifications that manages display and auto-dismissal.
Toggle: A controlled toggle switch form control.
ToggleRenderState: Snapshot of toggle state passed to a custom renderer.
TooltipAnchor: Anchor-relative positioning for a tooltip: the trigger’s window-space bounds plus the requested side and alignment. When present this replaces the default cursor-relative positioning.
TooltipId: An identifier for a tooltip.
TraceEvent: A single trace event compatible with the Chrome Trace Event format.
TraceSession: Bounded, redacted trace-session descriptor for native app diagnostics.
TraceSessionBuilder: Builder for bounded, content-safe trace sessions.
Tracer: A tracer that collects trace events and can export them in Chrome Trace Event format.
Transformation: A transformation to apply to an SVG element.
TransformationMatrix: A data type representing a 2 dimensional transformation that can be applied to an element.
TransitionConfig: Configuration for implicit style transitions on an element.
TrashRequest: Checked request to move a file or directory to the platform trash/recycle bin.
TrashRequestBuilder: Builder for checked platform trash/recycle requests.
TrayAppBuilder: Builder for installing tray menu, tooltip, panel behavior, and background lifetime together.
TrayAppConfig: A validated system-tray/background-app configuration.
TrayIconBuilder: Builder for a checked system tray icon.
TrayMenuBuilder: Builder for a system tray menu.
TrayPanelPlacementBuilder: Builder for resolving a tray-panel placement with a safe fallback.
TrayTooltipBuilder: Builder for a system tray tooltip.
TreeItem: A focusable tree item primitive with controlled selected and expanded state.
UTF16Selection: A struct representing a selection in a text buffer, in UTF16 characters. This is different from a range because the head may be before the tail.
UnderlineStyle: The properties that can be applied to an underline.
UnderlineStyleRefinement: A partial-update type for [#ident].
Undo: Restore the previous edit snapshot.
UniformList: A list element for efficiently laying out and displaying a list of uniform-height elements.
UniformListFrameState: Frame state used by the UniformList.
UniformListScrollHandle: A handle for controlling the scroll position of a uniform list. This should be stored in your view and passed to the uniform_list on each frame.
UniformListScrollState
UpdateInfo: Information about an available update.
UpdateInfoBuilder: Builder for update metadata entries.
UrlSchemeRegistrationBuilder: Builder for registering one or more custom URL schemes.
UserAttentionBuilder: Builder for requesting user attention from the OS.
UserAttentionCancelBuilder: Checked request for cancelling an active user-attention signal.
UserAttentionPlan: Checked user-attention request before platform mutation.
UserAttentionRequest: Active user-attention request returned by App::request_user_attention_with.
VisualCaptureHandoff: Checked native-first visual capture handoff for screenshots, thumbnails, and evidence.
VisualCaptureHandoffBuilder: Builder for checked visual capture handoffs.
WeakEntity: A weak reference to a entity of the given type.
WeakFocusHandle: A weak reference to a focus handle.
WebView: A native embedded WebView element.
WebViewBridgeMessage: A small, native desktop envelope for messages crossing a WebView island.
WebViewCapabilityEntry: Support entry for one WebViewCapability.
WebViewCapabilityReport: Operation-level WebView support for one concrete backend.
WebViewClipboardEvent: Event payload emitted by webview_clipboard_event_bridge_script.
WebViewConsoleEvent: Event payload emitted by webview_console_bridge_script.
WebViewContextMenuEvent: Event payload emitted by webview_context_menu_bridge_script.
WebViewController: A small command handle for an embedded WebView.
WebViewCookie: Cookie data read from an embedded WebView.
WebViewDialogEvent: Event payload emitted by webview_dialog_bridge_script.
WebViewDocumentForm: A form discovered in a WebView document snapshot.
WebViewDocumentHeading: A heading discovered in a WebView document snapshot.
WebViewDocumentImage: An image discovered in a WebView document snapshot.
WebViewDocumentLink: A link discovered in a WebView document snapshot.
WebViewDocumentSnapshot: Structured snapshot of a WebView document for diagnostics and agents.
WebViewDomImageCaptureOptions: DOM-to-SVG capture options for WebViewController::capture_dom_image.
WebViewDownloadCompleted: Completion details for a WebView download.
WebViewDownloadTriggerResult: Result for a WebView browser download trigger command.
WebViewElementAttribute: An attribute captured from a WebView DOM element snapshot.
WebViewElementRect: Bounding rectangle for a WebView DOM element in viewport CSS pixels.
WebViewElementSnapshot: Snapshot of one same-document WebView element selected by CSS selector.
WebViewFaviconEvent: Event payload emitted by webview_favicon_bridge_script.
WebViewFileInputEvent: Event payload emitted by webview_file_input_bridge_script.
WebViewFileInputFile: Browser file metadata from an <input type="file"> selection.
WebViewFindEvent: Event payload emitted by the internal webview_find_result_bridge_script helper.
WebViewFindOptions: Options for finding text inside a WebView document.
WebViewFindResult: Result for an native desktop WebView find operation.
WebViewFormControlState: Snapshot of a browser form control emitted by webview_form_bridge_script.
WebViewFormEvent: Event payload emitted by webview_form_bridge_script.
WebViewKeyboardEvent: Event payload emitted by webview_keyboard_bridge_script.
WebViewLifecycleEvent: Event payload emitted by webview_lifecycle_bridge_script.
WebViewLocationEvent: Event payload emitted by webview_location_bridge_script.
WebViewMediaElementOptions: Browser media element options applied by WebViewController::set_media_options.
WebViewMediaElementState: Snapshot of a browser <audio> or <video> element inside a WebView.
WebViewMediaEvent: Event payload emitted by webview_media_event_bridge_script.
WebViewMediaFrameCaptureOptions: Canvas capture options for WebViewController::capture_media_frame.
WebViewMediaTextCue: A browser text-track cue active for a WebView media element.
WebViewMediaTextTrackOptions: Browser <track> options added by WebViewController::add_media_text_track.
WebViewMediaTextTrackState: Browser text-track state for a WebView media element.
WebViewMediaTimeRange: A buffered media time range reported by a browser <audio> or <video> element.
WebViewNativePermissionRequest: Security context supplied to a native WebView permission policy.
WebViewNetworkEvent: Event payload emitted by webview_network_bridge_script.
WebViewOptions: Configuration for a WebView island.
WebViewPermissionRequest: Event payload emitted by webview_permission_bridge_script.
WebViewPointerEvent: Event payload emitted by webview_pointer_bridge_script.
WebViewResourceEvent: Event payload emitted by webview_resource_bridge_script.
WebViewScrollEvent: Event payload emitted by webview_scroll_bridge_script.
WebViewSelectionEvent: Event payload emitted by webview_selection_bridge_script.
WebViewStorageAreaSnapshot: Snapshot of one browser Web Storage area.
WebViewStorageEntry: A key/value entry from a WebView storage snapshot.
WebViewStorageEvent: Event payload emitted by webview_storage_bridge_script.
WebViewStorageMutationResult: Result for a WebView Web Storage mutation command.
WebViewStorageSnapshot: On-demand snapshot of browser Web Storage for a WebView document.
Window: Holds the state for a specific window.
WindowAppIdBuilder: Builder for validated platform window app identifiers.
WindowAtlasBudget: Checked memory budget for a window’s glyph/sprite atlas.
WindowAtlasBudgetBuilder: Builder for checked window atlas memory budgets.
WindowAutoscrollRequest: Checked autoscroll bounds for native drag, selection, and editor surfaces.
WindowAutoscrollRequestBuilder: Builder for checked native autoscroll requests.
WindowChromeCommand: Checked custom-window-chrome command for titlebars, menus, move, and resize.
WindowClientInset: Checked custom-chrome client inset for native window decorations.
WindowClientInsetBuilder: Builder for checked client-side decoration insets.
WindowContentProtection: Checked content-protection policy for a native window.
WindowContentProtectionBuilder: Builder for checked window content-protection policy.
WindowContentSize: Checked runtime content size for a native window.
WindowContentSizeBuilder: Builder for checked runtime native window resizing.
WindowControls: What window controls this platform supports
WindowCursorStyleCommand: Checked whole-window cursor style request for generated native UI surfaces.
WindowDocumentState: Checked document chrome state for editor and document windows.
WindowDocumentStateBuilder: Builder for checked document-window chrome state.
WindowHandle: A handle to a window with a specific root view type. Note that this does not keep the window alive on its own.
WindowId: A unique identifier for a window.
WindowIntentBuilder: Checked builder for window-management window intent presets.
WindowInteractionCommand: Checked window interaction command for visibility, focus, and mouse pass-through.
WindowManagementHandoff: Checked native window-management handoff for generated desktop shells.
WindowManagementHandoffBuilder: Builder for checked native window-management handoffs.
WindowOpacity: Checked native window opacity.
WindowOpacityBuilder: Builder for checked native window opacity.
WindowOptions: The variables that can be configured when creating a new window
WindowOptionsBuilder: Builder for WindowOptions.
WindowPlacement: Resolved desktop placement for a window or panel.
WindowPlacementBuilder: Builder for resolving a semantic desktop window placement into screen bounds.
WindowPresentationPolicy: Checked presentation/kiosk policy for a native window.
WindowPresentationPolicyBuilder: Builder for checked window presentation/kiosk policy.
WindowProgressBuilder: Builder for checked taskbar/dock progress state.
WindowRemSize: Checked base rem size for native window UI scaling.
WindowRemSizeBuilder: Builder for checked native window rem-size changes.
WindowRenderPolicy: Checked render policy for native window performance behavior.
WindowRenderPolicyBuilder: Builder for checked native window render/performance policy.
WindowRuntimeSnapshot: Runtime snapshot of native window state for diagnostics, chrome, and agents.
WindowRuntimeSnapshotQueryBuilder: Builder for checked runtime window snapshot queries.
WindowState: A snapshot of a window’s state for save/restore.
WindowSystemUiCommand: Checked native system-UI command for editor, custom-titlebar, and desktop flows.
WindowTabCommand: Checked native window-tab command for document and workspace flows.
WindowTabbingIdentifierBuilder: Builder for validated platform window tabbing identifiers.
WindowTextSystem: The GPUI text layout subsystem.
WindowTitleBuilder: Builder for validated platform window titles.
WindowZOrderPolicy: Checked native z-order policy for native desktop always-on-top windows.
WindowZOrderPolicyBuilder: Builder for checked native z-order policy.
WindowsFileAssociationDeclaration: Windows file association metadata shaped for installer/registry generation.
WorkspaceCloseBuilder: Builder for checked workspace closure.
WorkspaceOpenHandoff: Checked handoff for project/file opens after dialog, drop, deep link, or recent-document intake.
WorkspaceOpenHandoffBuilder: Builder for a checked project/file open handoff.
WrapBoundary: A boundary at which a line was wrapped
WrappedLine: A line of text that has been shaped, decorated, and wrapped by the text layout system.
WrappedLineLayout: A line of text that has been wrapped to fit a given width

Enums§

AbsoluteLength: Represents an absolute length in pixels or rems.
ActionBuildError: Error type for Keystroke::parse. This is used instead of anyhow::Error so that Kael can use markdown to display it.
AdvancedInputNextAction: Next action for checked advanced-input handoffs.
AdvancedInputRequest: Advanced input request for native games, creative tools, canvases, and device-heavy apps.
AlignContent: Sets the distribution of space between and around content items For Flexbox it controls alignment in the cross axis For Grid it controls alignment in the block axis
AlignItems: Used to control how child nodes are aligned. For Flexbox it controls alignment in the cross axis For Grid it controls alignment in the block axis
AnchoredFitMode: Which algorithm to use when fitting the anchored element to be inside the window.
AnchoredPositionMode: Which algorithm to use when positioning the anchored element.
AppChromeSurfaceNextAction: Next action for a checked native app-chrome workflow.
AppChromeSurfaceRequest: A checked request in a generated native app-chrome workflow.
AppDistributionFormat: Package artifact format.
AppDistributionPlatform: Operating system target for package artifact generation.
AppIconFormat: Icon file format.
AppIconPurpose: Semantic use for a package/runtime icon asset.
AppIdentityMetadataNextAction: Recommended next implementation action for app identity handoffs.
AppIdentityMetadataRequest: One checked app identity, packaging, or registration request for builders and agents.
AppLifecycleCommandKind: App-level lifecycle or activation command.
AppLifecycleStartupNextAction: Next action for a checked lifecycle/startup handoff.
AppLifecycleStartupRequest: Checked lifecycle/startup request for generated app setup and activation flows.
AppPackageReadinessIssueKind: Kind of package readiness finding.
AppPackageReadinessSeverity: Severity for a package readiness finding.
AppPathRole: Well-known application path roles for app-owned storage and user handoff locations.
AppPrivacyPermissionKind: Privacy-sensitive capability declared for packaging metadata.
AppResourceBudgetIssueKind: Kind of resource budget issue found in a process snapshot.
AppStorageDurability: Durability policy for an app storage entry.
AppStorageKind: Storage class for app-owned persistent or rebuildable data.
AppStorageSessionNextAction: The next product action needed for a checked app storage/session flow.
AppStorageSessionRequest: A checked app storage/session descriptor for builder and agent flows.
AppUpdateAction: Recommended UI action for the current update state.
AppUpdateChannel: Release channel used by app update UI and diagnostics.
AppUpdateOfferKind: Result of applying app update policy to one discovered release.
AppUpdateOfferReason: Reason an update was offered, deferred, or blocked.
AppUpdatePhase: Current state of an app update flow.
AppWindowCaptureFormat: Output encoding requested for an app-owned visual capture.
AppWindowCaptureTarget: Target for an app-owned visual capture request.
ArcCow: A value that is either borrowed or owned through an atomically reference-counted pointer.
AssetLogger: An asset Loader which logs the Err variant of a Result during loading
AttentionType: The type of user attention to request from the OS.
AudioPlaybackSourceKind: Source kind for checked native audio playback descriptors.
AudioWorkflowNextAction: Next action for checked audio workflow handoffs.
AudioWorkflowRequest: Native audio workflow request for playback, recording, waveform evidence, or fallback routing.
AvailableSpace: The space available for an element to be laid out in
Axis: Axis in a 2D cartesian space.
BiometricKind: The kind of biometric authentication available.
BiometricStatus: The availability status of biometric authentication.
BlendMode: The blend mode to apply when rendering a quad.
BorderStyle: The style of a border.
BrowserProfileStorageDestination: Target route for browser-profile storage when replacing Electron profile usage.
BrowserProfileStorageKind: Browser-profile storage classes that Electron apps commonly use implicitly.
BrowserProfileStorageNextAction: Next app-builder action for a browser-profile storage bridge plan.
BrowserWebViewLoading: Loading strategy for an iframe-backed browser WebView.
BrowserWebViewSandbox: Sandbox strength for an iframe-backed WebView in a Kael browser build.
ClickEvent: A click event, generated when a mouse button or keyboard button is pressed and released.
ClipShape: A non-rectangular clip region. Coordinates are in logical pixels, in the same space as the element’s bounds.
ClipboardEditingNextAction: The next product action needed for a checked clipboard or edit-command flow.
ClipboardEditingRequest: A checked clipboard or edit-command descriptor for builder and agent flows.
ClipboardEntry: Either a ClipboardString or a ClipboardImage
ColorSpace: A color space for color interpolation.
Corner: Identifies a corner of a 2d box.
CrashReportingNextAction: Next action for crash-reporting and diagnostics handoffs.
CrashReportingRequest: Crash-reporting workflow requests that should be checked before side effects.
CursorStyle: The style of the cursor (pointer)
DataTransferDropIntakeNextAction: Next action for a checked DataTransfer-style incoming drop.
DatePickerNavigationDirection: Direction of a date picker navigation button.
Decorations: A type to describe how this window is currently configured
DefaultHandlerScope: Whether a default-handler registration plan targets the current user or the system.
DefiniteLength: A non-auto length that can be defined in pixels, rems, or percent of parent.
DesktopShellChromeNextAction: Next shell/chrome action a builder or agent should take.
DesktopShellChromeRequest: A shell/chrome request that often spans several Electron-style app APIs.
DeveloperObservabilityNextAction: Next action for a checked developer tools and observability handoff.
DeveloperObservabilityRequest: Checked request inside a developer tools and observability handoff.
DeviceAccessKind: Native device access category.
DialogKind: The kind of a native dialog.
DispatchPhase: Represents the two different phases when dispatching events.
Display: Sets the layout used for the children of this node
DisplayQueryTarget: Which display or displays a query should return.
DisplayTopologyNextAction: Recommended next action for a screen/display topology handoff.
DisplayTopologyRequest: Unit of work covered by a checked screen/display topology handoff.
DocumentExportDestination: Where an exported document should be delivered.
DocumentExportFormat: Document export formats for native PDF export and save-page flows.
DocumentExportRequest: A checked document export request for native print jobs or WebView-hosted documents.
DocumentOutputNextAction: The next platform action a checked document output request needs.
DocumentOutputRequest: A print or export descriptor ready for a document-output implementation.
DocumentZoomMode: Native document zoom behavior requested by a handoff.
DownloadDestinationNextAction: Next app-builder action for a checked download destination plan.
DownloadExistingFilePolicy: Policy for destinations that already exist before an app-owned download starts.
DownloadHandoffNextAction: Recommended next action for an app-owned download handoff.
DragDropTransferNextAction: The next product action needed for a checked drag/drop transfer flow.
DragDropTransferRequest: A checked drag/drop descriptor for builder and agent flows.
ElementId: An identifier for an Element.
EmbeddedHostedPaneProfile: Explicit hosted-pane profile for embedded WebView islands.
EmbeddedHostedViewNextAction: Next action for a checked embedded-hosted-view workflow.
EmbeddedHostedViewRequest: A checked request in an embedded-hosted-view workflow.
FileAssociationRole: How strongly an app claims a file association.
FileDialogNextAction: Next action for a checked file-dialog workflow.
FileDialogRequest: A checked request in a generated file-dialog workflow.
FileDropEvent: A file drop event from the platform, generated when files are dragged and dropped onto the window.
FileDropPathKind: Path kind accepted by a file-drop intent.
FileDropPurpose: Semantic purpose for a native file drop.
FileExportDragItem: Data source for an app-owned outbound file drag/export.
FileIconSize: Requested native file icon size.
FileIntakeKind: Coarse content kind for app-owned file intake routing.
FileOperationHandoffRequest: One request in a checked file operation handoff.
FileOperationKind: App-owned filesystem operation kind.
FileOperationNextAction: Next action for checked file operation handoffs.
FileWatchEvent: A file-system change delivered by FileWatcher.
Fill: The kinds of fill that can be applied to a shape.
FillRule: The fill rule defines how to determine what is inside and what is outside of the shape.
FindZoomDirection: Direction for native find-result navigation.
FindZoomNextAction: Recommended next implementation move for a find/zoom handoff.
FindZoomRequest: Unit of work covered by a checked find/zoom handoff.
FlexDirection: The default behavior is FlexDirection::Row.
FlexWrap: Controls whether flex items are forced onto one line or can wrap onto multiple lines.
FontStyle: Allows italic or oblique faces to be selected.
FormFieldKind: Native form control categories covered by a checked form handoff.
FormValidationNextAction: Recommended next implementation move for a form-validation handoff.
FormValidationRequest: Unit of work covered by a native form-validation handoff.
FrameDamage: The region of a frame that changed relative to a previously presented frame.
GestureInputKind: Gesture class expected by an app-owned native surface.
GraphicsCanvasNextAction: Recommended next implementation action for graphics/canvas handoffs.
GraphicsCanvasRequest: Checked graphics/canvas unit of work for native-first generation.
GraphicsCanvasSurfaceKind: Graphics surface family covered by a checked graphics/canvas handoff.
GridAutoFlow: Controls how the grid auto-placement algorithm flows items into the grid (CSS grid-auto-flow).
GridPlacement: The placement of an item within a grid layout’s column or row.
GridTrack: The direction of the flexbox layout main axis.
GridTrackMax: The upper bound of a minmax() grid track.
GridTrackMin: The lower bound of a minmax() grid track. fr units are not valid as a minimum.
HardwareDeviceNextAction: Recommended next implementation action for hardware-device handoffs.
HardwareDeviceRequest: Unit of work covered by a checked hardware-device handoff.
HitboxBehavior: How the hitbox affects mouse behavior.
HostedVisualCaptureKind: Hosted visual capture kind for scoped WebView-owned evidence.
ImageAssetLoader: An image loader for the GPUI asset system
ImageCacheError: An error that can occur when interacting with the image cache.
ImageCacheItem: An image cache item
ImageFormat: One of the editor’s supported image formats (e.g. PNG, JPEG) - used when dealing with images in the clipboard
ImageIconAssetNextAction: Recommended next action for native image/icon handoffs.
ImageIconAssetRequest: Unit of work covered by a checked native image/icon asset handoff.
ImageIconAssetRoute: App-owned native image route to prepare before browser image fallbacks.
ImageSource: A source of image content.
KeyBindingContextPredicate: A datastructure for resolving whether an action should be dispatched Representing a small language for describing which contexts correspond to which actions.
KeyboardButton: An enum representing the keyboard button that was pressed for a click event.
LaunchEnvironmentNextAction: Recommended next implementation action for launch/environment handoffs.
LaunchEnvironmentRequest: One checked launch/environment startup request for builders and agents.
LayerPlacement: Controls how a layer is placed inside a LayerStack.
LayoutStylingNextAction: Next action for a checked layout/styling/animation workflow.
LayoutStylingRequest: A checked request in a native layout, styling, animation, and effects workflow.
Length: A length that can be defined in pixels, rems, percent of parent, or auto.
LineCap: Line cap as defined by the SVG specification.
LineFragment: A fragment of a line that can be wrapped.
LineJoin: Line join as defined by the SVG specification.
LinuxPackageFormat: Supported Linux packaging formats for auto-update.
ListAlignment: Whether the list is scrolling from top to bottom or bottom to top.
ListHorizontalSizingBehavior: The horizontal sizing behavior to apply during layout.
ListSizingBehavior: The sizing behavior to apply during layout.
LocaleTextDirection: Text direction inferred from a locale language.
LocalizationTextNextAction: Next localization/text action for native-first app generation.
LocalizationTextRequest: Localization/text workflow requests a generated app can route before side effects.
LocationAccuracy: Requested location accuracy for native geolocation.
LoopMode: The loop policy used by a Lottie player.
LottieAssetLoader: Asset loader for decoded Lottie animations.
LottieAssetSource: Internal asset-cache key used for Lottie resource loading.
LottieError: An error that can occur when loading or rendering a Lottie animation.
LottieSource: A source of Lottie animation content.
MediaKeyEvent: Media key events from hardware media keys or OS media controls.
MenuCommandNextAction: Next action for a checked menu/command workflow.
MenuCommandRequest: A checked request in a generated native menu workflow.
MenuItem: The different kinds of items that can be in a menu
MessageDialogNextAction: Next action for checked native message-dialog and prompt flows.
MessageDialogRequest: Checked request inside a native message-dialog and prompt handoff.
MouseButton: An enum representing the mouse button that was pressed.
NativeThemeAdaptation: Structured UI adaptation signal derived from native theme, accessibility, and power state.
NavigationDirection: A navigation direction, such as back or forward.
NavigationHandoffNextAction: Recommended next implementation action for a navigation handoff.
NavigationHandoffRequest: Unit of work covered by a checked navigation handoff.
NavigationPolicy: Controls whether a WebView navigation attempt should continue.
NetworkStatus: The current network connectivity status.
NotificationActionEvent: Action event emitted by a checked desktop notification callback.
NotificationActionFollowUpNextAction: Next app-builder action after a notification action callback fires.
NotificationFeature: Notification feature used when checking how a builder maps to a platform backend.
NotificationFlowNextAction: Next app-builder action for an OS notification flow.
NotificationUrgency: Delivery urgency for OS-level notifications.
ObjectFit: How to fit the image into the bounds of the element.
OpenRequestKind: The classified kind of an OS open request.
OpenRequestRouteNextAction: Next app-builder action after classifying OS open requests.
OsAction: OS actions are actions that are recognized by the operating system This allows the operating system to provide specialized behavior for these actions
Overflow: How children overflowing their container should affect layout
OwnedMenuItem: The different kinds of items that can be in a menu
PackagingUpdateNextAction: Recommended next implementation action for packaging/update handoffs.
PackagingUpdateRequest: One checked packaging, signing, updater, restart, or crash-reporting request.
PathStyle: Style of the PathBuilder
PerformanceEvidenceNextAction: Next action for checked performance and resource-evidence workflows.
PerformanceEvidenceRequest: Checked request inside a performance and resource-evidence handoff.
PermissionStatus: The status of a system permission.
PlatformInput: An enum corresponding to all kinds of platform input events.
PlaybackState: The playback state for a Lottie animation.
PointerInputCapability: Pointer affordance class expected by an app-owned native surface.
PointerPhase: Lifecycle phase of a rich pointer event.
PointerType: Physical pointer device category.
Position: The positioning strategy for this item.
PowerMode: The system’s current power policy.
PowerSaveBlockerKind: The kind of power save blocker to create.
PowerThemeIdleNextAction: Recommended next implementation action for a power/theme/idle handoff.
PowerThemeIdleRequest: Unit of work covered by a checked power/theme/idle handoff.
PrintDialogMode: How a native print job should be dispatched.
PrintImageFit: How to fit an image into a print image bounds rectangle.
PrintOrientation: Orientation metadata for a print job.
PrintPaperSize: Common paper sizes expressed in print points.
PrintRequest: A checked print request for native print jobs or WebView-hosted documents.
ProgressBarState: The state of a taskbar/dock progress bar for a window.
ProgressIndicatorKind: Progress indicator state for app-owned operations.
PromptButton: Prompt Button
PromptLevel: What kind of prompt styling to show
ResizeEdge: Which part of the window to resize
Resource: An enum representing
ResponsiveLayoutMode: Native layout strategy to use at a responsive breakpoint.
ScrollDelta: The scroll delta for a scroll wheel event.
ScrollStrategy: Where to place the element scrolled to.
SecureCredentialNextAction: Recommended next implementation action for secure credential handoffs.
SecureCredentialRequest: One checked secure-credential request for builders and agents.
SecurityPermissionNextAction: Next action for a checked security and permission policy handoff.
SecurityPermissionRequest: Checked request inside a security and permission policy handoff.
ShellTarget: A platform shell target that can be opened or revealed by the OS.
ShortcutInputNextAction: Recommended next action for shortcut/input handoffs.
ShortcutInputRequest: Unit of work covered by a checked shortcut/input handoff.
SingleInstanceLaunch: Outcome of a single-instance launch attempt.
StartupMode: Startup mode used by launch diagnostics and generated startup routing.
StorageCleanupKind: App-scoped storage cleanup target class.
StorageMigrationKind: App-scoped storage migration operation.
SurfaceSource: A source of a surface’s content.
SystemIdleEvaluation: Result of evaluating system idle time against a policy.
SystemMenuType: The type of system menu
SystemPowerEvent: System power state change events.
SystemPowerSource: The system’s current external-power or battery source.
TextAlign: How to align text within the element
TextInputKeyOutcome: The semantic result of a text-input key command.
TextInputKeyPolicy: Keyboard behavior used by a text input embedded in a canvas editor.
TextInputKeyTrigger: The physical key chord that produced a text-input command.
TextInputNavigationKey: Caret or selection navigation keys an embedded editor may consume before native movement.
TextOverflow: How to truncate text that overflows the width of the element
ToastPosition: Position where toasts appear on screen.
TooltipAlign: How a tooltip should be aligned along the side of its anchor bounds.
TooltipFocusBehavior: Controls whether a tooltip also opens when its trigger receives focus.
TooltipSide: The side of the anchor bounds a tooltip should be placed on.
TouchPhase: The phase of a touch motion event. Based on the winit enum of the same name.
TracePhase: The phase of a trace event in the Chrome Trace Event format.
TraceSessionKind: Category of native runtime activity to include in a trace session.
Transition: A transition applied between navigation stack changes.
TrayIconEvent: Events that can occur on a system tray icon.
TrayMenuItem: A menu item for a system tray context menu.
UpdateStatus: The current state of the auto-updater.
Visibility: The value of the visibility property, similar to the CSS property visibility
VisualCaptureNextAction: Recommended next implementation action for visual capture handoffs.
VisualCaptureRequest: Unit of work covered by a checked visual capture handoff.
WebViewBackend: Concrete embedded-browser backend selected for the current build/runtime.
WebViewCapability: One operation in Kael’s portable WebView contract.
WebViewDownloadPolicy: Controls whether a WebView download should proceed and where it should save.
WebViewDragDropEvent: A file drag/drop event delivered to a WebView island.
WebViewDragDropPolicy: Controls whether a WebView drag/drop event should reach browser defaults.
WebViewEditCommand: Browser edit command for hosted inputs and editable documents.
WebViewMediaCommand: Selector-scoped browser media command for WebViewController::media_command.
WebViewNewWindowPolicy: Controls how a WebView should handle window.open and target-blank requests.
WebViewPageLoadEvent: Page loading lifecycle event for an embedded WebView.
WebViewPermissionDecision: App decision for both native WebView permission policy and JavaScript permission preflighting.
WebViewPermissionFrame: Frame context attached to a native WebView permission request.
WebViewPermissionKind: Permission category requested by the native embedded-browser engine.
WebViewPermissionOriginSource: How accurately a native WebView backend identified the permission origin.
WebViewStopFindAction: Action to perform when stopping an active WebView find session.
WebViewStorageArea: Browser Web Storage area selected by WebView storage helpers.
WhiteSpace: How to handle whitespace in text
WindowAppearance: The appearance of the window, as defined by the operating system.
WindowBackgroundAppearance: The appearance of the background of the window itself, when there is no content or the content is transparent.
WindowBounds: Represents the status of how a window should be opened.
WindowCaptureError: A typed failure returned when exporting the rendered window scene.
WindowChromeCommandKind: Window-manager/custom-chrome command for native desktop frameless windows.
WindowCloseBehavior: How the application should behave when all windows are closed.
WindowContentProtectionMode: Desired capture/privacy behavior for a native window.
WindowControlArea: A type of window control area that corresponds to the platform window.
WindowDecorations: A type to describe the appearance of a window
WindowIntentKind: High-level intent for a native window.
WindowInteractionCommandKind: Window-level interaction command for native desktop window show/hide/focus flows.
WindowKind: The kind of window to create
WindowManagementNextAction: Next action for a checked native window-management handoff.
WindowManagementRequest: Checked request inside an Electron-style window-management handoff.
WindowPosition: A semantic window position for positioning windows relative to the screen.
WindowPresentationMode: Desired presentation behavior for a native window.
WindowSystemUiCommandKind: Native system-UI command for platform window affordances.
WindowTabCommandKind: Native window-tab command for document and workspace window management.
WorkspaceOpenNextAction: Next action for an opened set of app-owned paths.

Constants§

AUTO_SCROLL_STEP_PX: Distance to auto-scroll when dragging near an edge, in pixels per frame.
AUTO_SCROLL_THRESHOLD_PX: Edge band, in pixels, within which a drag triggers auto-scrolling.
KEYSTROKE_PARSE_EXPECTED_MESSAGE: Sentence explaining what keystroke parser expects, starting with “Expected …”
LOADING_DELAY: The delay before showing the loading state.
MAX_GRADIENT_STOPS: Number of gradient color stops the GPU pipeline carries per background.
SHUTDOWN_TIMEOUT: The duration for which futures returned from Context::on_app_quit can run before the application fully quits.

Traits§

Action: Actions are used to implement keyboard-driven UI. When you declare an action, you can bind keys to the action in the keymap and listeners for that action in the element tree.
Along: A trait for accessing the given unit along a certain axis.
AnimationExt: An extension trait for adding the animation wrapper to both Elements and Components
AppContext: The context trait, allows the different contexts in GPUI to be used interchangeably for certain operations.
AsKeystroke: This is a helper trait so that we can simplify the implementation of some functions
Asset: A trait for asynchronous asset loading.
AssetSource: A source of assets for this app to use.
BorrowAppContext: A helper trait for auto-implementing certain methods on contexts that can be used interchangeably.
Element: Implemented by types that participate in laying out and painting the contents of a window. Elements form a tree and are laid out according to web-based layout rules, as implemented by Taffy. You can create custom elements by implementing this trait, see the module-level documentation for more details.
EntityInputHandler: Implement this trait to allow views to handle textual input when implementing an editor, field, etc.
EventEmitter: A trait for tying together the types of a GPUI entity and the events it can emit.
Flatten: A flatten equivalent for anyhow Results.
Focusable: Focusable allows users of your view to easily focus it (using window.focus_view(cx, view))
FutureExt: Extensions for Future types that provide additional combinators and utilities.
Global: A marker trait for types that can be stored in GPUI’s global state.
Half: Provides a trait for types that can calculate half of their value.
ImageCache: An object that can handle the caching and unloading of images. Implementations of this trait should ensure that images are removed from all windows when they are no longer needed.
ImageCacheProvider: An object that can create an ImageCache during the render phase. See the ImageCache trait for more information.
InputEvent: An event from a platform input source.
InputHandler: Kael’s interface for handling text input from the platform’s IME system This is currently a 1:1 exposure of the NSTextInputClient API:
InputMask: A hook that can normalize a text edit before it is committed.
InteractiveElement: A trait for elements that want to use the standard GPUI event handlers that don’t require any state.
IntoElement: Implemented by any type that can be converted into an element.
IsEmpty: Reports whether a refinement contains any effective changes.
IsZero: A trait for checking if a value is zero.
KeyEvent: A key event from the platform.
ListDelegate: Supplies item counts, estimated heights, and item rendering for a RecyclingList.
ManagedView: ManagedView is a view (like a Modal, Popover, Menu, etc.) where the lifecycle of the view is handled by another view.
MouseEvent: A mouse event from the platform.
Negate: Provides a trait for types that can negate their values.
ParentElement: This is a helper trait to provide a uniform interface for constructing elements that can accept any number of any kind of child elements
PlatformDisplay: A handle to a platform’s display, e.g. a monitor or laptop screen.
PlatformInstaller: Trait for platform-specific update installation.
PlatformKeyboardLayout: A trait for platform-specific keyboard layouts
PlatformKeyboardMapper: A trait for platform-specific keyboard mappings
Prompt: A prompt that can be rendered in the window.
ReadGlobal: A trait for reading a global value from the context.
Refineable: A trait for types that can be refined with partial updates.
Render: An object that can be drawn to the screen. This is the trait that distinguishes “views” from other entities. Views are Entity’s which impl Render and drawn to the screen.
RenderOnce: You can derive IntoElement on any type that implements this trait. It is used to construct reusable components out of plain data. Think of components as a recipe for a certain pattern of elements. RenderOnce allows you to invoke this pattern, without breaking the fluent builder pattern of the element APIs.
ScreenCaptureSource: A source of on-screen video content that can be captured.
ScreenCaptureStream: A video stream captured from a screen.
SortableDelegate: Supplies item rendering and reorder behavior for a SortableList.
StatefulInteractiveElement: A trait for elements that want to use the standard GPUI interactivity features that require state.
Styled: A trait for elements that can be styled. Use this to opt-in to a utility CSS-like styling API.
StyledImage: Style an image element.
TooltipContent: Accepted content sources for tooltips on interactive elements.
TransitionAnimator: Renders a custom navigation transition.
UniformListDecoration: A decoration for a UniformList. This can be used for various things, such as rendering indent guides, or other visual effects.
UpdateGlobal: A trait for updating a global value in the context.
VisualContext: This trait is used for the different visual contexts in GPUI that require a window to be present.

Functions§

alert: Construct a semantic alert container.
anchored: anchored gives you an element that will avoid overflowing the window bounds. Its children should have no margin to avoid measurement issues.
apply_clip_mask_bgra: Apply a coverage mask to a tightly-packed 8-bit BGRA (or RGBA) pixel buffer in place, scaling each pixel’s alpha by its mask value. The visual effect is a clip: content is kept where the mask is 1.0 and cut where it is 0.0, with anti-aliased edges in between. mask is row-major with one entry per pixel; extra pixels are left untouched.
apply_reorder: Moves the item at from to to within items, clamping to into range.
auto: Returns a Length representing an automatic length.
auto_scroll_distance: Returns the per-frame auto-scroll distance for a drag at position within bounds: negative near the top edge, positive near the bottom, zero in the middle. Shared so every sortable list auto-scrolls with the same feel.
background_executor: Returns a background executor for the current platform.
black: Pure black in Hsla
blue: The color blue in Hsla
bounds: Create a bounds with the given origin and size
button: Construct a button primitive with caller-owned visuals.
cached: Reuses a child subtree’s previous prepaint and paint output until one of its tracked entities changes.
canvas: Construct a canvas element.
canvas_with_prepaint: Construct a canvas element from explicit prepaint and paint closures.
capture_crash_report: Capture a CrashReport from the current panic information.
checkbox: Construct a controlled checkbox form control.
clip_path: Clip a child subtree to an arbitrary ClipShape (circle, ellipse, or convex polygon).
combine_highlights: Combine and merge the highlights and ranges in the two iterators.
conic_gradient: Creates a conic (sweep) gradient background.
date_picker: Construct a controlled popup-backed date picker.
deferred: Builds a Deferred element, which delays the layout and paint of its child.
dialog: Construct a semantic dialog container.
disclosure: Construct a controlled disclosure primitive.
div: Construct a new Div element
effect_layer: Wraps a child subtree and applies CSS-style filter effects to it by rendering the subtree to an offscreen tile and compositing it with a gaussian content blur and/or a drop shadow that follows the subtree’s actual silhouette.
fallback_prompt_renderer: Use this function in conjunction with App::set_prompt_builder to force GPUI to always use the fallback prompt renderer.
fill: Creates a filled quad with the given bounds and background color.
font: Get a Font for a given name.
generate_list_of_all_registered_actions: Generate a list of all the registered actions. Useful for transforming the list of available actions into a format suited for static analysis such as in validating keymaps, or generating documentation.
green: The color green in Hsla
guess_compositor: Return which compositor we’re guessing we’ll use. Does not attempt to connect to the given compositor
hash: Use a quick, non-cryptographically secure hash function to get an identifier from data
hsla: Construct an Hsla object from plain values
icon: Create a built-in icon element from the generated icon atlas.
image_cache: An image cache element, all its child img elements will use the cache specified by this element. Note that this could as simple as passing an Entity<T: ImageCache>
img: Create a new image element.
is_no_action: Returns whether or not this action represents a removed key binding.
label: Construct a label primitive.
linear_color_stop: Creates a new linear color stop.
linear_gradient: Creates a LinearGradient background color.
link: Construct a semantic hyperlink primitive.
list: Construct a new list element
lottie: Create a Lottie animation element.
lru: Constructs a bounded LRU image cache (holding at most max_images decoded images) keyed to the element state for the given ID.
menu: Construct a semantic menu container.
menu_button: Construct a menu button primitive backed by an anchored popup menu.
menu_item: Construct a semantic menu item primitive.
modal: Construct a controlled modal primitive.
multi_stop_linear_gradient: Creates a linear gradient. The GPU pipeline carries 4 stops; longer stop lists are resampled to 4 with the first and last stops preserved.
navigator: Creates a navigator initialized with a single route.
opaque_grey: Opaque grey in Hsla, values will be clamped to the range [0, 1]
outline: Creates a rectangle outline with the given bounds, border color, and a 1px border width
pane: Construct a semantic pane container.
parse_update_feed: Parse an update feed, auto-detecting Sparkle appcast XML vs JSON format.
pattern_slash: Creates a hash pattern background
percentage: Generate a Radian from a percentage of a full circle.
phi: Returns the Golden Ratio, i.e. ~(1.0 + sqrt(5.0)) / 2.0.
point: Constructs a new Point<T> with the given x and y coordinates.
popover: Construct a controlled anchored popover primitive.
progress: Construct a progress indicator from the current value.
px: Constructs a Pixels value representing a length in pixels.
quad: Creates a quad with the given parameters.
radial_gradient: Creates a radial gradient background.
radians: Create a Radian from a raw value
radio_group: Construct a controlled radio group from a current value and labeled options.
recycling_list: Lazily render a heterogeneous list with estimated heights for off-screen items.
red: The color red in Hsla
relative: Constructs a DefiniteLength representing a relative fraction of a parent size.
rems: Constructs a Rems value representing a length in rems.
reorder_target: Translates a drag from a source item to an insertion slot into the final (from, to) index pair, or None when the move is a no-op or out of range.
retain_all: Constructs a retain-all image cache that uses the element state associated with the given ID.
rgb: Convert an RGB hex color code number to a color type
rgba: Convert an RGBA hex color code number to Rgba
rich_text: Creates a rich text element that supports styled spans, inline elements, and selection.
scroll_bar: Construct a scroll bar primitive bound to a scroll handle.
select: Construct a controlled combo box from the current value and labeled options.
send_activate_to_existing: Send an activation message to an already-running instance of the application.
separator: Construct a semantic separator primitive.
size: Constructs a new Size<T> with the provided width and height.
slider: Construct a controlled slider form control.
solid_background: Creates a solid background color.
sortable_auto_scroll_class: Coarse auto-scroll class for a drag position inside list bounds.
sortable_list: Creates a list with built-in internal drag-and-drop reordering.
sortable_reorder_plan: Build a content-safe reorder plan from a source item and insertion slot.
splitter: Construct a controlled splitter primitive for resizable panes.
stroke: Construct a stroke with the default cap and join settings.
surface: Create a new surface element.
svg: Create a new SVG element.
tabs: Construct a controlled tabs primitive.
text_input: Construct an editable text field.
toggle: Construct a controlled toggle switch form control.
toolbar: Construct a semantic toolbar container.
transparent_black: Transparent black in Hsla
transparent_white: Transparent white in Hsla
tree: Construct a semantic tree container.
tree_item: Construct a semantic tree item primitive.
try_background_executor: Attempts to create a background executor without panicking if platform initialization fails.
uniform_list: uniform_list provides lazy rendering for a set of items that are of uniform height. When rendered into a container with overflow-y: hidden and a fixed (or max) height, uniform_list will only render the visible subset of items.
webview: Creates a WebView element backed by the platform’s native embedded web content view.
webview_bridge_script: JavaScript helper injected into a WebView island for bridge messaging.
webview_clipboard_event_bridge_script: Build a script that forwards browser copy/cut/paste clipboard events.
webview_console_bridge_script: Build a script that forwards page console output through window.kael.
webview_context_menu_bridge_script: Build a script that forwards browser contextmenu events through window.kael.
webview_controller: Creates a controller for a WebView element with the given identifier.
webview_dialog_bridge_script: Build a script that forwards browser dialogs and beforeunload prompts.
webview_favicon_bridge_script: Build a script that forwards favicon candidate changes through window.kael.
webview_file: Creates a WebView element from a local HTML/document file.
webview_file_input_bridge_script: Build a script that forwards browser file-input selections through window.kael.
webview_file_url: Build a file:// URL for a local WebView document.
webview_file_with_options: Creates a local-file WebView with a reusable option bundle.
webview_form_bridge_script: Build a script that forwards browser form activity through window.kael.
webview_html: Creates a WebView element from an inline HTML document.
webview_html_url: Build a data: URL for an inline HTML document.
webview_html_with_options: Creates an inline HTML WebView with a reusable option bundle.
webview_keyboard_bridge_script: Build a script that forwards browser keyboard/input events through window.kael.
webview_lifecycle_bridge_script: Build a script that forwards browser lifecycle/focus events through window.kael.
webview_location_bridge_script: Build a script that forwards same-document location changes through window.kael.
webview_media_event_bridge_script: Build a script that forwards browser media element events through window.kael.
webview_navigation_state_bridge_script: JavaScript helper that tracks same-document navigation stack state.
webview_network_bridge_script: Build a script that forwards fetch and XMLHttpRequest outcomes.
webview_permission_bridge_script: Build a script that preflights browser permission requests through Kael.
webview_pointer_bridge_script: Build a script that forwards browser pointer context through window.kael.
webview_resource_bridge_script: Build a script that forwards browser resource timing and load/error activity.
webview_scroll_bridge_script: Build a script that forwards browser scroll/viewport snapshots through window.kael.
webview_selection_bridge_script: Build a script that forwards browser selection snapshots through window.kael.
webview_storage_bridge_script: Build a script that forwards Web Storage changes from hosted content.
webview_with_options: Creates a WebView element with a reusable option bundle.
white: Pure white in Hsla
write_crash_report: Write a crash report JSON file to the given directory.
yellow: The color yellow in Hsla

Type Aliases§

AlignSelf: Used to control how the specified nodes is aligned. Overrides the parent Node’s AlignItems property. For Flexbox it controls alignment in the cross axis For Grid it controls alignment in the block axis
ImageLoadingTask: An image loading task associated with an image cache.
ImgResourceLoader: A type alias to the resource loader that the img() element uses.
InspectorRenderer: Function set on App to render the inspector UI.
JustifyContent: Sets the distribution of space between and around content items For Flexbox it controls alignment in the main axis For Grid it controls alignment in the inline axis
JustifyItems: Used to control how child nodes are aligned. Does not apply to Flexbox, and will be ignored if specified on a flex container For Grid it controls alignment in the inline axis
JustifySelf: Used to control how the specified nodes is aligned. Overrides the parent Node’s JustifyItems property. Does not apply to Flexbox, and will be ignored if specified on a flex child For Grid it controls alignment in the inline axis
LottieResourceLoader: A type alias to the resource loader that the lottie() element uses.
Result: Result<T, Error>
Transform: Alias for euclid::default::Transform2D<f32>

Attribute Macros§

test: #[kael::test] annotates test functions that run with Kael support.

Derive Macros§

Action: Derives Kael’s Action protocol implementation for a concrete type.
AppContext: Derives AppContext for a type that holds a &mut App.
IntoElement: Derives IntoElement for a type that implements RenderOnce.
Refineable: Generates a partial-update type and Refineable implementation for a named struct.
VisualContext: Derives VisualContext for an AppContext that also holds a &mut Window.

Crate kael

Crate kael Copy item path

§kael

§Start here

§Optional features

Re-exports§

Modules§

Macros§

Structs§

Enums§

Constants§

Traits§

Functions§

Type Aliases§

Attribute Macros§

Derive Macros§

Crate kael