ferro_json_ui/
lib.rs

1//! # Ferro JSON-UI
2//!
3//! JSON-based server-driven UI schema types for the Ferro framework.
4//!
5//! This crate defines the v2 `Spec` foundation: a flat, ID-keyed element map
6//! with parse-time structural validation. Typed `*Props` structs describe
7//! per-component prop shape and feed the Phase 117 catalog via `JsonSchema`.
8//!
9//! ## Schema Structure
10//!
11//! A JSON-UI Spec consists of:
12//! - **Spec** - Top-level container: `$schema`, `root`, `elements`, `title?`, `layout?`, `data?`
13//! - **Element** - Single UI node: `type` (string), `props` (Value), `children` (`Vec<String>` of IDs), `action?`, `visible?`
14//! - **Actions** - Handler references with confirmations and outcomes
15//! - **Visibility** - Conditional rendering based on data conditions
16//!
17//! ## Example
18//!
19//! ```rust
20//! use ferro_json_ui::{Spec, Element};
21//!
22//! let spec = Spec::builder()
23//!     .title("Demo")
24//!     .element("root", Element::new("Text").prop("content", "Hi"))
25//!     .build()
26//!     .unwrap();
27//! ```
28
29pub mod action;
30pub mod assets;
31pub mod catalog;
32pub mod component;
33pub mod config;
34pub mod data;
35pub mod design;
36pub mod expression;
37pub mod layout;
38pub mod loader;
39pub mod plugin;
40pub mod plugins;
41pub mod render;
42pub mod resolve;
43pub mod spec;
44pub mod visibility;
45
46pub mod runtime;
47
48pub use action::{Action, ActionOutcome, ConfirmDialog, HttpMethod};
49pub use assets::FERRO_BASE_CSS;
50pub use component::{
51    ActionCardProps, ActionGroupProps, ActionItem, AlertProps, AvatarProps, BadgeProps,
52    BreadcrumbItem, BreadcrumbProps, ButtonGroupProps, ButtonProps, ButtonType, CardAppearance,
53    CardProps, CheckboxListProps, CheckboxProps, ChecklistItem, ChecklistProps, CollapsibleProps,
54    Column, ColumnFormat, DataTableProps, DescriptionItem, DescriptionListProps,
55    DropdownMenuAction, EmptyStateProps, FormMaxWidth, FormProps, FormSectionProps, GapSize,
56    GridProps, HeaderProps, IconPosition, ImageProps, InputProps, InputType, KanbanBoardProps,
57    KanbanColumnProps, ModalProps, NotificationDropdownProps, NotificationItem, Orientation,
58    PageHeaderProps, PaginationProps, ProductTileProps, ProgressProps, RawHtmlProps,
59    RichTextEditorProps, SegmentedControlProps, SegmentedItem, SelectOption, SelectProps,
60    SeparatorProps, SidebarGroup, SidebarLayoutItem, SidebarLayoutProps, SidebarNavItem,
61    SidebarProps, Size, SkeletonProps, SortDirection, StatCardProps, SwitchProps, Tab, TableProps,
62    TabsProps, TextElement, TextProps, ToastProps, Tone, Variant,
63};
64pub use config::JsonUiConfig;
65pub use design::{lint, rules, DesignMeta, DesignRule, Finding, Severity, KNOWN_INTENTS};
66pub use runtime::FERRO_RUNTIME_JS;
67// resolve_path and resolve_path_string are pub(crate) — internal render pipeline helpers
68pub use layout::{
69    register_layout, render_layout, DashboardLayout, DashboardLayoutConfig, Layout, LayoutContext,
70    LayoutRegistry, NavItem, SidebarSection,
71};
72// AppLayout, AuthLayout, DefaultLayout are pub in layout.rs but not user-facing — users select
73// layouts by name string ("dashboard", "app", "auth"), not by struct.
74// navigation, sidebar, footer, global_registry are framework-internal.
75pub use catalog::{global_catalog, Catalog, CatalogError, ComponentSpec};
76pub use expression::resolve_expressions;
77pub use loader::{load_cached, LoadError};
78pub use plugin::{
79    collect_plugin_assets, global_plugin_registry, register_plugin, registered_plugin_types,
80    with_plugin, Asset, CollectedAssets, JsonUiPlugin, PluginRegistry,
81};
82pub use plugins::{register_built_in_plugins, MapPlugin, RichTextEditorPlugin};
83pub use render::{render_spec_to_html, render_spec_to_html_with_plugins, RenderResult};
84pub use resolve::{
85    expand_directives, resolve_actions, resolve_actions_strict, resolve_errors, resolve_errors_all,
86};
87pub use spec::{
88    DataRef, Element, ElementBuilder, Spec, SpecBuilder, SpecError, TitleBinding,
89    MAX_NESTING_DEPTH, SCHEMA_VERSION,
90};
91pub use visibility::{Visibility, VisibilityCondition, VisibilityOperator};
92
93#[cfg(feature = "projections")]
94pub mod projection;
95
96#[cfg(feature = "projections")]
97pub use projection::{JsonUiRenderer, ProjectionError, RenderMode, VisualContext};
ferro_json_ui/lib.rs

ferro_json_ui/
lib.rs
