dioxus/examples/README.md

118 lines
2.7 KiB
Markdown
Raw Normal View History

# Examples
These examples are fully-fledged mini Dioxus apps.
2021-12-01 03:48:05 +00:00
You can run them with `cargo run --example EXAMPLE_NAME`. Example:
2021-12-01 03:48:05 +00:00
```shell
cargo run --example hello_world
2021-12-01 03:48:05 +00:00
```
(Most of these examples are run through webview, so you don't need the Dioxus CLI installed)
2021-12-01 03:48:05 +00:00
## Basic Features
2021-12-01 03:48:05 +00:00
[hello_world](./hello_world.rs) - Most basic example
2021-12-01 03:48:05 +00:00
[readme](./readme.rs) - Counter example from the Readme
2021-12-01 03:48:05 +00:00
[custom_assets](./custom_assets.rs) - Include images
2021-12-01 03:48:05 +00:00
[custom_html](./custom_html.rs) - Customize wrapper HTML
2021-12-01 03:48:05 +00:00
[eval](./eval.rs) - Evaluate JS expressions
2021-12-01 03:48:05 +00:00
### RSX
[rsx_usage](./rsx_usage.rs) - Demo of all RSX features
[xss_safety](./xss_safety.rs) - You can include text without worrying about injections by default
### Props
[optional_props](./optional_props.rs) - Optional props
### CSS
[tailwind](./tailwind/) - You can use a library for styling
## Input Handling
[all_events](./all_events.rs) - Basic event handling demo
[filedragdrop](./filedragdrop.rs) - Handle dropped files
[form](./form.rs) - Handle form submission
[inputs](./inputs.rs) - Input values
[nested_listeners](./nested_listeners.rs) - Nested handlers and bubbling
[textarea](textarea.rs) - Text area input
### State Management
### Async
[login_form](./login_form.rs) - Login endpoint example
[suspense](./suspense.rs) - Render placeholders while data is loading
[tasks](./tasks.rs) - Continuously run future
### SVG
[svg](./svg.rs)
## Server-side rendering
[ssr](./ssr.rs) - Rendering RSX server-side
[hydration](./hydration.rs) - Pre-rendering with hydration
## Common Patterns
[disabled](./disabled.rs) - Disable buttons conditionally
[error_handle](./error_handle.rs) - Handle errors with early return
## Routing
[flat_router](./flat_router.rs) - Basic, flat route example
[router](./router.rs) - Router example
[link](./link.rs) - Internal, external and custom links
## Platform Features
[window_event](./window_event.rs) - Window decorations, fullscreen, minimization, etc.
[window_zoom](./window_zoom.rs) Zoom in or out
## Example Apps
[calculator](./calculator.rs) - Simple calculator
[crm](./crm.rs) - Toy multi-page customer management app
[dog_app](./dog_app.rs) - Accesses dog API
[file_explorer](./file_explorer.rs) - File browser that uses `use_ref` to interact with the model
[todomvc](./todomvc.rs) - Todo task list example
# TODO
Missing Features
- Fine-grained reactivity
- Refs - imperative handles to elements
- Function-driven children: Pass functions to make VNodes
Missing examples
- Shared state
- Root-less element groups
- Custom elements
- Component Children: Pass children into child components
- Render To string: Render a mounted virtualdom to a string
- Testing and Debugging