Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,27 @@ jobs:
env:
RUSTDOCFLAGS: -Dwarnings --document-private-items

test-docs:
if: github.event.pull_request.draft == false
name: Test Docs
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- uses: awalsh128/cache-apt-pkgs-action@latest
with:
packages: libwebkit2gtk-4.1-dev libgtk-3-dev libasound2-dev libudev-dev libayatana-appindicator3-dev libxdo-dev libglib2.0-dev
version: 1.0
- name: Install Rust ${{ env.rust_nightly }}
uses: dtolnay/rust-toolchain@nightly
with:
toolchain: ${{ env.rust_nightly }}
- uses: Swatinem/rust-cache@v2
with:
cache-all-crates: "true"
- name: "doc --lib --all-features"
run: |
cargo test --doc --workspace --all-features

check:
if: github.event.pull_request.draft == false
name: Check
Expand Down
34 changes: 13 additions & 21 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
resolver = "2"
members = [
"packages/dioxus",
"packages/dioxus-lib",
"packages/core",
"packages/core-types",
"packages/cli",
Expand Down Expand Up @@ -32,7 +31,6 @@ members = [
"packages/desktop",
"packages/devtools-types",
"packages/devtools",
"packages/dioxus-lib",
"packages/dioxus",
"packages/document",
"packages/extension",
Expand Down Expand Up @@ -139,7 +137,6 @@ version = "0.7.0-alpha.3"
# dependencies that are shared across packages
[workspace.dependencies]
dioxus = { path = "packages/dioxus", version = "0.7.0-alpha.3" }
dioxus-lib = { path = "packages/dioxus-lib", version = "0.7.0-alpha.3", default-features = false }
dioxus-core = { path = "packages/core", version = "0.7.0-alpha.3" }
dioxus-core-types = { path = "packages/core-types", version = "0.7.0-alpha.3" }
dioxus-core-macro = { path = "packages/core-macro", version = "0.7.0-alpha.3" }
Expand Down
4 changes: 2 additions & 2 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

```rust, no_run
# tokio::runtime::Runtime::new().unwrap().block_on(async {
use dioxus_core::{VirtualDom, Event, Element, Mutations};
use dioxus_core::{VirtualDom, Event, Element, Mutations, VNode, ElementId};

let mut vdom = VirtualDom::new(app);
let real_dom = SomeRenderer::new();
Expand Down Expand Up @@ -59,7 +59,7 @@ The `dioxus` crate exports the `rsx` macro which transforms a helpful, simpler s
First, start with your app:

```rust
# use dioxus::dioxus_core::Mutations;
# use dioxus::dioxus_core::{Mutations, VirtualDom};
use dioxus::prelude::*;

// First, declare a root component
Expand Down
3 changes: 3 additions & 0 deletions packages/core/src/global_context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ pub fn suspend(task: Task) -> Element {
///
/// ```rust, no_run
/// # use dioxus::prelude::*;
/// # use dioxus_core::spawn_isomorphic;
/// // ❌ Do not do requests in isomorphic tasks. It may resolve at a different time on the server and client, causing hydration issues.
/// let mut state = use_signal(|| None);
/// spawn_isomorphic(async move {
Expand Down Expand Up @@ -171,6 +172,7 @@ pub fn queue_effect(f: impl FnOnce() + 'static) {
///
/// ```rust
/// use dioxus::prelude::*;
/// use dioxus_core::spawn_forever;
///
/// // The parent component can create and destroy children dynamically
/// fn App() -> Element {
Expand Down Expand Up @@ -373,6 +375,7 @@ pub fn schedule_update_any() -> Arc<dyn Fn(ScopeId) + Send + Sync> {
/// Example:
/// ```rust
/// use dioxus::prelude::*;
/// use dioxus_core::use_drop;
///
/// fn app() -> Element {
/// let mut state = use_signal(|| true);
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/reactive_context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ impl ReactiveContext {
///
/// ```rust, no_run
/// # use dioxus::prelude::*;
/// # use dioxus_core::ReactiveContext;
/// # use futures_util::StreamExt;
/// fn use_simplified_memo(mut closure: impl FnMut() -> i32 + 'static) -> Signal<i32> {
/// use_hook(|| {
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/runtime.rs
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,7 @@ impl Runtime {
///
/// ```rust
/// use dioxus::prelude::*;
/// use dioxus_core::{Runtime, RuntimeGuard};
///
/// fn main() {
/// let virtual_dom = VirtualDom::new(app);
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/scope_context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,7 @@ impl Scope {
///
/// ```rust, no_run
/// # use dioxus::prelude::*;
/// # use dioxus_core::spawn_isomorphic;
/// // ❌ Do not do requests in isomorphic tasks. It may resolve at a different time on the server and client, causing hydration issues.
/// let mut state = use_signal(|| None);
/// spawn_isomorphic(async move {
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/tasks.rs
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ impl Runtime {
///
/// ```rust, no_run
/// # use dioxus::prelude::*;
/// # use dioxus_core::spawn_isomorphic;
/// // ❌ Do not do requests in isomorphic tasks. It may resolve at a different time on the server and client, causing hydration issues.
/// let mut state = use_signal(|| None);
/// spawn_isomorphic(async move {
Expand Down
37 changes: 0 additions & 37 deletions packages/dioxus-lib/Cargo.toml

This file was deleted.

Loading
Loading