leptos_styling 0.3.1

A powerful styling solution for Leptos applications that enables seamless integration of CSS and SCSS stylesheets with type-safe class names and zero runtime overhead.
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
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

# Leptos Styling

[![Crates.io](https://img.shields.io/crates/v/leptos_styling.svg)](https://crates.io/crates/leptos_styling)
[![docs.rs](https://docs.rs/leptos_styling/badge.svg)](https://docs.rs/leptos_styling/)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

Leptos Styling is a powerful styling solution for [Leptos](https://github.com/leptos-rs/leptos) applications that enables seamless integration of CSS and SCSS stylesheets. It intelligently manages stylesheet embedding in both SSR (Server-Side Rendering) and CSR (Client-Side Rendering) modes.

This crate internally uses [turf](https://docs.rs/turf/) macros for efficient CSS processing and management.

## Features

- **CSS/SCSS Support**: Write your styles in CSS or SCSS and import them directly into your components
- **Smart Bundling**: Automatically handles stylesheet embedding based on your rendering mode (SSR/CSR)
- **Type-Safe Classes**: Generate type-safe CSS class names to prevent runtime errors
- **Zero Runtime Overhead**: All processing happens at compile time
- **Framework Integration**: Seamless integration with Axum and other web frameworks

## Installation

Add the following to your `Cargo.toml`:

```toml
[dependencies]
leptos_styling = "0.3.0"

[features]
ssr = ["leptos_styling/ssr"]
```

## Quick Start

### Define Your Styles

```rust
use leptos::prelude::*;
use leptos_styling::{style_sheet, inline_style_sheet};

// Import from external CSS file
style_sheet!(green_button, "src/green_button.css", "green_button");

// Or define styles inline
inline_style_sheet! {red_button, "red_button",
    .button {
        background-color: red;
        padding: 8px 16px;
        border-radius: 4px;
    }
}
```

### Use in Components

```rust
#[component]
pub fn MyButtons() -> impl IntoView {
    view! {
        <div>
            <button class=green_button::BUTTON>"Green Button"</button>
            <button class=red_button::BUTTON>"Red Button"</button>
        </div>
    }
}
```

## Setup

### Client-Side Setup(CSR)

```rust
#[cfg(feature = "hydrate")]
#[wasm_bindgen::prelude::wasm_bindgen]
pub fn hydrate() {
    // Initialize styling system
    leptos_styling::init();

    // Mount your app
    leptos::mount::hydrate_body(App);
}
```

### Client-Side Setup (SSR)
No special setup is required. Stylesheets are registered and managed automatically.

### Server-Side Setup(SSR)

```rust
async fn main() {
    let leptos_options = get_configuration(None).unwrap().leptos_options;

    // Generate stylesheets (Required for SSR)
    generate_style_sheets(leptos_options.clone());

    let app = Router::new()
        .leptos_routes(&leptos_options, routes, move || {
            provide_meta_context();
            view! { <App/> }
        });

    // Start your server...
}
```

### App Integration

```rust
#[component]
pub fn App() -> impl IntoView {
    provide_meta_context();

    view! {
        <Html attr:lang="en"/>
        <StyleSheets/> // Include this to inject styles
        <Router>
            // Your routes here
        </Router>
    }
}
```

## Feature Flags

| Flag      | Description                                      |
|-----------|--------------------------------------------------|
| `ssr`     | Enable server-side rendering support              |
| `csr`     | Enable client-side rendering support              |

## Version Compatibility

| Leptos Styling | Leptos Version |
|----------------|----------------|
| 0.2.x - 0.3.x  | 0.8            |
| 0.1.x          | 0.7            |

## Documentation

- [API Documentation](https://docs.rs/leptos_styling/)
- [Examples](./examples)

## Contributing

We welcome contributions!

## License

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

## Acknowledgements

- [Leptos](https://github.com/leptos-rs/leptos) - The web framework
- [turf](https://docs.rs/turf/) - CSS processing macros