WPF-UI 1.2.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package WPF-UI --version 1.2.3
NuGet\Install-Package WPF-UI -Version 1.2.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="WPF-UI" Version="1.2.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add WPF-UI --version 1.2.3
#r "nuget: WPF-UI, 1.2.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install WPF-UI as a Cake Addin
#addin nuget:?package=WPF-UI&version=1.2.3

// Install WPF-UI as a Cake Tool
#tool nuget:?package=WPF-UI&version=1.2.3

WPF UI

Created with ❤ in Poland by lepo.co
A simple way to make your application written in WPF keep up with modern design trends. Library changes the base elements like Page, ToggleButton or List, and also includes additional controls like Navigation, NumberBox, Dialog or Snackbar.

GitHub license Nuget Nuget (with prereleases) Nuget Size Sponsors

🚀 Getting started

For a starter guide see our documentation.

📁 What's included?

Name Framework
WPFUI Library that allows you to use all features in your own application NET6 NET5 NETCore3 NETFramework48 NETFramework47 NETFramework46
WPFUI.Demo An application written in WPF .NET 6 where you can test the features. NET6win

🏭 Branches

Branch Status
WPFUI Main Build status
WPFUI Development Build status

🏗️ Works with Visual Studio Designer

VS2022 Designer Preview

🛠️ Custom controls

Control Namespace Description
Anchor WPFUI.Controls Creates a hyperlink to web pages, files or anything else a URL can address.
Arc WPFUI.Controls Draws a symmetrical arc with rounded edges.
Badge WPFUI.Controls Used to highlight an item, attract attention or flag status.
Breadcrumb WPFUI.Controls Automatic display of the page title from the navigation in the application.
Button WPFUI.Controls Custom button with additional parameters like an icon.
Card WPFUI.Controls Simple card compatible with the theme for displaying other elements.
CardAction WPFUI.Controls Inherited from the Button interactive card styled according to Fluent Design.
CardControl WPFUI.Controls Inherited from the Button control which displays an additional control on the right side of the card.
CardExpander WPFUI.Controls Inherited from the ContentControl control which can hide the collapsable content.
CodeBlock WPFUI.Controls Formats syntax and display a fragment of the source code.
Dialog WPFUI.Controls Displays a large card with a slightly transparent background and two action buttons.
FontIcon WPFUI.Controls Represents a text element containing an icon glyph with selectable font family.
Hyperlink WPFUI.Controls Button that opens a URL in a web browser.
SymbolIcon WPFUI.Controls Represents a text element containing an icon glyph.
MessageBox WPFUI.Controls Custom window to display notifications outside the application.
Navigation WPFUI.Controls Navigation styled as UWP apps.
NavigationItem WPFUI.Controls Element of the navigation.
NavigationStore WPFUI.Controls Navigation styled as Windows 11 Store app
NavigationFluent WPFUI.Controls Navigation styled as Windows 11 Settings app.
NumberBox WPFUI.Controls Text field for entering numbers with the possibility of setting a mask.
ProgressRing WPFUI.Controls Rotating loading ring like in Windows 11.
Rating WPFUI.Controls Stars to display the rating.
SearchBox WPFUI.Controls Lets look for things and other stuff.
Snackbar WPFUI.Controls Animated card with a notification displayed at the bottom of the application.
TextBox WPFUI.Controls Text field for with placeholders and icons.
TitleBar WPFUI.Controls A set of buttons that can replace the default window navigation, giving it a new, modern look with implemented NotifyIcon.

🧩 Custom classes and tools

Class Namespace Description
Theme WPFUI.Appearance Allows to manage available color themes from the library.
Background WPFUI.Appearance Allows to add background effects like Mica or Acrylic.
Accent WPFUI.Appearance Allows to change the application color accents.
Watcher WPFUI.Appearance Listens for changes in system parameters, then switches theme with Appearance.Theme.Set.
Progress WPFUI.Taskbar Allows to change the status of the displayed notification in the application icon on the TaskBar.
NotifyIcon WPFUI.Tray Allows to create an icon and a menu in the tray.

🖌️ Custom XAML styles

Resource usage Description
<Window Style="{StaticResource UiWindow}"/> Adds a custom appearance to the window and removes the navigation buttons.
<Page Style="{StaticResource UiPage}"/> Adds a custom appearance to the page.
<Page Style="{StaticResource UiPageScrollable}"/> Adds a custom appearance to the page and automatic display of scrolling if the content is too long.

📖 Documentation

Documentation can be found at https://wpfui.lepo.co/. We also have a tutorial over there for newcomers.

🚧 Development

If you want to propose a new functionality or submit a bugfix, create a Pull Request for the branch development.

📐 How to use?

First, your application needs to load custom styles, add in the MyApp\App.xaml file:

<Application>
  <Application.Resources>
    <ResourceDictionary>
      <ResourceDictionary.MergedDictionaries>
        <ResourceDictionary Source="pack://application:,,,/WPFUI;component/Styles/Theme/Dark.xaml" />
        <ResourceDictionary Source="pack://application:,,,/WPFUI;component/Styles/WPFUI.xaml" />
      </ResourceDictionary.MergedDictionaries>
    </ResourceDictionary>
  </Application.Resources>
