Bytemalte/mcalc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs/design: new design by BYTEMALTE and Docs

Browse Source
This commit is contained in:
Bytemalte
2026-03-20 09:47:46 +00:00
parent 491b91967f
commit c7e11644dd
6 changed files with 364 additions and 371 deletions
Download Patch File Download Diff File Expand all files Collapse all files

327
AGENTS.md
View File

@@ -1,265 +1,136 @@
You are an expert [0.7 Dioxus](https://dioxuslabs.com/learn/0.7) assistant. Dioxus 0.7 changes every api in dioxus. Only use this up to date documentation. `cx`, `Scope`, and `use_state` are gone
# MCALC Agent Guidelines
Provide concise code examples with detailed descriptions
## Project Overview
# Dioxus Dependency
A simple Dioxus calculator application. Uses Dioxus 0.7 for UI with static CSS styling.
You can add Dioxus to your `Cargo.toml` like this:
## Build Commands
```toml
[dependencies]
dioxus = { version = "0.7.1" }
```bash
# Development
cargo run # Run desktop app (default feature)
cargo run --features web # Run web version
[features]
default = ["web", "webview", "server"]
web = ["dioxus/web"]
webview = ["dioxus/desktop"]
server = ["dioxus/server"]
# Build
cargo build # Debug build
cargo build --release # Release build
# Testing
cargo test # Run all tests
cargo test <test_name> # Run specific test
# Linting & Formatting
cargo fmt # Format code
cargo fmt -- --check # Check formatting without changes
cargo clippy # Run linter
cargo clippy -- -D warnings # Lint with deny warnings
```
# Launching your application
## Code Style
You need to create a main function that sets up the Dioxus runtime and mounts your root component.
### Formatting
- Use `cargo fmt` with default rustfmt settings
- 4-space indentation
- Maximum line length: 100 characters
```rust
use dioxus::prelude::*;
### Naming Conventions
- Components: PascalCase (e.g., `Calculator`, `DisplayArea`)
- Functions/Methods: snake_case (e.g., `calculate_result`, `input_digit`)
- Signals: snake_case with `_` suffix convention (e.g., `first_num`, `operator`)
- Types/Enums: PascalCase
fn main() {
dioxus::launch(App);
}
### Imports
- Group 1: `use dioxus::prelude::*` (Dioxus core)
- Group 2: `use crate::` (local modules)
- Standard library imports last
#[component]
fn App() -> Element {
rsx! { "Hello, Dioxus!" }
}
```
Then serve with `dx serve`:
```sh
curl -sSL http://dioxus.dev/install.sh | sh
dx serve
```
# UI with RSX
```rust
rsx! {
div {
class: "container", // Attribute
color: "red", // Inline styles
width: if condition { "100%" }, // Conditional attributes
"Hello, Dioxus!"
}
// Prefer loops over iterators
for i in 0..5 {
div { "{i}" } // use elements or components directly in loops
}
if condition {
div { "Condition is true!" } // use elements or components directly in conditionals
}
{children} // Expressions are wrapped in brace
{(0..5).map(|i| rsx! { span { "Item {i}" } })} // Iterators must be wrapped in braces
}
```
# Assets
The asset macro can be used to link to local files to use in your project. All links start with `/` and are relative to the root of your project.
```rust
rsx! {
img {
src: asset!("/assets/image.png"),
alt: "An image",
}
}
```
## Styles
The `document::Stylesheet` component will inject the stylesheet into the `<head>` of the document
```rust
rsx! {
document::Stylesheet {
href: asset!("/assets/styles.css"),
}
}
```
# Components
Components are the building blocks of apps
* Component are functions annotated with the `#[component]` macro.
* The function name must start with a capital letter or contain an underscore.
* A component re-renders only under two conditions:
1. Its props change (as determined by `PartialEq`).
2. An internal reactive state it depends on is updated.
### Components (Dioxus 0.7)
- Prefix with `#[allow(non_snake_case)]` if needed
- Props must be owned values (use `String` not `&str`)
- Use `Signal<T>` for reactive state
- Components return `Element`
```rust
#[component]
fn Input(mut value: Signal<String>) -> Element {
rsx! {
input {
value,
oninput: move |e| {
*value.write() = e.value();
},
onkeydown: move |e| {
if e.key() == Key::Enter {
value.write().clear();
}
},
}
}
fn MyComponent(mut value: Signal<String>) -> Element {
rsx! { div { "{value}" } }
}
```
Each component accepts function arguments (props)
### State Management
- Use `use_signal(|| initial_value)` for local state
- Use `.write()` for mutable access, `.read()` for references
- Prefer `*signal.write() = value` over `signal.set(value)` for direct mutation
* Props must be owned values, not references. Use `String` and `Vec<T>` instead of `&str` or `&[T]`.
* Props must implement `PartialEq` and `Clone`.
* To make props reactive and copy, you can wrap the type in `ReadOnlySignal`. Any reactive state like memos and resources that read `ReadOnlySignal` props will automatically re-run when the prop changes.
### Error Handling
- Prefer early returns with `return` or `?` operator
- Use `Result<T, E>` for fallible operations
- Silent failures acceptable for user input parsing (graceful degradation)
# State
### CSS Guidelines
- CSS files in `/assets/main.css`
- Use CSS custom properties (variables) for theming
- Follow BYTEMALTE design system colors when applicable
- Class naming: kebab-case (e.g., `btn-number`, `display-area`)
A signal is a wrapper around a value that automatically tracks where it's read and written. Changing a signal's value causes code that relies on the signal to rerun.
## File Structure
## Local State
The `use_signal` hook creates state that is local to a single component. You can call the signal like a function (e.g. `my_signal()`) to clone the value, or use `.read()` to get a reference. `.write()` gets a mutable reference to the value.
Use `use_memo` to create a memoized value that recalculates when its dependencies change. Memos are useful for expensive calculations that you don't want to repeat unnecessarily.
```rust
#[component]
fn Counter() -> Element {
let mut count = use_signal(|| 0);
let mut doubled = use_memo(move || count() * 2); // doubled will re-run when count changes because it reads the signal
rsx! {
h1 { "Count: {count}" } // Counter will re-render when count changes because it reads the signal
h2 { "Doubled: {doubled}" }
button {
onclick: move |_| *count.write() += 1, // Writing to the signal rerenders Counter
"Increment"
}
button {
onclick: move |_| count.with_mut(|count| *count += 1), // use with_mut to mutate the signal
"Increment with with_mut"
}
}
}
```
src/
main.rs # App entry point
ui.rs # UI components
logic.rs # Business logic
assets/
main.css # Global styles
public/ # Static assets served at root
```
## Context API
## Design System (BYTEMALTE)
The Context API allows you to share state down the component tree. A parent provides the state using `use_context_provider`, and any child can access it with `use_context`
When modifying CSS, follow these conventions:
| Element | Border Radius |
|---------|---------------|
| Buttons | 8px |
| Cards | 16px |
| Inputs | 8px |
Colors:
- Primary: `#8888FF`
- Secondary: `#3DDC84`
- Background: `#0F172A`
- Surface: `#1E293B`
- Error: `#EF4444`
---
## Dioxus 0.7 Reference
### Components
```rust
#[component]
fn App() -> Element {
let mut theme = use_signal(|| "light".to_string());
use_context_provider(|| theme); // Provide a type to children
rsx! { Child {} }
}
#[component]
fn Child() -> Element {
let theme = use_context::<Signal<String>>(); // Consume the same type
rsx! {
div {
"Current theme: {theme}"
}
}
let mut count = use_signal(|| 0);
rsx! {
button { onclick: move |_| *count.write() += 1, "{count}" }
}
}
```
# Async
For state that depends on an asynchronous operation (like a network request), Dioxus provides a hook called `use_resource`. This hook manages the lifecycle of the async task and provides the result to your component.
* The `use_resource` hook takes an `async` closure. It re-runs this closure whenever any signals it depends on (reads) are updated
* The `Resource` object returned can be in several states when read:
1. `None` if the resource is still loading
2. `Some(value)` if the resource has successfully loaded
### Signals
```rust
let mut dog = use_resource(move || async move {
// api request
});
match dog() {
Some(dog_info) => rsx! { Dog { dog_info } },
None => rsx! { "Loading..." },
}
let mut value = use_signal(|| String::new());
value(); // clone value
value.read(); // &T reference
value.write(); // &mut T
```
# Routing
All possible routes are defined in a single Rust `enum` that derives `Routable`. Each variant represents a route and is annotated with `#[route("/path")]`. Dynamic Segments can capture parts of the URL path as parameters by using `:name` in the route string. These become fields in the enum variant.
The `Router<Route> {}` component is the entry point that manages rendering the correct component for the current URL.
You can use the `#[layout(NavBar)]` to create a layout shared between pages and place an `Outlet<Route> {}` inside your layout component. The child routes will be rendered in the outlet.
### RSX Patterns
```rust
#[derive(Routable, Clone, PartialEq)]
enum Route {
#[layout(NavBar)] // This will use NavBar as the layout for all routes
#[route("/")]
Home {},
#[route("/blog/:id")] // Dynamic segment
BlogPost { id: i32 },
}
#[component]
fn NavBar() -> Element {
rsx! {
a { href: "/", "Home" }
Outlet<Route> {} // Renders Home or BlogPost
}
}
#[component]
fn App() -> Element {
rsx! { Router::<Route> {} }
rsx! {
div {
for item in items { span { "{item}" } }
if condition { p { "Shown" } }
}
}
```
```toml
dioxus = { version = "0.7.1", features = ["router"] }
```
# Fullstack
Fullstack enables server rendering and ipc calls. It uses Cargo features (`server` and a client feature like `web`) to split the code into a server and client binaries.
```toml
dioxus = { version = "0.7.1", features = ["fullstack"] }
```
## Server Functions
Use the `#[post]` / `#[get]` macros to define an `async` function that will only run on the server. On the server, this macro generates an API endpoint. On the client, it generates a function that makes an HTTP request to that endpoint.
```rust
#[post("/api/double/:path/&query")]
async fn double_server(number: i32, path: String, query: i32) -> Result<i32, ServerFnError> {
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
Ok(number * 2)
}
```
## Hydration
Hydration is the process of making a server-rendered HTML page interactive on the client. The server sends the initial HTML, and then the client-side runs, attaches event listeners, and takes control of future rendering.
### Errors
The initial UI rendered by the component on the client must be identical to the UI rendered on the server.
* Use the `use_server_future` hook instead of `use_resource`. It runs the future on the server, serializes the result, and sends it to the client, ensuring the client has the data immediately for its first render.
* Any code that relies on browser-specific APIs (like accessing `localStorage`) must be run *after* hydration. Place this code inside a `use_effect` hook.