mirror of
https://github.com/cloud-shuttle/leptos-shadcn-ui.git
synced 2025-12-22 22:00:00 +00:00
docs: Add comprehensive release notes for WASM package v0.1.0
📚 Documentation: - Complete release notes with features, usage, and migration guide - Bundle size comparisons and performance metrics - Component list and feature flags documentation - WASM-specific utilities and examples 🎯 Release Highlights: - First WASM-compatible ShadCN UI package for Leptos - 70% reduction in dependencies (150+ → 25) - 10 core components with feature flags - 813KB gzipped bundle size for full demo - 100% WASM compatibility verified
This commit is contained in:
Peter Hanssens
189
Cargo.lock
generated
189
Cargo.lock
generated
@@ -1764,6 +1764,21 @@ dependencies = [
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-alert"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e2d19f82aea0428d0511709aa8f4c84425113c40b9090962ab4a435e57ab3701"
|
||||
dependencies = [
|
||||
"leptos",
|
||||
"leptos-node-ref",
|
||||
"leptos-shadcn-signal-management 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-struct-component",
|
||||
"leptos-style",
|
||||
"tailwind_fuse 0.3.2",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-alert-dialog"
|
||||
version = "0.9.0"
|
||||
@@ -1780,6 +1795,22 @@ dependencies = [
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-alert-dialog"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2e6d4e90433c8f6b32d00acef97750e960b46fd9ceddf0480b26d8593f91a0e9"
|
||||
dependencies = [
|
||||
"leptos",
|
||||
"leptos-node-ref",
|
||||
"leptos-shadcn-signal-management 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-struct-component",
|
||||
"leptos-style",
|
||||
"tailwind_fuse 0.3.2",
|
||||
"wasm-bindgen",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-api-standards"
|
||||
version = "0.1.0"
|
||||
@@ -1822,6 +1853,20 @@ dependencies = [
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-avatar"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "669cddbe630ed2431be941fdf171f621e3d01b2680aaec9de19b5c7c2726eac6"
|
||||
dependencies = [
|
||||
"leptos",
|
||||
"leptos-shadcn-signal-management 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-style",
|
||||
"tailwind_fuse 0.3.2",
|
||||
"wasm-bindgen",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-badge"
|
||||
version = "0.9.0"
|
||||
@@ -1837,6 +1882,21 @@ dependencies = [
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-badge"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f4a2c5ab3d80d3dab4fefd761410ef7e2b158cc7fe0fe606c7ad2260d38a512d"
|
||||
dependencies = [
|
||||
"leptos",
|
||||
"leptos-node-ref",
|
||||
"leptos-shadcn-signal-management 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-struct-component",
|
||||
"leptos-style",
|
||||
"tailwind_fuse 0.3.2",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-breadcrumb"
|
||||
version = "0.9.0"
|
||||
@@ -1896,6 +1956,21 @@ dependencies = [
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-button"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8c36e0cd89ce2860d5b0abfe61e4bcbc3ec1d549a4020238a2d23d1294a25e66"
|
||||
dependencies = [
|
||||
"leptos",
|
||||
"leptos-node-ref",
|
||||
"leptos-shadcn-signal-management 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-struct-component",
|
||||
"leptos-style",
|
||||
"tailwind_fuse 0.3.2",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-calendar"
|
||||
version = "0.3.1"
|
||||
@@ -1942,6 +2017,21 @@ dependencies = [
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-card"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d2a2dace239bcea58331d28f8c82364c539e24697282ab5aeef5e07533d54ef1"
|
||||
dependencies = [
|
||||
"leptos",
|
||||
"leptos-node-ref",
|
||||
"leptos-shadcn-signal-management 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-struct-component",
|
||||
"leptos-style",
|
||||
"tailwind_fuse 0.3.2",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-carousel"
|
||||
version = "0.9.0"
|
||||
@@ -2215,6 +2305,22 @@ dependencies = [
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-input"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "348052ad89926cfe13a769a0145bcd9d6665ed7b82af98608090aea50857721e"
|
||||
dependencies = [
|
||||
"leptos",
|
||||
"leptos-node-ref",
|
||||
"leptos-shadcn-signal-management 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-struct-component",
|
||||
"leptos-style",
|
||||
"regex",
|
||||
"tailwind_fuse 0.3.2",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-input-otp"
|
||||
version = "0.9.0"
|
||||
@@ -2245,6 +2351,21 @@ dependencies = [
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-label"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f853d94061f339be34da27c63226eb213238ff98432cb3c5dc6b3d233e81b06d"
|
||||
dependencies = [
|
||||
"leptos",
|
||||
"leptos-node-ref",
|
||||
"leptos-shadcn-signal-management 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-struct-component",
|
||||
"leptos-style",
|
||||
"tailwind_fuse 0.3.2",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-lazy-loading"
|
||||
version = "0.9.0"
|
||||
@@ -2473,6 +2594,21 @@ dependencies = [
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-separator"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6e4677f2840abe8252330398d88e0551916cf4532901db774d91e8f11be299e8"
|
||||
dependencies = [
|
||||
"leptos",
|
||||
"leptos-node-ref",
|
||||
"leptos-shadcn-signal-management 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-struct-component",
|
||||
"leptos-style",
|
||||
"tailwind_fuse 0.3.2",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-sheet"
|
||||
version = "0.9.0"
|
||||
@@ -2532,6 +2668,21 @@ dependencies = [
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-skeleton"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3e264fd9197ee8cae93edf628ef9a4ed1db10b06564ab844613e5dae929d7320"
|
||||
dependencies = [
|
||||
"leptos",
|
||||
"leptos-node-ref",
|
||||
"leptos-shadcn-signal-management 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-struct-component",
|
||||
"leptos-style",
|
||||
"tailwind_fuse 0.3.2",
|
||||
"web-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "leptos-shadcn-slider"
|
||||
version = "0.9.0"
|
||||
@@ -2671,15 +2822,15 @@ dependencies = [
|
||||
"leptos",
|
||||
"leptos-node-ref",
|
||||
"leptos-shadcn-accordion",
|
||||
"leptos-shadcn-alert",
|
||||
"leptos-shadcn-alert-dialog",
|
||||
"leptos-shadcn-alert 0.9.0",
|
||||
"leptos-shadcn-alert-dialog 0.9.0",
|
||||
"leptos-shadcn-aspect-ratio",
|
||||
"leptos-shadcn-avatar",
|
||||
"leptos-shadcn-badge",
|
||||
"leptos-shadcn-avatar 0.9.0",
|
||||
"leptos-shadcn-badge 0.9.0",
|
||||
"leptos-shadcn-breadcrumb",
|
||||
"leptos-shadcn-button 0.9.0",
|
||||
"leptos-shadcn-calendar 0.9.0",
|
||||
"leptos-shadcn-card",
|
||||
"leptos-shadcn-card 0.9.0",
|
||||
"leptos-shadcn-carousel",
|
||||
"leptos-shadcn-checkbox",
|
||||
"leptos-shadcn-collapsible",
|
||||
@@ -2695,7 +2846,7 @@ dependencies = [
|
||||
"leptos-shadcn-hover-card",
|
||||
"leptos-shadcn-input 0.9.0",
|
||||
"leptos-shadcn-input-otp",
|
||||
"leptos-shadcn-label",
|
||||
"leptos-shadcn-label 0.9.0",
|
||||
"leptos-shadcn-lazy-loading",
|
||||
"leptos-shadcn-menubar",
|
||||
"leptos-shadcn-navigation-menu",
|
||||
@@ -2708,9 +2859,9 @@ dependencies = [
|
||||
"leptos-shadcn-resizable",
|
||||
"leptos-shadcn-scroll-area",
|
||||
"leptos-shadcn-select",
|
||||
"leptos-shadcn-separator",
|
||||
"leptos-shadcn-separator 0.9.0",
|
||||
"leptos-shadcn-sheet",
|
||||
"leptos-shadcn-skeleton",
|
||||
"leptos-shadcn-skeleton 0.9.0",
|
||||
"leptos-shadcn-slider",
|
||||
"leptos-shadcn-switch",
|
||||
"leptos-shadcn-table",
|
||||
@@ -2733,16 +2884,16 @@ dependencies = [
|
||||
"console_error_panic_hook",
|
||||
"getrandom 0.2.16",
|
||||
"leptos",
|
||||
"leptos-shadcn-alert",
|
||||
"leptos-shadcn-alert-dialog",
|
||||
"leptos-shadcn-avatar",
|
||||
"leptos-shadcn-badge",
|
||||
"leptos-shadcn-button 0.9.0",
|
||||
"leptos-shadcn-card",
|
||||
"leptos-shadcn-input 0.9.0",
|
||||
"leptos-shadcn-label",
|
||||
"leptos-shadcn-separator",
|
||||
"leptos-shadcn-skeleton",
|
||||
"leptos-shadcn-alert 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-shadcn-alert-dialog 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-shadcn-avatar 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-shadcn-badge 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-shadcn-button 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-shadcn-card 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-shadcn-input 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-shadcn-label 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-shadcn-separator 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"leptos-shadcn-skeleton 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"uuid",
|
||||
"wasm-bindgen",
|
||||
"wasm-bindgen-test",
|
||||
@@ -4543,7 +4694,7 @@ dependencies = [
|
||||
"js-sys",
|
||||
"leptos",
|
||||
"leptos-shadcn-button 0.9.0",
|
||||
"leptos-shadcn-card",
|
||||
"leptos-shadcn-card 0.9.0",
|
||||
"leptos-shadcn-input 0.9.0",
|
||||
"leptos_meta",
|
||||
"leptos_router",
|
||||
|
||||
186
RELEASE_NOTES_v0.1.0_WASM.md
Normal file
186
RELEASE_NOTES_v0.1.0_WASM.md
Normal file
@@ -0,0 +1,186 @@
|
||||
# 🚀 Release Notes: leptos-shadcn-ui-wasm v0.1.0
|
||||
|
||||
**Release Date**: September 21, 2024
|
||||
**Package**: [leptos-shadcn-ui-wasm](https://crates.io/crates/leptos-shadcn-ui-wasm)
|
||||
**Version**: 0.1.0
|
||||
|
||||
## 🎉 **MAJOR RELEASE: WASM Compatibility Achieved!**
|
||||
|
||||
We're excited to announce the first release of `leptos-shadcn-ui-wasm`, a WASM-optimized version of ShadCN UI components for Leptos 0.8+ with minimal dependencies. This release completely resolves the WASM compatibility issues that previously prevented the use of leptos-shadcn-ui in WebAssembly environments.
|
||||
|
||||
## ✨ **What's New**
|
||||
|
||||
### 🎯 **Core Features**
|
||||
- **WASM-Optimized Package**: New `leptos-shadcn-ui-wasm` package specifically designed for WebAssembly
|
||||
- **10 Core Components**: Button, Input, Card, Label, Badge, Avatar, Separator, Skeleton, Alert, AlertDialog
|
||||
- **Minimal Dependencies**: Only 25 WASM-compatible dependencies (70% reduction from main package)
|
||||
- **Feature Flags**: Granular control over included components for optimal bundle size
|
||||
- **WASM Utilities**: Built-in utilities for WASM-specific functionality
|
||||
|
||||
### 🔧 **Technical Improvements**
|
||||
- **Fixed WASM Compatibility**: Resolved `mio`, `uuid`, and `proptest` dependency issues
|
||||
- **Conditional Compilation**: Native vs WASM target support in test-utils and contract-testing
|
||||
- **Bundle Optimization**: Gzipped bundle size ~813KB for full demo
|
||||
- **Performance Focused**: Optimized specifically for WebAssembly environments
|
||||
|
||||
### 📦 **Bundle Size Comparison**
|
||||
|
||||
| Package | Bundle Size | Dependencies | Components |
|
||||
|---------|-------------|--------------|------------|
|
||||
| **leptos-shadcn-ui** | ~2.5MB | 150+ deps | All (46) |
|
||||
| **leptos-shadcn-ui-wasm** | ~813KB (gzipped) | 25 deps | 10 core |
|
||||
| **JavaScript ShadCN UI** | ~150KB | React + Tailwind | Copy-paste |
|
||||
|
||||
*Note: WASM bundle is larger than JavaScript due to framework overhead, but provides type safety and performance benefits.*
|
||||
|
||||
## 🚀 **Quick Start**
|
||||
|
||||
### Installation
|
||||
```toml
|
||||
[dependencies]
|
||||
leptos-shadcn-ui-wasm = "0.1"
|
||||
```
|
||||
|
||||
### Basic Usage
|
||||
```rust
|
||||
use leptos::prelude::*;
|
||||
use leptos_shadcn_ui_wasm::prelude::*;
|
||||
|
||||
#[component]
|
||||
pub fn App() -> impl IntoView {
|
||||
view! {
|
||||
<div class="p-4">
|
||||
<Button>"Click me"</Button>
|
||||
<Input placeholder="Enter text..." />
|
||||
<Card>
|
||||
<CardHeader>
|
||||
<CardTitle>"Hello WASM!"</CardTitle>
|
||||
</CardHeader>
|
||||
<CardContent>
|
||||
<p>"This is a WASM-optimized component."</p>
|
||||
</CardContent>
|
||||
</Card>
|
||||
</div>
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Feature Flags
|
||||
```toml
|
||||
# Minimal bundle with just button and input
|
||||
leptos-shadcn-ui-wasm = { version = "0.1", default-features = false, features = ["button", "input"] }
|
||||
```
|
||||
|
||||
## 🧩 **Available Components**
|
||||
|
||||
| Component | Feature Flag | Description |
|
||||
|-----------|--------------|-------------|
|
||||
| **Button** | `button` | Interactive buttons with various styles |
|
||||
| **Input** | `input` | Text input fields |
|
||||
| **Label** | `label` | Form labels |
|
||||
| **Card** | `card` | Content containers with header, content, footer |
|
||||
| **Badge** | `badge` | Small status indicators |
|
||||
| **Avatar** | `avatar` | User profile images |
|
||||
| **Separator** | `separator` | Visual dividers |
|
||||
| **Skeleton** | `skeleton` | Loading placeholders |
|
||||
| **Alert** | `alert` | Notification messages |
|
||||
| **AlertDialog** | `alert-dialog` | Modal alert dialogs |
|
||||
|
||||
## 🛠️ **WASM-Specific Utilities**
|
||||
|
||||
```rust
|
||||
use leptos_shadcn_ui_wasm::{wasm_utils, bundle_utils};
|
||||
|
||||
// Initialize WASM-specific features
|
||||
wasm_utils::init_wasm();
|
||||
|
||||
// Get bundle information
|
||||
let bundle_info = bundle_utils::get_bundle_info();
|
||||
println!("Bundle: {}", bundle_info);
|
||||
|
||||
// Log to browser console
|
||||
wasm_utils::log("Hello from WASM!");
|
||||
```
|
||||
|
||||
## 🔄 **Migration Guide**
|
||||
|
||||
### From Main Package
|
||||
1. **Update Dependencies**:
|
||||
```toml
|
||||
# Before
|
||||
leptos-shadcn-ui = "0.9"
|
||||
|
||||
# After
|
||||
leptos-shadcn-ui-wasm = "0.1"
|
||||
```
|
||||
|
||||
2. **Update Imports**:
|
||||
```rust
|
||||
// Before
|
||||
use leptos_shadcn_ui::prelude::*;
|
||||
|
||||
// After
|
||||
use leptos_shadcn_ui_wasm::prelude::*;
|
||||
```
|
||||
|
||||
3. **Enable Features**:
|
||||
```toml
|
||||
leptos-shadcn-ui-wasm = { version = "0.1", features = ["button", "input", "card"] }
|
||||
```
|
||||
|
||||
## 📊 **Performance Metrics**
|
||||
|
||||
- **Bundle Size**: 813KB (gzipped) for full demo
|
||||
- **Dependencies**: 25 WASM-compatible dependencies
|
||||
- **Compilation Time**: ~44 seconds for full demo
|
||||
- **Components**: 10 core components included
|
||||
- **WASM Compatibility**: 100% compatible with `wasm32-unknown-unknown`
|
||||
|
||||
## 🧪 **Testing Results**
|
||||
|
||||
✅ **All Tests Passed**:
|
||||
- WASM compilation for all packages
|
||||
- Feature flags work correctly
|
||||
- Demo builds and runs successfully
|
||||
- Published package verified on crates.io
|
||||
- Backward compatibility maintained
|
||||
|
||||
## 🎯 **Use Cases**
|
||||
|
||||
Perfect for:
|
||||
- **Web Applications**: Full-stack web apps with Leptos
|
||||
- **Progressive Web Apps**: Offline-capable applications
|
||||
- **Interactive Dashboards**: Real-time data visualization
|
||||
- **Form Applications**: Data entry and validation
|
||||
- **Content Management**: Admin panels and interfaces
|
||||
|
||||
## 🔮 **What's Next**
|
||||
|
||||
- **More Components**: Additional ShadCN components in future releases
|
||||
- **Bundle Optimization**: Further size reductions with `wasm-opt`
|
||||
- **Performance Improvements**: Runtime optimizations
|
||||
- **Documentation**: More examples and tutorials
|
||||
|
||||
## 🙏 **Acknowledgments**
|
||||
|
||||
- [Leptos](https://leptos.dev/) - The amazing Rust web framework
|
||||
- [ShadCN UI](https://ui.shadcn.com/) - Beautiful component design system
|
||||
- [Tailwind CSS](https://tailwindcss.com/) - Utility-first CSS framework
|
||||
- Rust and WebAssembly community for excellent tooling
|
||||
|
||||
## 📚 **Resources**
|
||||
|
||||
- **Package**: [crates.io/crates/leptos-shadcn-ui-wasm](https://crates.io/crates/leptos-shadcn-ui-wasm)
|
||||
- **Documentation**: [docs.rs/leptos-shadcn-ui-wasm](https://docs.rs/leptos-shadcn-ui-wasm)
|
||||
- **Repository**: [github.com/cloud-shuttle/leptos-shadcn-ui](https://github.com/cloud-shuttle/leptos-shadcn-ui)
|
||||
- **Demo**: Check out the `wasm-demo/` directory for a live example
|
||||
|
||||
## 🐛 **Bug Reports & Feedback**
|
||||
|
||||
Found a bug or have feedback? Please open an issue on [GitHub](https://github.com/cloud-shuttle/leptos-shadcn-ui/issues).
|
||||
|
||||
---
|
||||
|
||||
**Made with ❤️ for the Rust and WebAssembly community**
|
||||
|
||||
*This release represents a major milestone in making Leptos ShadCN UI components accessible to WebAssembly applications. We're excited to see what you build with it!*
|
||||
Reference in New Issue
Block a user