</Application>

Now, you can customize your views, for example by adding a non-standard look to the main window and navigation buttons

<Window
  xmlns:wpfui="clr-namespace:WPFUI.Controls;assembly=WPFUI"
  Style="{StaticResource UiWindow}">
  <Grid>
    <Grid.RowDefinitions>
      <RowDefinition Height="Auto" />
      <RowDefinition Height="*" />
    </Grid.RowDefinitions>

    <wpfui:TitleBar Grid.Row="0" ApplicationNavigation="True" />

    <Grid Grid.Row="1" Margin="12,6,12,12">
      <Grid.ColumnDefinitions>
        <ColumnDefinition Width="Auto" />
        <ColumnDefinition Width="*" />
      </Grid.ColumnDefinitions>

      <wpfui:NavigationFluent Grid.Column="0" Margin="0,0,12,0" />

      <Frame Grid.Column="1" />
    </Grid>
  </Grid>
</Window>

Special thanks

Crafting apps for .NET without the creators of tools like ReSharper or XAML Styler would never be such a fantastic adventure.

Microsoft Property

Design of the interface, choice of colors and the appearance of the controls were inspired by projects made by Microsoft for Windows 11.
The WPFUI.Demo app includes icons from Shell32 for Windows 11. These icons are the legal property of Microsoft and you may not use them in your own app without permission. They are used here as an example of creating tools for Microsoft systems.

Segoe Fluent Icons

WPF UI uses Fluent System Icons. Although this font was also created by Microsoft, it does not contain all the icons for Windows 11. If you need the missing icons, add Segoe Fluent Icons to your application.
According to the EULA of Segoe Fluent Icons we cannot ship a copy of it with this dll. Segoe Fluent Icons is installed by default on Windows 11, but if you want these icons in an application for Windows 10 and below, you must manually add the font to your application's resources.
https://docs.microsoft.com/en-us/windows/apps/design/style/segoe-fluent-icons-font
https://docs.microsoft.com/en-us/windows/apps/design/downloads/#fonts

In the app dictionaries, you can add an alternate path to the font

<FontFamily x:Key="SegoeFluentIcons">pack://application:,,,/;component/Fonts/#Segoe Fluent Icons</FontFamily>

Compilation

Use Visual Studio 2022 and invoke the .sln.

Visual Studio
WPF UI is an Open Source project. You are entitled to download and use the freely available Visual Studio Community Edition to build, run or develop for WPF UI. As per the Visual Studio Community Edition license, this applies regardless of whether you are an individual or a corporate user.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.

License

WPF UI is free and open source software licensed under MIT License. You can use it in private and commercial projects.
Keep in mind that you must include a copy of the license in your project.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net5.0-windows7.0 is compatible.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net6.0-windows7.0 is compatible.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
.NET Framework net46 is compatible.  net461 was computed.  net462 was computed.  net463 was computed.  net47 is compatible.  net471 was computed.  net472 was computed.  net48 is compatible.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (11)

Showing the top 5 NuGet packages that depend on WPF-UI:

Package Downloads
xml.Revit.Toolkit

Revit Plugin Description for xml.Revit.Toolkit.

WPF-UI.Tray

Native tray menu icon support for WPF using the WPF UI library.

Hsm.Ui.Core

UI Core library for Ham Station Master

AwesomeProperties

This nuget can help you to create properties tab and will bind data for you

LYSoft.Libs.Wpf.WpfUI

Package Description

GitHub repositories (22)

Showing the top 5 popular GitHub repositories that depend on WPF-UI:

Repository Stars
microsoft/PowerToys
Windows system utilities to maximize productivity
lepoco/wpfui
WPF UI provides the Fluent experience in your known and loved WPF framework. Intuitive design, themes, navigation and new immersive controls. All natively and effortlessly.
BartoszCichecki/LenovoLegionToolkit
Lightweight Lenovo Vantage and Hotkeys replacement for Lenovo Legion laptops.
TheJoeFin/Text-Grab
Use OCR in Windows quickly and easily with Text Grab. With optional background process and notifications.
CosmosOS/Cosmos
Cosmos is an operating system "construction kit". Build your own OS using managed languages such as C#, VB.NET, and more!
Version Downloads Last updated
3.0.3 966 3/24/2024
3.0.2 1,053 3/19/2024
3.0.1 1,523 3/13/2024
3.0.0 9,712 2/4/2024
2.1.0 24,222 8/19/2023
2.0.3 54,137 9/25/2022
2.0.2 9,433 7/18/2022
2.0.1 3,703 6/18/2022
2.0.0 1,499 6/16/2022
1.2.7 6,315 5/7/2022
1.2.6 1,631 5/2/2022
1.2.4 2,224 4/20/2022
1.2.3 1,204 4/16/2022
1.2.2 2,631 3/20/2022
1.2.1 2,996 12/22/2021
1.2.0 818 12/22/2021
1.1.0 1,119 11/12/2021
1.0.0 1,233 10/3/2021