Skip to main content

ferroui_designer/
lib.rs

1//! Reusable native workspace for editing FerroUI XAML.
2//!
3//! [`DesignerSession`] is the UI-thread transaction boundary used by source editing,
4//! visual tools and automation. [`DesignerWorkspace`] is an optional embeddable view
5//! of that session. Neither starts a window, server or background transport.
6mod affine_manipulation;
7mod animation_runtime;
8mod animation_session;
9mod asset_toolbox;
10mod chrome;
11mod canvas_guides;
12mod canvas_guide_overlay;
13mod canvas_guides_editor;
14mod collaboration;
15mod component_browser;
16mod component_session;
17mod definition_manipulation;
18mod definition_projection;
19mod definition_session;
20mod design_time;
21mod native_types;
22mod design_time_samples;
23mod editors;
24mod element_names;
25mod focus_order;
26mod focus_order_editor;
27mod grid_track_editor;
28mod icons;
29mod interaction_session;
30mod layer_state;
31mod layout_helper_renderer;
32mod preview_environment;
33mod preview_host;
34mod preview_prototype;
35mod preview_prototype_editor;
36mod preview_prototype_player;
37mod preview_prototype_view;
38#[cfg(test)]
39mod preview_prototype_ui_tests;
40mod preview_stages;
41mod preview_stage_export;
42mod preview_stage_matrix;
43mod preview_stage_matrix_editor;
44#[cfg(test)]
45mod preview_stage_matrix_ui_tests;
46mod preview_stage_scenarios;
47mod preview_stage_editor;
48mod preview_stage_view;
49mod preview_source;
50mod property_color_editor;
51mod property_controls;
52mod property_inspector_view;
53mod property_literals;
54mod property_transfer;
55mod property_transfer_editor;
56mod resource_editor;
57mod runtime;
58mod selection_layout;
59mod session;
60pub mod sharing;
61mod surface;
62mod timeline_lane;
63mod viewport;
64mod workspace;
65
66pub use asset_toolbox::{
67    AssetIcon, AssetToolbox, AssetViewMode, DesignerAsset, default_designer_assets,
68};
69pub use chrome::designer_chrome_style;
70pub use canvas_guides::{CanvasGuide, CanvasGuideAxis, CanvasGuideSettings};
71pub use canvas_guides_editor::CanvasGuidesEditor;
72pub use workspace::{CanvasGuideEditSnapshot, CanvasGuideViewSnapshot};
73pub use component_browser::{ComponentLibrary, ComponentLibraryFilter, ComponentLibraryItem};
74pub use component_session::ComponentEditPreview;
75pub use definition_projection::{DefinitionPreviewOptions, DefinitionScope};
76pub use design_time::{
77    DesignTimeEdit, DesignTimeEditor, DesignTimeEditorModel, DesignTimeProperty,
78    DesignTimeSnapshot, plan_design_time_edits,
79};
80pub use editors::{
81    PropertyBindingDraft, PropertyBindingEditor, PropertyBindingOption, PropertyBindingSource,
82    PropertyEditorContext, PropertyEditorFactory, PropertyEditorKind, PropertyEditorMetadata,
83    PropertyLiteralValidator, PropertyObjectDraft, PropertyResourceChoice, PropertyValueCommit,
84    PropertyValueEdit, PropertyValueSource, PropertyVectorEditor, binding_expression,
85    create_property_editor, resolve_property_editor_metadata,
86};
87pub use ferroui_designer_core::{Document, Edit, NodeId};
88pub use element_names::plan_element_names;
89pub use ferroui_designer_tools as tools;
90pub use focus_order::{
91    FocusLabelAssociation, FocusLabelTarget, FocusOrderCatalog, FocusOrderEdit, FocusOrderItem,
92    FocusOrderScope, FocusOrderSnapshot, navigation_mode_name,
93};
94pub use focus_order_editor::FocusOrderEditor;
95pub use grid_track_editor::GridTrackEditor;
96pub use layer_state::{LayerCommand, LayerEditSnapshot, LayerState, LayerViewSnapshot};
97pub use preview_environment::{
98    PREVIEW_SIZE_PRESETS, PreviewEnvironment, PreviewEnvironmentEditor, PreviewFlowDirection,
99    PreviewSizePreset, PreviewTheme,
100};
101pub use preview_host::{
102    PreviewFactory, PreviewHostOptions, PreviewRequest, ResourcePreviewFactory,
103};
104pub use preview_prototype::{
105    PreviewPrototype, PreviewPrototypeAction, PreviewPrototypeActionManifest, PreviewPrototypeFlow,
106    PreviewPrototypeFlowManifest, PreviewPrototypeLink, PreviewPrototypeLinkManifest,
107    PreviewPrototypeManifest, PreviewPrototypeOverlay, PreviewPrototypeOverlayOptions,
108    PreviewPrototypeOverlayPlacement, PreviewPrototypeSession, MAX_PREVIEW_PROTOTYPE_FLOWS,
109    MAX_PREVIEW_PROTOTYPE_HISTORY, MAX_PREVIEW_PROTOTYPE_LINKS, MAX_PREVIEW_PROTOTYPE_OVERLAYS,
110    MAX_PREVIEW_PROTOTYPE_OVERLAY_OFFSET,
111};
112pub use preview_prototype_editor::{
113    PreviewPrototypeElementChoice, PreviewPrototypeFlowEditor, PreviewPrototypeLinkEditor,
114};
115pub use preview_prototype_player::{
116    PreviewPrototypeHotspot, PreviewPrototypePlayerAction, PreviewPrototypePlayerLayer,
117    PreviewPrototypePlayerView,
118};
119pub use preview_prototype_view::{PreviewPrototypeView, PreviewPrototypeViewAction};
120pub use preview_stages::{
121    MAX_PREVIEW_STAGES, PreviewSourceAnchor, PreviewSourceSegment, PreviewStageBoard,
122    PreviewStageConfiguration, PreviewStageId, PreviewStageInfo, PreviewStageManifest,
123    PreviewStageLayout, PreviewStageSize, PreviewStageMode, PreviewStageSelection, PreviewStageSelectionToken, PreviewStageSnapshot,
124    PreviewStageSource, PreviewStageState, PreviewStageStatus, PreviewStageTarget,
125};
126pub use preview_stage_editor::PreviewStageEditor;
127pub use preview_stage_export::{
128    capture_preview_stage_png, PreviewStageExportOptions, PreviewStageImage,
129    MAX_PREVIEW_STAGE_EXPORT_BYTES, MAX_PREVIEW_STAGE_EXPORT_PIXELS,
130};
131pub use preview_stage_matrix::{PreviewStageMatrix, PreviewStageMatrixSize, PreviewStageStateAxis};
132pub use preview_stage_matrix_editor::PreviewStageMatrixEditor;
133pub use preview_stage_view::{PreviewStageAction, PreviewStageComparison, PreviewStageView};
134pub use property_color_editor::PropertyColorEditor;
135pub use property_controls::{
136    PropertyComponentsEditor, PropertyComponentsKind, PropertyNumberOptions,
137    PropertyNumberScrubber, property_value_data_format,
138};
139pub use property_inspector_view::{
140    PropertyInspectorFilter, PropertyInspectorSort, PropertyInspectorView,
141};
142pub use property_transfer::{
143    CopiedProperty, CopiedPropertyKind, PropertyClipboard, PropertyPasteChange,
144    PropertyPastePreview, PropertyTransferIssue,
145};
146pub use property_transfer_editor::PropertyTransferEditor;
147pub use resource_editor::{
148    DefinitionCreationKind, DefinitionEditorCommand, DefinitionPreviewSettings,
149    DefinitionPropertyField, DefinitionReference, ResourceDefinitionEditor,
150    ResourceDefinitionModel,
151};
152pub use runtime::{PreviewStatus, RuntimeNode};
153pub use selection_layout::{LayoutMatch, LayoutReset};
154pub use session::DesignerSession;
155pub use surface::{DesignGesture, DesignSurface};
156pub use timeline_lane::{EasingPreview, TimelineLane};
157pub use viewport::{CanvasViewport, CanvasWheelMode};
158pub use workspace::shell::{NavigationPane, WorkspaceViewMode};
159pub use workspace::{
160    CanvasLayerChoice, CanvasSelectionSnapshot, DesignerDefinitionAsset, DesignerWorkspace,
161    OutlineCommand, OutlineMode, PreviewPrototypePlaybackInfo,
162};
163
164/// The self-contained example opened by Designer Studio and usable by hosts.
165pub const STARTER_XAML: &str = include_str!("Starter.xaml");
166
167#[cfg(test)]
168mod layer_state_tests;
169#[cfg(test)]
170mod native_extensions_tests;
171#[cfg(test)]
172mod tests;
173#[cfg(test)]
174mod workspace_authoring_tests;
175mod workspace_layout_helpers;
176#[cfg(test)]
177mod workspace_shell_tests;
178#[cfg(test)]
179mod workspace_navigation_tests;
180#[cfg(test)]
181mod workspace_guides_tests;
182#[cfg(test)]
183mod workspace_navigation_file_tests;
184mod workspace_tools;
185
186pub use layout_helper_renderer::{
187    DragVisualGhost, LayoutHelperRenderState, hit_test_layout_handle, hover_layout_handle,
188    render_layout_helpers, render_layout_helpers_with_state, render_manipulation_metrics,
189};
190pub use workspace_layout_helpers::{LayoutEditPreview, LayoutHelperSnapshot};
191
192#[cfg(feature = "mcp")]
193pub mod mcp;
194
195#[cfg(all(test, feature = "render-smoke"))]
196mod render_tests;
197
198#[cfg(test)]
199mod animation_integration_tests;