English

Compiler Conf (gen_ui.toml)

gen_ui.toml is the configuration file of the GenUI project, which configures the compiler for specific project information and compiles the underlying and development plugins.

Configuration example

gen_ui.toml

1[compiler]
2target = "makepad"
3logo = true
4log_level = "info"
5excludes = ["Cargo.toml", "Cargo.lock", "target", ".gen_ui_cache", "gen_ui.toml", ".plugins"]
6
7[makepad]
8
9[makepad.root]
10path = "/Users/shengyifei/projects/gen_ui/made_with_GenUI/quickstart/start/views/root.gen"
11window = { height = "Fill", width = "Fill", flow = "Down", window_size = { inner_size = { x = 1080.0, y = 720.0 } } }
12
13[makepad.dependencies]
14makepad-widgets = { path = "/Users/shengyifei/projects/makepad/makepad/widgets" }
15
16[plugins]

Configuration description

key	value type	description
`compiler`	`CompilerConf`	Compile basic configuration
`underlayer`	`CompileUnderlayer`	Compile underlying configuration (dynamic type)
`plugins`	`Option<HashMap<String, PathBuf>>`	GenUI plugin

`[compiler]`

key	value type	description
`target`	`Underlayer`	Compile the underlying layer
`logo`	`bool`	Show GenUI Logo
`log_level`	`LogLevel`	Log level
`excludes`	`Excludes`	Files and directories that need to be excluded by the compiler

Underlayer

LogLevel

Excludes

Underlayer

makepad

None

`[makepad]`

key	value type	description
`entry`	`Option<String>`	Entry file name
`root`	`RootConf`	Entry configuration, including UI entry address and window properties
`dependencies`	`Option<Vec<RustDependence>>`	Rust dependencies
`router`	`Option<PathBuf>`	Path of the router.toml
`wasm`	`Option<WasmConf>`	wasm related configuration (compilation synchronization mode, not supported yet)

`[makepad.root]`

key	value type	description
`path`	`PathBuf`	address of ui root file
`window`	`Prop<WindowProps>`	the props of window

WindowProps

`[makepad.dependencies]`

Here use Option<Vec<RustDependence>>

RustDependence

`[makepad.wasm]`

key	value type	description
`fresh`	`bool`	need to recompile after each update?
`port`	`Option<u16>`	port (default is 8010)

`[plugins]`

Option<HashMap<String, PathBuf>>: Development plugin entry

This configuration is usually automatically added by the ract add command, unless you need to use a local plugin developed by yourself. Its writing method is very uniform, pointing to the directory where the plugin's token.toml is located

plugin_name = ".plugins/plugin_name"

Table of Contents

#Compiler Conf (gen_ui.toml)

#Configuration example

#Configuration description

#[compiler]

#Underlayer

#[makepad]

#[makepad.root]

#[makepad.dependencies]

#[makepad.wasm]

#[plugins]