Skip to content

Commit

Permalink
Update readme with 1.0 changes & 1.1 roadmap (#6460)
Browse files Browse the repository at this point in the history 
* Updates for 1.0

* Roadmap updates for 1.1
  • Loading branch information
@gabbybilka
gabbybilka authored Dec 11, 2021
1 parent d2e60f8 commit a1ace79
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 40 deletions.
14 changes: 8 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ WinUI 3 is the next generation of the WinUI framework. It dramatically expands W

The WinUI community call is your monthly opportunity to learn about native UX development for Windows with WinUI.

In these calls we’ll discuss the WinUI roadmap, our status and your feedback.
In these calls we’ll discuss the WinUI [roadmap](docs/roadmap.md), our status and your feedback.

You can watch them online here on YouTube at the [Windows Developer channel](https://www.youtube.com/channel/UCzLbHrU7U3cUDNQWWAqjceA).

Add the event to your calendar: [ICS calendar file](docs/communitycalls/WinUICommunityCall.ics)

## Using WinUI 3

You can build new Windows apps using WinUI 3, which ships as a part of the Windows App SDK. The latest available stable release is the Windows App SDK 0.8 (previously called Project Reunion). With this release, you can ship production Desktop apps to the Microsoft Store.
You can build new Windows apps using WinUI 3, which ships as a part of the Windows App SDK. The latest available stable release is the Windows App SDK 1.0 (previously called Project Reunion). With this release, you can ship production Desktop apps to the Microsoft Store.

See the [installation instructions](https://docs.microsoft.com/windows/apps/windows-app-sdk/set-up-your-development-environment), and guidelines on [creating your first WinUI 3 app](https://docs.microsoft.com/windows/apps/winui/winui3/create-your-first-winui3-app).

Expand All @@ -32,14 +32,14 @@ You can download and use WinUI packages in your app using the NuGet package mana

| NuGet Package | Build Status | Latest Versions | Documentation |
| --- | --- | --- | --- |
| [Microsoft.UI.Xaml](https://www.nuget.org/packages/Microsoft.UI.Xaml) <br /> Controls and Fluent Design for UWP apps | [![Build Status](https://dev.azure.com/ms/microsoft-ui-xaml/_apis/build/status/WinUI-Public-MUX-CI?branchName=main)](https://dev.azure.com/ms/microsoft-ui-xaml/_build/latest?definitionId=20?branchName=main) | [![latest stable version](https://img.shields.io/nuget/v/Microsoft.UI.Xaml.svg)](https://www.nuget.org/packages/Microsoft.UI.Xaml) <br /> [![latest prerelease version](https://img.shields.io/nuget/vpre/Microsoft.UI.Xaml.svg)](https://www.nuget.org/packages/Microsoft.UI.Xaml/absoluteLatest) | [2.5 release](https://docs.microsoft.com/windows/apps/winui/winui2/release-notes/winui-2.5) |
| [Microsoft.UI.Xaml](https://www.nuget.org/packages/Microsoft.UI.Xaml) <br /> Controls and Fluent Design for UWP apps | [![Build Status](https://dev.azure.com/ms/microsoft-ui-xaml/_apis/build/status/WinUI-Public-MUX-CI?branchName=main)](https://dev.azure.com/ms/microsoft-ui-xaml/_build/latest?definitionId=20?branchName=main) | [![latest stable version](https://img.shields.io/nuget/v/Microsoft.UI.Xaml.svg)](https://www.nuget.org/packages/Microsoft.UI.Xaml) <br /> [![latest prerelease version](https://img.shields.io/nuget/vpre/Microsoft.UI.Xaml.svg)](https://www.nuget.org/packages/Microsoft.UI.Xaml/absoluteLatest) | [2.7 release](https://docs.microsoft.com/windows/apps/winui/winui2/release-notes/winui-2.7) |
| [Microsoft.UI.Xaml.Core.Direct](https://www.nuget.org/packages/Microsoft.UI.Xaml.Core.Direct) <br /> Low-level APIs for middleware components | | [![latest prerelease version](https://img.shields.io/nuget/vpre/Microsoft.UI.Xaml.Core.Direct.svg)](https://www.nuget.org/packages/Microsoft.UI.Xaml.Core.Direct/absoluteLatest) | [2.0 prerelease](https://docs.microsoft.com/uwp/api/microsoft.ui.xaml.core.direct) |

You can also build a WinUI package yourself from source. See [Contributing to the Windows UI Library](CONTRIBUTING.md) for more information on building and contributing to WinUI.

## Documentation

To find resources for Windows UI 2.6, like the Figma design toolkit, Segoe UI Variable Font, and samples, visit [Design toolkits and samples for Windows apps](https://docs.microsoft.com/windows/apps/design/downloads/)
To find resources for Windows UI 2.7, like the [Figma design toolkit](aka.ms/figmatoolkit), Segoe UI Variable Font, and samples, visit [Design toolkits and samples for Windows apps](https://docs.microsoft.com/windows/apps/design/downloads/)

If you find any issues with the Windows UI toolkit, you can file a bug [here](https://aka.ms/WinUIToolkitBug)

Expand Down Expand Up @@ -83,7 +83,7 @@ You don't need version checks or conditional XAML markup to use WinUI controls o

### Version support

The Microsoft.UI.Xaml 2.4 NuGet package requires your project to have TargetPlatformVersion &gt;= 10.0.18362.0 and TargetPlatformMinVersion &gt;= 10.0.15063.0 when building.
The Microsoft.UI.Xaml 2.7 NuGet package requires your project to have TargetPlatformVersion &gt;= 10.0.18362.0 and TargetPlatformMinVersion &gt;= 10.0.15063.0 when building.

Your app's users can be on any of the following supported Windows 10 versions:

Expand All @@ -100,7 +100,9 @@ For info on the WinUI release schedule and high level plans please see the [Wind
## WinUI 3 is a part of the Windows App SDK family
The [Windows App SDK](https://github.com/microsoft/ProjectReunion) is a set of libraries, frameworks, components, and tools that you can use in your apps to access powerful Windows platform functionality from all kinds of apps on many versions of Windows. The Windows App SDK combines the powers of Win32 native applications alongside modern API usage techniques, so your apps light up everywhere your users are.

Other Windows App SDK components are: [WebView2](https://docs.microsoft.com/microsoft-edge/webview2/), [MSIX (MSIX-Core)](https://docs.microsoft.com/windows/msix/overview), [C++/WinRT](https://github.com/microsoft/cppwinrt), [Rust/WinRT](https://github.com/microsoft/winrt-rs), and [C#/WinRT](https://github.com/microsoft/cswinrt). If you'd like to learn more and contribute to Windows App SDK, or have **UWP/app model related questions**, visit our [Github repo](https://github.com/microsoft/ProjectReunion).
Other Windows App SDK components are: [WebView2](https://docs.microsoft.com/microsoft-edge/webview2/), [MSIX (MSIX-Core)](https://docs.microsoft.com/windows/msix/overview), [C++/WinRT](https://github.com/microsoft/cppwinrt), [Rust/WinRT](https://github.com/microsoft/winrt-rs), and [C#/WinRT](https://github.com/microsoft/cswinrt). If you'd like to learn more and contribute to Windows App SDK, or have **UWP/app model related questions**, visit our [Github repo](https://github.com/microsoft/WindowsAppSDK).

To see the Windows App SDK full roadmap and features that are under consideration (or to submit feature requests), [visit the productboard portal](https://portal.productboard.com/winappsdk/1-windows-app-sdk).

## Data/Telemetry

Expand Down
69 changes: 35 additions & 34 deletions docs/roadmap.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ It focuses on enabling three main use cases:
3. **Enabling other frameworks**
* Providing the native implementation for other frameworks like [React Native](https://github.com/Microsoft/react-native-windows) when running on Windows

WinUI 3 is available as a part of the [Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk) for building stable and supported desktop/Win32 apps for production scenarios. The latest release is the Windows App SDK 0.8, which you can download and read more about at the documentation linked below:
WinUI 3 is available as a part of the [Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk) for building stable and supported desktop/Win32 apps for production scenarios. The latest release is the Windows App SDK 1.0, which you can download and read more about at the documentation linked below:

[Stable release channel for the Windows App SDK](https://docs.microsoft.com/windows/apps/windows-app-sdk/stable-channel)

Expand All @@ -66,7 +66,7 @@ There's also a version of WinUI 3 available that includes experimental features.


## WinUI 3 Feature Roadmap
The images below lists out what the WinUI team plans to ship in 2021.
The images below list out what the WinUI team has shipped in 2021. Stay tuned for an updated visual roadmap for 2022.

The Windows App SDK ships experimental, preview, and stable builds (with WinUI 3 as a component). You can read more about the shipping schedule and cadence in our [Release Channels doc](https://docs.microsoft.com/windows/apps/windows-app-sdk/release-channels). For more details on when specific features will become available, see the feature roadmap table below.

Expand Down Expand Up @@ -96,35 +96,36 @@ For questions or status updates on either features listed here, or features not

Blank - Not available


**WinUI 3 - Windows App SDK 0.8** is our latest release.

| Customer Capability | Project Reunion 0.5 <br/>(March 2021) | Windows App SDK 0.8 <br/>(June 2021) | Windows App SDK 1.0 <br/>(Q4 2021) | Planned for a future update |
| ------------------------------------------------------ | -------------------------------- | ------------------------------- | ----------------------------- | --------------------------- |
| Supported in any app using the Windows App SDK | &#128994; | &#128994; | &#128994; | &#128994; |
| Contains new Windows 11 controls/styles from WinUI 2.6 | | | &#128994; | &#128994;
| Supports MSIX Deployment | &#128994; | &#128994; | &#128994; | &#128994; |
| Supports Unpackaged (non-MSIX) Deployment | | | &#128994; | &#128994; |
| Works downlevel to Windows 10 version 1809 and above | &#128994; | &#128994; | &#128994; | &#128994; |
| Supports the latest .NET | &#128994; | &#128994; | &#128994; | &#128994; |
| ARM64 support | &#128994; | &#128994; | &#128994; | &#128994; |
| `<SwapChainPanel> ` | &#128994; | &#128994; | &#128994; | &#128994; |
| Intellisense, Hot Reload, Live Visual Tree | &#128311; | &#128311; | &#128994; | &#128994; |
| Chromium-based WebView2 | &#128994; | &#128994; | &#128994; | &#128994; |
| Title bar customization | &#128994; | &#128994; | &#128994; | &#128994; |
| Fluent Shadows | &#128994; | &#128994; | &#128994; | &#128994; |
| Input validation for data fields | &#128311; | &#128311; | &#128311; | &#128994; |
| Supports multiple top-level windows on the same thread | &#128311; | &#128311; | &#128311; | &#128994; |
| Support multiple top-level windows on separate threads | &#128311; | &#128311; | &#128311; | &#128994; |
| Drag and drop | &#128994; | &#128994; | &#128994; | &#128994; |
| RenderTargetBitmap | &#128994; | &#128994; | &#128994; | &#128994; |
| Mouse cursor customization | &#128994; | &#128994; | &#128994; | &#128994; |
| Animated Gif support | &#128994; | &#128994; | &#128994; | &#128994; |
| VirtualSurfaceImageSource (VSIS) support | &#128994; | &#128994; | &#128994; | &#128994; |
| In-app acrylic | &#128994; | &#128994; | &#128994; | &#128994; |
| Background acrylic | | | |&#128994; | |
| Mica | | | | &#128994; | |
| XAML Islands | | | | &#128994; |
| Media Controls (e.g. `<MediaPlayerElement>`) | | | | &#128994; |
| `<InkCanvas>` | | | | &#128994; |
| `<MapControl>` | | | | &#129002; |
**WinUI 3 - Windows App SDK 1.0** is our latest release.

| Customer Capability | Project Reunion 0.5 <br/>(March 2021) | Windows App SDK 0.8 <br/>(June 2021) | Windows App SDK 1.0 <br/> (November 2021) | Planned for Windows App SDK 1.1 | Planned for a future update |
| ------------------------------------------------------ | -------------------------------- | ------------------------------- | ----------------------------- | --------------------------- | --------------------------- |
| Supported in any app using the Windows App SDK | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| Contains new Windows 11 controls/styles from WinUI 2.6 | | | &#128994; | &#128994; | &#128994; |
| Supports MSIX Deployment | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| Supports Unpackaged (non-MSIX) Deployment | | | &#128994; | &#128994; | &#128994; |
| Works downlevel to Windows 10 version 1809 and above | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| Supports the latest .NET | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| ARM64 support | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| `<SwapChainPanel> ` | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| Intellisense, Hot Reload, Live Visual Tree | &#128311; | &#128311; | &#128994;[^1] | &#128994; | &#128994; |
| Chromium-based WebView2 | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| Title bar customization | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| Fluent Shadows | &#128994; | &#128994; | &#128994; | &#128994;
| Input validation for data fields | &#128311; | &#128311; | &#128311; | &#128311; | &#128994; |
| Supports multiple top-level windows on the same thread | &#128311; | &#128311; | &#128311; | &#128994; | &#128994; |
| Support multiple top-level windows on separate threads | &#128311; | &#128311; | &#128311; | &#128311; | &#128994; |
| Drag and drop | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| RenderTargetBitmap | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| Mouse cursor customization | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| Animated Gif support | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| VirtualSurfaceImageSource (VSIS) support | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| In-app acrylic | &#128994; | &#128994; | &#128994; | &#128994; | &#128994; |
| Background acrylic | | | | &#128994; | &#128994; |
| Mica | | | | &#128994; | &#128994; |
| XAML Islands | | &#128311; | &#128311; | &#128311; | &#128994; |
| Media Controls (e.g. `<MediaPlayerElement>`) | | | | | &#128994; |
| `<InkCanvas>` | | | | | &#128994; |
| `<MapControl>` | | | | | &#129002; |

[^1]: Supported in packaged apps only

0 comments on commit a1ace79

Please sign in to comment.