microsoft-webui-cli 0.0.12

docs.rs failed to build microsoft-webui-cli-0.0.12
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

microsoft-webui-cli

Command-line tool for the WebUI framework — build, serve, and inspect WebUI applications.

Install

cargo install microsoft-webui-cli

This installs the webui binary.

Commands

webui build

Build a WebUI application into a compiled protocol and CSS files.

webui build [APP] --out <DIR> [--entry <FILE>] [--css <MODE>] [--plugin <NAME>]
Option Default Description
APP . Template/component directory
--out (required) Output directory for protocol.bin + CSS
--entry index.html Entry HTML file
--css link CSS mode: link (external files) or style (inline)
--plugin (none) Framework plugin: webui for WebUI Framework, fast-v3 for @microsoft/fast-element 3.x hydration, or deprecated fast-v2/fast for @microsoft/fast-element 2.x compatibility 
webui build ./src --out ./dist
webui build ./src --out ./dist --plugin webui --css style

webui serve

Start a development server with live rebuild and HMR.

webui serve [APP] [--state <FILE>] [--servedir <DIR>] [--port <PORT>] [--api-port <PORT>] [--plugin <NAME>] [--watch]
Option Default Description
APP . Template/component directory
--state (none) JSON state file for rendering
--servedir (none) Static assets directory served at /*
--port 3000 Server port
--api-port (none) Proxy API requests to this port
--plugin (none) Framework plugin: webui for WebUI Framework, fast-v3 for @microsoft/fast-element 3.x hydration, or deprecated fast-v2/fast for @microsoft/fast-element 2.x compatibility
--watch off Enable file watching + HMR 
webui serve ./src --state ./data/state.json --port 3000 --watch
webui serve ./src --plugin webui --servedir ./dist --port 3004 --api-port 3014 --watch

Features:

  • Renders HTML at / and all route paths
  • Serves static files from --servedir
  • JSON partials for client-side navigation (Accept: application/json)
  • HMR polling at /hmr when --watch is enabled
  • API proxy when --api-port is set

webui inspect

Convert a compiled protocol to JSON for debugging.

webui inspect <FILE>

webui inspect ./dist/protocol.bin

App Layout

my-app/
├── src/
│   ├── index.html          # entry template
│   ├── my-card.html         # component template
│   └── my-card.css          # component styles
├── data/
│   └── state.json           # render state
└── dist/                    # build output
    ├── protocol.bin
    └── my-card.css

License

MIT