Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VincentH-Net/CSharpForMarkup
Concise, declarative C# UI markup for .NET browser / native UI frameworks
https://github.com/VincentH-Net/CSharpForMarkup
csharp ide-support maui readability uno-platform winui3 wpf xamarin xamarin-forms xaml
Last synced: 30 days ago
JSON representation
Concise, declarative C# UI markup for .NET browser / native UI frameworks
- Host: GitHub
- URL: https://github.com/VincentH-Net/CSharpForMarkup
- Owner: VincentH-Net
- License: mit
- Created: 2018-03-21T13:33:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-07T09:28:45.000Z (7 months ago)
- Last Synced: 2024-11-08T03:41:18.708Z (about 1 month ago)
- Topics: csharp, ide-support, maui, readability, uno-platform, winui3, wpf, xamarin, xamarin-forms, xaml
- Language: C#
- Homepage:
- Size: 16.3 MB
- Stars: 751
- Watchers: 35
- Forks: 43
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-xamarin-forms - CSharpForMarkup ★438
README
# C# Markup 2
*Concise* next-gen C# Markup for .NET UI frameworks
## C# Markup 2 for Uno Platform
C# Markup 2 supports multiple UI frameworks, including the **excellent** [Uno Platform](https://platform.uno/).
If you don't know Uno, I recommend you check them out; Uno is one of the best and most mature .NET UI frameworks, it offers an impressive breadth of features that will have your back when you need to create real-world production apps end2end, *fast*.
## Quick play-around
```bat
dotnet new install Uno.Templates
dotnet new install Modern.CSharp.Templates
md UnoCSharpMarkup2
cd UnoCSharpMarkup2
dotnet new unoapp -preset recommended
dotnet new mcs-uno-markup2 --presentation mvux --allow-scripts yes
```
## Markup options at a glance - good for everyone!
Uno Platform supports XAML but recently has embraced C# UI as well with [Uno C# Markup](https://platform.uno/c-markup/). C# Markup 2 adds another option that goes above and beyond what gen-1 C# Markup variants offer.
It's good to have options - everyone wins: devs get the experience that they like best, and the UI framework gains more adoption. Check it out and pick what you like!
As a first impression, here's a quick side-by-side comparison:
Enjoy a Flutter-like UI development experience with C# Markup 2:
- Build **.NET applications fully in C#**
- Unclutter your markup - while reading *and* writing.
- C# Markup **2** goes above and beyond gen 1 C# Markup approaches (e.g. [Maui](https://learn.microsoft.com/en-us/dotnet/communitytoolkit/maui/markup/markup) or [Uno](https://aka.platform.uno/csharp-markup)) to eliminate a lot of verbosity: no more endless repetitions of `new `, `HorizontalAlignment = HorizontalAlignment.Center`, `() => ` or `nameof()`, no more specifying for each and every `TextBlock` binding that yes, you want to bind to the `Text` property...
- Separated markup namespaces eliminate intellisense pollution, allow quick discovery and encourage clean separation of markup and logic: no more intellisense lists where you have to search in a sea of irrelevant options for the few that you are interested in. See only Markup API's while editing `MyPage.cs`, see UI framework and other API's while editing `MyPage.logic.cs`.
- Target browsers and native desktop / mobile
- Use existing UI frameworks. Mature or bleeding edge is *your* choice: WPF, WinUI 3 for Windows App SDK and Uno Platform. Coming: AvaloniaUI, Maui, possibly Blazor.
- Use the built-in MVVM support - or any other update model that supports your UI framework (e.g. [Uno's MVUX](https://platform.uno/docs/articles/external/uno.extensions/doc/Overview/Mvux/Overview.html) or [ReactiveUI](https://www.reactiveui.net/))
- Use for part or all of your application UI
- Designed to handle large UI fast: practically allocation-free, no reflection, efficient C#
No XAML / HTML / JavaScript / CSS required. No engine or layers to get in your way.
> NuGet
>[](https://www.nuget.org/packages/Modern.CSharp.Templates)
>[](https://www.nuget.org/packages/CSharpMarkup.WinUI)
>[](https://www.nuget.org/packages/CSharpMarkup.WinUI.Uno.Toolkit)
>[](https://www.nuget.org/packages/CSharpMarkup.WinUI.Uno.Extensions.Reactive)
>[](https://www.nuget.org/packages/CSharpMarkup.WinUI.Uno.Extensions.Navigation)
>[](https://www.nuget.org/packages/CSharpMarkup.WinUI.Uno.Extensions.Navigation.Toolkit)
>[](https://www.nuget.org/packages/CSharpMarkup.WinUI.LiveChartsCore.SkiaSharpView)
>
>[](https://www.nuget.org/packages/CSharpMarkup.WPF)
>
> Chat (if needed, [join DotNetEvolution](https://aka.ms/dotnet-discord) first)
> [](https://discord.com/channels/732297728826277939/931198774234189844)
> **The best place to ask questions or help!**
# Getting Started
- **Uno Platform / WinUI 3**: [Getting started with C# Markup 2 for WinUI 3 and Windows App SDK / Uno Platform](#getting-started-for-winui-3-and-windows-app-sdk--uno-platform)
- **WPF**: [Getting started with C# Markup 2 for WPF](#getting-started-for-wpf)
*Looking for C# Markup 1? Find it [here](https://github.com/VincentH-Net/CSharpForMarkup/tree/csharpformarkup1-archive)*
# News
*May 7, 2024*
> ## New C# Markup 2.4 for Uno Platform 5.2 incl .NET Single Project
Today's release is fully updated to Updated to Uno 5.2 including Uno's [.NET Single Project](https://platform.uno/blog/the-first-and-only-true-single-project-for-mobile-web-desktop-and-embedded-in-net/) and `uno.sdk`!
Plus:
- Added support for latest `dotnet new unoapp` template
- Updated to Uno.Extensions.* 4.1
- Updated to Microsoft.WindowsAppSDK 1.5
*Dec 21, 2023*
> ## New C# Markup 2 templates for Uno Platform 5
In addition to some new C# Markup 2 methods, today's release adds support for the new [C# Markup 2 templates for Uno Platform 5](https://github.com/Applicita/Modern.CSharp.Templates): an updated `mcs-uno-markup2` template, and a new `mcs-uno-view` template.
- Enjoy improved frictionless startup for both existing and new Uno solutions - whether created with Uno's `dotnet new unoapp` template or with the Uno solution wizard for Visual Studio
- Full support for .NET 8 / .NET 7, as well as model types MVUX / MVVM / none
- The new `mcs-uno-view` template is used by the convenient `New-View.ps1` script, which is included in `mcs-uno-markup2`
- Templates are now pre-structured in accordance with best practices for maintainability and code reuse of C# Markup 2 UI.
*Nov 18, 2023*
> ## 2.3 Release is GA - adds support for .NET 8, Uno 5 plus 5 Uno Libraries!
This release is fully updated to the awesome **Uno 5** release and .NET 8 GA. You can use the **Uno Solution Wizard for Visual Studio** and add a C# Markup 2 project to it at any time with one command. All Uno wizard customizations are supported: combine C# Markup 2 with MVUX or MVVM, XAML or Uno C# Markup, use Uno Navigation extensions, and target .NET 8 or .NET 7. All Uno target platforms are supported.
A brand new dotnet new C# Markup 2 project template gets you going in no time - carefully optimized for an optimal developer experience: uncluttered solution explorer view, automatic file grouping of markup and logic files, uncluttered markup source, focused intellisense, clear starting points for markup extensions in your code, plus fast hot reload - both automatic and with a hot reload button overlay in debug mode, for the platforms that your IDE can hot reload but cannot (yet) update the UI automatically.
Enjoy general C# Markup 2 improvements, plus C# Markup 2 API's for 5 additional Uno libraries:
- Support for Uno's [UI Toolkit](https://platform.uno/uno-toolkit/), [Reactive / MVUX extension](https://platform.uno/docs/articles/external/uno.extensions/doc/Overview/Mvux/Overview.html) and [Navigation extensions](https://platform.uno/docs/articles/external/uno.extensions/doc/Overview/Navigation/NavigationOverview.html)
- Support for the awesome [LiveCharts2](https://livecharts.dev/)
- All `ThemeResource`s searchable in C# intellisense, strongly typed
The [getting started](#getting-started-for-winui-3-and-windows-app-sdk--uno-platform) is fully up to date. Examples in this repo and this readme will be updated soon to show off the new features.
NJoy *concise* C# Markup!
*Nov 1, 2023*
> ## 2.3 Preview Release adds 5 Uno Libraries!
Enjoy general C# Markup 2 improvements, plus C# Markup 2 API's for 5 additional Uno libraries:
- Support for Uno's UI toolkit, Reactive and Navigation extensions
- Support for the awesome [LiveCharts2](https://livecharts.dev/)
- All `ThemeResource`s searchable in C# intellisense, strongly typed
- Automatic UI update on C# hot reload
- A development tools overlay
You can try this today - see the NuGets listed above.
Documentation of the new features plus a new getting started guide is coming with the **next release** - soon!
*June 27, 2023*
> ## 2.2 Release & start of .NET MAUI support
- [Release 2.2 is out](https://twitter.com/vincenth_net/status/1673330170441224192)! Enjoy this polished release for Windows App SDK, Uno Platform and WPF.
- As the poll results indicated, C# Markup 2 support for **.NET MAUI** is most wanted.
Implementation [has started](https://twitter.com/vincenth_net/status/1673383755023523857)!
*March 25, 2023*
> ## Poll results are in! And the winner is...
The March 2023 poll results on what to build next for C# Markup 2 are in!
A surprise addition was the ask for C# Markup 2 for Avalonia UI in the replies; it got a big response that catapulted it into a very close 2nd place.
Here are the results for the [poll](https://twitter.com/vincenth_net/status/1637065646688043012) including the likes for "Other" options [Blazor](https://twitter.com/vincenth_net/status/1637119462603145226) and [AvaloniaUI](https://twitter.com/alex8x8/status/1638278598267228163):
And the winner is: **C# Markup 2 for MAUI**!
Watch and star this repo to catch the release; you can also watch [#CSharpForMarkup tweets](https://twitter.com/search?q=%23CSharpForMarkup&src=typed_query&f=live) for progress. Thanks for your response!
*Feb 28, 2023*
> ## Major Release - C# Markup 2 version 2.0 for WinUI 3!
C# Markup 2 version 2.0 for WinUI 3 is here! Completely updated to .NET 7, C# 11 and the latest Windows App SDK and Uno Platform.
With many improvements including 6 supported target platforms, C# hot reload support and [dotnet new project templates](https://github.com/Applicita/Modern.CSharp.Templates).
**Brought to you by Applicita**
Special thanks go to [Applicita](https://applicita.com/) for making this release possible; it's inspiring to see a company support OSS in this way (Applicita also open-sourced several [other useful libraries](https://github.com/Applicita))
More on what's new in this release [here](https://github.com/VincentH-Net/CSharpForMarkup/releases/tag/csharpmarkup2-winui-2-0-0).
*Feb 16, 2023*
> ## A new release of C# Markup 2 for WinUI 3 and Uno Platform is coming in Feb 2023
Updated to .NET 7, C# 11 and the latest Windows App SDK and Uno Platform. With many improvements - including C# hot reload support and a dotnet new project template.
Watch this space!
*April 14, 2022*
> ## New 0.8 release: adds `ControlTemplate` support and `Style` improvements!
See [here](https://github.com/VincentH-Net/CSharpForMarkup/releases/tag/csharpmarkup2-winui-wpf-0-8-2) and [here](https://github.com/VincentH-Net/CSharpForMarkup/releases/tag/csharpmarkup2-winui-wpf-0-8-1) for the full list of improvements
*February 15, 2022*
> ## New 0.6 release: adds WPF and many improvements!
See [here](https://github.com/VincentH-Net/CSharpForMarkup/releases/tag/csharpmarkup2-winui-wpf-0-6-14) for the full list of improvements
*November 30, 2021*
>## C# Markup 2 announced at UNOCONF 2021!
> This first preview targets WinUI 3 and Uno Platform - including browser webassembly - with C# 10 and .NET 6. It supports .NET Hot Reload for a fast inner dev loop.
>
> See the [C# Markup 2 announcement at UNOCONF 2021](https://youtu.be/UJ7EzQeEQAg?t=2566):
> [](https://youtu.be/UJ7EzQeEQAg?t=2566)
## Getting started for WPF
1. Clone this repo
2. Open [CSharpMarkup.Wpf.Examples.sln](src/CSharpMarkup.Wpf.Examples/) and explore the source for the example pages. Note how page markup and page logic are separated in partial class files, and integrated with `Build()`, `Assign()` and `Invoke()`.
3. **.NET Hot Reload** is supported; edit and save the page markup in VS 2022 while debugging to see instant updates
4. To learn how to use C# Markup 2, read the [features description](#features) below and experiment in the example app
5. To build your own app, reference [](https://www.nuget.org/packages/CSharpMarkup.WPF) from a .NET 6 WPF project and create the C# Markup UI windows, pages etc in that project. Note that for existing apps you can reference (WPF / class library) projects that target older .NET versions from the .NET 6 project, so you can add C# Markup UI to your app without having to migrate existing logic and/or WPF UI to .NET 6 and C# 10.
## Getting started for WinUI 3 and Windows App SDK / Uno Platform
1) First check if your development environment is ready:
- [Visual Studio 2022 on Windows](https://platform.uno/docs/articles/get-started-vs-2022.html)
- [Other IDE's and OS-es](https://platform.uno/docs/articles/get-started.html)
2) Either choose an existing Uno Platform 5.2 solution, or create a new one with the [Uno Platform Template Wizard](https://platform.uno/docs/articles/getting-started/wizard/using-wizard.html) or the [dotnet new unoapp](https://www.nuget.org/packages/Uno.Templates) template. Feel free to select any options; C# Markup 2 fully supports Uno 5.2 with .NET 8 or .NET 7, [MVUX](https://platform.uno/docs/articles/external/uno.extensions/doc/Overview/Mvux/Overview.html) or MVVM, XAML or Uno C# Markup, on all target platforms.
3) Install the latest [Modern.CSharp.Templates](https://www.nuget.org/packages/Modern.CSharp.Templates) for `dotnet new` to get [these templates for Windows App SDK, Uno Platform and more](https://github.com/Applicita/Modern.CSharp.Templates#readme)
```bat
dotnet new install Modern.CSharp.Templates
```
To see help about the template parameters:
```bat
dotnet new mcs-uno-markup2 -h
```
4) Add a C# Markup 2 project to the Uno Platform solution, e.g.:
```bat
cd C:\Repos\UnoApp1
dotnet new mcs-uno-markup2 --appRootNamespace InnoWvate.UnoApp1 --presentation mvux --allow-scripts Yes
```
This will:
- Add a new project `UnoApp1.Presentation` to the solution, with a working example:
- Pages
- Models of the specified type (in above example [MVUX](https://platform.uno/docs/articles/external/uno.extensions/doc/Overview/Mvux/Overview.html))
- Navigation
- A `New-View.ps1` script to quickly add more pages and models
- A `Readme.md` with instructions on how to get started quickly
The Presentation project is pre-structured for maintainability in accordance with best practices for C# Markup UI
- Add NuGet package references to the Presentation project
- Add a reference to the Presentation project in the `UnoApp1` project
Note that you can use the `--name` parameter of `dotnet new` to specify the name of your *existing* Uno project, if that differs from the solution folder name (in above example, `UnoApp1`). The specified name will be used with the `.Presentation` suffix for the new project as well.
5) Open or reload the Uno solution and follow the steps in the `Readme.md` of the Presentation project to get started.
To learn how to use C# Markup 2, read the [features description](#features) below.
Fore a more complete example, see the [example app](src/CSharpMarkup.WinUI.Examples/) in this repo.
# Features
C# Markup 2 contains a full declarative, fluent API for existing UI frameworks. It surfaces virtually every layout, view and property, including attached properties, and includes **full inline documentation** that links each markup helper / parameter to the inline documentation for the underlying UI object / property.
The rich UI frameworks that C# Markup 2 surfaces can contain as much as **500+ UI object types**. E.g. layouts, views and styles, but also brushes, rich text elements, drawing primitives, transformations, animations, visual states and more. In addition C# Markup offers powerful and concise **convenience API's** for layout, bindings, convertors, templates and more.
- When targeting **Windows Desktop**, the WinUI API from the Windows App SDK is surfaced (without any dependency on Uno Platform).
- When targeting **Uno Platform**, the Uno.WinUI API is surfaced (atm only webassembly is tested, but any Uno target platform that can support .NET 6 and C# 10 should work)
- When targeting **WPF**, the WPF API is surfaced.
## Basic markup anatomy
Layouts, views, properties and property values look like this:
All properties can be set with extension methods: properties defined on the view type or it's base types, as well as attached properties.
**Properties that are defined directly on the view type** can alternatively be set with named parameters:
This is mainly useful for properties that take primitive types.
**Properties that take enum values** have extension methods so the enum name does not have to be repeated
(as in `TextAlignment: TextAlignment.Center`):
**Attached property** names are prefixed with the defining type plus underscore:
You can **set multiple attached property values** for the same defining type **in one call**:
In addition to this, there are **convenience overloads** for some view types with just the most commonly used parameters:
## Property value converters
Implicit converters are provided in the `to` subnamespace for common property value types:
These are:
- All converters that accept `string` values, as specified by the UI framework with the [TypeConverter attribute](https://docs.microsoft.com/en-us/dotnet/api/system.componentmodel.typeconverterattribute)
Note that WinUI 3 Desktop does not use this attribute, but Uno Platform and WPF do.
- Additional manual converters that also accept other types than `string`, including tuples if more than one value is expected. E.g.:
Allows you to specify:
`Button() .CornerRadius (2.5)` or
`Button() .CornerRadius ((2.5, 0, 2.5, 0))`
An example using `to.Point`:
```csharp
Button() .Background (RadialGradientBrush (Center: (50, 50), GradientOrigin: (100, 50)))
```
An example using `to.TimeSpan` and `to.Duration`:
```csharp
ColorAnimation (BeginTime: "0:0:5", Duration: 2.5)
```
In many cases the inline documentation on the `to.` type describes the supported values and formatting; especially for strings this can avoid guesswork.
## Styles
Styles can be assigned like this:
And defined like this:
In WPF you can bind a style setter value (WinUI 3 does not support this):
## Templates
A `DataTemplate` is passed in as a `Func`:
A `ControlTemplate` can be created like this:
- The `.BindTemplate()` method lets you bind template properties to the templated parent
- The `targetType` parameter is optional
- `b` here is a null-valued `static UI_Button` field. In this example it only serves to demonstrate one way to get intellisense when editing binding expressions for a `Button`; see [Binding power](#binding-power) for details.
Here is how you can use a `ControlTemplate` in an implicit or explicit `Style`:
## Enums for Grid rows and columns
You can use enums instead of numbers for Grid rows and colums. This improves readability and saves you from manually renumbering rows and columns when adding/removing/reordering them
## Shorthand helpers
Shorthand helpers are included as an alternative to common combinations of markup helpers:
## Insert layout children: conditional and Spread
All layouts ignore `null` values in their `children`; this makes it possible to have conditional views depending on the value of an expression at page (re) build time.
The `Spread` helper allows to insert a variable number of children at a specific position in the `children` list (similar to what Flutter offers).
## Binding power
Thanks to the C# 10 [CallerArgumentExpression attribute](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#callerargumentexpression-attribute-diagnostics), you don't have to use strings or `nameof()` to specify binding paths *with good performance*. Instead you can use C# expressions and enjoy all the goodness that they bring: full intellisense, compiler checked, renaming support :
**Note** from the intellisense description in above image that the `pathExpression` parameter supports several **convenience binding syntaxes**, which allows to:
- Identify the viewmodel part of the expression with parenthesis:
path expression = `viewmodel.path` || `(viewmodel expression).path`, where `path` can contain `.` e.g.:
- `.Bind (vm.SelectedTweet)` binds to "SelectedTweet"
- `.Bind ((vm.SelectedTweet).Title)` binds to "Title"
- `.Bind ((vm.SelectedTweet).Author.Name)` binds to "Author.Name"
- Use `?` with null-valued type instances to enjoy C# goodness without needing object instances e.g.:
- `.Bind (vm?.SelectedTweet?.Title)` binds to "Title"
Note that using `?` can be necessary because the expression will be evaluated at runtime, even though we don't care about it's value; the [CallerArgumentExpression attribute](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#callerargumentexpression-attribute-diagnostics) supplies an expression string *in addition to* the expression value.
- You can still pass in string literals
- `.Bind ("SelectedTweet")` binds to "SelectedTweet"
Any surrounding `"`, `@` or whitespace characters in `pathExpression` are ignored
`Bind` supports almost all functionality that the UI framework offers for binding. In addition, there are many `Bind` overloads that allows to:
- Omit the property name to bind to the **default property** of a view type:
- Bind with **inline conversion**:
- Bind a **command and it's parameter** in one go:
## Page anatomy - separate markup and UI logic
A typical markup page starts like this:
`FlutterPage.cs`:
```csharp
using CSharpMarkup.;
using static CSharpMarkup..Helpers;
namespace Examples;
partial class FlutterPage
{
public void Build() => Content =
```
Note the use of `partial class`; this lets you separate the UI markup from **UI logic**:
`FlutterPage.logic.cs`:
```csharp
using .Controls;
namespace Examples;
public sealed partial class FlutterPage : Page, IBuild
{
readonly FlutterViewModel vm;
public FlutterPage()
{
InitializeComponent(); // Only needed for WinUI
DataContext = vm = ;
Build();
```
### Namespace separation of markup and UI logic
**IMPORTANT:**
- In **C# markup files** like **`.cs`**:
Include `CSharpMarkup.*` namespace usings but **no UI objectmodel usings** such as `using Microsoft.UI.Xaml;`
(by design the type names in the CSharpMarkup namespace are identical to the type names in the UI objectmodel, so including both would cause ambiguities)
Try to limit using the UI object model to UI logic files. If you must, you *can* use the UI objectmodel safely in C# markup files; a good practice then is to
define global namespace using aliases, e.g. `global using UI = Microsoft.UI;`
For more guidance, see the comments in the `GlobalUsings.cs` of a project created with `dotnet new mcs-uno-markup2`.
- In **UI logic files** like **`.logic.cs`**:
Do not use `CSharpMarkup` objects
Markup object instances are not safe to use outside of a markup expression (due to performance features - each markup object type has a single static instance to prevent allocating an extra object for each view).
That is why `Assign` and `Invoke` (see [below](#Integrate-UI-markup-with-UI-logic)) pass the UI object contained in the markup object to the logic, instead of the markup object itself.
## Integrate UI markup with UI logic
With `Assign` and `Invoke` you can integrate UI markup with UI logic:
`SearchPage.cs`:
`SearchPage.logic.cs`:
`SearchPage.cs`:
`SearchPage.logic.cs`:
> **Note**:
> In `SearchPage.cs`, `StackPanel` and `TextBox` are **markup** object types, while
> in `SearchPage.logic.cs` they are the corresponding **UI framework** object types
# Development workflow tips
## Improve markup colorization in Visual Studio
There is no C# Markup IDE extension (yet...) to properly colorize markup, however C# Markup readability can be improved with this workaround in Visual Studio options:
Under `Fonts and Colors`, copy the color of `User Types - Classes` to `User Members - Methods` (with the `Custom...` button). Now the markup color for views and properties will no longer be the same.
