microsoft/Terminal

Add new code sample for GUIConsole using WinUI 3 - Windows App SDK v1.1

Open

#13,851 opened on Aug 25, 2022

View on GitHub
 (5 comments) (1 reaction) (0 assignees)C++ (3,212 forks)batch import
Area-TerminalControlHelp WantedIssue-DocsProduct-Meta

Repository metrics

Stars
 (35,764 stars)
PR merge metrics
 (Avg merge 27d 19h) (24 merged PRs in 30d)

Description

Description of the new feature/enhancement

I'm creating a WinUI 3 Desktop application (using VS 2022 17.3 Blank App WinUI 3 in Desktop template) where I'd like to use the Windows Terminal API to create a terminal window control to use inside my application.

I started by looking at your GUIConsole.WPF sample that is written in WPF for .NET Framework 4.6.1.

I tried to port the classes and the XAML window but I'm not able to let it work. I still have errors both on XAML and on code.

Proposed technical implementation details

Can you please add a new version of the code sample that is written using the new Windows App SDK v1.1?

Contributor guide

Research direction
Create a new sample project using the Blank App WinUI 3 template in VS 2022, port the ConPTY classes from the WPF sample, and adapt XAML and code to WinUI 3. Refer to Windows Terminal API documentation and the existing WPF sample for guidance.
Tech stack
csharpcpp
Domain
desktopapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Windows developmentWinUI 3Windows App SDKTerminal API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45