KEMBAR78
Extension API: icon support in walkthroughs is inconsistent · Issue #154963 · microsoft/vscode · GitHub
Skip to content

Extension API: icon support in walkthroughs is inconsistent #154963

@shinypb

Description

@shinypb

This is a bug in the walkthroughs contribution point.

In general, the extension API allows icons to be embedded in text by referencing them inside of $(...). This functionality does not work consistently in the walkthroughs API.

Does this issue occur when all extensions are disabled?: N/A; this is a bug in the extension API

  • VS Code Version: 1.69
  • OS Version: macOS 12.4

Steps to Reproduce:

  1. Create a walkthrough step in your extension, e.g.

     "walkthroughs": [
     	{
     		"id": "welcome",
     		"title": "Example $(github)",
     		"description": "See? The icon looks nice, doesn't it?",
     		"steps": [
     			{
     				"id": "example-step",
     				"title": "Example step",
     				"description": "Example description",
     				"media": {
     					"image": "icon.png",
     					"altText": ""
     				}
     			}
     		]
     	}
     ]
    

2 Observe that the icon in the title ($(github) in the example above) renders correctly in the Open Walkthrough… quickpick list:

Screen Shot 2022-07-12 at 10 21 08 AM

  1. Open up the walkthrough and observe that the icon is not rendered, and instead you see the literal string $(github):

Screen Shot 2022-07-12 at 10 22 09 AM

Metadata

Metadata

Assignees

Labels

bugIssue identified by VS Code Team member as probable buggetting-startedinsiders-releasedPatch has been released in VS Code InsidersverifiedVerification succeeded

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions