teksilo-preview 0.9.0

Storybook-style preview registry for Teksilo widgets — catalog trait, typed knobs and variants, with no GUI dependency.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

// SPDX-License-Identifier: MPL-2.0
// SPDX-FileCopyrightText: 2026 FernTech

//! Trait + types + registry for Teksilo's widget previewer
//! infrastructure.
//!
//! This crate is **framework-side, UI-free**: it defines the
//! `WidgetCatalog` trait, the `KnobSpec` / `KnobValues` types, and the
//! `inventory`-backed registry. The 3-pane previewer GUI lives in the
//! sibling [`teksilo-preview-ui`](../teksilo_preview_ui/index.html) crate;
//! per-application binaries (`teksilo-widgets-previewer`, etc.) link the
//! two together along with their own widget set.
//!
//! # Authoring a catalog impl
//!
//! ```ignore
//! use teksilo_preview::{
//!     register_widget_catalog, KnobSpec, KnobValues, PreviewVariant,
//!     KnobOverrides, WidgetCatalog,
//! };
//! use teksilo_core::widget::Widget;
//! use my_widgets::Button;
//!
//! impl WidgetCatalog for Button {
//!     fn id() -> &'static str { "button" }
//!     fn group() -> &'static str { "Controls" }
//!     fn display_name() -> &'static str { "Button" }
//!     fn knobs() -> KnobSpec {
//!         KnobSpec::new()
//!             .text("label", "Label", "Click me")
//!             .bool_("disabled", "Disabled", false)
//!     }
//!     fn variants() -> Vec<PreviewVariant> {
//!         vec![
//!             PreviewVariant::defaults("default"),
//!             PreviewVariant::knobs("disabled",
//!                 KnobOverrides::new().bool_("disabled", true)),
//!         ]
//!     }
//!     fn build(_variant: &str, knobs: &KnobValues) -> Box<dyn Widget> {
//!         let label = knobs.text("label").get();
//!         Box::new(Button::new(label).enabled(!knobs.bool_("disabled").get()))
//!     }
//! }
//! register_widget_catalog!(Button);
//! ```

mod builder_props;
mod catalog;
mod doc_snippet;
mod knob;
mod registry;
mod source_loc;
mod variant;

pub use builder_props::builder_property_groups;
pub use catalog::{CatalogEntry, SlottedChild, WidgetCatalog, WidgetCategory};
pub use doc_snippet::{DocSnippet, iter_doc_snippets};
pub use knob::{EnumInfo, KnobDecl, KnobKind, KnobOverrides, KnobSpec, KnobValue, KnobValues};
pub use registry::{entries_by_group, find_by_file, find_by_id, iter_entries};
pub use source_loc::SourceLoc;
pub use teksilo_core::widget_id::WidgetId;
pub use variant::{PreviewVariant, ScenarioBuilder};

// Internal re-exports used by the `register_widget_catalog!` macro.
// Hidden from the public API; exposed only because the macro must
// reference these symbols through the crate path.
#[doc(hidden)]
pub mod __widget {
    pub use teksilo_core::widget::Widget;
}

#[doc(hidden)]
pub mod __widget_id {
    pub use teksilo_core::widget_id::WidgetId;
}

#[doc(hidden)]
pub use inventory as __inventory;