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

Initial commit with README.md

Browse Source
This commit is contained in:
Bytemalte
2025-12-19 09:27:13 +01:00
commit ec6216f24c
12 changed files with 6568 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
.gitignore vendored Normal file
View File

@@ -0,0 +1,7 @@
# Generated by Cargo
# will have compiled files and executables
/target
.DS_Store
# These are backup files generated by rustfmt
**/*.rs.bk

265
AGENTS.md Normal file
View File

@@ -0,0 +1,265 @@
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
Provide concise code examples with detailed descriptions
# Dioxus Dependency
You can add Dioxus to your `Cargo.toml` like this:
```toml
[dependencies]
dioxus = { version = "0.7.1" }
[features]
default = ["web", "webview", "server"]
web = ["dioxus/web"]
webview = ["dioxus/desktop"]
server = ["dioxus/server"]
```
# Launching your application
You need to create a main function that sets up the Dioxus runtime and mounts your root component.
```rust
use dioxus::prelude::*;
fn main() {
dioxus::launch(App);
}
#[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.
```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();
}
},
}
}
}
```
Each component accepts function arguments (props)
* 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.
# State
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.
## 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"
}
}
}
```
## Context API
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`
```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}"
}
}
}
```
# 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
```rust
let mut dog = use_resource(move || async move {
// api request
});
match dog() {
Some(dog_info) => rsx! { Dog { dog_info } },
None => rsx! { "Loading..." },
}
```
# 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.
```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> {} }
}
```
```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.

5982
Cargo.lock generated Normal file
View File

File diff suppressed because it is too large Load Diff

16
Cargo.toml Normal file
View File

@@ -0,0 +1,16 @@
[package]
name = "mdo"
version = "0.1.0"
authors = ["malxte"]
edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
dioxus = { version = "0.7.1", features = [] }
[features]
default = ["desktop"]
web = ["dioxus/web"]
desktop = ["dioxus/desktop"]
mobile = ["dioxus/mobile"]

21
Dioxus.toml Normal file
View File

@@ -0,0 +1,21 @@
[application]
[web.app]
# HTML title tag content
title = "mdo"
# include `assets` in web platform
[web.resource]
# Additional CSS style files
style = []
# Additional JavaScript files
script = []
[web.resource.dev]
# Javascript code file
# serve: [dev-server] only
script = []

25
README.md Normal file
View File

@@ -0,0 +1,25 @@
# Development
Your new bare-bones project includes minimal organization with a single `main.rs` file and a few assets.
```
project/
├─ assets/ # Any assets that are used by the app should be placed here
├─ src/
│ ├─ main.rs # main.rs is the entry point to your application and currently contains all components for the app
├─ Cargo.toml # The Cargo.toml file defines the dependencies and feature flags for your project
```
### Serving Your App
Run the following command in the root of your project to start developing with the default platform:
```bash
dx serve
```
To run for a different platform, use the `--platform platform` flag. E.g.
```bash
dx serve --platform desktop
```

BIN
assets/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 130 KiB

20
assets/header.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 23 KiB

127
assets/main.css Normal file
View File

@@ -0,0 +1,127 @@
/* App-wide styling */
body {
background-color: #0f1116;
color: #ffffff;
font-family: "Segoe UI", Tahoma, Geneva, Verdana, sans-serif;
margin: 20px;
}
#hero {
margin: 0;
display: flex;
flex-direction: column;
justify-content: center;
align-items: center;
}
#links {
width: 400px;
text-align: left;
font-size: x-large;
color: white;
display: flex;
flex-direction: column;
}
#links a {
color: white;
text-decoration: none;
margin-top: 20px;
margin: 10px 0px;
border: white 1px solid;
border-radius: 5px;
padding: 10px;
}
#links a:hover {
background-color: #1f1f1f;
cursor: pointer;
}
#input {
display: flex;
justify-content: center;
gap: 10px;
margin-bottom: 2rem;
padding-top: 2rem;
}
#input input {
padding: 12px 20px;
border-radius: 8px;
border: 1px solid #333;
background-color: #1a1d24;
color: white;
font-size: 1rem;
outline: none;
width: 300px;
transition: box-shadow 0.2s, border-color 0.2s;
}
#input input:focus {
border-color: #4a9eff;
box-shadow: 0 0 0 2px rgba(74, 158, 255, 0.2);
}
#input button {
padding: 12px 24px;
border-radius: 8px;
border: none;
background-color: #4a9eff;
color: white;
font-weight: 600;
font-size: 1rem;
cursor: pointer;
transition: background-color 0.2s, transform 0.1s;
}
#input button:hover {
background-color: #3b7ecc;
}
#input button:active {
transform: scale(0.98);
}
#todos ul {
list-style: none;
padding: 0;
width: 400px;
margin: 0 auto;
}
#todos li {
background-color: #1a1d24;
margin-bottom: 12px;
padding: 16px 20px;
border-radius: 8px;
font-size: 1.1rem;
border: 1px solid #333;
transition: transform 0.2s cubic-bezier(0.2, 0.8, 0.2, 1), border-color 0.2s;
cursor: default;
display: flex;
justify-content: space-between;
align-items: center;
}
#todos li:hover {
transform: translateX(8px);
border-color: #4a9eff;
}
.delete-btn {
background-color: #e63946;
color: white;
border: none;
padding: 8px 16px;
border-radius: 6px;
font-size: 0.9rem;
font-weight: 600;
cursor: pointer;
transition: box-shadow 0.2s, background-color 0.2s;
}
.delete-btn:hover {
background-color: #d62839;
box-shadow: 0 0 8px rgba(230, 57, 70, 0.6);
}

