Struct BuildOptions 

pub struct BuildOptions {

    pub app_dir: PathBuf,
    pub entry: String,
    pub css: CssStrategy,
    pub dom: DomStrategy,
    pub plugin: Option<Plugin>,
    pub components: Vec<String>,
    pub component_asset_roots: Vec<String>,
    pub metafile: bool,
    pub css_file_name_template: String,
    pub css_public_base: Option<String>,
    pub legal_comments: LegalComments,
    pub theme: Option<TokenFile>,
    pub projection_manifests: Vec<ProjectionManifestSource>,
}

Options for building a WebUI application.

Fields

app_dir: PathBuf

Path to the application folder containing templates.

entry: String

Entry HTML file name (e.g., "index.html").

css: CssStrategy

CSS delivery strategy for component stylesheets.

dom: DomStrategy

DOM strategy for component rendering (shadow or light).

plugin: Option<Plugin>

Framework plugin to load.

components: Vec<String>

Additional component sources (npm packages or local paths).

component_asset_roots: Vec<String>

Additional root components to compile for static component asset emission.

These roots are parsed into the protocol so their templates, styles, and dependency closures can be emitted later, but they are not connected to the entry fragment and therefore are not rendered during initial SSR.

metafile: bool

Whether to serialize an esbuild-compatible component asset metafile.

css_file_name_template: String

Emitted asset filename template using [name], [hash], and [ext].

Applies to Link-mode CSS files and static component assets.

css_public_base: Option<String>

Optional URL/base-path prefix for Link-mode css_href values. When set, emitted protocol hrefs become <base>/<filename>.

legal_comments: LegalComments

Legal comment preservation strategy.

theme: Option<TokenFile>

Optional loaded design-token theme used to validate discovered CSS tokens.

When present, every discovered CSS token that remains unresolved after local and ancestor CSS definitions are removed must exist in every theme, unless the var() usage supplies a literal CSS fallback (e.g. var(--x, 16px)), which provides its own value. Missing required tokens fail the build as parser diagnostics.

projection_manifests: Vec<ProjectionManifestSource>

Bundler-neutral state projection manifest fragments supplied as disk paths or inline JSON with a logical manifest path.

Empty (the default) means projection is disabled: the build emits webui_protocol::InitialStateStrategy::Full and every scripted component keeps a full-state (All) partial-navigation surface. No JavaScript/TypeScript analysis ever runs in Rust.

When non-empty, every manifest is loaded, hash-validated against the files it declares, merged by component tag, and used to narrow each scripted component that is actually compiled into the protocol down to an exact hydration/navigation key surface. Every such scripted component must have exactly one manifest entry, or the build fails with WebUIError::Projection (PROJ-B001). Supplying manifests with a plugin other than Plugin::WebUI fails the build immediately (PROJ-B002): only the WebUI plugin produces protocol fields compatible with per-component key encoding.

Manifests are read only at build time. The runtime handler never opens a manifest file; the compiled protocol is fully self-contained.

Trait Implementations

impl Clone for BuildOptions

fn clone(&self) -> BuildOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildOptions

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

Formats the value using the given formatter.

impl Default for BuildOptions

fn default() -> Self

Returns the “default value” for a type.