weavetui_derive 0.1.2

Procedural macro for weavetui components.
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

# weavetui_derive

![Crates.io](https://img.shields.io/crates/v/weavetui_derive) ![Docs.rs](https://docs.rs/weavetui_derive/badge.svg)

`weavetui_derive` is the procedural macro companion for the `weavetui` Text User Interface (TUI) framework. It provides the powerful `#[component]` attribute macro, significantly reducing boilerplate code and streamlining the development of `weavetui` components.

## ✨ Features

*   **Automatic Trait Implementation:** Automatically implements `weavetui_core::Component` and `weavetui_core::ComponentAccessor` for your structs, handling the necessary boilerplate.
*   **Declarative Child Management:** Easily define and manage child components directly within your component's attribute, fostering a clear and hierarchical UI structure.
*   **Default Implementations:** Provides sensible default implementations for component methods, allowing you to focus on custom logic.
*   **Reduced Boilerplate:** Drastically cuts down on repetitive code, making component creation faster and less error-prone.

## 🚀 Getting Started

To use the `#[component]` macro in your `weavetui` project, add `weavetui_derive` as a dependency in your `Cargo.toml`:

```toml
[dependencies]
weavetui_derive = { version = "0.1.1" } # Or specify a path/git dependency for development
```

## 📚 Usage

Apply the `#[component]` attribute to your struct definitions. The macro will automatically generate the necessary trait implementations. A practical example of its usage can be found in the `counter_app.rs` example within the main `weavetui` repository.

### Basic Component

```rust
use weavetui_derive::component;

#[component(default)]
struct MySimpleComponent {
    // Your component's fields
}

// MySimpleComponent now implements weavetui_core::Component and weavetui_core::ComponentAccessor
```

### Component with Children

You can declare child components directly within the `#[component]` attribute. The macro will automatically create a `children` field (if not present) and initialize the specified children.

```rust
use weavetui_derive::component;
use weavetui_core::Component; // This import might not be strictly necessary for the example, but good for context

#[component(default)]
struct HeaderComponent;

#[component(default)]
struct FooterComponent;

#[component(default)]
struct ButtonComponent;

#[component(default, children(
    "header" => HeaderComponent,
    "footer" => FooterComponent,
    "button_area" => ButtonComponent,
))]
struct ParentComponent {
    title: String,
}

// ParentComponent will have a `children` field (BTreeMap<String, Box<dyn weavetui_core::Component>>)
// initialized with instances of HeaderComponent, FooterComponent, and ButtonComponent.
```

## 🤝 Contributing

We welcome contributions to `weavetui_derive`! Please refer to the main `weavetui` project's [CONTRIBUTING.md](../../CONTRIBUTING.md) for detailed guidelines on how to get involved, report issues, and submit pull requests.

## 📄 License

This project is licensed under the MIT License. See the [LICENSE](../../LICENSE) file for details.