cargo new to a windowFerroUI is a set of crates released together at one version. Name the same version for every FerroUI crate.
+FerroUI is a set of crates released together at one version. Name the same version for every FerroUI crate, or generate a project from one of the templates.
One command creates a project with its theme, its first window and its tests, in XAML with MVVM or code-behind, with builders or with rsx!, or as a cross-platform repository. The templates list them with their options.
cargo install cargo-generate
+cargo generate --git https://github.com/FerroUI/templates app --name my-appA desktop application names the base library, the controls, the desktop entry point and a theme:
Solitaire, Ember, FerroDesign and Calculator are set up this way: FerroUI as a git submodule, its workspace dependencies and profiles copied into the application's workspace, and FerroUI's reusable workflow for CI and GitHub Pages. The guide is docs/apps.md.
+Solitaire, Ember, FerroDesign and Calculator are set up this way: FerroUI as a git submodule, its workspace dependencies and profiles copied into the application's workspace, and FerroUI's reusable workflow for CI and GitHub Pages. The guide is docs/apps.md. The cross-platform template generates this layout with desktop, browser, Android and iOS hosts.
cargo generateProject and item templates in the spirit of the dotnet new templates of .NET UI frameworks: XAML with MVVM or code-behind, builders, rsx! with hooks, a cross-platform repository with desktop, browser, Android and iOS hosts, a control library, and the items you add to a project. Each project template asks for its theme.
cargo install cargo-generate
+
+# Pick a template from the list, or name it
+cargo generate --git https://github.com/FerroUI/templates
+cargo generate --git https://github.com/FerroUI/templates app --name my-app
+cd my-app
+cargo runThe templates live in FerroUI/templates, one folder per template, and are made with cargo-generate. Each option is a prompt, or --define name=value on the command line.
The single-crate templates name every FerroUI crate at =. The cross-platform template uses the layout of an application repository: FerroUI as a git submodule and its reusable CI workflow.
is being released. The generated projects build once it is on crates.io; the cross-platform template builds from the submodule already.
+A desktop application in XAML with the MVVM pattern, as in samples/MiniMvvm and samples/ReactiveUIExample. The build script compiles the documents to Rust; the view model and the window come with tests.
cargo generate --git https://github.com/FerroUI/templates app --name my-app
+cd my-app
+cargo runA desktop application in XAML with code-behind and no view models: the window names its event handler (Click="OnGreetClick") and its class implements it.
cargo generate --git https://github.com/FerroUI/templates app-codebehind --name my-app
+cd my-app
+cargo runA desktop application written in Rust with the builders of ferroui-view (stack_panel(), button()) and a signal the controls follow, as in samples/HelloWorld.Builders.
cargo generate --git https://github.com/FerroUI/templates declarative --name my-app
+cd my-app
+cargo runA desktop application with the React-like API: rsx! trees, #[component] functions, a signal, and a component that renders again when its hook state changes (use_signal, #[component(rerender)]), as in samples/HelloWorld.Macros and samples/HelloWorld.Hooks.
cargo generate --git https://github.com/FerroUI/templates rsx --name my-app
+cd my-app
+cargo runAn application repository laid out as docs/apps.md describes: a shared crate in XAML with the MVVM pattern, the hosts you choose, FerroUI as a git submodule at FerroUI/ and a CI workflow that calls FerroUI's app.yml, with the browser site on GitHub Pages. scripts/setup.sh adds the submodule once.
cargo generate --git https://github.com/FerroUI/templates cross-platform --name my-app
+cd my-app
+scripts/setup.sh
+cargo run -p my-app-desktopA library crate with a templated control: styled properties declared with ferro_properties!, a control theme in XAML keyed by the type of the control, the registration of both, and tests that apply the theme in a window.
cargo generate --git https://github.com/FerroUI/templates control-library --name my-controls
+cd my-controls
+cargo testA window: a XAML document with x:Class and its class with InitializeComponent(). Its README.md says how to declare and register it.
cd my-app/src/views
+cargo generate --git https://github.com/FerroUI/templates window --name SettingsWindow \
+ --define namespace=MyApp.Views
+# Then wire it in as README.md in the new folder saysA user control: a XAML document with x:Class and its class, to show as the content of a window or of another control.
cd my-app/src/views
+cargo generate --git https://github.com/FerroUI/templates user-control --name StatusView \
+ --define namespace=MyApp.Views
+# Then wire it in as README.md in the new folder saysA templated control: its class with the styled properties Header and IsHighlighted, and its control theme, which the application merges into its resources.
cd my-app/src/views
+cargo generate --git https://github.com/FerroUI/templates templated-control --name BadgeCard \
+ --define namespace=MyApp.Views
+# Then wire it in as README.md in the new folder saysA resource dictionary in XAML, merged into the resources of the application with ResourceInclude.
cd my-app/src
+cargo generate --git https://github.com/FerroUI/templates resource-dictionary --name AppResources
+# Then wire it in as README.md in the new folder saysA set of styles in XAML, included after the theme with StyleInclude.
cd my-app/src
+cargo generate --git https://github.com/FerroUI/templates styles --name AppStyles
+# Then wire it in as README.md in the new folder says