Skip to content

Fix help katex support under remote development #1217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
renkun-ken merged 1 commit into from
Oct 8, 2022
Merged

Fix help katex support under remote development #1217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions src/helpViewer/panel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,19 @@ export class HelpPanel {
}

// retrieves the stored webview or creates a new one if the webview was closed
private getWebview(preserveFocus: boolean = false, viewColumn: vscode.ViewColumn = vscode.ViewColumn.Two): vscode.Webview {
private getWebview(port: number | undefined = 0, preserveFocus: boolean = false, viewColumn: vscode.ViewColumn = vscode.ViewColumn.Two): vscode.Webview {
// create webview if necessary
if (!this.panel) {
const webViewOptions: vscode.WebviewOptions & vscode.WebviewPanelOptions = {
enableScripts: true,
enableFindWidget: true,
retainContextWhenHidden: true // keep scroll position when not focussed
retainContextWhenHidden: true, // keep scroll position when not focussed
portMapping: port ? [
{
webviewPort: port,
extensionHostPort: port
}
] : undefined
};
const showOptions = {
viewColumn: viewColumn,
Expand Down Expand Up @@ -146,9 +152,6 @@ export class HelpPanel {
viewer ||= config().get<string>('session.viewers.viewColumn.helpPanel');
const viewColumn = asViewColumn(viewer);

// get or create webview:
const webview = this.getWebview(preserveFocus, viewColumn);

// make sure helpFile is not a promise:
helpFile = await helpFile;

Expand All @@ -157,6 +160,10 @@ export class HelpPanel {
// modify html
helpFile = this.pimpMyHelp(helpFile, this.webviewStyleUri, this.webviewScriptUri);

// get or create webview:
const helpUrl = helpFile.url ? new URL(helpFile.url) : undefined;
const webview = this.getWebview(helpUrl ? Number(helpUrl.port) : undefined, preserveFocus, viewColumn);

// actually show the help page
webview.html = helpFile.html;

Expand Down