Skip to content

Commit 35fcbba

Browse files
jkelleyrtpealmloff
jkelleyrtp
and
ealmloff
authored
more work on 0.7 docs (#532)
* wip * better ui * wip: more docs on UI * spreading attributes and clipboard * fill out render loop * add todo list * outline async chapter * clean up async index * dupe some pages * docs on asset pipeline * document spawn * finish assets * more section headers * more sections... * finish styling * cleanup styling a bit * wip hotreload guide * update suspense guide * Outline data fetching documentation * pull out and fix code for data fetching * pull out crash course code * finish async guide * 0.7 migration is unfinished * Document 0.7 migration * use the new CLI args in the documentation instead of platform * fix install script * clean up hot-reload, make videos smaller in css * css grid * remove de-duped * add notes from discussion * re-organize docs under new basics/advanced * Add tooling section * overview, note "routes" * Project setup in core concepts * finish escaping section * better grammar * more reactivity.... * memo, signals * add more docs for signals * effects and memos * Finish user input * capitlization * talk about read signals * global context * update progress * stores & collections, error handling * comment out uneeded docs * comment out project setup section * import spawn --------- Co-authored-by: Evan Almloff <[email protected]>
1 parent 9885067 commit 35fcbba

File tree

128 files changed

+5353
-822
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

128 files changed

+5353
-822
lines changed

‎README.md‎

Lines changed: 62 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -35,56 +35,76 @@ We use TailwindCSS which is included automatically with dx 0.7.
3535
## Dioxus 0.7 Overhaul Progress
3636
We are overhauling the docs for Dioxus 0.7. Here is the current progress:
3737

38-
3938
```
4039
✅ - [Core Concepts](essentials/index.md)
40+
❌ - [Setup]()
41+
❌ - [Tools]
42+
❌ - [Feature Flags]
43+
❌ - [Folder Structure]
44+
45+
- [Project Setup](essentials/setup/index.md)
46+
- [Create a New App](essentials/setup/tooling.md)
47+
- [Integrated Devserver](essentials/setup/devserver.md)
48+
- [File-system Layout](essentials/setup/structure.md)
49+
- [Cross-platform Configuration](essentials/setup/configuration.md)
50+
4151
✅ - [Building User Interfaces](essentials/ui/index.md)
4252
✅ - [Introducing RSX](essentials/ui/rsx.md)
4353
✅ - [Elements and Text](essentials/ui/elements.md)
4454
✅ - [Dynamic Attributes](essentials/ui/attributes.md)
4555
✅ - [Components and Properties](essentials/ui/components.md)
4656
✅ - [How Components Render](essentials/ui/render.md)
47-
❌ - [Conditional Rendering](essentials/ui/conditional.md)
48-
❌ - [Rendering Lists](essentials/ui/iteration.md)
49-
❌ - [Escape Hatches](essentials/ui/escape.md)
50-
❌ - [Assets](essentials/ui/assets.md)
51-
❌ - [Styling](essentials/ui/styling.md)
52-
❌ - [Hot-Reload](essentials/ui/hotreload.md)
53-
❌ - [Reactivity](essentials/reactivity/index.md)
54-
❌ - [Thinking Reactively](essentials/reactivity/reactivity.md)
55-
❌ - [Handling Events](essentials/reactivity/event_handlers.md)
56-
❌ - [Using Signals](essentials/reactivity/signals.md)
57+
✅ - [Conditional Rendering](essentials/ui/conditional.md)
58+
✅ - [Rendering Lists](essentials/ui/iteration.md)
59+
✅ - [Assets](essentials/ui/assets.md)
60+
✅ - [Styling](essentials/ui/styling.md)
61+
✅ - [Hot-Reload](essentials/ui/hotreload.md)
62+
✅ - [Escape Hatches](essentials/ui/escape.md)
63+
64+
❌ - [User Interaction](essentials/state/index.md)
65+
✅ - [Intro to Reactivity]
66+
✅ - [Storing State in Hooks](essentials/state/hooks.md)
67+
✅ - Reactive Signals use_signal
68+
✅ - User Input and Events
69+
✅ - Futures (crash-course (lite), loop/spawn, onclick: move |_| async {})
70+
✅ - Fetching? (use_resource, network requests)
71+
✅ - Effects and Memos (use_memo + use_effect)
72+
✅ - Hoisting State (lifting state and refactoring)
73+
✅ - Global Context (context, global signals)
74+
✅ - Stores and Collections
75+
✅ - [Error Handling (+boundaries)](essentials/state/error_handling.md)
76+
77+
78+
❌ - [Advanced Reactivity](essentials/reactivity/index.md)
79+
❌ - The Outside World (sync signals, external callbacks, layout effects, onmounted)
80+
❌ - [Reactive Context](essentials/reactivity/reactivity.md)
81+
❌ - [Custom Hooks (schedule_update, use_hook)](essentials/state/custom_hooks.md)
5782
❌ - [Component Lifecycle](essentials/reactivity/lifecycle.md)
58-
❌ - [Using Effects](essentials/reactivity/effects.md)
83+
❌ - [Side Effects](essentials/reactivity/effects.md)
5984
❌ - [Maintaing Purity](essentials/reactivity/purity.md)
60-
❌ - [Reactive Collections](essentials/reactivity/collections.md)
61-
❌ - [Managing State](essentials/state/index.md)
62-
❌ - [State is Essential](essentials/state/essential.md)
63-
❌ - [Local State](essentials/state/state.md)
64-
❌ - [Hooks](essentials/state/hooks.md)
65-
❌ - [Custom Hooks](essentials/state/custom_hooks.md)
66-
❌ - [Passing State](essentials/state/passing.md)
67-
❌ - [Context](essentials/state/context.md)
68-
❌ - [Global State](essentials/state/global_state.md)
6985
❌ - [Memoization](essentials/state/memoization.md)
7086
❌ - [Optimization](essentials/state/optimization.md)
71-
❌ - [Error Handling](essentials/state/error_handling.md)
72-
❌ - [Async](essentials/async/index.md)
73-
❌ - [Spawning Futures](essentials/async/futures.md)
74-
❌ - [Async Resources](essentials/async/resources.md)
75-
❌ - [Making network requests](essentials/async/network_requests.md)
7687
❌ - [Suspense](essentials/async/suspense.md)
77-
❌ - [Parallelism](essentials/async/parallel.md)
88+
❌ - [Futures in Depth (+threads/workers)](essentials/async/crash_course.md)
89+
90+
<!-- - [Reactive Context](essentials/advanced/reactivity.md) -->
91+
<!-- - [Side Effects](essentials/advanced/effects.md) -->
92+
<!-- - [Maintaing Purity](essentials/advanced/purity.md) -->
93+
<!-- - [Memoization](essentials/advanced/memoization.md) -->
94+
<!-- - [Optimization](essentials/advanced/optimization.md) -->
95+
<!-- - [Futures in Depth](essentials/advanced/futures.md) -->
96+
7897
❌ - [Routing](essentials/router/index.md)
79-
❌ - [Defining Routes](essentials/router/routes.md)
98+
✅ - [Defining Routes](essentials/router/routes.md)
8099
✅ - [Nested Routes](essentials/router/nested-routes.md)
81100
✅ - [Layouts](essentials/router/layouts.md)
82101
✅ - [Navigation](essentials/router/navigation/index.md)
83102
✅ - [Programmatic Navigation](essentials/router/programmatic-navigation.md)
84103
✅ - [History Providers](essentials/router/history-providers.md)
85104
✅ - [History Buttons](essentials/router/history-buttons.md)
86105
✅ - [Routing Update Callback](essentials/router/routing-update-callback.md)
87-
✅ - [Fullstack](essentials/fullstack/index.md)
106+
107+
❌ - [Fullstack](essentials/fullstack/index.md)
88108
✅ - [Hydration](essentials/fullstack/hydration.md)
89109
✅ - [Managing Dependencies](essentials/fullstack/managing_dependencies.md)
90110
✅ - [Server Functions](essentials/fullstack/server_functions.md)
@@ -95,24 +115,32 @@ We are overhauling the docs for Dioxus 0.7. Here is the current progress:
95115
✅ - [Streaming](essentials/fullstack/streaming.md)
96116
✅ - [Static Site Generation](essentials/fullstack/static_site_generation.md)
97117
✅ - [Axum Integration](essentials/fullstack/axum.md)
98-
❌ - [Breaking Out](essentials/breaking/index.md)
99118
100119
---
101120
102-
❌ - [Guides](guides/index.md)
121+
❌ - [Guides (digging deeper)](guides/index.md)
103122
❌ - [Tools](guides/tools/index.md)
104123
❌ - [Serve](guides/tools/serve.md)
105124
❌ - [Bundle](guides/tools/bundle.md)
106125
❌ - [Create a Project](guides/tools/creating.md)
107126
❌ - [Configure Project](guides/tools/configure.md)
108-
❌ - [Android](guides/tools/android.md)
109-
❌ - [iOS](guides/tools/ios.md)
110127
❌ - [Translate HTML](guides/tools/translate.md)
111128
❌ - [VSCode Extension](guides/tools/vscode.md)
129+
❌ - [APIs?](guides/platforms/index.md)
130+
❌ - feature overview
131+
❌ - window
132+
❌ - document
133+
❌ - history
134+
❌ - desktop/webview
135+
❌ - native
136+
❌ - components
137+
❌ - sdk
112138
❌ - [Platform Support](guides/platforms/index.md)
113139
❌ - [Web](guides/platforms/web.md)
114140
❌ - [Desktop](guides/platforms/desktop.md)
115141
❌ - [Mobile](guides/platforms/mobile.md)
142+
❌ - [Android](guides/tools/android.md)
143+
❌ - [iOS](guides/tools/ios.md)
116144
❌ - [Publishing](guides/deploy/index.md)
117145
❌ - [Web Apps](guides/deploy/web.md)
118146
❌ - [SSG](guides/deploy/ssg.md)
@@ -141,7 +169,7 @@ We are overhauling the docs for Dioxus 0.7. Here is the current progress:
141169
❌ - [In-Depth](guides/depth/index.md)
142170
❌ - [Asset Pipeline](guides/depth/assets.md)
143171
❌ - [Custom Renderer](guides/depth/custom_renderer.md)
144-
❌ - [Migration](migration/index.md)
172+
✅ - [Migration](migration/index.md)
145173
✅ - [To 0.7](migration/to_07.md)
146174
✅ - [To 0.6](migration/to_06.md)
147175
✅ - [To 0.5](migration/to_05/index.md)
@@ -152,7 +180,6 @@ We are overhauling the docs for Dioxus 0.7. Here is the current progress:
152180
```
153181

154182

155-
156183
## Contributing
157184

158185
- Check out the website [section on contributing]

‎_typos.toml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[default.extend-words]
2+
# https://ratatui.rs/
3+
ratatui = "ratatui"
4+
# lits is short for literals
5+
lits = "lits"
6+
# https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seeked_event
7+
seeked = "seeked"
8+
# https://developer.apple.com/forums/thread/108953
9+
# udid = unique device identifier
10+
udid = "udid"
11+
# Part of Blitz's API
12+
unparented = "unparented"
13+
14+
[files]
15+
extend-exclude = ["translations/*", "docs-src/0.3", "docs-src/0.4", "docs-src/0.5", "CHANGELOG.md", "*.js"]

‎docs-src/0.6/src/essentials/state/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ DemoFrame {
8989

9090
### Working with Untracked State
9191

92-
Most of the state in your app will be tracked values. All built in hooks return tracked values, and we encourage custom hooks to do the same. However, there are times when you need to work with untracked state. For example, you may receive a raw untracked value in props. When you read an untracked value inside a reactive context, it will not subscribe to the value:
92+
Most of the state in your app will be tracked values. All built in hooks return tracked values, and we encourage custom hooks to do the same. However, there are times when you need to work with untracked state. For example, you may receive a raw untracked value in props. When you read an untracked value inside a reactive scope, it will not subscribe to the value:
9393

9494
```rust
9595
{{#include ../docs-router/src/doc_examples/untested_06/reactivity.rs:non_reactive}}
@@ -101,7 +101,7 @@ DemoFrame {
101101
}
102102
```
103103

104-
You can start tracking raw state with the `use_reactive` hook. This hook takes a tuple of dependencies and returns a reactive closure. When the closure is called in a reactive context, it will track subscribe to the dependencies and rerun the closure when the dependencies change.
104+
You can start tracking raw state with the `use_reactive` hook. This hook takes a tuple of dependencies and returns a reactive closure. When the closure is called in a reactive scope, it will track subscribe to the dependencies and rerun the closure when the dependencies change.
105105

106106
```rust
107107
{{#include ../docs-router/src/doc_examples/untested_06/reactivity.rs:use_reactive}}
@@ -115,7 +115,7 @@ DemoFrame {
115115

116116
### Opting Out of Subscriptions
117117

118-
In some situations, you may need to read a reactive value without subscribing to it. You can use the `peek` method to get a reference to the inner value without registering the value as a dependency of the current reactive context:
118+
In some situations, you may need to read a reactive value without subscribing to it. You can use the `peek` method to get a reference to the inner value without registering the value as a dependency of the current reactive scope:
119119

120120
```rust
121121
{{#include ../docs-router/src/doc_examples/untested_06/reactivity.rs:peek}}

‎docs-src/0.7/src/SUMMARY.md‎

Lines changed: 36 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Summary
22

3-
- [Introduction](index.md)
3+
- [Introduction](getting_started/welcome.md)
4+
- [Welcome](index.md)
45
- [Getting Started](getting_started/index.md)
56
---
67

7-
- [Tutorial](tutorial/index.md)
8+
- [Take a Tour](tutorial/overview.md)
9+
- [Overview](tutorial/index.md)
810
- [Tooling Setup](tutorial/tooling.md)
911
- [Creating a new app](tutorial/new_app.md)
1012
- [Your First Component](tutorial/component.md)
@@ -21,44 +23,37 @@
2123

2224
---
2325

24-
- [Core Concepts](essentials/index.md)
26+
- [Core Concepts](essentials/overview.md)
27+
- [Overview](essentials/index.md)
2528
- [Building User Interfaces](essentials/ui/index.md)
2629
- [Introducing RSX](essentials/ui/rsx.md)
2730
- [Elements and Text](essentials/ui/elements.md)
2831
- [Dynamic Attributes](essentials/ui/attributes.md)
2932
- [Conditional Rendering](essentials/ui/conditional.md)
3033
- [Rendering Lists](essentials/ui/iteration.md)
31-
- [Components and Properties](essentials/ui/components.md)
32-
- [How Components Render](essentials/ui/render.md)
33-
- [Escape Hatches](essentials/ui/escape.md)
34+
- [Components](essentials/ui/components.md)
35+
- [Reconciliation](essentials/ui/render.md)
3436
- [Assets](essentials/ui/assets.md)
3537
- [Styling](essentials/ui/styling.md)
3638
- [Hot-Reload](essentials/ui/hotreload.md)
37-
- [Reactivity](essentials/reactivity/index.md)
38-
- [Thinking Reactively](essentials/reactivity/reactivity.md)
39-
- [Handling Events](essentials/reactivity/event_handlers.md)
40-
- [Using Signals](essentials/reactivity/signals.md)
41-
- [Component Lifecycle](essentials/reactivity/lifecycle.md)
42-
- [Using Effects](essentials/reactivity/effects.md)
43-
- [Maintaing Purity](essentials/reactivity/purity.md)
44-
- [Reactive Collections](essentials/reactivity/collections.md)
45-
- [Managing State](essentials/state/index.md)
46-
- [State is Essential](essentials/state/essential.md)
47-
- [Local State](essentials/state/state.md)
48-
- [Hooks](essentials/state/hooks.md)
49-
- [Custom Hooks](essentials/state/custom_hooks.md)
50-
- [Passing State](essentials/state/passing.md)
51-
- [Context](essentials/state/context.md)
52-
- [Global State](essentials/state/global_state.md)
53-
- [Memoization](essentials/state/memoization.md)
54-
- [Optimization](essentials/state/optimization.md)
55-
- [Error Handling](essentials/state/error_handling.md)
56-
- [Async](essentials/async/index.md)
57-
- [Spawning Futures](essentials/async/futures.md)
58-
- [Async Resources](essentials/async/resources.md)
59-
- [Making network requests](essentials/async/network_requests.md)
60-
- [Suspense](essentials/async/suspense.md)
61-
- [Parallelism](essentials/async/parallel.md)
39+
- [Escape Hatches](essentials/ui/escape.md)
40+
- [The Basics of State](essentials/basics/index.md)
41+
- [Intro to Reactivity](essentials/basics/reactivity.md)
42+
- [Storing State in Hooks](essentials/basics/hooks.md)
43+
- [Reactive Signals](essentials/basics/signals.md)
44+
- [User Input](essentials/basics/event_handlers.md)
45+
- [Async and Futures](essentials/basics/async.md)
46+
- [Data Fetching](essentials/basics/resources.md)
47+
- [Effects and Memos](essentials/basics/effects.md)
48+
- [Hoisting State](essentials/basics/hoisting.md)
49+
- [Global Context](essentials/basics/context.md)
50+
- [Stores and Collections](essentials/basics/collections.md)
51+
- [Error Handling](essentials/basics/error_handling.md)
52+
- [Advanced Topics](essentials/advanced/index.md)
53+
- [Custom Hooks](essentials/advanced/custom_hooks.md)
54+
- [Component Lifecycle](essentials/advanced/lifecycle.md)
55+
- [Suspense](essentials/advanced/suspense.md)
56+
- [Breaking Out](essentials/advanced/breaking_out.md)
6257
- [Routing](essentials/router/index.md)
6358
- [Defining Routes](essentials/router/routes.md)
6459
- [Nested Routes](essentials/router/nested-routes.md)
@@ -69,17 +64,16 @@
6964
- [History Buttons](essentials/router/history-buttons.md)
7065
- [Routing Update Callback](essentials/router/routing-update-callback.md)
7166
- [Fullstack](essentials/fullstack/index.md)
67+
- [Server Functions](essentials/fullstack/server_functions.md)
7268
- [Hydration](essentials/fullstack/hydration.md)
7369
- [Managing Dependencies](essentials/fullstack/managing_dependencies.md)
74-
- [Server Functions](essentials/fullstack/server_functions.md)
7570
- [Extractors](essentials/fullstack/extractors.md)
7671
- [Middleware](essentials/fullstack/middleware.md)
7772
- [Authentication](essentials/fullstack/authentication.md)
7873
- [Routing](essentials/fullstack/routing.md)
7974
- [Streaming](essentials/fullstack/streaming.md)
8075
- [Static Site Generation](essentials/fullstack/static_site_generation.md)
8176
- [Axum Integration](essentials/fullstack/axum.md)
82-
- [Breaking Out](essentials/breaking/index.md)
8377

8478
---
8579

@@ -93,6 +87,15 @@
9387
- [iOS](guides/tools/ios.md)
9488
- [Translate HTML](guides/tools/translate.md)
9589
- [VSCode Extension](guides/tools/vscode.md)
90+
- [Platform APIs](guides/apis/index.md)
91+
- [Dioxus Feature Overview](guides/apis/features.md)
92+
- [Window](guides/apis/window.md)
93+
- [Document](guides/apis/document.md)
94+
- [History](guides/apis/history.md)
95+
- [Desktop Webview](guides/apis/desktop.md)
96+
- [Native](guides/apis/native.md)
97+
- [Components](guides/apis/components.md)
98+
- [SDK](guides/apis/sdk.md)
9699
- [Platform Support](guides/platforms/index.md)
97100
- [Web](guides/platforms/web.md)
98101
- [Desktop](guides/platforms/desktop.md)
@@ -138,52 +141,3 @@
138141
- [Beyond](beyond/index.md)
139142
- [Contributing](beyond/contributing.md)
140143
- [Project Structure](beyond/project_structure.md)
141-
142-
<!-- - [Guiding Principles](contributing/guiding_principles.md) -->
143-
<!-- - [SSR](guides/ssr.md) -->
144-
<!--
145-
- [Example Router Project](router-example/index.md)
146-
- [Creating Our First Route](router-example/first-route.md)
147-
- [Building a Nest](router-example/building-a-nest.md)
148-
- [Navigation Targets](router-example/navigation-targets.md)
149-
- [Redirection Perfection](router-example/redirection-perfection.md)
150-
- [Full Code](router-example/full-code.md) -->
151-
152-
<!-- - [Static Generation](router/reference/static-generation.md) -->
153-
<!-- - [CLI in Depth](router/reference/cli-in-depth.md)
154-
- [SDK](router/reference/sdk.md)
155-
- [Fullstack and the server](router/reference/fullstack-and-the-server.md) -->
156-
157-
<!-- - [Walkthrough of Internals](contributing/walkthrough_readme.md) -->
158-
<!-- Empty file. TODO: Uncomment when the file is finished. - [Governance](contributing/governance.md) -->
159-
160-
<!--
161-
- [Liveview](reference/liveview.md)
162-
- [Choosing A Web Renderer](reference/choosing_a_web_renderer.md) -->
163-
164-
165-
<!-- # Overview / what these guides are for -->
166-
167-
<!-- [Important Hooks - Overview]()
168-
[Router and managing “pages”]()
169-
[The “Document” abstraction]()
170-
[Understanding Hot-Reloading]()
171-
[CLI in Depth]()
172-
[SDK]()
173-
[Fullstack/The server]()
174-
[WASM]()
175-
[Desktop]()
176-
[Mobile]()
177-
[SDK]()
178-
[Hosting Options]()
179-
[Reactivity in way too much depth]()
180-
[rsx! in way too much depth?]()
181-
[Building Libraries for Dioxus]()
182-
[Custom Renderer]()
183-
[Crates and Compatibility]()
184-
[Accessibility]() -->
185-
186-
187-
<!-- - [Reference](reference/index.md)
188-
- [Managing State](reference/managing_state.md)
189-
- [Component Lifecycle](reference/component_lifecycle.md) -->

‎docs-src/0.7/src/essentials/breaking/index.md‎ renamed to ‎docs-src/0.7/src/essentials/advanced/breaking_out.md‎

File renamed without changes.

0 commit comments

Comments
 (0)