2021-05-17 21:59:10 +00:00
|
|
|
# Examples
|
|
|
|
|
|
2021-07-02 05:30:52 +00:00
|
|
|
Most of these examples are run through webview so you don't need the dioxus cli installed to preview the functionality.
|
2021-06-17 03:37:55 +00:00
|
|
|
|
2021-07-02 05:30:52 +00:00
|
|
|
These examples are fully-fledged micro apps. They can be ran with the `cargo run --example XYZ`
|
2021-07-01 20:03:27 +00:00
|
|
|
|
2021-07-02 05:30:52 +00:00
|
|
|
| Example | What it does | Status |
|
|
|
|
|
| --------------------------------------------------- | ------------------------------------------- | ------ |
|
|
|
|
|
| [The basics](./basics.rs) | A few basic examples to preview Dioxus | 🛠 |
|
|
|
|
|
| [fine grained reactivity](./signals.rs) | Escape `diffing` by writing values directly | 🛠 |
|
|
|
|
|
| [Global State Management](./statemanagement.rs) | Share state between components | 🛠 |
|
|
|
|
|
| [Virtual Refs]() | Cross-platform imperative elements | 🛠 |
|
|
|
|
|
| [Inline Styles](./inline-styles.rs) | Define styles for elements inline | 🛠 |
|
2021-07-12 06:23:46 +00:00
|
|
|
| [Conditional Rendering](./conditional-rendering.rs) | Hide/Show elements using conditionals | ✅ |
|
2021-07-02 05:30:52 +00:00
|
|
|
|
|
|
|
|
These examples are not necessarily meant to be run, but rather serve as a reference for the given functionality.
|
|
|
|
|
|
|
|
|
|
| Example | What it does | Status |
|
|
|
|
|
| --------------------------------------------------- | ----------------------------------------------- | ------ |
|
|
|
|
|
| [The basics](./basics.rs) | A few basic examples to preview Dioxus | 🛠 |
|
|
|
|
|
| [fine grained reactivity](./signals.rs) | Escape `diffing` by writing values directly | 🛠 |
|
|
|
|
|
| [Global State Management](./statemanagement.rs) | Share state between components | 🛠 |
|
|
|
|
|
| [Virtual Refs]() | Cross-platform imperative elements | 🛠 |
|
|
|
|
|
| [Inline Styles](./inline-styles.rs) | Define styles for elements inline | 🛠 |
|
2021-07-12 06:23:46 +00:00
|
|
|
| [Conditional Rendering](./conditional-rendering.rs) | Hide/Show elements using conditionals | ✅ |
|
|
|
|
|
| [Maps/Iterators](./iterators.rs) | Use iterators in the rsx! macro | ✅ |
|
2021-07-02 05:30:52 +00:00
|
|
|
| [Render To string](./tostring.rs) | Render a mounted virtualdom to a string | 🛠 |
|
|
|
|
|
| [Component Children](./children.rs) | Pass children into child components | 🛠 |
|
|
|
|
|
| [Function Driven children]() | Pass functions to make VNodes | 🛠 |
|
2021-07-12 06:23:46 +00:00
|
|
|
| [Memoization & Borrowed Data](./memo.rs) | Suppress renders, borrow from parents | ✅ |
|
|
|
|
|
| [Fragments](./fragments.rs) | Support root-less element groups | ✅ |
|
2021-07-02 05:30:52 +00:00
|
|
|
| [Null/None Components](./empty.rs) | Return nothing! | 🛠 |
|
2021-07-12 06:23:46 +00:00
|
|
|
| [Spread Pattern for props](./spreadpattern.rs) | Manually specify and override props | ✅ |
|
2021-07-02 05:30:52 +00:00
|
|
|
| [Controlled Inputs](./controlled-inputs.rs) | this does | 🛠 |
|
|
|
|
|
| [Custom Elements]() | Define custom elements | 🛠 |
|
|
|
|
|
| [Web Components]() | Custom elements to interface with WebComponents | 🛠 |
|
|
|
|
|
| [Testing And debugging]() | this does | 🛠 |
|
|
|
|
|
| [Asynchronous Data]() | Using suspense to wait for data | 🛠 |
|
|
|
|
|
| [Fiber/Scheduled Rendering]() | this does | 🛠 |
|
|
|
|
|
| [CSS Compiled Styles]() | this does | 🛠 |
|
2021-07-12 06:23:46 +00:00
|
|
|
| [Anti-patterns](./antipatterns.rs) | A collection of discouraged patterns | ✅ |
|
|
|
|
|
| [Complete rsx reference](./rsx_usage.rs) | A complete reference for all rsx! usage | ✅ |
|
|
|
|
|
| [Event Listeners](./listener.rs) | Attach closures to events on elements | ✅ |
|
2021-07-02 05:30:52 +00:00
|
|
|
|
|
|
|
|
These web-specific examples must be run with `dioxus-cli` using `dioxus develop --example XYZ`
|
|
|
|
|
|
|
|
|
|
| Example | What it does |
|
|
|
|
|
| ------- | ------------ |
|
|
|
|
|
| asd | this does |
|
|
|
|
|
| asd | this does |
|
