development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-09-18 01:58:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #124622 from microsoft/gettingstarted/navigateToStep

Browse source 
Support navigation to category/section in getting started
This commit is contained in:
Peng Lyu 2021-05-25 17:22:09 -07:00 committed by GitHub
parent 7c01395da1
commit 8822790908
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/vs/workbench/contrib/welcome/gettingStarted/browser/gettingStarted.contribution.ts
View file

@ -24,7 +24,6 @@ import { workbenchConfigurationNodeBase } from 'vs/workbench/common/configuratio
import product from 'vs/platform/product/common/product';
import { IEditorGroupsService } from 'vs/workbench/services/editor/common/editorGroupsService';
import { EditorOverride } from 'vs/platform/editor/common/editor';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { CommandsRegistry } from 'vs/platform/commands/common/commands';
@ -45,18 +44,19 @@ registerAction2(class extends Action2 {
});
}
public run(accessor: ServicesAccessor, walkthroughID: string | undefined, toSide: boolean | undefined) {
public run(accessor: ServicesAccessor, walkthroughID: string | { category: string, step: string } | undefined, toSide: boolean | undefined) {
const editorGroupsService = accessor.get(IEditorGroupsService);
const instantiationService = accessor.get(IInstantiationService);
const editorService = accessor.get(IEditorService);
const configurationService = accessor.get(IConfigurationService);
if (walkthroughID) {
const selectedCategory = typeof walkthroughID === 'string' ? walkthroughID : walkthroughID.category;
const selectedStep = typeof walkthroughID === 'string' ? undefined : walkthroughID.step;
// Try first to select the walkthrough on an active getting started page with no selected walkthrough
for (const group of editorGroupsService.groups) {
if (group.activeEditor instanceof GettingStartedInput) {
if (!group.activeEditor.selectedCategory) {
(group.activeEditorPane as GettingStartedPage).makeCategoryVisibleWhenAvailable(walkthroughID);
(group.activeEditorPane as GettingStartedPage).makeCategoryVisibleWhenAvailable(selectedCategory, selectedStep);
return;
}
}
@ -67,7 +67,8 @@ registerAction2(class extends Action2 {
for (const { editor, groupId } of result) {
if (editor instanceof GettingStartedInput) {
if (!editor.selectedCategory) {
editor.selectedCategory = walkthroughID;
editor.selectedCategory = selectedCategory;
editor.selectedStep = selectedStep;
editorService.openEditor(editor, { revealIfOpened: true, override: EditorOverride.DISABLED }, groupId);
return;
}
@ -75,9 +76,7 @@ registerAction2(class extends Action2 {
}
// Otherwise, just make a new one.
if (configurationService.getValue<boolean>('workbench.welcomePage.experimental.extensionContributions')) {
editorService.openEditor(instantiationService.createInstance(GettingStartedInput, { selectedCategory: walkthroughID }), {}, toSide ? SIDE_GROUP : undefined);
}
editorService.openEditor(instantiationService.createInstance(GettingStartedInput, { selectedCategory: selectedCategory, selectedStep: selectedStep }), {}, toSide ? SIDE_GROUP : undefined);
} else {
editorService.openEditor(new GettingStartedInput({}), {});
}

7
src/vs/workbench/contrib/welcome/gettingStarted/browser/gettingStarted.ts
View file

@ -233,7 +233,7 @@ export class GettingStartedPage extends EditorPane {
setTimeout(() => this.container.classList.add('animationReady'), 0);
}
async makeCategoryVisibleWhenAvailable(categoryID: string) {
async makeCategoryVisibleWhenAvailable(categoryID: string, stepId?: string) {
await this.gettingStartedService.installedExtensionsRegistered;
this.gettingStartedCategories = this.gettingStartedService.getCategories();
@ -244,7 +244,7 @@ export class GettingStartedPage extends EditorPane {
if (ourCategory.content.type !== 'steps') {
throw Error('internaal error: category is not steps');
}
this.scrollToCategory(categoryID);
this.scrollToCategory(categoryID, stepId);
}
private registerDispatchListeners() {
@ -870,10 +870,11 @@ export class GettingStartedPage extends EditorPane {
});
}
private async scrollToCategory(categoryID: string) {
private async scrollToCategory(categoryID: string, stepId?: string) {
this.inProgressScroll = this.inProgressScroll.then(async () => {
reset(this.stepsContent);
this.editorInput.selectedCategory = categoryID;
this.editorInput.selectedStep = stepId;
this.currentCategory = this.gettingStartedCategories.find(category => category.id === categoryID);
this.buildCategorySlide(categoryID);
this.setSlide('details');