dioxus-element-plug 0.1.2

Element UI theme-chalk components for Dioxus applications with built-in SCSS support
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370

# Dioxus Element Plug

<a href="https://github.com/pauljohn21/dioxus-element-plug">
  <img src="https://img.shields.io/github/stars/pauljohn21/dioxus-element-plug?style=social" alt="GitHub stars">
  <img src="https://img.shields.io/github/forks/pauljohn21/dioxus-element-plug?style=social" alt="GitHub forks">
  <img src="https://img.shields.io/github/issues/pauljohn21/dioxus-element-plug" alt="GitHub issues">
  <img src="https://img.shields.io/github/license/pauljohn21/dioxus-element-plug" alt="GitHub license">
</a>

Element UI theme-chalk components for Dioxus applications with built-in SCSS support.

<a href="https://crates.io/crates/dioxus-element-plug">
  <img src="https://img.shields.io/crates/v/dioxus-element-plug.svg" alt="Crates.io version">
  <img src="https://img.shields.io/crates/d/dioxus-element-plug.svg" alt="Crates.io downloads">
  <img src="https://img.shields.io/crates/l/dioxus-element-plug.svg" alt="Crates.io license">
</a>

<a href="https://docs.rs/dioxus-element-plug">
  <img src="https://docs.rs/dioxus-element-plug/badge.svg" alt="Documentation">
</a>

