Replace examples with doc tests

dioxus-community · Oct 27, 2023 · 6f677c1 · 6f677c1
1 parent 7c7080a
commit 6f677c1
Show file tree

Hide file tree

Showing 14 changed files with 21 additions and 164 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,7 +17,7 @@ jobs:
     - uses: Swatinem/rust-cache@v2
     - name: Build core features
       run: cargo build --verbose
-    - name: Build all features
-      run: cargo build --verbose
+    - name: Build lookbook
+      run: cd lookbook && cargo build --verbose
     - name: Run tests
       run: cargo test --verbose
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,7 +13,7 @@ members = [
 
 [dependencies]
 dioxus = { git = "https://github.com/dioxuslabs/dioxus" }
-dioxus-web = { git = "https://github.com/dioxuslabs/dioxus" }
+# dioxus-web = { git = "https://github.com/dioxuslabs/dioxus" }
 dioxus-signals = { git = "https://github.com/dioxuslabs/dioxus" }
 dioxus-use-mounted = { git = "https://github.com/matthunz/dioxus-use-mounted" }
 dioxus-spring = { git = "https://github.com/matthunz/dioxus-spring" }

diff --git a/examples/button.rs b/examples/button.rs
diff --git a/examples/chip.rs b/examples/chip.rs
diff --git a/examples/dialog.rs b/examples/dialog.rs
diff --git a/examples/icon.rs b/examples/icon.rs
diff --git a/examples/navigation_rail.rs b/examples/navigation_rail.rs
diff --git a/examples/tab_row.rs b/examples/tab_row.rs
diff --git a/examples/text_field.rs b/examples/text_field.rs
diff --git a/lookbook/src/previews/text_button.rs b/lookbook/src/previews/text_button.rs
@@ -1,5 +1,5 @@
 use dioxus::prelude::*;
-use dioxus_material::{TextButton, use_theme};
+use dioxus_material::{use_theme, TextButton};
 use lookbook::preview;
 
 /// Buttons let people take action and make choices with one tap.

diff --git a/src/dialog.rs b/src/dialog.rs
@@ -4,6 +4,19 @@ use dioxus::prelude::*;
 /// Dialogs provide important prompts in a user flow.
 ///
 /// [material.io](https://m3.material.io/components/dialogs)
+///
+/// ```
+/// use dioxus::prelude::*;
+/// use dioxus_material::{Dialog, Theme};
+///
+/// fn app(cx: Scope) -> Element {
+///     render!(
+///         Theme {
+///             Dialog { is_visible: true, h1 { "Dialog" } }
+///         }
+///     )
+/// }
+/// ```
 #[component]
 pub fn Dialog<'a>(cx: Scope<'a>, children: Element<'a>, is_visible: bool) -> Element<'a> {
     let theme = use_theme(cx);

diff --git a/src/menu.rs b/src/menu.rs
@@ -1,6 +1,6 @@
 use dioxus::prelude::*;
 
 #[component]
-pub fn Menu(cx: Scope) -> Element {
+pub fn Menu(_cx: Scope) -> Element {
     todo!()
 }
diff --git a/src/tab.rs b/src/tab.rs
@@ -2,10 +2,7 @@ use dioxus::prelude::*;
 
 #[component]
 pub fn Tab<'a>(cx: Scope<'a>, children: Element<'a>) -> Element<'a> {
-    render!(div {
-        font_size: "1.2em",
-        padding: "10px 0",
-        text_align: "center",
-        children
-    })
+    render!(
+        div { font_size: "1.2em", padding: "10px 0", text_align: "center", children }
+    )
 }