orbital-macros 0.1.2

Proc macros for Orbital component documentation and routing helpers
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
80
81
82

# 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.

```rust
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):**

```toml
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:**

```toml
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.