41
output.txt Normal file
View File

@@ -0,0 +1,41 @@
Checking mdo v0.1.0 (/home/malxte/Documents/Programming/Plattforms/Dioxus/mdo)
error[E0277]: the trait bound `ListenerCallback<MouseData>: SuperFrom<(), _>` is not satisfied
--> src/ui.rs:14:31
|
14 | button { onclick: add_todo(tocontent) }
| -----------------^^^^^^^^^^^
| | |
| | the trait `SuperFrom<(), _>` is not implemented for `ListenerCallback<MouseData>`
| required by a bound introduced by this call
|
= help: the following other types implement trait `SuperFrom<T, M>`:
`ListenerCallback<T>` implements `SuperFrom<Callback<dioxus::prelude::Event<T>>>`
`ListenerCallback<T>` implements `SuperFrom<Function, MarkerWrapper<Marker>>`
= note: required for `()` to implement `SuperInto<ListenerCallback<MouseData>, _>`
note: required by a bound in `onclick`
--> /home/malxte/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/dioxus-html-0.7.2/src/events/mouse.rs:47:1
|
47 | / impl_event! {
48 | | MouseData;
49 | |
50 | | /// Execute a callback when a button is clicked.
... |
73 | | onclick
| | ------- required by a bound in this function
... |
104 | | onmouseup
105 | | }
| |_^ required by this bound in `onclick`
= note: this error originates in the macro `impl_event` (in Nightly builds, run with -Z macro-backtrace for more info)
warning: unused variable: `tocontent`
--> src/ui.rs:34:13
|
34 | fn add_todo(tocontent: String) {}
| ^^^^^^^^^ help: if this is intentional, prefix it with an underscore: `_tocontent`
|
= note: `#[warn(unused_variables)]` (part of `#[warn(unused)]`) on by default
For more information about this error, try `rustc --explain E0277`.
warning: `mdo` (bin "mdo") generated 1 warning
error: could not compile `mdo` (bin "mdo") due to 1 previous error; 1 warning emitted

19
src/main.rs Normal file
View File

@@ -0,0 +1,19 @@
use dioxus::prelude::*;
mod ui;
const FAVICON: Asset = asset!("/assets/favicon.ico");
const MAIN_CSS: Asset = asset!("/assets/main.css");
fn main() {
dioxus::launch(App);
}
#[component]
fn App() -> Element {
rsx! {
document::Link { rel: "icon", href: FAVICON }
document::Link { rel: "stylesheet", href: MAIN_CSS }
ui::Hero {}
}
}

45
src/ui.rs Normal file
View File

@@ -0,0 +1,45 @@
use dioxus::prelude::*;
#[component]
pub fn Hero() -> Element {
let mut to_do = use_signal(|| "".to_string());
let mut todos = use_signal(|| Vec::<String>::new());
rsx! {
div { id: "input",
input {
placeholder: "Add To Do ...",
value: "{to_do}",
oninput: move |e| to_do.set(e.value()),
}
button {
onclick: move |_| {
if !to_do.read().is_empty() {
todos.push(to_do.to_string());
to_do.set("".to_string());
}
},
"Add"
}
}
div { id: "hero",
div { id: "todos",
ul {
for (i, todo) in todos.read().iter().enumerate() {
li {
"{todo}"
button {
class: "delete-btn",
onclick: move |_| {
todos.write().remove(i);
},
"Delete"
}
}
}
}
}
}
}
}