Microsoft/vscode

`retainContextWhenHidden` does not work with `when` clauses for Webview Views

Open

#149,041 opened on May 8, 2022

View on GitHub
 (1 comment) (2 reactions) (1 assignee)TypeScript (10,221 forks)batch import
bughelp wantedwebview-views

Repository metrics

Stars
 (74,848 stars)
PR merge metrics
 (Avg merge 11h 43m) (1,000 merged PRs in 30d)

Description

Does this issue occur when all extensions are disabled?: (This scenario only applies to extensions)

  • VS Code Version: 1.67.0-insider
  • OS Version: Windows 10

Steps to Reproduce:

  1. Register a custom view provider with vscode.window.registerWebviewViewProvider and the option retainContextWhenHidden: true
  2. Add a when clause for the view in package.json
  3. Observe that when the panel is hidden due to the view context, the context is not retained and the panel needs to reload

I noticed also that manually hiding the panel (e.g. right clicking in a panel and deselecting the view) will retain the context. Would it be possible to do something similar or at least providing an API/command to programmatically trigger the same hiding mechanism?

Contributor guide

Research direction
Investigate the code path for `retainContextWhenHidden` when `when` clauses are evaluated. Look at how the panel hides due to context vs manual hiding, and ensure context retention is consistent.
Tech stack
typescript
Domain
frontenddeveloper experience
Issue type
Bug
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
vscode extension developmentTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60