This crate provides a set of UI components styled with the popular Element UI theme-chalk CSS framework, designed specifically for use with the Dioxus framework. **Hosted on GitHub: [pauljohn21/dioxus-element-plug](https://github.com/pauljohn21/dioxus-element-plug)**

## Features

- ๐ŸŽจ **Complete Element UI styling** - All components use authentic theme-chalk CSS
- ๐Ÿฆ€ **Rust-native components** - Type-safe components built for Dioxus 0.7
- ๐Ÿ“ฆ **Ready to use** - Components work out of the box with proper styling
- ๐ŸŽฏ **Consistent API** - Intuitive props and events matching Dioxus patterns
- ๐Ÿ“ฑ **Responsive design** - Mobile-friendly components with flexible grid system
- ๐Ÿ”ง **Active Development** - Regular updates and community contributions
- ๐ŸŽจ **SCSS Support** - Built-in SCSS compilation and theme customization

## Quick Start

### 1. Add to your Cargo.toml

For local development:
```toml
[dependencies]
dioxus-element-plug = { path = "../dioxus-element-plug" }
```

For production use (once published to crates.io):
```toml
[dependencies]
dioxus-element-plug = "0.1.0"
```

Or use directly from GitHub:
```toml
dioxus-element-plug = { git = "https://github.com/pauljohn21/dioxus-element-plug.git" }
```

### 2. Use Built-in SCSS Support

With Dioxus Element Plug, CSS compilation is built-in using manganis. No external tools needed!

```rust
use manganis::asset;

static STYLES: Asset = asset!("/assets/theme-chalk.scss");
```

ๆŸฅ็œ‹ [`examples/with-scss-asset/`](examples/with-scss-asset/) ็คบไพ‹ไบ†่งฃๅฎŒๆ•ด็”จๆณ•ใ€‚

#### ๆ–นๅผไบŒ๏ผšไผ ็ปŸๅค–้ƒจ็ผ–่ฏ‘ๆ–นๅผ (ๆŽจ่็”จไบŽ็Žฐๆœ‰้กน็›ฎ)
ไฝฟ็”จไผ ็ปŸ็š„ Sass ็ผ–่ฏ‘ๅ™จ่ฟ›่กŒๆž„ๅปบ๏ผš

```bash
cd dioxus-element-plug
make setup    # Install dependencies (Node.js + Sass compiler)
make build-css # Compile SCSS to CSS
```

**ๅ…ณไบŽ Dioxus 0.7 ็š„ๆ ทๅผๆ”ฏๆŒ่ฏดๆ˜Ž๏ผš**
- ๐ŸŽ‰ **Dioxus 0.7 ๆ”ฏๆŒๅ†…็ฝฎ SCSS ็ผ–่ฏ‘** (้€š่ฟ‡ manganis asset ๅฎ)
- ไผ ็ปŸ็š„ๅค–้ƒจ Sass ็ผ–่ฏ‘ๅ™จๆ–นๅผไป็„ถๅฏ็”จ
- ไธค็งๆ–นๅผ้ƒฝๆ”ฏๆŒ๏ผŒๅผ€ๅ‘่€…ๅฏไปฅๆ นๆฎ้กน็›ฎ้œ€ๆฑ‚้€‰ๆ‹ฉ

### 3. Add CSS to your HTML

Add this to your `index.html`:

```html
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link rel="stylesheet" href="/dist/theme-chalk.css">
</head>
<body>
    <div id="main"></div>
</body>
</html>
```

### 4. Use the components

```rust
use dioxus::prelude::*;
use dioxus_element_plug::prelude::*;

fn App() -> Element {
    rsx! {
        Container {
            Header {
                h1 { "My App" }
            }
            Main {
                Row {
                    Col { span: Some(12) {
                        h2 { "Welcome!" }
                        Button {
                            variant: ButtonVariant::Primary,
                            "Click me!",
                        }
                        Input {
                            placeholder: "Enter text...",
                            size: Some(InputSize::Medium),
                        }
                    }}
                }
            }
        }
    }
}
```

## Available Components

### Layout
- `Container` - Main container wrapper
- `Header` - Page header
- `Aside` - Sidebar
- `Main` - Main content area
- `Footer` - Page footer
- `Row`/`Col` - Grid system

### Form Controls
- `Button` - Various button styles and sizes
- `Input` - Text inputs with validation
- `SearchInput` - Search input with icon
- `PasswordInput` - Password input with toggle

### Soon to come
- Forms (Checkbox, Radio, Select)
- Navigation (Menu, Tabs, Breadcrumb)
- Feedback (Alert, Message, Notification)
- Data Display (Table, Card, List)

## Component Examples

### Buttons

```rust
use dioxus_element_plug::components::button::*;

rsx! {
    div {
        Button { variant: ButtonVariant::Primary, "Primary" }
        Button { variant: ButtonVariant::Success, "Success" }
        Button { variant: ButtonVariant::Warning, "Warning" }
        Button { variant: ButtonVariant::Danger, "Danger" }
        OutlineButton { variant: ButtonVariant::Info, "Info Outline" }
        TextButton { "Text Button" }
    }
}
```

### Input

```rust
use dioxus_element_plug::components::input::*;

rsx! {
    div {
        Input {
            placeholder: "Enter your name",
            size: Some(InputSize::Large),
            on_input: move |evt| println!("Input: {}", evt.value()),
        }
        PasswordInput {
            placeholder: "Password",
            clearable: true,
        }
        SearchInput {
            placeholder: "Search...",
            prefix_icon: Some("el-icon-search".to_string()),
        }
    }
}
```

### Layout Grid

```rust
use dioxus_element_plug::components::layout::*;

rsx! {
    Container {
        Header { height: 60 {
            h1 { "My App" }
        }}
        Main {
            Row { gutter: Some(20) {
                Col { span: Some(8) {
                    p { "Column 1" }
                }}
                Col { span: Some(8) {
                    p { "Column 2" }
                }}
                Col { span: Some(8) {
                    p { "Column 3" }
                }}
            }}
        }
        Footer { height: 60 {
            p { "Footer" }
        }}
    }
}
```

## Building CSS

The theme CSS needs to be compiled from SCSS:

### Prerequisites
- Node.js 16+
- npm or yarn

### Setup and Build

```bash
# Setup (installs sass compiler)
make setup

# Build CSS
make build-css

# Watch for changes during development
make watch-css

# Full build (Rust + CSS)
make build
```

## Development

### Project Structure

```
dioxus-theme-chalk/
โ”œโ”€โ”€ src/               # Rust component library
โ”‚   โ”œโ”€โ”€ components/    # UI components
โ”‚   โ””โ”€โ”€ theme.rs       # Theme constants
โ”œโ”€โ”€ build.rs           # Build script
โ”œโ”€โ”€ Cargo.toml         # Rust dependencies
โ”œโ”€โ”€ Makefile          # Build automation
โ”œโ”€โ”€ README.md         # Documentation
โ””โ”€โ”€ example/          # Example app (coming soon)
```

### Working with SCSS

The original SCSS files are in the parent `src/` directory. The Makefile compiles them to the `dist/` directory.

To watch for changes while developing:

```bash
# Terminal 1: Watch Rust code
cargo watch -x run

# Terminal 2: Watch SCSS changes
make watch-css
```

## Theming

This library uses the exact same CSS classes and variables as Element UI. You can customize the theme by:

1. **Override CSS variables** in your custom CSS
2. **Modify the SCSS source** before building
3. **Use custom classes** via the `class` prop on components

### CSS Variables

Key variables you can override:

```css
:root {
    --el-color-primary: #409eff;
    --el-font-size-base: 14px;
    --el-border-radius-base: 4px;
    /* ... */
}
```

## License

MIT License - see LICENSE file for details.

## Contributing

We welcome contributions from the community! Please feel free to submit issues and pull requests on our [GitHub repository](https://github.com/pauljohn21/dioxus-element-plug).

### Development Setup

1. **Fork the repository** on [GitHub](https://github.com/pauljohn21/dioxus-element-plug/fork)
2. **Clone your fork**:
   ```bash
   git clone https://github.com/YOUR_USERNAME/dioxus-element-plug.git
   cd dioxus-element-plug
   ```
3. **Create a feature branch**:
   ```bash
   git checkout -b feature/your-feature-name
   ```
4. **Make your changes** and test locally
5. **Commit with a clear message**:
   ```bash
   git commit -m "feat: add new awesome feature"
   ```
6. **Push and create a Pull Request** on GitHub

### GitHub Workflow
- **Issues**: Report bugs and feature requests [here](https://github.com/pauljohn21/dioxus-element-plug/issues)
- **Pull Requests**: Submit improvements [here](https://github.com/pauljohn21/dioxus-element-plug/pulls)
- **Discussions**: Join conversations [here](https://github.com/pauljohn21/dioxus-element-plug/discussions)

We use conventional commit messages and semantic versioning. Please ensure your code follows the existing style and includes appropriate tests.

## Credits

- [Element UI](https://element.eleme.io/) - Original design system and theme-chalk CSS
- [Dioxus](https://dioxuslabs.com/) - React-like framework for Rust
- [GitHub Contributors](https://github.com/pauljohn21/dioxus-element-plug/graphs/contributors) - Open source community

## License

MIT License - see LICENSE file for details.

## Star History

If you find this project helpful, please consider giving it a โญ on [GitHub](https://github.com/pauljohn21/dioxus-element-plug)!

---

**Ready to level up your Dioxus apps with beautiful Element UI styling? Start building today!** ๐Ÿš€

---

### Project Status

This project is actively maintained on GitHub. Check out our:
- ๐Ÿ“ˆ [Project Insights](https://github.com/pauljohn21/dioxus-element-plug/pulse)
- ๐Ÿ—๏ธ [Automated Builds](https://github.com/pauljohn21/dioxus-element-plug/actions)
- ๐Ÿ“Š [Code Quality](https://github.com/pauljohn21/dioxus-element-plug/graphs/contributors)
- ๐Ÿ”„ [Release Notes](https://github.com/pauljohn21/dioxus-element-plug/releases)

### Join the Community

- ๐Ÿ’ฌ [GitHub Discussions](https://github.com/pauljohn21/dioxus-element-plug/discussions)
- ๐Ÿ› [Issue Tracker](https://github.com/pauljohn21/dioxus-element-plug/issues)
- ๐ŸŒŸ [Star the Repository](https://github.com/pauljohn21/dioxus-element-plug)
- ๐Ÿด [Fork for Your Projects](https://github.com/pauljohn21/dioxus-element-plug/fork)

**Together, we're building the future of Dioxus UI development!** ๐ŸŽ‰