Skip to main content

functora_egui/
lib.rs

1//! functora-egui: shadcn/ui-inspired widgets for egui.
2//!
3//! Feature flags (see `Cargo.toml`):
4//! - `platform`: cross-platform bridge (web/wasm, Android JNI, desktop)
5//! - `clipboard`: clipboard read/write plus paste/clear input widgets
6//! - `files`: file picking, downloads, blob previews, QR scanner widget
7//! - `runtime`: async task spawning (`spawn_async`, worker)
8//! - `storage`: persistent key-value storage
9//! - `crypto`, `zip`, `package`: re-exported functora-core crypto/archive APIs
10//! - `html-markdown`, `thumbnail`, `qr`: re-exported functora-core APIs
11//! - `web`, `android`, `build`: platform runners, templates and codegen
12//! - `images`: image loaders and bundled sample fixtures
13//! - `images-remote`: opt-in `file://` and `http(s)://` image loaders
14//! - `camera`: camera capture APIs (module itself is gated on `platform`)
15//! - `markdown`: markdown rendering (`markdown_view`, data-URL loader)
16//! - `markdown-fetch`: opt-in remote image loading inside rendered markdown
17
18#[cfg(any(feature = "android", feature = "build"))]
19pub mod android;
20#[cfg(feature = "build")]
21pub mod build;
22#[cfg(feature = "platform")]
23pub mod camera;
24pub mod cast;
25#[cfg(any(feature = "desktop", feature = "build"))]
26pub mod desktop;
27pub mod frame;
28#[cfg(feature = "platform")]
29pub use camera::{
30    FrameData, begin_capture_session, capture_frame, check_camera, sleep, start_camera,
31    stop_camera, stop_capture_worker,
32};
33#[cfg(feature = "clipboard")]
34pub mod clipboard;
35#[cfg(any(
36    feature = "web",
37    feature = "android",
38    feature = "desktop",
39    feature = "build"
40))]
41pub mod config;
42pub mod deep_link;
43#[cfg(feature = "files")]
44pub mod download;
45pub mod error;
46#[cfg(feature = "files")]
47pub mod files;
48pub mod paste_image;
49
50#[cfg(feature = "files")]
51pub use files::BlobMemo;
52#[cfg(feature = "files")]
53pub use files::CancelToken;
54#[cfg(feature = "files")]
55pub use files::PickResult;
56#[cfg(feature = "files")]
57pub use files::cancel;
58#[cfg(feature = "files")]
59pub use files::data_url_mime;
60#[cfg(feature = "files")]
61pub use files::is_cancelled;
62#[cfg(feature = "files")]
63pub use files::mime_for_name;
64#[cfg(feature = "files")]
65pub use files::new_cancel_token;
66#[cfg(feature = "files")]
67pub use files::pick_files;
68#[cfg(feature = "files")]
69pub use files::pick_files_with_cancel;
70#[cfg(feature = "files")]
71pub use files::pick_files_with_progress;
72#[cfg(feature = "files")]
73pub use files::pick_files_with_shared_progress;
74#[cfg(feature = "files")]
75pub use files::preview_blob;
76#[cfg(feature = "files")]
77pub use files::revoke_blob_url;
78#[cfg(all(feature = "files", feature = "thumbnail"))]
79pub use files::video_thumbnail;
80
81#[cfg(any(feature = "android", feature = "desktop", feature = "build"))]
82pub mod icon_export;
83pub mod icons;
84#[cfg(feature = "images")]
85pub mod image_samples;
86pub mod layout;
87pub mod nav;
88pub mod paint;
89pub mod platform;
90pub mod poll;
91pub mod progress;
92pub mod pwa;
93pub use pwa::{InstallHint, PwaInstallOutcome, install_hint, trigger_pwa_install};
94pub mod responsive;
95pub mod route;
96#[cfg(feature = "clipboard")]
97pub mod share;
98#[cfg(feature = "storage")]
99pub mod storage;
100#[cfg(feature = "storage")]
101pub use storage::Persistent;
102#[cfg(feature = "storage")]
103pub use storage::{Storage, files_dir_for};
104pub mod text;
105pub mod theme;
106pub mod theme_extra;
107pub mod tokens;
108pub mod utils;
109#[cfg(feature = "runtime")]
110pub use utils::spawn_async;
111#[cfg(any(feature = "web", feature = "build"))]
112pub mod web;
113pub mod widgets;
114pub mod worker;
115
116#[cfg(feature = "crypto")]
117pub mod crypto {
118    pub use functora_core::crypto::*;
119}
120pub mod encoding {
121    pub use functora_core::encoding::*;
122}
123pub mod i18n {
124    pub use functora_core::i18n::*;
125}
126pub mod language;
127#[cfg(feature = "html-markdown")]
128pub mod markdown {
129    pub use functora_core::markdown::*;
130}
131#[cfg(feature = "markdown")]
132pub mod markdown_loader;
133#[cfg(feature = "markdown")]
134pub mod markdown_view;
135#[cfg(feature = "markdown")]
136pub use egui_commonmark::{CommonMarkCache, CommonMarkViewer};
137#[cfg(feature = "markdown")]
138pub use markdown_loader::{WasmSafeDataUrlLoader, install_data_url_loader};
139pub mod messages {
140    pub use functora_core::messages::*;
141}
142#[cfg(feature = "thumbnail")]
143pub mod thumbnail {
144    pub use functora_core::thumbnail::*;
145}
146#[cfg(feature = "package")]
147pub mod package;
148pub mod white_label;
149#[cfg(feature = "zip")]
150pub mod zip;
151#[cfg(feature = "qr")]
152pub mod qr {
153    pub use functora_core::qr::*;
154}
155pub mod in_flight;
156pub mod state;
157
158pub use responsive::breakpoint::Breakpoint;
159pub use responsive::responsive_ext::ResponsiveExt;
160pub use responsive::spacing::Spacing;
161
162pub use layout::shell::Shell;
163pub use layout::shell::initial_sidebar_collapsed;
164pub use layout::shell::sidebar_effective_width;
165pub use platform::android_back::BackOutcome;
166pub use platform::android_back::{handle_system_back, is_back_pressed};
167pub use poll::{PollOutcome, poll_channel};
168pub use widgets::navbar::widget::Navbar;
169
170pub use egui_flex::FlexAlign;
171pub use egui_flex::FlexItem;
172pub use egui_flex::FlexJustify;
173pub use icons::lucide_icon::LucideIcon;
174pub use icons::paint_icon::paint_icon;
175pub use icons::paint_icon::paint_icon_svg;
176#[cfg(feature = "images")]
177pub use image_samples::{ImageBytes, ImageSamples, ImageType, image_samples};
178pub use in_flight::{InFlight, InFlightGuard};
179pub use layout::center::center;
180pub use layout::flex::Flex;
181pub use layout::flex_instance::FlexInst;
182pub use nav::NavHistory;
183pub use progress::JobGuard;
184pub use progress::{claim_job, clear_progress, report, report_progress, report_progress_named};
185pub use route::AppRouter;
186pub use route::BreadcrumbPosition;
187pub use route::BreadcrumbSegment;
188pub use route::COMPONENT_PARAM;
189pub use route::ROOT_PATH;
190pub use route::Routable;
191pub use route::RouteKind;
192pub use route::RouteMetadata;
193pub use route::SCREEN_PARAM;
194pub use route::breadcrumbs_for;
195pub use route::{history_push, history_replace};
196pub use state::PersistentState;
197pub use text::Wrap;
198pub use theme::setup_fonts::setup_fonts;
199pub use theme::setup_image_loaders::setup_image_loaders;
200pub use theme::shadcn_theme::ShadcnTheme;
201pub use theme::shadcn_theme_ext::ShadcnThemeExt;
202pub use theme_extra::{default_theme, detect_system_theme, detect_system_theme_wasm};
203pub use tokens::alert_variant::AlertVariant;
204pub use tokens::badge_variant::BadgeVariant;
205pub use tokens::button_variant::ButtonVariant;
206pub use tokens::component_size::ComponentSize;
207pub use tokens::item_variant::ItemVariant;
208pub use tokens::sheet_side::SheetSide;
209pub use tokens::toast_variant::ToastVariant;
210pub use tokens::toggle_variant::ToggleVariant;
211pub use tokens::typography_variant::TypographyVariant;
212pub use widgets::accordion::widget::Accordion;
213pub use widgets::alert::widget::Alert;
214pub use widgets::alert_dialog::alert_dialog_show::AlertDialogResult;
215pub use widgets::alert_dialog::widget::AlertDialog;
216pub use widgets::area_chart::widget::AreaChart;
217pub use widgets::area_chart::widget::AreaSeries;
218pub use widgets::aspect_ratio::widget::AspectRatio;
219pub use widgets::avatar::widget::Avatar;
220pub use widgets::badge::widget::Badge;
221pub use widgets::blocking_overlay::widget::BlockingOverlay;
222pub use widgets::breadcrumb::{Breadcrumb, NavAction};
223pub use widgets::button::widget::Button;
224pub use widgets::button_group::widget::ButtonGroup;
225pub use widgets::button_group::widget::ButtonGroupPosition;
226pub use widgets::calendar::widget::Calendar;
227#[cfg(feature = "platform")]
228pub use widgets::camera_view::camera_view_state::CameraViewState;
229#[cfg(feature = "platform")]
230pub use widgets::camera_view::widget::CameraView;
231pub use widgets::card::widget::Card;
232pub use widgets::carousel::widget::Carousel;
233pub use widgets::checkbox::widget::Checkbox;
234pub use widgets::code_snippet::{snippet, snippet_break_long_words};
235pub use widgets::collapsible::widget::Collapsible;
236pub use widgets::color_swatch::widget::ColorSwatch;
237pub use widgets::combobox::widget::Combobox;
238pub use widgets::combobox::widget::ComboboxValue;
239pub use widgets::command::widget::{Command, CommandItem, CommandValue};
240pub use widgets::context_menu::widget::ContextMenu;
241pub use widgets::date_picker::date_picker_state::DatePickerState;
242pub use widgets::date_picker::widget::DatePicker;
243pub use widgets::dialog::widget::Dialog;
244pub use widgets::dropdown_menu::widget::DropdownMenu;
245pub use widgets::dropdown_menu::widget::MenuItem;
246pub use widgets::empty::widget::Empty;
247pub use widgets::field::field_description::FieldDescription;
248pub use widgets::field::field_group::FieldGroup;
249pub use widgets::field::field_legend::FieldLegend;
250pub use widgets::field::field_set::FieldSet;
251pub use widgets::footer::widget::Footer;
252pub use widgets::hover_card::widget::HoverCard;
253pub use widgets::hyperlink::widget::Hyperlink;
254pub use widgets::hypertext::widget::Hypertext;
255pub use widgets::hypertext::widget::Segment;
256pub use widgets::input::widget::Input;
257pub use widgets::input_group::widget::InputGroup;
258pub use widgets::input_otp::widget::InputOtp;
259#[cfg(feature = "clipboard")]
260pub use widgets::input_paste_clear::input_paste_clear_show::PasteClearResponse as InputPasteClearResponse;
261#[cfg(feature = "clipboard")]
262pub use widgets::input_paste_clear::widget::InputPasteClear;
263pub use widgets::item::widget::Item;
264pub use widgets::kbd::widget::Kbd;
265pub use widgets::label::widget::Label;
266pub use widgets::menubar::widget::Menubar;
267pub use widgets::navigation_menu::widget::NavigationMenu;
268pub use widgets::navigation_menu::widget::NavigationMenuValue;
269pub use widgets::number_input::widget::NumberInput;
270pub use widgets::pagination::widget::Pagination;
271pub use widgets::popover::widget::Popover;
272pub use widgets::progress::widget::Progress;
273pub use widgets::property_grid::property_row::PropertyRow;
274pub use widgets::property_grid::widget::PropertyGrid;
275pub use widgets::qr_image::widget::QrImage;
276#[cfg(feature = "files")]
277pub use widgets::qr_scanner::qr_scanner_state::QrScannerState;
278#[cfg(feature = "files")]
279pub use widgets::qr_scanner::widget::QrScanner;
280pub use widgets::radio::widget::Radio;
281pub use widgets::radio_group::widget::RadioGroup;
282pub use widgets::radio_group::widget::RadioGroupLabeled;
283pub use widgets::resizable::widget::Resizable;
284pub use widgets::scroll_area::widget::ScrollArea;
285pub use widgets::select::widget::Select;
286pub use widgets::select::widget::SelectLabeled;
287pub use widgets::select::widget::SelectValue;
288pub use widgets::select::widget::SelectValueLabeled;
289pub use widgets::separator::widget::Separator;
290pub use widgets::sheet::widget::Sheet;
291pub use widgets::sidebar::widget::Sidebar;
292pub use widgets::skeleton::widget::Skeleton;
293pub use widgets::slider::widget::Slider;
294pub use widgets::spinner::widget::Spinner;
295pub use widgets::status_bar::widget::StatusBar;
296pub use widgets::switch::widget::Switch;
297pub use widgets::table::widget::Table;
298pub use widgets::tabs::widget::IconTabs;
299pub use widgets::tabs::widget::IconTabsValue;
300pub use widgets::tabs::widget::TabEntry;
301pub use widgets::tabs::widget::Tabs;
302pub use widgets::tabs::widget::TabsValue;
303pub use widgets::textarea::widget::Textarea;
304#[cfg(feature = "clipboard")]
305pub use widgets::textarea_paste_clear::textarea_paste_clear_show::PasteClearResponse as TextareaPasteClearResponse;
306#[cfg(feature = "clipboard")]
307pub use widgets::textarea_paste_clear::widget::TextareaPasteClear;
308pub use widgets::toast::toast_entry::ToastEntry;
309pub use widgets::toast::toast_state::ToastState;
310pub use widgets::toggle::widget::Toggle;
311pub use widgets::toggle_group::widget::ToggleGroup;
312pub use widgets::toggle_group::widget::ToggleGroupValue;
313pub use widgets::toolbar::widget::Toolbar;
314pub use widgets::tooltip::widget::Tooltip;
315pub use widgets::typography::widget::Typography;
316pub use worker::Reporter;
317pub use worker::run as worker_run;
318
319pub use functora_core::{FUNCTORA_CORE_DATE, FUNCTORA_CORE_YEAR};
320pub use language::{current_language, set_language};
321pub use theme_extra::{Theme, current_theme, set_theme};