Struct ScalarConfig 

pub struct ScalarConfig {

    pub theme: ScalarTheme,
    pub dark_mode: bool,
    pub hide_search: bool,
    pub hide_dark_mode_toggle: bool,
    pub show_sidebar: bool,
    pub layout: ScalarLayout,
    pub hide_models: bool,
    pub hide_client_button: bool,
    pub document_download: DocumentDownload,
    pub show_developer_tools: DeveloperTools,
    pub agent_enabled: bool,
    pub mcp_enabled: bool,
    pub cdn_url: Option<String>,
}

Scalar UI rendering options.

All fields default to the values the crate has shipped since the initial Scalar adoption — constructing ScalarConfig::default() and passing it to MountOpts::scalar is a no-op compared to omitting the call entirely.

Example

use doxa::{ScalarConfig, ScalarLayout, ScalarTheme};

let cfg = ScalarConfig::default()
    .layout(ScalarLayout::Classic)
    .theme(ScalarTheme::Solarized)
    .dark_mode(false);

Fields

theme: ScalarTheme

Visual theme. Defaults to ScalarTheme::Default.

dark_mode: bool

Initial dark mode state. Defaults to true. The user-facing toggle remains visible unless Self::hide_dark_mode_toggle is set.

hide_search: bool

Hide the search box. Defaults to false.

hide_dark_mode_toggle: bool

Hide the dark-mode toggle in the header. Defaults to false.

show_sidebar: bool

Show the left sidebar. Defaults to true.

layout: ScalarLayout

Page layout. Defaults to ScalarLayout::Modern (three-pane nav / description / playground).

hide_models: bool

Hide the standalone “Models” / schemas index. Defaults to true — referenced schemas still render inline under each operation.

hide_client_button: bool

Hide the “copy as curl/node/…” codegen button row. Defaults to true. The interactive try-it-out panel is unaffected.

document_download: DocumentDownload

Format offered by the header “Download OpenAPI” button. Defaults to DocumentDownload::None — the spec is still reachable at the mounted JSON path.

show_developer_tools: DeveloperTools

When the developer-tools drawer is exposed. Defaults to DeveloperTools::Never.

agent_enabled: bool

Enable Scalar’s “Ask AI” assistant. Defaults to false. Scalar charges for production use of this feature; leaving it off keeps the docs UI free of upsell surface.

mcp_enabled: bool

Enable Scalar’s “Generate MCP” integration. Defaults to false for the same reason as Self::agent_enabled.

cdn_url: Option<String>

Override the Scalar CDN URL. None keeps the crate’s default (https://cdn.jsdelivr.net/npm/@scalar/api-reference). Useful for air-gapped deployments, CDN mirrors, or self-hosted Scalar bundles — set this to the URL of the @scalar/api-reference script the browser should load.

This field is skipped during JSON serialization — it is a server-side concern only (the URL is written into the HTML template, not handed to Scalar as configuration).

Implementations

impl ScalarConfig

pub fn theme(self, theme: ScalarTheme) -> Self

Override the visual theme.

pub fn layout(self, layout: ScalarLayout) -> Self

Override the page layout.

pub fn dark_mode(self, on: bool) -> Self

Set the initial dark mode state.

pub fn hide_dark_mode_toggle(self, hide: bool) -> Self

Hide or show the dark-mode toggle.

pub fn hide_search(self, hide: bool) -> Self

Hide or show the search box.

pub fn show_sidebar(self, show: bool) -> Self

Show or hide the left sidebar.

pub fn hide_models(self, hide: bool) -> Self

Hide or show the standalone schemas index.

pub fn hide_client_button(self, hide: bool) -> Self

Hide or show the codegen button row.

pub fn document_download(self, format: DocumentDownload) -> Self

Configure the header download button format.

pub fn show_developer_tools(self, when: DeveloperTools) -> Self

Configure when the developer-tools drawer is exposed.

pub fn agent_enabled(self, on: bool) -> Self

Enable or disable Scalar’s “Ask AI” agent.

pub fn mcp_enabled(self, on: bool) -> Self

Enable or disable Scalar’s “Generate MCP” integration.

pub fn cdn_url(self, url: impl Into<String>) -> Self

Override the Scalar CDN URL. See Self::cdn_url for when to use this.

Trait Implementations

impl Clone for ScalarConfig

fn clone(&self) -> ScalarConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScalarConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScalarConfig

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for ScalarConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.