1a2bda2e4b | ||
---|---|---|
.github/ISSUE_TEMPLATE | ||
build | ||
dev | ||
docs | ||
idl | ||
manifest | ||
test | ||
tools | ||
winrt | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
Build.cmd | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
CustomInlineTasks.targets | ||
CustomTasks.sln | ||
DevCmd.cmd | ||
Directory.Build.props | ||
LICENSE | ||
MUXControls.sln | ||
ProjectConfigurations.props | ||
README.md | ||
RunTests.ps1 | ||
SdkVersion.props | ||
custom.props | ||
dirs | ||
environment.props | ||
mux.controls.props | ||
nuget.config |
README.md
Windows UI Library
The Windows UI Library (WinUI) is a set of open source Microsoft UI controls and features for the Windows UWP platform.
WinUI is the easiest way to build great Fluent Design experiences for Windows.
WinUI can be used in any Windows 10 UWP XAML app, or in a Xamarin.Forms app running on Windows 10 using native view embedding.
Using WinUI
You can download and use WinUI packages in your app using the NuGet package manager: see the Getting Started with the Windows UI Library page for more information.
Packages
NuGet Package Name | Description |
---|---|
Microsoft.UI.Xaml | Controls and features for building apps for Windows 10 |
Microsoft.UI.Xaml.Core.Direct | Low-level APIs for creating middleware components. Not intended or required for general application use |
You can also build a WinUI package yourself from source. See Contributing to the Windows UI Library for more information on building and contributing to WinUI.
Build Status
Documentation
WinUI usage documentation can be found here:
https://docs.microsoft.com/uwp/toolkits/winui
Contributing to WinUI
The WinUI team welcomes feedback and contributions!
For information on how to contribute please see Contributing to the Windows UI Library.
WinUI features
Benefits
The WinUI Library provides some useful benefits when building apps for Windows 10:
-
Helps you stay up to date
WinUI helps keep your app up to date with the latest versions of key controls and features of UWP XAML and the Fluent Design System -
Provides backward compatibility
WinUI is backward-compatible with a wide range of Windows 10 versions: you can start building and shipping apps with new XAML features immediately as soon as they're released, even if your your users aren't on the latest version of Windows 10 -
Makes it simpler to build version adaptive apps
You don't need version checks or conditional XAML markup to use WinUI controls or features: WinUI automatically adapts to the user's OS version
Version support
The Microsoft.UI.Xaml NuGet package requires your project to have TargetPlatformVersion >= 10.0.17134.0 and TargetPlatformMinVersion >= 10.0.14393.0 when building.
Your app's users can be on any of the following supported Windows versions:
- Windows Insider Previews
- October 2018 Update (17763)
- April 2018 Update (17134)
- Fall Creators Update (16299)
- Creators Update (15063)
- Anniversary Update (14393)
Some features may have a reduced or slightly different user experience on older versions, particularly on builds before 15063. This should not impact overall usability.
Contents
The Microsoft.UI.Xaml 2.0 stable package includes:
- Fluent Design control styles for all XAML controls (from both WinUI and the standard Windows 10 SDK)
- Fluent materials and styles including Fluent Acrylic and Fluent Reveal
- Many new and popular controls like ColorPicker, MenuBar, NavigationView, ParallaxView, PersonPicture, RatingControl, RefreshContainer, SplitButton, SwipeControl, and TreeView
Prerelease Microsoft.UI.Xaml packages also include previews of features and controls that we are still working on, like:
The Microsoft.UI.Xaml.Core.Direct package includes:
- XamlDirect and related APIs to improve performance for middleware components
Roadmap
For info on schedules and plans please see the high level plans see the Windows UI Library Roadmap.
Data/Telemetry
This project collects usage data and sends it to Microsoft to help improve our products and services. Read Microsoft's privacy statement to learn more.
For more information on telemetry implementation see the developer guide.