Orbital Macros

Proc macros for Orbital design-system documentation and routing helpers.

Macros (this crate)

#[component_doc]

Extracts component documentation and optional preview registration metadata.

use orbital_macros::component_doc;

#[component_doc(
    category = "Layout",
    preview_slug = "flex",
    preview_label = "Flex",
)]
#[component]
pub fn Flex(/* ... */) -> impl IntoView { /* ... */ }

#[component_doc(
    category = "Surfaces",
    group = "Card",
    preview_slug = "card-header",
    preview_label = "Card Header",
)]
#[component]
pub fn CardHeader(/* ... */) -> impl IntoView { /* ... */ }

#[component_doc(
    section = "Getting Started",
    nav_item = true,
    preview_slug = "theme",
    preview_label = "Theme",
)]
#[component]
pub fn ThemePreview(/* ... */) -> impl IntoView { /* ... */ }

Nav metadata fields: section, section_priority, category, category_priority, category_default_collapsed, group, group_priority, nav_item. Defaults for section/category/group ordering live in category_defaults.rs.

Consumer feature flags

Component crates expose a preview feature. When it is disabled (the default on orbital-core-components):

• #[component_doc] passes the component through without emitting doc/preview tokens.
• Preview-only deps (inventory, pulldown-cmark) are not required.

When preview is enabled, the macro emits doc constants, props metadata, preview wrapper components, and PreviewRegistration entries for the catalog.

Production app (components only):

orbital-core-components = { path = "../orbital-core-components", default-features = false }
# or via the facade:
orbital-ui = { path = "../orbital", package = "orbital-ui", default-features = false, features = ["hydrate"] }

Preview app / maintainer workflows:

orbital-ui = { path = "../orbital", package = "orbital-ui", features = ["preview", "hydrate"] }
# or per crate:
orbital-core-components = { path = "../orbital-core-components", features = ["preview"] }

Note: hydrate and ssr on several Orbital crates currently enable preview as well. Use default-features = false and enable only the features you need if you want hydrate without the preview catalog.

orbital_routes!

Include multiple route components inside <Routes>.

#[orbital_routes_extract]

Generate a typed paths module from a route component's view! tree.