diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 0b31ea87d..9b7ffc2ec 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -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 diff --git a/Cargo.lock b/Cargo.lock index 412afc943..7244aa647 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -5443,14 +5443,15 @@ dependencies = [ "ciborium", "dioxus", "dioxus-cli-config", + "dioxus-core", "dioxus-desktop", "dioxus-devtools", + "dioxus-document", "dioxus-fullstack-hooks", "dioxus-fullstack-protocol", "dioxus-history", "dioxus-interpreter-js", "dioxus-isrg", - "dioxus-lib", "dioxus-router", "dioxus-server", "dioxus-web", @@ -5465,6 +5466,7 @@ dependencies = [ "serde", "server_fn", "thiserror 2.0.12", + "tokio", "tokio-stream", "tokio-util", "tower 0.5.2", @@ -5485,7 +5487,6 @@ dependencies = [ "dioxus-fullstack-protocol", "dioxus-history", "dioxus-hooks", - "dioxus-lib", "dioxus-signals", "futures-channel", "serde", @@ -5601,23 +5602,6 @@ dependencies = [ "walkdir", ] -[[package]] -name = "dioxus-lib" -version = "0.7.0-alpha.3" -dependencies = [ - "dioxus", - "dioxus-config-macro", - "dioxus-core", - "dioxus-core-macro", - "dioxus-document", - "dioxus-history", - "dioxus-hooks", - "dioxus-html", - "dioxus-rsx", - "dioxus-signals", - "warnings", -] - [[package]] name = "dioxus-liveview" version = "0.7.0-alpha.3" @@ -5787,11 +5771,15 @@ dependencies = [ "criterion", "dioxus", "dioxus-cli-config", + "dioxus-core", + "dioxus-core-macro", "dioxus-fullstack-hooks", "dioxus-history", - "dioxus-lib", + "dioxus-hooks", + "dioxus-html", "dioxus-router", "dioxus-router-macro", + "dioxus-signals", "dioxus-ssr", "percent-encoding", "rustversion", @@ -5871,14 +5859,18 @@ dependencies = [ "dashmap 6.1.0", "dioxus", "dioxus-cli-config", + "dioxus-core", + "dioxus-core-macro", "dioxus-devtools", + "dioxus-document", "dioxus-fullstack-hooks", "dioxus-fullstack-protocol", "dioxus-history", + "dioxus-html", "dioxus-interpreter-js", "dioxus-isrg", - "dioxus-lib", "dioxus-router", + "dioxus-signals", "dioxus-ssr", "enumset", "futures-channel", diff --git a/Cargo.toml b/Cargo.toml index a9cf1404a..d2ee10132 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,6 @@ resolver = "2" members = [ "packages/dioxus", - "packages/dioxus-lib", "packages/core", "packages/core-types", "packages/cli", @@ -32,7 +31,6 @@ members = [ "packages/desktop", "packages/devtools-types", "packages/devtools", - "packages/dioxus-lib", "packages/dioxus", "packages/document", "packages/extension", @@ -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" } diff --git a/packages/core/README.md b/packages/core/README.md index 37790897e..ae568c14d 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -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(); @@ -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 diff --git a/packages/core/src/global_context.rs b/packages/core/src/global_context.rs index af43a4065..854c6be86 100644 --- a/packages/core/src/global_context.rs +++ b/packages/core/src/global_context.rs @@ -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 { @@ -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 { @@ -373,6 +375,7 @@ pub fn schedule_update_any() -> Arc { /// Example: /// ```rust /// use dioxus::prelude::*; +/// use dioxus_core::use_drop; /// /// fn app() -> Element { /// let mut state = use_signal(|| true); diff --git a/packages/core/src/reactive_context.rs b/packages/core/src/reactive_context.rs index 83ac2e1e1..3bdc50c41 100644 --- a/packages/core/src/reactive_context.rs +++ b/packages/core/src/reactive_context.rs @@ -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 { /// use_hook(|| { diff --git a/packages/core/src/runtime.rs b/packages/core/src/runtime.rs index 1855ea09d..82c0d9229 100644 --- a/packages/core/src/runtime.rs +++ b/packages/core/src/runtime.rs @@ -448,6 +448,7 @@ impl Runtime { /// /// ```rust /// use dioxus::prelude::*; +/// use dioxus_core::{Runtime, RuntimeGuard}; /// /// fn main() { /// let virtual_dom = VirtualDom::new(app); diff --git a/packages/core/src/scope_context.rs b/packages/core/src/scope_context.rs index 8eb96e937..b1715c5b9 100644 --- a/packages/core/src/scope_context.rs +++ b/packages/core/src/scope_context.rs @@ -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 { diff --git a/packages/core/src/tasks.rs b/packages/core/src/tasks.rs index 431147687..e11f3a19c 100644 --- a/packages/core/src/tasks.rs +++ b/packages/core/src/tasks.rs @@ -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 { diff --git a/packages/dioxus-lib/Cargo.toml b/packages/dioxus-lib/Cargo.toml deleted file mode 100644 index 1417836ee..000000000 --- a/packages/dioxus-lib/Cargo.toml +++ /dev/null @@ -1,37 +0,0 @@ -[package] -name = "dioxus-lib" -version = { workspace = true } -authors = ["Jonathan Kelley", "Dioxus Labs", "ealmloff"] -edition = "2021" -description = "Build fullstack web, desktop, and mobile apps with a single codebase." -license = "MIT OR Apache-2.0" -repository = "https://github.com/DioxusLabs/dioxus/" -homepage = "https://dioxuslabs.com/learn/0.6/" -keywords = ["dom", "ui", "gui", "react", "wasm"] -rust-version = "1.79.0" - -[dependencies] -dioxus-core = { workspace = true } -dioxus-html = { workspace = true, optional = true } -dioxus-document = { workspace = true, optional = true } -dioxus-history = { workspace = true, optional = true } -dioxus-core-macro = { workspace = true, optional = true } -dioxus-config-macro = { workspace = true, optional = true } -dioxus-hooks = { workspace = true, optional = true } -dioxus-rsx = { workspace = true, optional = true } -dioxus-signals = { workspace = true, optional = true } -warnings = { workspace = true, optional = true } - -[dev-dependencies] -dioxus = { workspace = true } - -[features] -default = ["macro", "html", "signals", "hooks", "warnings"] -signals = ["dep:dioxus-signals"] -macro = ["dep:dioxus-core-macro", "dep:dioxus-rsx", "dep:dioxus-config-macro"] -html = ["dep:dioxus-html", "dep:dioxus-document", "dep:dioxus-history"] -hooks = ["dep:dioxus-hooks"] -warnings = ["dep:warnings"] - -[package.metadata.docs.rs] -cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"] diff --git a/packages/dioxus-lib/README.md b/packages/dioxus-lib/README.md deleted file mode 100644 index eb28cb7b1..000000000 --- a/packages/dioxus-lib/README.md +++ /dev/null @@ -1,274 +0,0 @@ -
- Build web, desktop, and mobile apps with a single codebase. -
- Getting Started | Book (0.6) | Examples -
-
- ---- - -> This crate implements dioxus-lib which is a renderer-free version of Dioxus. This crate is intended to be used by library authors who need a stable core version of dioxus withuot pulling in renderer-related dependencies on accident. - -# Overview and Goals - -Dioxus makes it easy to quickly build complex user interfaces with Rust. Any Dioxus app can run in the web browser, -as a desktop app, as a mobile app, or anywhere else provided you build the right renderer. - -Dioxus is heavily inspired by React, supporting many of the same concepts: - -- Hooks for state -- VirtualDom & diffing -- Concurrency, fibers, and asynchronous rendering -- JSX-like templating syntax - -If you know React, then you know Dioxus. - -Dioxus is _substantially_ more performant than many of the other Rust UI libraries (Yew/Percy) and is _significantly_ more performant -than React—roughly competitive with InfernoJS. - -Remember: Dioxus is a library for declaring interactive user interfaces—it is not a dedicated renderer. Most 1st party renderers for Dioxus currently only support web technologies. - -## Brief Overview - -All Dioxus apps are built by composing functions that return an `Element`. - -To launch an app, we use the `launch` method and use features in `Cargo.toml` to specify which renderer we want to use. In the launch function, we pass the app's root `Component`. - -```rust, no_run -use dioxus::prelude::*; - -fn main() { - dioxus::launch(App); -} - -// The #[component] attribute streamlines component creation. -// It's not required, but highly recommended. For example, UpperCamelCase components will not generate a warning. -#[component] -fn App() -> Element { - rsx! { "hello world!" } -} -``` - -## Elements & your first component - -To assemble UI trees with Dioxus, you need to use the `render` function on -something called `LazyNodes`. To produce `LazyNodes`, you can use the `rsx!` -macro or the NodeFactory API. For the most part, you want to use the `rsx!` -macro. - -Any element in `rsx!` can have attributes, listeners, and children. For -consistency, we force all attributes and listeners to be listed _before_ -children. - -```rust, ignore -let value = "123"; - -rsx! { - div { - class: "my-class {value}", // <--- attribute - onclick: move |_| info!("clicked!"), // <--- listener - h1 { "hello world" }, // <--- child - } -} -``` - -The `rsx!` macro accepts attributes in "struct form". Any rust expression contained within curly braces that implements `IntoIterator` will be parsed as a child. We make two exceptions: both `for` loops and `if` statements are parsed where their body is parsed as a child. - -```rust, ignore -rsx! { - div { - for _ in 0..10 { - span { "hello world" } - } - } -} -``` - -The `rsx!` macro is what generates the `Element` that our components return. - -```rust, ignore -#[component] -fn Example() -> Element { - rsx!{ "hello world" } -} -``` - -Putting everything together, we can write a simple component that renders a list of -elements: - -```rust, ignore -#[component] -fn App() -> Element { - let name = "dave"; - rsx! { - h1 { "Hello, {name}!" } - div { class: "my-class", id: "my-id", - for i in 0..5 { - div { "FizzBuzz: {i}" } - } - } - } -} -``` - -## Components - -We can compose these function components to build a complex app. Each new -component we design must take some Properties. For components with no explicit -properties we can omit the type altogether. - -In Dioxus, all properties are memoized by default, and this implement both Clone and PartialEq. For props you can't clone, simply wrap the fields in a ReadOnlySignal and Dioxus will handle the wrapping for you. - -```rust, ignore -#[component] -fn App() -> Element { - rsx! { - Header { - title: "My App", - color: "red", - } - } -} -``` - -Our `Header` component takes a `title` and a `color` property, which we -declare on an explicit `HeaderProps` struct. - -```rust, ignore -// The `Props` derive macro lets us add additional functionality to how props are interpreted. -#[derive(Props, PartialEq)] -struct HeaderProps { - title: String, - color: String, -} - -#[component] -fn Header(props: HeaderProps) -> Element { - rsx! { - div { - background_color: "{props.color}" - h1 { "{props.title}" } - } - } -} -``` - -The `#[component]` macro also allows you to derive the props -struct from function arguments: - -```rust, ignore -#[component] -fn Header(title: String, color: String) -> Element { - rsx! { - div { - background_color: "{color}" - h1 { "{title}" } - } - } -} -``` - -Components that begin with an uppercase letter may be called with -the traditional (for React) curly-brace syntax like so: - -```rust, ignore -rsx! { - Header { title: "My App" } -} -``` - -## Hooks - -While components are reusable forms of UI elements, hooks are reusable forms -of logic. Hooks provide us a way of retrieving state from Dioxus' internal `Scope` and using -it to render UI elements. - -By convention, all hooks are functions that should start with `use_`. We can -use hooks to define the state and modify it from within listeners. - -```rust, ignore -#[component] -fn App() -> Element { - let name = use_signal(|| "world"); - - rsx! { "hello {name}!" } -} -``` - -Hooks are sensitive to how they are used. To use hooks, you must abide by the -["rules of hooks"](https://dioxuslabs.com/learn/0.6/reference/hooks#rules-of-hooks): - -- Functions with "use\_" should not be called in callbacks -- Functions with "use\_" should not be called out of order -- Functions with "use\_" should not be called in loops or conditionals - -In a sense, hooks let us add a field of state to our component without declaring -an explicit state struct. However, this means we need to "load" the struct in the right -order. If that order is wrong, then the hook will pick the wrong state and panic. - -Most hooks you'll write are simply compositions of other hooks: - -```rust, ignore -fn use_username(d: Uuid) -> bool { - let users = use_context::(); - users.get(&id).map(|user| user.logged_in).ok_or(false) -} -``` - -To create entirely new foundational hooks, we can use the `use_hook` method. - -```rust, ignore -fn use_mut_string() -> String { - use_hook(|_| "Hello".to_string()) -} -``` - -If you want to extend Dioxus with some new functionality, you'll probably want to implement a new hook from scratch. - -## Putting it all together - -Using components, templates, and hooks, we can build a simple app. - -```rust, ignore -use dioxus::prelude::*; - -fn main() { - dioxus::launch(App); -} - -#[component] -fn App() -> Element { - let mut count = use_signal(|| 0); - - rsx!( - div { "Count: {count}" } - button { onclick: move |_| count += 1, "Increment" } - button { onclick: move |_| count -= 1, "Decrement" } - ) -} -``` - -## Features - -This overview doesn't cover everything. Make sure to check out the tutorial and reference guide on the official -website for more details. - -Beyond this overview, Dioxus supports: - -- Server-side rendering -- Concurrent rendering (with async support) -- Web/Desktop/Mobile support -- Pre-rendering and rehydration -- Fragments, Portals, and Suspense -- Inline-styles -- Custom event handlers -- Custom elements -- Basic fine-grained reactivity (IE SolidJS/Svelte) -- and more! - -Build cool things ✌️ diff --git a/packages/dioxus-lib/src/lib.rs b/packages/dioxus-lib/src/lib.rs deleted file mode 100644 index c5a3920db..000000000 --- a/packages/dioxus-lib/src/lib.rs +++ /dev/null @@ -1,69 +0,0 @@ -#![doc = include_str!("../README.md")] -#![cfg_attr(docsrs, feature(doc_cfg))] -#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")] -#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")] - -pub use dioxus_core as core; - -#[cfg(feature = "hooks")] -pub use dioxus_hooks as hooks; - -#[cfg(feature = "signals")] -pub use dioxus_signals as signals; - -pub mod events { - // #[cfg(feature = "html")] - // pub use dioxus_html::prelude::*; -} - -#[cfg(feature = "html")] -pub use dioxus_html as html; - -#[cfg(feature = "html")] -pub use dioxus_document as document; - -#[cfg(feature = "html")] -pub use dioxus_history as history; - -#[cfg(feature = "macro")] -pub use dioxus_rsx as rsx; - -#[cfg(feature = "macro")] -pub use dioxus_core_macro as core_macro; - -#[cfg(feature = "warnings")] -pub use warnings; - -pub mod prelude { - #[cfg(feature = "html")] - #[cfg_attr(docsrs, doc(cfg(feature = "html")))] - pub use dioxus_history::{history, History}; - - #[cfg(feature = "hooks")] - pub use crate::hooks::*; - - #[cfg(feature = "signals")] - pub use dioxus_signals::*; - - #[cfg(feature = "macro")] - #[allow(deprecated)] - pub use dioxus_core_macro::{component, rsx, Props}; - - #[cfg(feature = "macro")] - pub use dioxus_config_macro::*; - - #[cfg(feature = "html")] - pub use dioxus_html as dioxus_elements; - - #[cfg(feature = "html")] - pub use dioxus_elements::{events::*, global_attributes, svg_attributes, traits::*}; - - pub use dioxus_core; - - pub use dioxus_core::{ - consume_context, provide_context, spawn, suspend, try_consume_context, use_hook, Attribute, - Callback, Component, Context, Element, ErrorBoundary, ErrorContext, Event, EventHandler, - Fragment, HasAttributes, IntoDynNode, RenderError, ScopeId, SuspenseBoundary, - SuspenseContext, SuspenseExtension, VNode, VirtualDom, - }; -} diff --git a/packages/dioxus/Cargo.toml b/packages/dioxus/Cargo.toml index 84c290222..bbe8c7162 100644 --- a/packages/dioxus/Cargo.toml +++ b/packages/dioxus/Cargo.toml @@ -41,20 +41,25 @@ dioxus-devtools = { workspace = true, optional = true } [features] default = [ + "launch", + "devtools", + "logger", + "lib" +] +# All features recommended for use in libraries +lib = [ "macro", "html", "signals", "hooks", - "launch", "mounted", "file_engine", "document", "asset", - "devtools", - "logger", "warnings", "cli-config", ] +# The minimal set of features required to use dioxus renderers for minimal binary size minimal = ["macro", "html", "signals", "hooks", "launch"] signals = ["dep:dioxus-signals"] macro = ["dep:dioxus-core-macro"] diff --git a/packages/dioxus/src/lib.rs b/packages/dioxus/src/lib.rs index 5a53a73ec..1324844c4 100644 --- a/packages/dioxus/src/lib.rs +++ b/packages/dioxus/src/lib.rs @@ -26,6 +26,7 @@ #![cfg_attr(docsrs, feature(doc_cfg))] pub use dioxus_core; +#[doc(inline)] pub use dioxus_core::{CapturedError, Ok, Result}; #[cfg(feature = "launch")] @@ -127,27 +128,33 @@ pub use subsecond; pub mod prelude { #[cfg(feature = "document")] #[cfg_attr(docsrs, doc(cfg(feature = "document")))] + #[doc(inline)] pub use dioxus_document as document; #[cfg(feature = "document")] #[cfg_attr(docsrs, doc(cfg(feature = "document")))] + #[doc(inline)] pub use dioxus_history::{history, History}; #[cfg(feature = "launch")] #[cfg_attr(docsrs, doc(cfg(feature = "launch")))] + #[doc(inline)] pub use crate::launch::*; #[cfg(feature = "hooks")] #[cfg_attr(docsrs, doc(cfg(feature = "hooks")))] + #[doc(inline)] pub use crate::hooks::*; #[cfg(feature = "signals")] #[cfg_attr(docsrs, doc(cfg(feature = "signals")))] + #[doc(inline)] pub use dioxus_signals::*; #[cfg(feature = "macro")] #[cfg_attr(docsrs, doc(cfg(feature = "macro")))] #[allow(deprecated)] + #[doc(inline)] pub use dioxus_core_macro::{component, rsx, Props}; #[cfg(feature = "launch")] @@ -160,9 +167,15 @@ pub mod prelude { #[cfg(feature = "html")] #[cfg_attr(docsrs, doc(cfg(feature = "html")))] + #[doc(inline)] + pub use dioxus_elements::{Code, Key, Location, Modifiers}; + + #[cfg(feature = "html")] + #[cfg_attr(docsrs, doc(cfg(feature = "html")))] + #[doc(no_inline)] pub use dioxus_elements::{ events::*, extensions::*, global_attributes, keyboard_types, svg_attributes, traits::*, - Code, GlobalAttributesExtension, Key, Location, Modifiers, SvgAttributesExtension, + GlobalAttributesExtension, SvgAttributesExtension, }; #[cfg(feature = "devtools")] @@ -173,12 +186,14 @@ pub mod prelude { #[cfg(feature = "fullstack")] #[cfg_attr(docsrs, doc(cfg(feature = "fullstack")))] + #[doc(inline)] pub use dioxus_fullstack::{ server, server_fn, use_server_cached, use_server_future, ServerFnError, ServerFnResult, }; #[cfg(feature = "server")] #[cfg_attr(docsrs, doc(cfg(feature = "server")))] + #[doc(inline)] pub use dioxus_server::{ extract, DioxusRouterExt, DioxusRouterFnExt, FromContext, ServeConfig, }; @@ -189,6 +204,7 @@ pub mod prelude { #[cfg(feature = "router")] #[cfg_attr(docsrs, doc(cfg(feature = "router")))] + #[doc(inline)] pub use dioxus_router::{ hooks::*, navigator, use_navigator, GoBackButton, GoForwardButton, Link, NavigationTarget, Outlet, Routable, Router, @@ -196,12 +212,14 @@ pub mod prelude { #[cfg(feature = "asset")] #[cfg_attr(docsrs, doc(cfg(feature = "asset")))] + #[doc(inline)] pub use manganis::{self, *}; #[cfg(feature = "wasm-split")] #[cfg_attr(docsrs, doc(cfg(feature = "wasm-split")))] pub use wasm_splitter as wasm_split; + #[doc(inline)] pub use dioxus_core::{ consume_context, provide_context, spawn, suspend, try_consume_context, use_hook, Attribute, Callback, Component, Context, Element, ErrorBoundary, ErrorContext, Event, EventHandler, diff --git a/packages/fullstack-hooks/Cargo.toml b/packages/fullstack-hooks/Cargo.toml index a825f9194..31269a58d 100644 --- a/packages/fullstack-hooks/Cargo.toml +++ b/packages/fullstack-hooks/Cargo.toml @@ -21,8 +21,7 @@ dioxus-history.workspace = true [dev-dependencies] dioxus-fullstack = { workspace = true } -dioxus-lib = { workspace = true } -dioxus = { workspace = true } +dioxus = { workspace = true, features = ["fullstack"] } [features] web = [] diff --git a/packages/fullstack-hooks/src/hooks/server_cached.rs b/packages/fullstack-hooks/src/hooks/server_cached.rs index 0c7c85264..dad43a0e9 100644 --- a/packages/fullstack-hooks/src/hooks/server_cached.rs +++ b/packages/fullstack-hooks/src/hooks/server_cached.rs @@ -10,8 +10,7 @@ use serde::{de::DeserializeOwned, Serialize}; /// /// # Example /// ```rust -/// use dioxus_lib::prelude::*; -/// use dioxus_fullstack::prelude::*; +/// use dioxus::prelude::*; /// /// fn app() -> Element { /// let state1 = use_server_cached(|| { diff --git a/packages/fullstack/Cargo.toml b/packages/fullstack/Cargo.toml index 9e6f1abab..487c2c351 100644 --- a/packages/fullstack/Cargo.toml +++ b/packages/fullstack/Cargo.toml @@ -19,7 +19,8 @@ dioxus_server_macro = { workspace = true } axum = { workspace = true, optional = true } tower-http = { workspace = true, optional = true, features = ["fs"] } -dioxus-lib = { workspace = true, features = ["html"] } +dioxus-core = { workspace = true } +dioxus-document = { workspace = true } generational-box = { workspace = true } # Dioxus + SSR @@ -73,6 +74,7 @@ dioxus-history = { workspace = true } [dev-dependencies] dioxus = { workspace = true, features = ["fullstack"] } +tokio = { workspace = true, features = ["full"] } [features] default = ["devtools", "document", "file_engine", "mounted"] diff --git a/packages/fullstack/README.md b/packages/fullstack/README.md index a4a8b3771..23dcaffaa 100644 --- a/packages/fullstack/README.md +++ b/packages/fullstack/README.md @@ -86,6 +86,7 @@ Then we can set up dioxus with the axum server: ```rust, no_run #![allow(non_snake_case)] use dioxus::prelude::*; +use dioxus_fullstack::ServeConfig; // The entry point for the server #[cfg(feature = "server")] @@ -99,7 +100,7 @@ async fn main() { let router = axum::Router::new() // You can add a dioxus application to the router with the `serve_dioxus_application` method // This will add a fallback route to the router that will serve your component and server functions - .serve_dioxus_application(ServeConfigBuilder::default(), App); + .serve_dioxus_application(ServeConfig::new().unwrap(), App); // Finally, we can launch the server let router = router.into_make_service(); diff --git a/packages/fullstack/docs/request_origin.md b/packages/fullstack/docs/request_origin.md index bdd57dfc8..07208b904 100644 --- a/packages/fullstack/docs/request_origin.md +++ b/packages/fullstack/docs/request_origin.md @@ -1,6 +1,6 @@ This method interacts with information from the current request. The request may come from: -1. The initial SSR render if this method called from a [`Component`](dioxus_lib::prelude::component) or a [`server`](dioxus_server) function that is called during the initial render +1. The initial SSR render if this method called from a [`Component`](dioxus_core_macro::component) or a [`server`](dioxus_server) function that is called during the initial render ```rust # use dioxus::prelude::*; diff --git a/packages/fullstack/src/error.rs b/packages/fullstack/src/error.rs index b880eae4f..8d745b7da 100644 --- a/packages/fullstack/src/error.rs +++ b/packages/fullstack/src/error.rs @@ -4,7 +4,7 @@ use std::{ str::FromStr, }; -use dioxus_lib::core::{CapturedError, RenderError}; +use dioxus_core::{CapturedError, RenderError}; use serde::{de::DeserializeOwned, Serialize}; use server_fn::{ codec::JsonEncoding, @@ -33,7 +33,7 @@ pub type ServerFnResult = std::result::Result) -> std::fmt::Result { - /// write!(f, "My custom error") - /// } - /// } - /// /// #[server] - /// async fn server_function() -> ServerFnResult { + /// async fn server_function() -> ServerFnResult { /// // Return your custom error /// Err(ServerFnError::new("Something went wrong")) /// } diff --git a/packages/fullstack/src/web.rs b/packages/fullstack/src/web.rs index 21b6547d5..c1479cf6f 100644 --- a/packages/fullstack/src/web.rs +++ b/packages/fullstack/src/web.rs @@ -1,6 +1,6 @@ //! On the client, we use the [`WebDocument`] implementation to render the head for any elements that were not rendered on the server. -use dioxus_lib::document::*; +use dioxus_document::*; use dioxus_web::WebDocument; fn head_element_written_on_server() -> bool { diff --git a/packages/history/src/memory.rs b/packages/history/src/memory.rs index 2a6f3b82c..1d89e25ff 100644 --- a/packages/history/src/memory.rs +++ b/packages/history/src/memory.rs @@ -24,7 +24,6 @@ impl MemoryHistory { /// Create a [`MemoryHistory`] starting at `path`. /// /// ```rust - /// # use dioxus_router::prelude::*; /// # use dioxus::prelude::*; /// # #[component] /// # fn Index() -> Element { VNode::empty() } diff --git a/packages/manganis/manganis-core/src/css.rs b/packages/manganis/manganis-core/src/css.rs index 50da2ed30..67166409d 100644 --- a/packages/manganis/manganis-core/src/css.rs +++ b/packages/manganis/manganis-core/src/css.rs @@ -54,7 +54,7 @@ impl AssetOptions { /// Create a new css asset builder /// /// ```rust - /// # use manganis::{asset, Asset, CssAssetOptions}; + /// # use manganis::{asset, Asset, AssetOptions}; /// const _: Asset = asset!("/assets/style.css", AssetOptions::css()); /// ``` pub const fn css() -> AssetOptionsBuilder { @@ -68,7 +68,7 @@ impl AssetOptionsBuilder { /// Minifying the css can make your site load faster by loading less data /// /// ```rust - /// # use manganis::{asset, Asset, CssAssetOptions}; + /// # use manganis::{asset, Asset, AssetOptions}; /// const _: Asset = asset!("/assets/style.css", AssetOptions::css().with_minify(false)); /// ``` pub const fn with_minify(mut self, minify: bool) -> Self { @@ -81,7 +81,7 @@ impl AssetOptionsBuilder { /// Preloading css will make the image start to load as soon as possible. This is useful for css that is used soon after the page loads or css that may not be used immediately, but should start loading sooner /// /// ```rust - /// # use manganis::{asset, Asset, CssAssetOptions}; + /// # use manganis::{asset, Asset, AssetOptions}; /// const _: Asset = asset!("/assets/style.css", AssetOptions::css().with_preload(true)); /// ``` pub const fn with_preload(mut self, preload: bool) -> Self { diff --git a/packages/manganis/manganis-core/src/css_module.rs b/packages/manganis/manganis-core/src/css_module.rs index 402d7f65a..f46ec41c2 100644 --- a/packages/manganis/manganis-core/src/css_module.rs +++ b/packages/manganis/manganis-core/src/css_module.rs @@ -57,7 +57,7 @@ impl AssetOptions { /// Create a new css module asset builder /// /// ```rust - /// # use manganis::{asset, Asset, CssModuleAssetOptions}; + /// # use manganis::{asset, Asset, AssetOptions}; /// const _: Asset = asset!("/assets/style.css", AssetOptions::css_module()); /// ``` pub const fn css_module() -> AssetOptionsBuilder { diff --git a/packages/manganis/manganis-core/src/images.rs b/packages/manganis/manganis-core/src/images.rs index 9ceee9cd8..f3a4f00a3 100644 --- a/packages/manganis/manganis-core/src/images.rs +++ b/packages/manganis/manganis-core/src/images.rs @@ -127,7 +127,7 @@ impl AssetOptions { /// Create a new image asset builder /// /// ```rust - /// # use manganis::{asset, Asset, ImageAssetOptions}; + /// # use manganis::{asset, Asset, AssetOptions}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image()); /// ``` pub const fn image() -> AssetOptionsBuilder { @@ -141,7 +141,7 @@ impl AssetOptionsBuilder { /// Preloading an image will make the image start to load as soon as possible. This is useful for images that will be displayed soon after the page loads or images that may not be visible immediately, but should start loading sooner /// /// ```rust - /// # use manganis::{asset, Asset, ImageAssetOptions}; + /// # use manganis::{asset, Asset, AssetOptions}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image().with_preload(true)); /// ``` pub const fn with_preload(mut self, preload: bool) -> Self { @@ -154,7 +154,7 @@ impl AssetOptionsBuilder { /// Choosing the right format can make your site load much faster. Webp and avif images tend to be a good default for most images /// /// ```rust - /// # use manganis::{asset, Asset, ImageAssetOptions, ImageFormat}; + /// # use manganis::{asset, Asset, AssetOptions, ImageFormat}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image().with_format(ImageFormat::Webp)); /// ``` pub const fn with_format(mut self, format: ImageFormat) -> Self { @@ -168,7 +168,7 @@ impl AssetOptionsBuilder { /// they compress images well /// /// ```rust - /// # use manganis::{asset, Asset, ImageAssetOptions, ImageFormat}; + /// # use manganis::{asset, Asset, AssetOptions, ImageFormat}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image().with_avif()); /// ``` pub const fn with_avif(self) -> Self { @@ -181,7 +181,7 @@ impl AssetOptionsBuilder { /// they compress images well /// /// ```rust - /// # use manganis::{asset, Asset, ImageAssetOptions, ImageFormat}; + /// # use manganis::{asset, Asset, AssetOptions, ImageFormat}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image().with_webp()); /// ``` pub const fn with_webp(self) -> Self { @@ -193,7 +193,7 @@ impl AssetOptionsBuilder { /// Jpeg images compress much better than [`ImageFormat::Png`], but worse than [`ImageFormat::Webp`] or [`ImageFormat::Avif`] /// /// ```rust - /// # use manganis::{asset, Asset, ImageAssetOptions, ImageFormat}; + /// # use manganis::{asset, Asset, AssetOptions, ImageFormat}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image().with_jpg()); /// ``` pub const fn with_jpg(self) -> Self { @@ -205,7 +205,7 @@ impl AssetOptionsBuilder { /// Png images don't compress very well, so they are not recommended for large images /// /// ```rust - /// # use manganis::{asset, Asset, ImageAssetOptions, ImageFormat}; + /// # use manganis::{asset, Asset, AssetOptions, ImageFormat}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image().with_png()); /// ``` pub const fn with_png(self) -> Self { @@ -217,7 +217,7 @@ impl AssetOptionsBuilder { /// If you only use the image in one place, you can set the size of the image to the size it will be displayed at. This will make the image load faster /// /// ```rust - /// # use manganis::{asset, Asset, ImageAssetOptions, ImageSize}; + /// # use manganis::{asset, Asset, AssetOptions, ImageSize}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image().with_size(ImageSize::Manual { width: 512, height: 512 })); /// ``` pub const fn with_size(mut self, size: ImageSize) -> Self { diff --git a/packages/manganis/manganis-core/src/js.rs b/packages/manganis/manganis-core/src/js.rs index 6aed6cdc8..8ac9613d6 100644 --- a/packages/manganis/manganis-core/src/js.rs +++ b/packages/manganis/manganis-core/src/js.rs @@ -55,7 +55,7 @@ impl AssetOptions { /// Create a new js asset builder /// /// ```rust - /// # use manganis::{asset, Asset, JsAssetOptions}; + /// # use manganis::{asset, Asset, AssetOptions}; /// const _: Asset = asset!("/assets/script.js", AssetOptions::js()); /// ``` pub const fn js() -> AssetOptionsBuilder { @@ -69,7 +69,7 @@ impl AssetOptionsBuilder { /// Minifying the js can make your site load faster by loading less data /// /// ```rust - /// # use manganis::{asset, Asset, JsAssetOptions}; + /// # use manganis::{asset, Asset, AssetOptions}; /// const _: Asset = asset!("/assets/script.js", AssetOptions::js().with_minify(false)); /// ``` #[allow(unused)] @@ -83,7 +83,7 @@ impl AssetOptionsBuilder { /// Preloading the javascript will make the javascript start to load as soon as possible. This is useful for javascript that will be used soon after the page loads or javascript that may not be used immediately, but should start loading sooner /// /// ```rust - /// # use manganis::{asset, Asset, JsAssetOptions}; + /// # use manganis::{asset, Asset, AssetOptions}; /// const _: Asset = asset!("/assets/script.js", AssetOptions::js().with_preload(true)); /// ``` #[allow(unused)] diff --git a/packages/manganis/manganis-core/src/options.rs b/packages/manganis/manganis-core/src/options.rs index 263f11721..dd383ab4d 100644 --- a/packages/manganis/manganis-core/src/options.rs +++ b/packages/manganis/manganis-core/src/options.rs @@ -62,10 +62,10 @@ impl AssetOptions { /// A builder for [`AssetOptions`] /// /// ```rust -/// # use manganis::AssetOptionsBuilder; +/// # use manganis::{AssetOptions, Asset, asset}; /// static ASSET: Asset = asset!( -/// "image.png", -/// AssetOptionsBuilder::new() +/// "/assets/style.css", +/// AssetOptions::builder() /// .with_hash_suffix(false) /// ); /// ``` @@ -130,8 +130,8 @@ impl AssetOptionsBuilder { /// ```rust /// #[used] /// static ASSET: manganis::Asset = manganis::asset!( - /// "path/to/asset.png", - /// AssetVariant::Unknown.into_asset_options() + /// "/assets/style.css", + /// manganis::AssetOptions::builder() /// .with_hash_suffix(false) /// ); /// ``` diff --git a/packages/manganis/manganis-macro/src/lib.rs b/packages/manganis/manganis-macro/src/lib.rs index f73685dac..e497d805b 100644 --- a/packages/manganis/manganis-macro/src/lib.rs +++ b/packages/manganis/manganis-macro/src/lib.rs @@ -45,17 +45,17 @@ use linker::generate_link_section; /// ``` /// Resize the image at compile time to make the assets file size smaller: /// ```rust -/// # use manganis::{asset, Asset, ImageAssetOptions, ImageSize}; +/// # use manganis::{asset, Asset, AssetOptions, ImageSize}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image().with_size(ImageSize::Manual { width: 52, height: 52 })); /// ``` /// Or convert the image at compile time to a web friendly format: /// ```rust -/// # use manganis::{asset, Asset, ImageAssetOptions, ImageSize, ImageFormat}; +/// # use manganis::{asset, Asset, AssetOptions, ImageSize, ImageFormat}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image().with_format(ImageFormat::Avif)); /// ``` /// You can mark images as preloaded to make them load faster in your app /// ```rust -/// # use manganis::{asset, Asset, ImageAssetOptions}; +/// # use manganis::{asset, Asset, AssetOptions}; /// const _: Asset = asset!("/assets/image.png", AssetOptions::image().with_preload(true)); /// ``` #[proc_macro] @@ -77,7 +77,7 @@ pub fn asset(input: TokenStream) -> TokenStream { /// - The asset string path. This is the absolute path (from the crate root) to your CSS module. /// - An optional `CssModuleAssetOptions` struct to configure the processing of your CSS module. /// -/// ```rust +/// ```rust, ignore /// css_module!(StylesIdent = "/my.module.css", AssetOptions::css_module()); /// ``` /// @@ -90,7 +90,7 @@ pub fn asset(input: TokenStream) -> TokenStream { /// - It generates an asset using the `asset!()` macro and automatically inserts it into the app meta. /// - It generates a struct with snake-case associated constants of your CSS idents. /// -/// ```rust +/// ```rust, ignore /// // This macro usage: /// css_module!(Styles = "/mycss.module.css"); /// @@ -99,7 +99,7 @@ pub fn asset(input: TokenStream) -> TokenStream { /// /// impl Styles { /// // This can be accessed with `Styles::your_ident` -/// pub const your_ident: &str = "abc", +/// pub const your_ident: &str = "abc"; /// } /// ``` /// @@ -121,13 +121,13 @@ pub fn asset(input: TokenStream) -> TokenStream { /// # Variable Visibility /// If you want your asset or styles constant to be public, you can add the `pub` keyword in front of them. /// Restricted visibility (`pub(super)`, `pub(crate)`, etc) is also supported. -/// ```rust +/// ```rust, ignore /// css_module!(pub Styles = "/mycss.module.css"); /// ``` /// /// # Asset Options /// Similar to the `asset!()` macro, you can pass an optional `CssModuleAssetOptions` to configure a few processing settings. -/// ```rust +/// ```rust, ignore /// use manganis::CssModuleAssetOptions; /// /// css_module!(Styles = "/mycss.module.css", @@ -155,7 +155,7 @@ pub fn asset(input: TokenStream) -> TokenStream { /// } /// ``` /// Then you can use the `css_module!()` macro in your Rust project: -/// ```rust +/// ```rust, ignore /// css_module!(Styles = "/mycss.module.css"); /// /// println!("{}", Styles::header); diff --git a/packages/manganis/manganis/README.md b/packages/manganis/manganis/README.md index 48d3f7838..81a5486dd 100644 --- a/packages/manganis/manganis/README.md +++ b/packages/manganis/manganis/README.md @@ -12,7 +12,7 @@ const AVIF_ASSET: Asset = manganis::asset!("/assets/image.png"); AVIF_ASSET will be set to a new file name that will be served by some CLI. That file can be collected by any package that depends on the component library. ```rust -use manganis::{ImageFormat, ImageAssetOptions, Asset, asset, ImageSize}; +use manganis::{ImageFormat, Asset, asset, ImageSize, AssetOptions}; // You can collect arbitrary files. Absolute paths are resolved relative to the package root const _: Asset = asset!("/assets/script.js"); diff --git a/packages/router/Cargo.toml b/packages/router/Cargo.toml index 32e8613dd..4a1ad42ba 100644 --- a/packages/router/Cargo.toml +++ b/packages/router/Cargo.toml @@ -10,7 +10,11 @@ homepage = "https://dioxuslabs.com" keywords = ["dom", "ui", "gui", "react", "wasm"] [dependencies] -dioxus-lib = { workspace = true, default-features = false, features = ["signals", "macro", "hooks"] } +dioxus-core = { workspace = true } +dioxus-core-macro = { workspace = true } +dioxus-signals = { workspace = true } +dioxus-hooks = { workspace = true } +dioxus-html = { workspace = true, optional = true } dioxus-history = { workspace = true } dioxus-router-macro = { workspace = true } dioxus-fullstack-hooks = { workspace = true, optional = true } @@ -24,7 +28,7 @@ rustversion = { workspace = true } default = ["html"] streaming = ["dep:dioxus-fullstack-hooks"] wasm-split = [] -html = ["dioxus-lib/html"] +html = ["dep:dioxus-html"] [dev-dependencies] axum = { workspace = true, features = ["ws"] } diff --git a/packages/router/README.md b/packages/router/README.md index 95b61f41b..0d73931f3 100644 --- a/packages/router/README.md +++ b/packages/router/README.md @@ -27,7 +27,6 @@ expressiveness. ```rust, no_run use dioxus::prelude::*; -use dioxus_router::prelude::*; use std::str::FromStr; #[rustfmt::skip] diff --git a/packages/router/src/components/child_router.rs b/packages/router/src/components/child_router.rs index 2abd37171..edead0735 100644 --- a/packages/router/src/components/child_router.rs +++ b/packages/router/src/components/child_router.rs @@ -1,8 +1,8 @@ /// Components that allow the macro to add child routers. This component provides a context /// to the child router that maps child routes to root routes and vice versa. -use dioxus_lib::prelude::*; - use crate::Routable; +use dioxus_core::{provide_context, try_consume_context, use_hook, Element}; +use dioxus_core_macro::{component, Props}; /// Maps a child route into the root router and vice versa // NOTE: Currently child routers only support simple static prefixes, but this @@ -53,7 +53,7 @@ impl PartialEq for ChildRouterProps { } } -/// A component that provides a [`History`] to a child router. The `#[child]` attribute on the router macro will insert this automatically. +/// A component that provides a [`History`](dioxus_history::History) to a child router. The `#[child]` attribute on the router macro will insert this automatically. #[component] #[allow(missing_docs)] pub fn ChildRouter(props: ChildRouterProps) -> Element { diff --git a/packages/router/src/components/default_errors.rs b/packages/router/src/components/default_errors.rs index 7d54084ad..d20384466 100644 --- a/packages/router/src/components/default_errors.rs +++ b/packages/router/src/components/default_errors.rs @@ -1,6 +1,10 @@ +use dioxus_core::Element; +use dioxus_core_macro::rsx; +use dioxus_html as dioxus_elements; +use dioxus_signals::{GlobalSignal, Readable}; + #[allow(deprecated)] use crate::hooks::use_router; -use dioxus_lib::prelude::*; /// The default component to render when an external navigation fails. #[allow(non_snake_case)] diff --git a/packages/router/src/components/history_buttons.rs b/packages/router/src/components/history_buttons.rs index d58932f0d..5fa3ed727 100644 --- a/packages/router/src/components/history_buttons.rs +++ b/packages/router/src/components/history_buttons.rs @@ -1,4 +1,7 @@ -use dioxus_lib::prelude::*; +use dioxus_core::{Element, VNode}; +use dioxus_core_macro::{rsx, Props}; +use dioxus_html as dioxus_elements; +use dioxus_signals::{GlobalSignal, Readable}; use tracing::error; @@ -24,7 +27,6 @@ pub struct HistoryButtonProps { /// # Example /// ```rust /// # use dioxus::prelude::*; -/// # use dioxus_router::prelude::*; /// #[derive(Clone, Routable)] /// enum Route { /// #[route("/")] @@ -97,7 +99,6 @@ pub fn GoBackButton(props: HistoryButtonProps) -> Element { /// # Example /// ```rust /// # use dioxus::prelude::*; -/// # use dioxus_router::prelude::*; /// #[derive(Clone, Routable)] /// enum Route { /// #[route("/")] diff --git a/packages/router/src/components/history_provider.rs b/packages/router/src/components/history_provider.rs index e0ed6b6f1..c6e4a4bb5 100644 --- a/packages/router/src/components/history_provider.rs +++ b/packages/router/src/components/history_provider.rs @@ -1,5 +1,7 @@ +use dioxus_core::{use_hook, Callback, Element}; +use dioxus_core_macro::{component, Props}; use dioxus_history::{provide_history_context, History}; -use dioxus_lib::prelude::*; +use dioxus_signals::Owner; use std::rc::Rc; diff --git a/packages/router/src/components/link.rs b/packages/router/src/components/link.rs index 171867569..3c7e684e2 100644 --- a/packages/router/src/components/link.rs +++ b/packages/router/src/components/link.rs @@ -2,7 +2,12 @@ use std::fmt::Debug; -use dioxus_lib::prelude::*; +use dioxus_core::{Attribute, Element, EventHandler, VNode}; +use dioxus_core_macro::{rsx, Props}; +use dioxus_html::{ + self as dioxus_elements, ModifiersInteraction, MountedEvent, MouseEvent, PointerInteraction, +}; +use dioxus_signals::{GlobalSignal, Owner, Readable}; use tracing::error; @@ -91,7 +96,6 @@ impl Debug for LinkProps { /// # Example /// ```rust /// # use dioxus::prelude::*; -/// # use dioxus_router::prelude::*; /// /// #[derive(Clone, Routable)] /// enum Route { diff --git a/packages/router/src/components/outlet.rs b/packages/router/src/components/outlet.rs index c4fe2c51c..add96a655 100644 --- a/packages/router/src/components/outlet.rs +++ b/packages/router/src/components/outlet.rs @@ -1,5 +1,5 @@ use crate::{outlet::OutletContext, *}; -use dioxus_lib::prelude::*; +use dioxus_core::Element; /// An outlet for the current content. /// @@ -15,7 +15,6 @@ use dioxus_lib::prelude::*; /// # Example /// ```rust /// # use dioxus::prelude::*; -/// # use dioxus_router::prelude::*; /// #[derive(Clone, Routable)] /// #[rustfmt::skip] /// enum Route { diff --git a/packages/router/src/components/router.rs b/packages/router/src/components/router.rs index e1d04c02c..ba559568d 100644 --- a/packages/router/src/components/router.rs +++ b/packages/router/src/components/router.rs @@ -1,6 +1,7 @@ -use dioxus_lib::prelude::*; - use crate::{provide_router_context, routable::Routable, router_cfg::RouterConfig, Outlet}; +use dioxus_core::{provide_context, use_hook, Callback, Element}; +use dioxus_core_macro::{rsx, Props}; +use dioxus_signals::{GlobalSignal, Owner, Readable}; /// The props for [`Router`]. #[derive(Props)] @@ -41,7 +42,7 @@ pub fn Router(props: RouterProps) -> Element { }); #[cfg(feature = "streaming")] - use_after_suspense_resolved(|| { + dioxus_hooks::use_after_suspense_resolved(|| { dioxus_fullstack_hooks::commit_initial_chunk(); }); diff --git a/packages/router/src/contexts/navigator.rs b/packages/router/src/contexts/navigator.rs index f1563f017..83cd8f3c4 100644 --- a/packages/router/src/contexts/navigator.rs +++ b/packages/router/src/contexts/navigator.rs @@ -9,7 +9,7 @@ use crate::{ExternalNavigationFailure, NavigationTarget, RouterContext}; /// Panics if there is no router present. pub fn navigator() -> Navigator { Navigator( - dioxus_lib::core::try_consume_context::() + dioxus_core::try_consume_context::() .expect("A router must be present to use navigator"), ) } diff --git a/packages/router/src/contexts/outlet.rs b/packages/router/src/contexts/outlet.rs index 0795fc340..a18aaf52a 100644 --- a/packages/router/src/contexts/outlet.rs +++ b/packages/router/src/contexts/outlet.rs @@ -1,4 +1,4 @@ -use dioxus_lib::core::{provide_context, try_consume_context, use_hook, Element, VNode}; +use dioxus_core::{provide_context, try_consume_context, use_hook, Element, VNode}; use crate::{routable::Routable, utils::use_router_internal::use_router_internal}; @@ -75,8 +75,8 @@ impl OutletContext { /// # Examples /// /// ```rust, no_run -/// # use dioxus_lib::prelude::*; -/// # use dioxus_router::prelude::{use_outlet_context,Routable}; +/// # use dioxus::prelude::*; +/// # use dioxus_router::use_outlet_context; /// /// # #[derive(Routable,Clone,PartialEq)] /// # enum MyRouter { diff --git a/packages/router/src/contexts/router.rs b/packages/router/src/contexts/router.rs index d2281cd11..a93f382d3 100644 --- a/packages/router/src/contexts/router.rs +++ b/packages/router/src/contexts/router.rs @@ -5,8 +5,9 @@ use std::{ sync::{Arc, Mutex}, }; +use dioxus_core::{provide_context, Element, ReactiveContext, ScopeId}; use dioxus_history::history; -use dioxus_lib::{core::ReactiveContext, prelude::*}; +use dioxus_signals::{CopyValue, Readable, Signal, Writable}; use crate::{ components::child_router::consume_child_route_mapping, navigation::NavigationTarget, diff --git a/packages/router/src/hooks/use_navigator.rs b/packages/router/src/hooks/use_navigator.rs index 48f417f90..e0bbcc102 100644 --- a/packages/router/src/hooks/use_navigator.rs +++ b/packages/router/src/hooks/use_navigator.rs @@ -1,4 +1,4 @@ -use dioxus_lib::core::{try_consume_context, use_hook}; +use dioxus_core::{try_consume_context, use_hook}; use crate::{Navigator, RouterContext}; @@ -8,7 +8,6 @@ use crate::{Navigator, RouterContext}; /// /// ```rust /// # use dioxus::prelude::*; -/// # use dioxus_router::prelude::*; /// #[derive(Clone, Routable)] /// enum Route { /// #[route("/")] diff --git a/packages/router/src/hooks/use_router.rs b/packages/router/src/hooks/use_router.rs index 7fb380183..86b7c8f38 100644 --- a/packages/router/src/hooks/use_router.rs +++ b/packages/router/src/hooks/use_router.rs @@ -10,11 +10,11 @@ pub fn use_router() -> RouterContext { /// Acquire the router without subscribing to updates. #[doc(alias = "url")] pub fn router() -> RouterContext { - dioxus_lib::core::consume_context() + dioxus_core::consume_context() } /// Try to acquire the router without subscribing to updates. #[doc(alias = "url")] pub fn try_router() -> Option { - dioxus_lib::core::try_consume_context() + dioxus_core::try_consume_context() } diff --git a/packages/router/src/lib.rs b/packages/router/src/lib.rs index 400fd5949..6e9804f32 100644 --- a/packages/router/src/lib.rs +++ b/packages/router/src/lib.rs @@ -82,7 +82,7 @@ pub trait HasProps { type Props; } -impl

HasProps for dioxus_lib::core::Component

{ +impl

HasProps for dioxus_core::Component

{ type Props = P; } diff --git a/packages/router/src/navigation.rs b/packages/router/src/navigation.rs index cd331122f..be085c48e 100644 --- a/packages/router/src/navigation.rs +++ b/packages/router/src/navigation.rs @@ -30,7 +30,6 @@ pub enum NavigationTarget { /// /// ```rust /// # use dioxus::prelude::*; - /// # use dioxus_router::prelude::*; /// # use dioxus_router::navigation::NavigationTarget; /// # #[component] /// # fn Index() -> Element { @@ -50,7 +49,6 @@ pub enum NavigationTarget { /// /// ```rust /// # use dioxus::prelude::*; - /// # use dioxus_router::prelude::*; /// # use dioxus_router::navigation::NavigationTarget; /// # #[component] /// # fn Index() -> Element { diff --git a/packages/router/src/routable.rs b/packages/router/src/routable.rs index b5fb670df..1abf7d463 100644 --- a/packages/router/src/routable.rs +++ b/packages/router/src/routable.rs @@ -1,7 +1,7 @@ #![allow(non_snake_case)] //! # Routable -use dioxus_lib::core::Element; +use dioxus_core::Element; use std::iter::FlatMap; use std::slice::Iter; use std::{fmt::Display, str::FromStr}; @@ -308,6 +308,7 @@ impl, M> Display for DisplayQueryArgument<'_, T, M> { /// /// ```rust /// use dioxus::prelude::*; +/// use dioxus_router::FromHashFragment; /// /// #[derive(Routable, Clone)] /// #[rustfmt::skip] @@ -475,6 +476,7 @@ fn full_circle() { /// /// ```rust /// use dioxus::prelude::*; +/// use dioxus_router::{ToRouteSegments, FromRouteSegments}; /// /// #[derive(Routable, Clone, PartialEq, Debug)] /// enum Route { @@ -566,6 +568,7 @@ fn to_route_segments() { /// /// ```rust /// use dioxus::prelude::*; +/// use dioxus_router::{ToRouteSegments, FromRouteSegments}; /// /// #[derive(Routable, Clone, PartialEq, Debug)] /// enum Route { @@ -735,7 +738,6 @@ pub trait Routable: FromStr + Display + Clone + 'static { /// /// # Example /// ```rust - /// use dioxus_router::prelude::*; /// use dioxus::prelude::*; /// /// #[component] @@ -803,7 +805,6 @@ pub trait Routable: FromStr + Display + Clone + 'static { /// /// # Example /// ```rust - /// use dioxus_router::prelude::*; /// use dioxus::prelude::*; /// /// #[component] diff --git a/packages/router/src/router_cfg.rs b/packages/router/src/router_cfg.rs index 729cc3a6c..9f9886b91 100644 --- a/packages/router/src/router_cfg.rs +++ b/packages/router/src/router_cfg.rs @@ -1,13 +1,13 @@ use crate::{GenericRouterContext, NavigationTarget, Routable, RoutingCallback}; -use dioxus_lib::core::Element; +use dioxus_core::Element; use std::sync::Arc; /// Global configuration options for the router. /// /// This implements [`Default`] and follows the builder pattern, so you can use it like this: /// ```rust,no_run -/// # use dioxus_router::prelude::*; /// # use dioxus::prelude::*; +/// # use dioxus_router::RouterConfig; /// # #[component] /// # fn Index() -> Element { /// # VNode::empty() diff --git a/packages/router/src/utils/use_router_internal.rs b/packages/router/src/utils/use_router_internal.rs index bf6bc7f9b..21f172479 100644 --- a/packages/router/src/utils/use_router_internal.rs +++ b/packages/router/src/utils/use_router_internal.rs @@ -1,5 +1,5 @@ use crate::RouterContext; -use dioxus_lib::core::{try_consume_context, use_hook}; +use dioxus_core::{try_consume_context, use_hook}; /// A private hook to subscribe to the router. /// diff --git a/packages/rsx/src/expr_node.rs b/packages/rsx/src/expr_node.rs index 9ca7b9098..8c08df146 100644 --- a/packages/rsx/src/expr_node.rs +++ b/packages/rsx/src/expr_node.rs @@ -27,7 +27,11 @@ impl ToTokens for ExprNode { fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) { let expr = &self.expr; tokens.append_all(quote! { - { let ___nodes = (#expr).into_dyn_node(); ___nodes } + { + #[allow(unused_braces)] + let ___nodes = dioxus_core::IntoDynNode::into_dyn_node(#expr); + ___nodes + } }) } } diff --git a/packages/rsx/src/forloop.rs b/packages/rsx/src/forloop.rs index b17a7d9c4..2e5f93b7b 100644 --- a/packages/rsx/src/forloop.rs +++ b/packages/rsx/src/forloop.rs @@ -49,7 +49,7 @@ impl ToTokens for ForLoop { // the temporary is important so we create a lifetime binding tokens.append_all(quote! { { - let ___nodes = (#expr).into_iter().map(|#pat| { #body }).into_dyn_node(); + let ___nodes = dioxus_core::IntoDynNode::into_dyn_node((#expr).into_iter().map(|#pat| { #body })); ___nodes } }); diff --git a/packages/rsx/src/ifchain.rs b/packages/rsx/src/ifchain.rs index b1f6cee99..1530faf5e 100644 --- a/packages/rsx/src/ifchain.rs +++ b/packages/rsx/src/ifchain.rs @@ -127,7 +127,7 @@ impl ToTokens for IfChain { tokens.append_all(quote! { { - let ___nodes = (#body).into_dyn_node(); + let ___nodes = dioxus_core::IntoDynNode::into_dyn_node(#body); ___nodes } }) diff --git a/packages/server/Cargo.toml b/packages/server/Cargo.toml index 85977e930..f158f254e 100644 --- a/packages/server/Cargo.toml +++ b/packages/server/Cargo.toml @@ -12,7 +12,11 @@ resolver = "2" [dependencies] # dioxus -dioxus-lib = { workspace = true } +dioxus-core = { workspace = true } +dioxus-core-macro = { workspace = true } +dioxus-signals = { workspace = true } +dioxus-document = { workspace = true } +dioxus-html = { workspace = true } generational-box = { workspace = true } # server functions diff --git a/packages/server/docs/request_origin.md b/packages/server/docs/request_origin.md index a56372514..5a28b834d 100644 --- a/packages/server/docs/request_origin.md +++ b/packages/server/docs/request_origin.md @@ -1,9 +1,10 @@ This method interacts with information from the current request. The request may come from: -1. The initial SSR render if this method called from a [`Component`](dioxus_lib::prelude::component) or a [`server`](crate) function that is called during the initial render +1. The initial SSR render if this method called from a [`Component`](dioxus_core_macro::component) or a [`server`](crate) function that is called during the initial render ```rust # use dioxus::prelude::*; +use dioxus_server::server_context; #[component] fn PrintHtmlRequestInfo() -> Element { // The server context only exists on the server, so we need to put it behind a server_only! config @@ -22,6 +23,7 @@ fn PrintHtmlRequestInfo() -> Element { ```rust # use dioxus::prelude::*; +use dioxus_server::server_context; #[server] async fn read_headers() -> ServerFnResult { // Since we are calling this from a server function, the server context that is may be from the diff --git a/packages/server/src/config.rs b/packages/server/src/config.rs index 286ed38f8..e7b209825 100644 --- a/packages/server/src/config.rs +++ b/packages/server/src/config.rs @@ -1,7 +1,7 @@ //! Configuration for how to serve a Dioxus application #![allow(non_snake_case)] -use dioxus_lib::prelude::dioxus_core::LaunchConfig; +use dioxus_core::LaunchConfig; use std::any::Any; use std::fs::File; use std::io::Read; @@ -49,7 +49,7 @@ impl ServeConfigBuilder { /// // Finally, launch the app with the config /// LaunchBuilder::new() /// // Only set the server config if the server feature is enabled - /// .with_cfg(server_only!(ServeConfigBuilder::default().incremental(IncrementalRendererConfig::default()))) + /// .with_cfg(server_only!(dioxus_server::ServeConfigBuilder::default().incremental(dioxus_server::IncrementalRendererConfig::default()))) /// .launch(app); /// ``` pub fn incremental(mut self, cfg: dioxus_isrg::IncrementalRendererConfig) -> Self { @@ -96,7 +96,7 @@ impl ServeConfigBuilder { /// LaunchBuilder::new() /// // Only set the server config if the server feature is enabled /// .with_cfg(server_only! { - /// ServeConfigBuilder::default().root_id("app") + /// dioxus_server::ServeConfigBuilder::default().root_id("app") /// }) /// // You also need to set the root id in your web config /// .with_cfg(web! { @@ -113,7 +113,7 @@ impl ServeConfigBuilder { self } - /// Provide context to the root and server functions. You can use this context while rendering with [`consume_context`](dioxus_lib::prelude::consume_context) + /// Provide context to the root and server functions. You can use this context while rendering with [`consume_context`](dioxus_core::consume_context) /// or in server functions with [`FromContext`](crate::FromContext). /// /// @@ -183,7 +183,7 @@ impl ServeConfigBuilder { } /// Provide context to the root and server functions. You can use this context - /// while rendering with [`consume_context`](dioxus_lib::prelude::consume_context) or in server functions with [`FromContext`](crate::FromContext). + /// while rendering with [`consume_context`](dioxus_core::consume_context) or in server functions with [`FromContext`](crate::FromContext). /// /// /// The context providers passed into this method will be called when the context type is requested which may happen many times in the lifecycle of the application. @@ -246,7 +246,7 @@ impl ServeConfigBuilder { self } - /// Provide context to the root and server functions. You can use this context while rendering with [`consume_context`](dioxus_lib::prelude::consume_context) + /// Provide context to the root and server functions. You can use this context while rendering with [`consume_context`](dioxus_core::consume_context) /// or in server functions with [`FromContext`](crate::FromContext). /// /// Context will be forwarded from the LaunchBuilder if it is provided. diff --git a/packages/server/src/context.rs b/packages/server/src/context.rs index ef67cef17..89ad93d23 100644 --- a/packages/server/src/context.rs +++ b/packages/server/src/context.rs @@ -47,6 +47,7 @@ impl AtomicResponsePartsModified { /// /// ```rust, no_run /// # use dioxus::prelude::*; +/// use dioxus_server::server_context; /// #[server] /// async fn read_headers() -> ServerFnResult { /// let server_context = server_context(); @@ -200,6 +201,7 @@ mod server_fn_impl { /// /// ```rust, no_run /// # use dioxus::prelude::*; + /// use dioxus_server::server_context; /// #[server] /// async fn set_headers() -> ServerFnResult { /// let server_context = server_context(); @@ -224,6 +226,7 @@ mod server_fn_impl { /// /// ```rust, no_run /// # use dioxus::prelude::*; + /// use dioxus_server::server_context; /// #[server] /// async fn set_headers() -> ServerFnResult { /// let server_context = server_context(); @@ -246,6 +249,7 @@ mod server_fn_impl { /// /// ```rust, no_run /// # use dioxus::prelude::*; + /// use dioxus_server::server_context; /// #[server] /// async fn set_status() -> ServerFnResult { /// let server_context = server_context(); @@ -267,6 +271,7 @@ mod server_fn_impl { /// /// ```rust, no_run /// # use dioxus::prelude::*; + /// use dioxus_server::server_context; /// #[server] /// async fn set_version() -> ServerFnResult { /// let server_context = server_context(); @@ -288,6 +293,7 @@ mod server_fn_impl { /// /// ```rust, no_run /// # use dioxus::prelude::*; + /// use dioxus_server::server_context; /// #[server] /// async fn set_version() -> ServerFnResult { /// let server_context = server_context(); @@ -322,6 +328,7 @@ mod server_fn_impl { /// /// ```rust, no_run /// # use dioxus::prelude::*; + /// use dioxus_server::server_context; /// #[server] /// async fn read_headers() -> ServerFnResult { /// let server_context = server_context(); @@ -346,6 +353,7 @@ mod server_fn_impl { /// /// ```rust, no_run /// # use dioxus::prelude::*; + /// use dioxus_server::server_context; /// #[server] /// async fn read_headers() -> ServerFnResult { /// let server_context = server_context(); @@ -369,6 +377,7 @@ mod server_fn_impl { /// /// ```rust, no_run /// # use dioxus::prelude::*; + /// use dioxus_server::server_context; /// #[server] /// async fn read_headers() -> ServerFnResult { /// let server_context = server_context(); diff --git a/packages/server/src/document.rs b/packages/server/src/document.rs index cb1ee6769..5eb566caf 100644 --- a/packages/server/src/document.rs +++ b/packages/server/src/document.rs @@ -4,7 +4,13 @@ use std::cell::RefCell; -use dioxus_lib::{document::*, prelude::*}; +use dioxus_core::Element; +use dioxus_core_macro::rsx; +use dioxus_document::{ + Document, Eval, LinkProps, MetaProps, NoOpDocument, ScriptProps, StyleProps, +}; +use dioxus_html as dioxus_elements; +use dioxus_signals::{GlobalSignal, Readable}; use dioxus_ssr::Renderer; use parking_lot::RwLock; use std::sync::LazyLock; diff --git a/packages/server/src/launch.rs b/packages/server/src/launch.rs index 07db84293..ac5891ad5 100644 --- a/packages/server/src/launch.rs +++ b/packages/server/src/launch.rs @@ -11,8 +11,10 @@ use axum::{ routing::IntoMakeService, }; use dioxus_cli_config::base_path; +use dioxus_core::Element; +#[cfg(not(target_arch = "wasm32"))] +use dioxus_core::{RenderError, VNode}; use dioxus_devtools::DevserverMsg; -use dioxus_lib::prelude::*; use futures_util::{stream::FusedStream, StreamExt}; use hyper::body::Incoming; use hyper_util::server::conn::auto::Builder as HyperBuilder; diff --git a/packages/server/src/render.rs b/packages/server/src/render.rs index f9d75a2ab..ffbac12dc 100644 --- a/packages/server/src/render.rs +++ b/packages/server/src/render.rs @@ -5,16 +5,14 @@ use crate::{ DioxusServerContext, }; use dioxus_cli_config::base_path; +use dioxus_core::{ + has_context, provide_error_boundary, DynamicNode, ErrorContext, ScopeId, SuspenseContext, + VNode, VirtualDom, +}; use dioxus_fullstack_hooks::history::FullstackHistory; use dioxus_fullstack_hooks::{StreamingContext, StreamingStatus}; use dioxus_fullstack_protocol::{HydrationContext, SerializedHydrationData}; use dioxus_isrg::{CachedRender, IncrementalRendererError, RenderFreshness}; -use dioxus_lib::{ - core::{ - has_context, provide_error_boundary, DynamicNode, ErrorContext, SuspenseContext, VirtualDom, - }, - document::Document, -}; use dioxus_router::ParseRouteError; use dioxus_ssr::Renderer; use futures_channel::mpsc::Sender; @@ -23,7 +21,6 @@ use std::{collections::HashMap, fmt::Write, future::Future, rc::Rc, sync::Arc, s use tokio::task::JoinHandle; use crate::StreamingMode; -use dioxus_lib::prelude::*; /// A suspense boundary that is pending with a placeholder in the client struct PendingSuspenseBoundary { @@ -210,7 +207,7 @@ impl SsrRendererPool { let streaming_context = in_root_scope(&virtual_dom, StreamingContext::new); virtual_dom.provide_root_context(Rc::new(history) as Rc); - virtual_dom.provide_root_context(document.clone() as Rc); + virtual_dom.provide_root_context(document.clone() as Rc); virtual_dom.provide_root_context(streaming_context); // rebuild the virtual dom diff --git a/packages/server/src/server.rs b/packages/server/src/server.rs index a2455ae4a..844eedf07 100644 --- a/packages/server/src/server.rs +++ b/packages/server/src/server.rs @@ -9,7 +9,7 @@ use axum::{ response::IntoResponse, }; -use dioxus_lib::prelude::{Element, VirtualDom}; +use dioxus_core::{Element, VirtualDom}; use http::header::*; use server_fn::ServerFnTraitObj; use std::path::Path; @@ -25,8 +25,7 @@ pub trait DioxusRouterExt: DioxusRouterFnExt { /// # Example /// ```rust, no_run /// # #![allow(non_snake_case)] - /// # use dioxus_lib::prelude::*; - /// # use dioxus_server::prelude::*; + /// # use dioxus::prelude::*; /// use dioxus_server::{DioxusRouterExt, DioxusRouterFnExt}; /// /// #[tokio::main] @@ -52,9 +51,8 @@ pub trait DioxusRouterExt: DioxusRouterFnExt { /// # Example /// ```rust, no_run /// # #![allow(non_snake_case)] - /// # use dioxus_lib::prelude::*; - /// # use dioxus_server::prelude::*; - /// use dioxus_server::{DioxusRouterExt, DioxusRouterFnExt}; + /// # use dioxus::prelude::*; + /// use dioxus_server::{DioxusRouterExt, DioxusRouterFnExt, ServeConfig}; /// /// #[tokio::main] /// async fn main() { @@ -113,8 +111,8 @@ pub trait DioxusRouterFnExt { /// /// # Example /// ```rust, no_run - /// # use dioxus_lib::prelude::*; - /// # use dioxus_server::prelude::*; + /// # use dioxus::prelude::*; + /// # use dioxus_server::DioxusRouterFnExt; /// #[tokio::main] /// async fn main() { /// let addr = dioxus::cli_config::fullstack_address_or_localhost(); @@ -138,8 +136,8 @@ pub trait DioxusRouterFnExt { /// /// # Example /// ```rust, no_run - /// # use dioxus_lib::prelude::*; - /// # use dioxus_server::prelude::*; + /// # use dioxus::prelude::*; + /// # use dioxus_server::DioxusRouterFnExt; /// # use std::sync::Arc; /// #[tokio::main] /// async fn main() { @@ -162,9 +160,8 @@ pub trait DioxusRouterFnExt { /// /// # Example /// ```rust, no_run - /// # use dioxus_lib::prelude::*; - /// # use dioxus_server::prelude::*; - /// # use dioxus_server::prelude::*; + /// # use dioxus::prelude::*; + /// # use dioxus_server::{DioxusRouterFnExt, ServeConfig}; /// #[tokio::main] /// async fn main() { /// let router = axum::Router::new()