microsoft/Terminal

Data URI scheme support for images in settings.json

Open

#6,747 opened on Jul 1, 2020

View on GitHub
 (1 comment) (7 reactions) (0 assignees)C++ (3,212 forks)batch import
Area-SettingsHelp WantedIssue-TaskPriority-2Product-Terminal

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

It would be great to be able to set image files (like icon or backgroundImage) in settings.json using data URI scheme. This could be useful when making backups or clones of Windows terminal settings, when syncing them with other devices, etc., especially when our custom profiles are concerned.

Proposed technical implementation details

An example fragment from settings.json for a custom icon:

{
    "guid": "{7895828e-1e14-4068-89b4-582567b7495e}",
    "name": "MySQL",
    "commandline": "wsl.exe mysql -u username -p",
    "hidden": false,
    "icon": "data:image/png;base64,iVBORw0KG..............goAJRU5ErkJggg=="
}

Contributor guide

Research direction
Study the current implementation of icon paths in settings.json, specifically how icons are loaded and rendered. Then design an approach to parse data URI strings, decode the base64 image, and render it. Consider using existing Windows API for bitmap handling.
Tech stack
cpp
Domain
desktop
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++JSON
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50