FSC - Web UI Framework - A simple, but great way to design modern applications for windows in C#
WUF is short and means Web UI Framework. This framework is based on WPF and the webview2. This library makes it possible to use HTML and CSS instead of XAML. It is important to not forget, that this is not a website. Yes, you load html and css, but javascript is blocked. Instead of JavaScript, there is a JS - C# bridge with a lot of methods to use. It works really well.
The library includes bootrap 5 by default. So if you don't have any experience in CSS, you are able to use all bootstrap features.
Yes, custom CSS is supported. It can be used by appending a css resource to the head.
No, this doesn't work. It is different to a normal website. For example the input tags and others that work like that, may not end without a slash.
- wrong.
- right. As it is visible, the library has some special rules. Same as loading the "page". You are not able to load one big HTML file. There is a limit of 2 MB. To load bigger content, make an index.html as your default site and load with innerHtml, append or prepend the content into the body or into other elements.
Yes, it's true. What ever happens, this library will not reload the view. Everything works dynamic with C#. You need a table? Add one per html resource. You want to add a table row? Sure, add it per html resource. It is very easy to use.
No, don't worry. You need to set all files that you want to use as an embedded resource. After compiling, they will not be visible from the outside. There is almost no visible difference to a normal program.
It works with every .Net6 and .Net7 project. The recommend way is the following:
- Start a .Net6|7 console project
- Go to the project properties and change the application type from console to windows application
- Start writing the code ...
using System.Diagnostics;
using System.Windows;
using System.Windows.Media;
namespace FSC.WUF.TEST
{
internal class Program
{
[STAThread] // <- This is important
static void Main(string[] args)
{
var window = WindowManager.Create((WindowManager window) => Run(window), new Size(300, 300));
Application application = new Application();
application.Run();
}
static Action<WindowManager> Run = (WindowManager window) =>
{
var html = new Html();
html.Load("index.html");
window.ShowIcon = Visibility.Collapsed;
window.ResizeMode = ResizeMode.CanResize;
window.Background = new SolidColorBrush(Color.FromRgb(33, 37, 41));
window.Titlebar = new WindowTitlebar
{
Background = new SolidColorBrush(Color.FromRgb(33, 37, 41)),
Foreground = new SolidColorBrush(Color.FromRgb(255, 255, 255))
};
window.Load(html);
window.OnLoaded += async (s, e) =>
{
await window.AddEventListener(".btn-primary", "click", async (HtmlDocument element) =>
{
var input = await window.GetElement("input").Value();
input = input.Trim('"');
if (string.IsNullOrWhiteSpace(input))
{
MessageBox.Show("Enter a name please ...");
return;
}
MessageBox.Show("Hello " + input);
});
await window.AddEventListener(".btn-secondary", "click", (HtmlDocument element) =>
{
MessageBox.Show("Please use login ...");
});
var css = new Css();
css.Load("test.css");
await window.GetElement("head").Append(css);
window.OnPopup += (s, e) => Process.Start(new ProcessStartInfo(e?.Link) { UseShellExecute = true });
};
};
}
}This html file is a demo. Normally you should split it up into multiple html files, otherwise your file could become larger than 2 MB
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title></title>
</head>
<body class="bg-dark">
<div class="container">
<h1 class="text-white h1 mt-3">Login</h1>
<p class="text text-white">
Please login to use our services
</p>
<!--<img class="img-fluid" src="res://test.png" />--> <!-- Resources can load with a res:// link. To be more exact, it could be res://namespace.test.png -->
<!--<a class="link" href="test" target="_blank">Test</a>-->
<form>
<div class="input-group flex-nowrap my-2">
<span class="input-group-text" id="addon-wrapping">@</span>
<input type="text" class="form-control" placeholder="Username" aria-label="Username" aria-describedby="addon-wrapping"/>
</div>
<div class="input-group flex-nowrap my-2">
<span class="input-group-text" id="addon-wrapping">*</span>
<input type="password" disabled="disabled" class="form-control" placeholder="Password" aria-label="Username" aria-describedby="addon-wrapping"/>
</div>
<div class="w-100">
<button id="unique-btn" class="btn btn-primary float-end">Login</button>
<button class="btn btn-secondary mx-2 float-end">Register</button>
</div>
<a href="https://google.com">Click here >Google<</a>
</form>
</div>
</body>
</html>h1 {
background-image: url("res://test.png"); // Even here you can set resources per res url
background-size: auto 100%;
}We all know the old bindings. They are still there and work as usual. But now there are new ones. They are called "ForEach Bindings". You use them in your html file with a foreach loop.
Program.cs
{ ... } // Removed for shorter code
var html = new Html();
html.Load("index.html");
html.ForEachBinding(new People()); <-- This is a foreach binding. It only needs the instance of the class where the iteration objects are located.
window.ShowIcon = Visibility.Collapsed;
window.ResizeMode = ResizeMode.CanResize;
window.Background = new SolidColorBrush(Color.FromRgb(33, 37, 41));
window.WindowStartupLocation = WindowStartupLocation.CenterScreen;
window.Titlebar = new WindowTitlebar
{
Background = new SolidColorBrush(Color.FromRgb(33, 37, 41)),
Foreground = new SolidColorBrush(Color.FromRgb(255, 255, 255))
};
ImageSource? icon = GetIconFromResource("FSC.WUF.TEST.icon.ico");
if (icon is not null)
{
window.Icon = icon;
}
window.Load(html);
{ ... } // Removed for shorter codePeople.cs
public class People
{
public List<Person> GetPeople = new List<Person>();
public People()
{
var person1 = new Person
{
Id = 0,
FirstName = "Jack",
LastName = "Exampleman",
Age = 30,
};
var person2 = new Person
{
Id = 1,
FirstName = "Timmy",
LastName = "Lalala",
Age = 16,
};
var person3 = new Person
{
Id = 2,
FirstName = "Cindy",
LastName = "Stone",
Age = 25,
};
GetPeople.Add(person1);
GetPeople.Add(person2);
GetPeople.Add(person3);
}
}index.html
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Table Binding</title>
</head>
<body class="bg-dark">
<table class="table table-dark table-striped">
<thead>
<tr>
<th scope="col">Id</th>
<th scope="col">First name</th>
<th scope="col">Last name</th>
<th scope="col">Age</th>
</tr>
</thead>
<tbody class="people">
<foreach from="GetPeople" as="person"> <-- This is the foreach binding. It needs the iteration object name (list, dictionary, ...) and the name of the iteration variable that you want to use.
<tr>
<th scope="row">@Binding->person.Id;</th>
<td>@Binding->person.FirstName;</td>
<td>@Binding->person.LastName;</td>
<td>@Binding->person.Age;</td>
</tr>
</foreach>
</tbody>
</table>
</body>
</html>You are using a dictionary or a list inside a class, but you only need an element at a specific index? No problem. You can use the index in the foreach binding.
<th scope="row">@Binding->person.Id[0];</th>
<th scope="row">@Binding->person.Id["example"];</th>
Currently only integer and string is supported as indexer
Info: If you put the foreach into a new file, you need a parent element, that wraps everything. The foreach is not a valid wrapper node.
JsString is not a JavaScript code. It is the opposite. Sadly it came up, that code injection is possible. This class can be used like string
JsString variable = "Hello World";
So don't worry, nothing will change for you.
By using this class, users of your program can't inject code anymore. It will be delivered safely.
Let's take a small look at them
Program.cs
namespace FSC.WUF.TEST
{
internal class Program
{
[STAThread]
static void Main(string[] args)
{
var window = WindowManager.Create((WindowManager window) => Run(window), new Size(600, 500));
Application application = new Application();
application.Run();
}
static Action<WindowManager> Run = (WindowManager window) =>
{
var html = new Html();
html.Load("index.html");
window.ShowIcon = Visibility.Collapsed;
window.ResizeMode = ResizeMode.CanResize;
window.Background = new SolidColorBrush(Color.FromRgb(33, 37, 41));
window.WindowStartupLocation = WindowStartupLocation.CenterScreen;
window.Titlebar = new WindowTitlebar
{
Background = new SolidColorBrush(Color.FromRgb(33, 37, 41)),
Foreground = new SolidColorBrush(Color.FromRgb(255, 255, 255))
};
window.Load(html);
window.OnLoaded += async (s, e) =>
{
var people = new List<Person>();
var person1 = new Person {
Id = 0,
FirstName = "Jack",
LastName = "Exampleman",
Age = 30,
};
var person2 = new Person {
Id = 1,
FirstName = "Timmy",
LastName = "Lalala",
Age = 16,
};
var person3 = new Person {
Id = 2,
FirstName = "Cindy",
LastName = "Stone",
Age = 25,
};
people.Add(person1);
people.Add(person2);
people.Add(person3);
var html = new Html();
html.Load("table_row.html");
html.Bind(people);
await window.GetElement(".people").Append(html);
};
};
}
}index.html
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Table Binding</title>
</head>
<body class="bg-dark">
<table class="table table-dark table-striped">
<thead>
<tr>
<th scope="col">Id</th>
<th scope="col">First name</th>
<th scope="col">Last name</th>
<th scope="col">Age</th>
</tr>
</thead>
<tbody class="people">
</tbody>
</table>
</body>
</html>table_row.html
<tr>
<th scope="row">@Binding->Id;</th>
<td>@Binding->FirstName;</td>
<td>@Binding->LastName;</td>
<td>@Binding->Age;</td>
</tr>