Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move to table of features for leptos #2044

Closed
wants to merge 2 commits into from
Closed

docs: move to table of features for leptos #2044

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f332cdc
docs: feature table and clarifications
chrisp60 Nov 19, 2023
da8aa93
fix: remove change to cfg
chrisp60 Nov 19, 2023
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
53 changes: 31 additions & 22 deletions leptos/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,28 +75,6 @@
//! - **Routing**: the [`leptos_router`](https://docs.rs/leptos_router/latest/leptos_router/) crate
//! - **Server Functions**: the [`server`](crate::leptos_server) macro, [`create_action`], and [`create_server_action`]
//!
//! # Feature Flags
//! - `nightly`: On `nightly` Rust, enables the function-call syntax for signal getters and setters.
//! - `csr` Client-side rendering: Generate DOM nodes in the browser
//! - `ssr` Server-side rendering: Generate an HTML string (typically on the server)
//! - `hydrate` Hydration: use this to add interactivity to an SSRed Leptos app
//! - `serde` (*Default*) In SSR/hydrate mode, uses [`serde`](https://docs.rs/serde/latest/serde/) to serialize resources and send them
//! from the server to the client.
//! - `serde-lite` In SSR/hydrate mode, uses [`serde-lite`](https://docs.rs/serde-lite/latest/serde_lite/) to serialize resources and send them
//! from the server to the client.
//! - `rkyv` In SSR/hydrate mode, uses [`rkyv`](https://docs.rs/rkyv/latest/rkyv/) to serialize resources and send them
//! from the server to the client.
//! - `miniserde` In SSR/hydrate mode, uses [`miniserde`](https://docs.rs/miniserde/latest/miniserde/) to serialize resources and send them
//! from the server to the client.
//! - `tracing` Adds additional support for [`tracing`](https://docs.rs/tracing/latest/tracing/) to components.
//! - `default-tls` Use default native TLS support. (Only applies when using server functions with a non-WASM client like a desktop app.)
//! - `rustls` Use `rustls`. (Only applies when using server functions with a non-WASM client like a desktop app.)
//! - `template_macro` Enables the [`template!`](leptos_macro::template) macro, which offers faster DOM node creation for some use cases in `csr`.
//!
//! **Important Note:** You must enable one of `csr`, `hydrate`, or `ssr` to tell Leptos
//! which mode your app is operating in. You should only enable one of these per build target,
//! i.e., you should not have both `hydrate` and `ssr` enabled for your server binary, only `ssr`.
//!
//! # A Simple Counter
//!
//! ```rust
Expand Down Expand Up @@ -140,6 +118,37 @@
//! }
//! # }
//! ```
//!
//! # All Features
//!
//! | Feature | Description | Default |
//! |:---------------------- |:------------------------------------------------------------ |:--------|
//! | nightly | **Syntax**: conveniences like `name()` vs. `name.get()` | No |
//! | csr[^1] | **Rendering**: Client-side. DOM nodes in browser. | No |
//! | ssr[^1] | **Rendering**: Server-side. HTML typically on server. | No |
//! | experimental-islands[^1] | **Rendering**: Render components on server by default. | No |
//! | hydrate[^1] | **Rendering-ish**: Add interactivity to an SSR app. | No |
//! | serde | **(De)Serialization**: use [serde] for [Resource]s. | Yes |
//! | serde-lite | **(De)Serialization**: use [serde-lite] for [Resource]s. | No |
//! | rkyv | **(De)Serialization**: use [rkyv] for [Resource]s. | No |
//! | miniserde | **(De)Serialization**: use [miniserde] for [Resource]s. | No |
//! | tracing | **Logs & Telemetry**, [tracing] support for [component]s. | No |
//! | default-tls[^2] | **Networking**: Use default native TLS support. | No |
//! | rustls[^2] | **Networking**: Use [rustls]. | No |
//! | template_macro | **Templating**: Enables the legacy [template] macro. | No |
//!
//! [^1]: At least one **rendering** feature must be enabled. An Isomorphic crate may have
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This rewritten version sounds misleading to me. Exactly one should be enabled, not more than one.

//! multiple rendering features listed in `Cargo.toml`. When compiling, ensure **one** rendering
//! feature is active at any given build step.
//!
//! [^2]: Only applies when using server functions with a non-WASM client like a desktop app
//!
//! [tracing]: https://docs.rs/tracing/latest/tracing/
//! [serde]: https://docs.rs/serde/latest/serde/
//! [rkyv]: https://docs.rs/rkyv/latest/rkyv/
//! [serde-lite]: https://docs.rs/serde-lite/latest/serde_lite/
//! [miniserde]: https://docs.rs/miniserde/latest/miniserde/
//! [rustls]: https://docs.rs/rustls/latest/rustls/

mod additional_attributes;
pub use additional_attributes::*;
Expand Down
Loading