Refactor Notebook cell toolbar dropdown actions (#23369)

This commit is contained in:
Charles Gagnon
2023-06-12 13:01:12 -07:00
committed by GitHub
parent d857ddb54b
commit e58f3ff277
8 changed files with 184 additions and 168 deletions

View File

@@ -6,20 +6,22 @@
import { localize } from 'vs/nls'; import { localize } from 'vs/nls';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation'; import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { INotificationService } from 'vs/platform/notification/common/notification'; import { INotificationService } from 'vs/platform/notification/common/notification';
import { Action, IAction, Separator } from 'vs/base/common/actions'; import { Action, IAction, IActionRunner, Separator } from 'vs/base/common/actions';
import { ActionBar, ActionsOrientation } from 'vs/base/browser/ui/actionbar/actionbar';
import { CellActionBase, CellContext } from 'sql/workbench/contrib/notebook/browser/cellViews/codeActions'; import { CellActionBase, CellContext } from 'sql/workbench/contrib/notebook/browser/cellViews/codeActions';
import { CellModel } from 'sql/workbench/services/notebook/browser/models/cell'; import { CellModel } from 'sql/workbench/services/notebook/browser/models/cell';
import { CellTypes, CellType } from 'sql/workbench/services/notebook/common/contracts'; import { CellTypes, CellType } from 'sql/workbench/services/notebook/common/contracts';
import { ToggleableAction } from 'sql/workbench/contrib/notebook/browser/notebookActions'; import { AddCodeCellAction, AddTextCellAction, ToggleableAction } from 'sql/workbench/contrib/notebook/browser/notebookActions';
import { getErrorMessage } from 'vs/base/common/errors'; import { getErrorMessage } from 'vs/base/common/errors';
import Severity from 'vs/base/common/severity'; import Severity from 'vs/base/common/severity';
import { INotebookService } from 'sql/workbench/services/notebook/browser/notebookService'; import { INotebookService } from 'sql/workbench/services/notebook/browser/notebookService';
import { IContextMenuService } from 'vs/platform/contextview/browser/contextView'; import { IContextMenuService } from 'vs/platform/contextview/browser/contextView';
import { StandardKeyboardEvent } from 'vs/base/browser/keyboardEvent';
import { CellEditModes, MoveDirection } from 'sql/workbench/services/notebook/browser/models/modelInterfaces'; import { CellEditModes, MoveDirection } from 'sql/workbench/services/notebook/browser/models/modelInterfaces';
import * as TelemetryKeys from 'sql/platform/telemetry/common/telemetryKeys'; import * as TelemetryKeys from 'sql/platform/telemetry/common/telemetryKeys';
const moreActionsLabel = localize('moreActionsLabel', "More"); import { DropdownMenuActionViewItem } from 'vs/base/browser/ui/dropdown/dropdownActionViewItem';
import { AnchorAlignment } from 'vs/base/browser/ui/contextview/contextview';
import { moreActionsLabel } from 'sql/workbench/contrib/notebook/common/notebookLoc';
const addCellLabel = localize('addCellLabel', "Add cell");
export class EditCellAction extends ToggleableAction { export class EditCellAction extends ToggleableAction {
// Constants // Constants
@@ -147,49 +149,6 @@ export class DeleteCellAction extends CellActionBase {
} }
} }
export class CellToggleMoreActions {
private _actions: (Action | CellActionBase)[] = [];
private _moreActions: ActionBar;
private _moreActionsElement: HTMLElement;
constructor(
@IInstantiationService private instantiationService: IInstantiationService
) {
this._actions.push(
instantiationService.createInstance(ConvertCellAction, 'convertCell', localize('convertCell', "Convert Cell")),
new Separator(),
instantiationService.createInstance(RunCellsAction, 'runAllAbove', localize('runAllAbove', "Run Cells Above"), false),
instantiationService.createInstance(RunCellsAction, 'runAllBelow', localize('runAllBelow', "Run Cells Below"), true),
new Separator(),
instantiationService.createInstance(AddCellFromContextAction, 'codeAbove', localize('codeAbove', "Insert Code Above"), CellTypes.Code, false),
instantiationService.createInstance(AddCellFromContextAction, 'codeBelow', localize('codeBelow', "Insert Code Below"), CellTypes.Code, true),
new Separator(),
instantiationService.createInstance(AddCellFromContextAction, 'markdownAbove', localize('markdownAbove', "Insert Text Above"), CellTypes.Markdown, false),
instantiationService.createInstance(AddCellFromContextAction, 'markdownBelow', localize('markdownBelow', "Insert Text Below"), CellTypes.Markdown, true),
new Separator(),
instantiationService.createInstance(CollapseCellAction, 'collapseCell', localize('collapseCell', "Collapse Cell"), true),
instantiationService.createInstance(CollapseCellAction, 'expandCell', localize('expandCell', "Expand Cell"), false),
new Separator(),
instantiationService.createInstance(ParametersCellAction, 'makeParameterCell', localize('makeParameterCell', "Make parameter cell"), true),
instantiationService.createInstance(ParametersCellAction, 'removeParameterCell', localize('RemoveParameterCell', "Remove parameter cell"), false),
new Separator(),
instantiationService.createInstance(ClearCellOutputAction, 'clear', localize('clear', "Clear Result")),
);
}
public onInit(elementRef: HTMLElement, context: CellContext) {
this._moreActionsElement = elementRef;
this._moreActionsElement.setAttribute('aria-haspopup', 'menu');
if (this._moreActionsElement.childNodes.length > 0) {
this._moreActionsElement.removeChild(this._moreActionsElement.childNodes[0]);
}
this._moreActions = new ActionBar(this._moreActionsElement, { orientation: ActionsOrientation.VERTICAL, ariaLabel: moreActionsLabel });
this._moreActions.context = { target: this._moreActionsElement };
let validActions = this._actions.filter(a => a instanceof Separator || a instanceof CellActionBase && a.canRun(context));
removeDuplicatedAndStartingSeparators(validActions);
this._moreActions.push(this.instantiationService.createInstance(ToggleMoreActions, validActions, context), { icon: true, label: false });
}
}
export function removeDuplicatedAndStartingSeparators(actions: (Action | CellActionBase)[]): void { export function removeDuplicatedAndStartingSeparators(actions: (Action | CellActionBase)[]): void {
let indexesToRemove: number[] = []; let indexesToRemove: number[] = [];
for (let i = 0; i < actions.length; i++) { for (let i = 0; i < actions.length; i++) {
@@ -368,26 +327,104 @@ export class CollapseCellAction extends CellActionBase {
} }
} }
export class ToggleMoreActions extends Action { export class ToggleAddCellDropdownAction extends Action {
private static readonly ID = 'toggleMore'; public static readonly ID = 'notebook.toggleAddCell';
private static readonly LABEL = moreActionsLabel; public static readonly LABEL = addCellLabel;
private static readonly ICON = 'masked-icon more'; public static readonly ICON = 'codicon masked-icon new';
constructor( constructor(
private readonly _actions: Array<IAction>,
private readonly _context: CellContext,
@IContextMenuService private readonly _contextMenuService: IContextMenuService
) { ) {
super(ToggleMoreActions.ID, ToggleMoreActions.LABEL, ToggleMoreActions.ICON); super(ToggleAddCellDropdownAction.ID);
this.tooltip = ToggleAddCellDropdownAction.LABEL;
}
}
export class ToggleAddCellActionViewItem extends DropdownMenuActionViewItem {
constructor(
action: IAction,
actionRunner: IActionRunner,
cellContext: CellContext,
@IContextMenuService contextMenuService: IContextMenuService,
@IInstantiationService instantiationService: IInstantiationService
) {
super(action,
[
instantiationService.createInstance(AddCodeCellAction),
instantiationService.createInstance(AddTextCellAction)
],
contextMenuService,
{
actionRunner,
classNames: ToggleAddCellDropdownAction.ICON,
anchorAlignmentProvider: () => AnchorAlignment.RIGHT
});
this.setActionContext(cellContext);
}
}
export class CellToggleMoreAction extends Action {
public static readonly ID = 'notebook.toggleMore';
public static readonly LABEL = moreActionsLabel;
public static readonly ICON = 'codicon masked-icon more';
constructor() {
super(CellToggleMoreAction.ID);
this.tooltip = CellToggleMoreAction.LABEL;
}
}
export class CellToggleMoreActionViewItem extends DropdownMenuActionViewItem {
private _actions: (Action | CellActionBase)[];
constructor(
action: IAction,
actionRunner: IActionRunner,
private _cellContext: CellContext,
@IContextMenuService contextMenuService: IContextMenuService,
@IInstantiationService instantiationService: IInstantiationService
) {
super(action,
{
getActions: () => { return this.getValidActions(); }
},
contextMenuService,
{
actionRunner,
classNames: CellToggleMoreAction.ICON,
anchorAlignmentProvider: () => AnchorAlignment.RIGHT
});
this.setActionContext(this._cellContext);
this._actions = [
instantiationService.createInstance(ConvertCellAction, 'convertCell', localize('convertCell', "Convert Cell")),
new Separator(),
instantiationService.createInstance(RunCellsAction, 'runAllAbove', localize('runAllAbove', "Run Cells Above"), false),
instantiationService.createInstance(RunCellsAction, 'runAllBelow', localize('runAllBelow', "Run Cells Below"), true),
new Separator(),
instantiationService.createInstance(AddCellFromContextAction, 'codeAbove', localize('codeAbove', "Insert Code Above"), CellTypes.Code, false),
instantiationService.createInstance(AddCellFromContextAction, 'codeBelow', localize('codeBelow', "Insert Code Below"), CellTypes.Code, true),
new Separator(),
instantiationService.createInstance(AddCellFromContextAction, 'markdownAbove', localize('markdownAbove', "Insert Text Above"), CellTypes.Markdown, false),
instantiationService.createInstance(AddCellFromContextAction, 'markdownBelow', localize('markdownBelow', "Insert Text Below"), CellTypes.Markdown, true),
new Separator(),
instantiationService.createInstance(CollapseCellAction, 'collapseCell', localize('collapseCell', "Collapse Cell"), true),
instantiationService.createInstance(CollapseCellAction, 'expandCell', localize('expandCell', "Expand Cell"), false),
new Separator(),
instantiationService.createInstance(ParametersCellAction, 'makeParameterCell', localize('makeParameterCell', "Make parameter cell"), true),
instantiationService.createInstance(ParametersCellAction, 'removeParameterCell', localize('RemoveParameterCell', "Remove parameter cell"), false),
new Separator(),
instantiationService.createInstance(ClearCellOutputAction, 'clear', localize('clear', "Clear Result")),
];
} }
override async run(context: StandardKeyboardEvent): Promise<void> { /**
this._contextMenuService.showContextMenu({ * Gets the actions that are valid for the current cell context
getAnchor: () => context.target, * @returns The list of valid actions
getActions: () => this._actions, */
getActionsContext: () => this._context public getValidActions(): readonly IAction[] {
}); const validActions = this._actions.filter(a => a instanceof Separator || a instanceof CellActionBase && a.canRun(this._cellContext));
removeDuplicatedAndStartingSeparators(validActions);
return validActions;
} }
} }

View File

@@ -4,16 +4,12 @@
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import 'vs/css!./cellToolbar'; import 'vs/css!./cellToolbar';
import * as DOM from 'vs/base/browser/dom';
import { Component, Inject, ViewChild, ElementRef, Input } from '@angular/core'; import { Component, Inject, ViewChild, ElementRef, Input } from '@angular/core';
import { localize } from 'vs/nls'; import { localize } from 'vs/nls';
import { Taskbar, ITaskbarContent } from 'sql/base/browser/ui/taskbar/taskbar'; import { Taskbar, ITaskbarContent } from 'sql/base/browser/ui/taskbar/taskbar';
import { IContextMenuService } from 'vs/platform/contextview/browser/contextView';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation'; import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { DeleteCellAction, EditCellAction, CellToggleMoreActions, MoveCellAction, SplitCellAction } from 'sql/workbench/contrib/notebook/browser/cellToolbarActions'; import { DeleteCellAction, EditCellAction, CellToggleMoreActionViewItem, MoveCellAction, SplitCellAction, CellToggleMoreAction, ToggleAddCellDropdownAction, ToggleAddCellActionViewItem } from 'sql/workbench/contrib/notebook/browser/cellToolbarActions';
import { AddCodeCellAction, AddTextCellAction, ToggleAddCellDropdownAction } from 'sql/workbench/contrib/notebook/browser/notebookActions';
import { CellTypes } from 'sql/workbench/services/notebook/common/contracts'; import { CellTypes } from 'sql/workbench/services/notebook/common/contracts';
import { DropdownMenuActionViewItem } from 'sql/base/browser/ui/buttonMenu/buttonMenu';
import { ICellModel } from 'sql/workbench/services/notebook/browser/models/modelInterfaces'; import { ICellModel } from 'sql/workbench/services/notebook/browser/models/modelInterfaces';
import { NotebookModel } from 'sql/workbench/services/notebook/browser/models/notebookModel'; import { NotebookModel } from 'sql/workbench/services/notebook/browser/models/notebookModel';
import { CellContext } from 'sql/workbench/contrib/notebook/browser/cellViews/codeActions'; import { CellContext } from 'sql/workbench/contrib/notebook/browser/cellViews/codeActions';
@@ -44,13 +40,10 @@ export class CellToolbarComponent {
private _editCellAction: EditCellAction; private _editCellAction: EditCellAction;
private _cellContext: CellContext; private _cellContext: CellContext;
private _typeChangedListener: IDisposable; private _typeChangedListener: IDisposable;
public _cellToggleMoreActions: CellToggleMoreActions;
constructor( constructor(
@Inject(IInstantiationService) private instantiationService: IInstantiationService, @Inject(IInstantiationService) private instantiationService: IInstantiationService
@Inject(IContextMenuService) private contextMenuService: IContextMenuService
) { ) {
this._cellToggleMoreActions = this.instantiationService.createInstance(CellToggleMoreActions);
this._disposableActions = new DisposableStore(); this._disposableActions = new DisposableStore();
} }
@@ -70,7 +63,16 @@ export class CellToolbarComponent {
protected initActionBar(): void { protected initActionBar(): void {
this._cellContext = new CellContext(this.model, this.cellModel); this._cellContext = new CellContext(this.model, this.cellModel);
let taskbar = <HTMLElement>this.celltoolbar.nativeElement; let taskbar = <HTMLElement>this.celltoolbar.nativeElement;
this._actionBar = new Taskbar(taskbar); this._actionBar = new Taskbar(taskbar, {
actionViewItemProvider: action => {
if (action.id === ToggleAddCellDropdownAction.ID) {
return this.instantiationService.createInstance(ToggleAddCellActionViewItem, action, this._actionBar.actionRunner, this._cellContext);
} else if (action.id === CellToggleMoreAction.ID) {
return this.instantiationService.createInstance(CellToggleMoreActionViewItem, action, this._actionBar.actionRunner, this._cellContext);
}
return undefined;
}
});
this._actionBar.context = this._cellContext; this._actionBar.context = this._cellContext;
this.setupActions(); this.setupActions();
@@ -79,67 +81,36 @@ export class CellToolbarComponent {
private setupActions(): void { private setupActions(): void {
this._disposableActions.clear(); this._disposableActions.clear();
let toggleAddCellDropdown = this.instantiationService.createInstance(ToggleAddCellDropdownAction); const toggleAddCellDropdownAction = this._disposableActions.add(this.instantiationService.createInstance(ToggleAddCellDropdownAction));
this._disposableActions.add(toggleAddCellDropdown);
let addCodeCellAction = this.instantiationService.createInstance(AddCodeCellAction); const moveCellDownAction = this._disposableActions.add(this.instantiationService.createInstance(MoveCellAction, 'notebook.MoveCellDown', 'masked-icon move-down', this.buttonMoveDown));
addCodeCellAction.cellType = CellTypes.Code; const moveCellUpAction = this._disposableActions.add(this.instantiationService.createInstance(MoveCellAction, 'notebook.MoveCellUp', 'masked-icon move-up', this.buttonMoveUp));
this._disposableActions.add(addCodeCellAction);
let addTextCellAction = this.instantiationService.createInstance(AddTextCellAction); const splitCellAction = this._disposableActions.add(this.instantiationService.createInstance(SplitCellAction, 'notebook.SplitCellAtCursor', this.buttonSplitCell, 'masked-icon icon-split-cell'));
addTextCellAction.cellType = CellTypes.Markdown;
this._disposableActions.add(addTextCellAction);
let moveCellDownAction = this.instantiationService.createInstance(MoveCellAction, 'notebook.MoveCellDown', 'masked-icon move-down', this.buttonMoveDown);
let moveCellUpAction = this.instantiationService.createInstance(MoveCellAction, 'notebook.MoveCellUp', 'masked-icon move-up', this.buttonMoveUp);
this._disposableActions.add(moveCellDownAction);
this._disposableActions.add(moveCellUpAction);
let splitCellAction = this.instantiationService.createInstance(SplitCellAction, 'notebook.SplitCellAtCursor', this.buttonSplitCell, 'masked-icon icon-split-cell');
splitCellAction.setListener(this._cellContext); splitCellAction.setListener(this._cellContext);
splitCellAction.enabled = this.cellModel.cellType !== 'markdown'; splitCellAction.enabled = this.cellModel.cellType !== 'markdown';
this._disposableActions.add(splitCellAction);
let deleteAction = this.instantiationService.createInstance(DeleteCellAction, 'notebook.DeleteCell', 'masked-icon delete', this.buttonDelete); const deleteAction = this._disposableActions.add(this.instantiationService.createInstance(DeleteCellAction, 'notebook.DeleteCell', 'masked-icon delete', this.buttonDelete));
this._disposableActions.add(deleteAction);
let moreActionsContainer = DOM.$('li.action-item'); this._editCellAction = this._disposableActions.add(this.instantiationService.createInstance(EditCellAction, 'notebook.EditCell', true, this.cellModel.isEditMode));
this._cellToggleMoreActions = this.instantiationService.createInstance(CellToggleMoreActions);
this._cellToggleMoreActions.onInit(moreActionsContainer, this._cellContext);
this._editCellAction = this.instantiationService.createInstance(EditCellAction, 'notebook.EditCell', true, this.cellModel.isEditMode);
this._editCellAction.enabled = true; this._editCellAction.enabled = true;
this._disposableActions.add(this._editCellAction);
let addCellDropdownContainer = DOM.$('li.action-item'); const moreAction = this._disposableActions.add(this.instantiationService.createInstance(CellToggleMoreAction));
addCellDropdownContainer.setAttribute('role', 'presentation');
let dropdownMenuActionViewItem = new DropdownMenuActionViewItem(
toggleAddCellDropdown,
[addCodeCellAction, addTextCellAction],
this.contextMenuService,
undefined,
this._actionBar.actionRunner,
undefined,
'codicon masked-icon new',
'',
undefined
);
dropdownMenuActionViewItem.render(addCellDropdownContainer);
dropdownMenuActionViewItem.setActionContext(this._cellContext);
let taskbarContent: ITaskbarContent[] = []; const taskbarContent: ITaskbarContent[] = [];
if (this.cellModel.cellType === CellTypes.Markdown) { if (this.cellModel.cellType === CellTypes.Markdown) {
taskbarContent.push( taskbarContent.push(
{ action: this._editCellAction } { action: this._editCellAction }
); );
} }
taskbarContent.push( taskbarContent.push(
{ element: addCellDropdownContainer }, { action: toggleAddCellDropdownAction },
{ action: moveCellDownAction }, { action: moveCellDownAction },
{ action: moveCellUpAction }, { action: moveCellUpAction },
{ action: splitCellAction }, { action: splitCellAction },
{ action: deleteAction }, { action: deleteAction },
{ element: moreActionsContainer }); { action: moreAction }
);
this._actionBar.setContent(taskbarContent); this._actionBar.setContent(taskbarContent);
} }

View File

@@ -27,7 +27,7 @@ import { INotebookService, INotebookParams, INotebookEditor, INotebookSection, I
import { NotebookModel } from 'sql/workbench/services/notebook/browser/models/notebookModel'; import { NotebookModel } from 'sql/workbench/services/notebook/browser/models/notebookModel';
import { Deferred } from 'sql/base/common/promise'; import { Deferred } from 'sql/base/common/promise';
import { ITaskbarContent, Taskbar } from 'sql/base/browser/ui/taskbar/taskbar'; import { ITaskbarContent, Taskbar } from 'sql/base/browser/ui/taskbar/taskbar';
import { KernelsDropdown, AttachToDropdown, TrustedAction, RunAllCellsAction, ClearAllOutputsAction, CollapseCellsAction, RunParametersAction, NotebookViewsActionProvider, AddCodeCellAction, AddTextCellAction, ToggleAddCellDropdownAction } from 'sql/workbench/contrib/notebook/browser/notebookActions'; import { KernelsDropdown, AttachToDropdown, TrustedAction, RunAllCellsAction, ClearAllOutputsAction, CollapseCellsAction, RunParametersAction, NotebookViewsActionProvider, AddCodeCellAction, AddTextCellAction } from 'sql/workbench/contrib/notebook/browser/notebookActions';
import { DropdownMenuActionViewItem } from 'sql/base/browser/ui/buttonMenu/buttonMenu'; import { DropdownMenuActionViewItem } from 'sql/base/browser/ui/buttonMenu/buttonMenu';
import { INotebookEditOperation } from 'sql/workbench/api/common/sqlExtHostTypes'; import { INotebookEditOperation } from 'sql/workbench/api/common/sqlExtHostTypes';
import { IConnectionDialogService } from 'sql/workbench/services/connection/common/connectionDialogService'; import { IConnectionDialogService } from 'sql/workbench/services/connection/common/connectionDialogService';
@@ -58,6 +58,7 @@ import { RedoCommand, UndoCommand } from 'vs/editor/browser/editorExtensions';
import { StandardKeyboardEvent } from 'vs/base/browser/keyboardEvent'; import { StandardKeyboardEvent } from 'vs/base/browser/keyboardEvent';
import { KeyCode } from 'vs/base/common/keyCodes'; import { KeyCode } from 'vs/base/common/keyCodes';
import { debounce } from 'vs/base/common/decorators'; import { debounce } from 'vs/base/common/decorators';
import { ToggleAddCellDropdownAction } from 'sql/workbench/contrib/notebook/browser/cellToolbarActions';
export const NOTEBOOK_SELECTOR: string = 'notebook-component'; export const NOTEBOOK_SELECTOR: string = 'notebook-component';
const PRIORITY = 105; const PRIORITY = 105;

View File

@@ -59,12 +59,6 @@ export const noParameterCell: string = localize('noParametersCell', "This notebo
export const noParametersInCell: string = localize('noParametersInCell', "This notebook cannot run with parameters until there are parameters added to the parameter cell. [Learn more](https://docs.microsoft.com/sql/azure-data-studio/notebooks/notebooks-parameterization)."); export const noParametersInCell: string = localize('noParametersInCell', "This notebook cannot run with parameters until there are parameters added to the parameter cell. [Learn more](https://docs.microsoft.com/sql/azure-data-studio/notebooks/notebooks-parameterization).");
export const untitledNotSupported: string = localize('untitledNotSupported', "Run with parameters is not supported for Untitled notebooks. Please save the notebook before continuing. [Learn more](https://docs.microsoft.com/sql/azure-data-studio/notebooks/notebooks-parameterization)."); export const untitledNotSupported: string = localize('untitledNotSupported', "Run with parameters is not supported for Untitled notebooks. Please save the notebook before continuing. [Learn more](https://docs.microsoft.com/sql/azure-data-studio/notebooks/notebooks-parameterization).");
export class ToggleAddCellDropdownAction extends Action {
constructor() {
super('notebook.toggleAddCell', localize('codeCellsPreview', "Add cell"))
}
}
export abstract class AddCellAction extends Action { export abstract class AddCellAction extends Action {
public cellType: CellType; public cellType: CellType;

View File

@@ -3,7 +3,7 @@
* Licensed under the Source EULA. See License.txt in the project root for license information. * Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import { Action } from 'vs/base/common/actions'; import { Action, IAction, IActionRunner } from 'vs/base/common/actions';
import { ViewOptionsModal } from 'sql/workbench/contrib/notebook/browser/notebookViews/viewOptionsModal'; import { ViewOptionsModal } from 'sql/workbench/contrib/notebook/browser/notebookViews/viewOptionsModal';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation'; import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { localize } from 'vs/nls'; import { localize } from 'vs/nls';
@@ -19,11 +19,12 @@ import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
import { ILogService } from 'vs/platform/log/common/log'; import { ILogService } from 'vs/platform/log/common/log';
import { getErrorMessage } from 'vs/base/common/errors'; import { getErrorMessage } from 'vs/base/common/errors';
import * as types from 'vs/base/common/types'; import * as types from 'vs/base/common/types';
import { ActionBar, ActionsOrientation } from 'vs/base/browser/ui/actionbar/actionbar';
import { Separator } from 'sql/base/browser/ui/separator/separator';
import { ToggleMoreActions } from 'sql/workbench/contrib/notebook/browser/cellToolbarActions';
import { NotebookViewsExtension } from 'sql/workbench/services/notebook/browser/notebookViews/notebookViewsExtension'; import { NotebookViewsExtension } from 'sql/workbench/services/notebook/browser/notebookViews/notebookViewsExtension';
import { INotebookView } from 'sql/workbench/services/notebook/browser/notebookViews/notebookViews'; import { INotebookView } from 'sql/workbench/services/notebook/browser/notebookViews/notebookViews';
import { moreActionsLabel } from 'sql/workbench/contrib/notebook/common/notebookLoc';
import { DropdownMenuActionViewItem } from 'vs/base/browser/ui/dropdown/dropdownActionViewItem';
import { IContextMenuService } from 'vs/platform/contextview/browser/contextView';
import { AnchorAlignment } from 'vs/base/browser/ui/contextview/contextview';
export class ViewSettingsAction extends Action { export class ViewSettingsAction extends Action {
private static readonly ID = 'notebookView.viewSettings'; private static readonly ID = 'notebookView.viewSettings';
@@ -216,27 +217,35 @@ export class ViewCellInNotebook extends CellActionBase {
} }
} }
export class ViewCellToggleMoreActions { export class ViewCellToggleMoreAction extends Action {
private _actions: (Action | CellActionBase)[] = []; public static readonly ID = 'notebook.viewToggleMore';
private _moreActions: ActionBar; public static readonly LABEL = moreActionsLabel;
private _moreActionsElement: HTMLElement; public static readonly ICON = 'codicon masked-icon more';
constructor(
@IInstantiationService private instantiationService: IInstantiationService
) {
this._actions.push(
instantiationService.createInstance(ViewCellInNotebook, 'viewCellInNotebook', localize('viewCellInNotebook', "View Cell In Notebook")),
);
}
public onInit(elementRef: HTMLElement, context: CellContext) { constructor() {
this._moreActionsElement = elementRef; super(ViewCellToggleMoreAction.ID);
this._moreActionsElement.setAttribute('aria-haspopup', 'menu'); this.tooltip = ViewCellToggleMoreAction.LABEL;
if (this._moreActionsElement.childNodes.length > 0) { }
this._moreActionsElement.removeChild(this._moreActionsElement.childNodes[0]); }
}
this._moreActions = new ActionBar(this._moreActionsElement, { orientation: ActionsOrientation.VERTICAL, ariaLabel: localize('moreActionsLabel', "More") }); export class ViewCellToggleMoreActionViewItem extends DropdownMenuActionViewItem {
this._moreActions.context = { target: this._moreActionsElement }; constructor(
let validActions = this._actions.filter(a => a instanceof Separator || a instanceof CellActionBase && a.canRun(context)); action: IAction,
this._moreActions.push(this.instantiationService.createInstance(ToggleMoreActions, validActions, context), { icon: true, label: false }); actionRunner: IActionRunner,
private _cellContext: CellContext,
@IContextMenuService contextMenuService: IContextMenuService,
@IInstantiationService instantiationService: IInstantiationService
) {
super(action,
[
instantiationService.createInstance(ViewCellInNotebook, 'viewCellInNotebook', localize('viewCellInNotebook', "View Cell In Notebook"))
],
contextMenuService,
{
actionRunner,
classNames: ViewCellToggleMoreAction.ICON,
anchorAlignmentProvider: () => AnchorAlignment.RIGHT
});
this.setActionContext(this._cellContext);
} }
} }

View File

@@ -3,7 +3,6 @@
* Licensed under the Source EULA. See License.txt in the project root for license information. * Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import 'vs/css!./cellToolbar'; import 'vs/css!./cellToolbar';
import * as DOM from 'vs/base/browser/dom';
import { Component, OnInit, Input, ViewChild, TemplateRef, ElementRef, Inject, Output, EventEmitter, ChangeDetectorRef, forwardRef, SimpleChange } from '@angular/core'; import { Component, OnInit, Input, ViewChild, TemplateRef, ElementRef, Inject, Output, EventEmitter, ChangeDetectorRef, forwardRef, SimpleChange } from '@angular/core';
import { CellExecutionState, ICellModel } from 'sql/workbench/services/notebook/browser/models/modelInterfaces'; import { CellExecutionState, ICellModel } from 'sql/workbench/services/notebook/browser/models/modelInterfaces';
import { NotebookModel } from 'sql/workbench/services/notebook/browser/models/notebookModel'; import { NotebookModel } from 'sql/workbench/services/notebook/browser/models/notebookModel';
@@ -11,7 +10,7 @@ import { DEFAULT_VIEW_CARD_HEIGHT, DEFAULT_VIEW_CARD_WIDTH, ViewsTab } from 'sql
import { CellChangeEventType, INotebookView, INotebookViewCard } from 'sql/workbench/services/notebook/browser/notebookViews/notebookViews'; import { CellChangeEventType, INotebookView, INotebookViewCard } from 'sql/workbench/services/notebook/browser/notebookViews/notebookViews';
import { ITaskbarContent, Taskbar } from 'sql/base/browser/ui/taskbar/taskbar'; import { ITaskbarContent, Taskbar } from 'sql/base/browser/ui/taskbar/taskbar';
import { CellContext } from 'sql/workbench/contrib/notebook/browser/cellViews/codeActions'; import { CellContext } from 'sql/workbench/contrib/notebook/browser/cellViews/codeActions';
import { RunCellAction, HideCellAction, ViewCellToggleMoreActions } from 'sql/workbench/contrib/notebook/browser/notebookViews/notebookViewsActions'; import { RunCellAction, HideCellAction, ViewCellToggleMoreAction, ViewCellToggleMoreActionViewItem } from 'sql/workbench/contrib/notebook/browser/notebookViews/notebookViewsActions';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation'; import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { CellTypes } from 'sql/workbench/services/notebook/common/contracts'; import { CellTypes } from 'sql/workbench/services/notebook/common/contracts';
import { AngularDisposable } from 'sql/base/browser/lifecycle'; import { AngularDisposable } from 'sql/base/browser/lifecycle';
@@ -31,8 +30,6 @@ export class NotebookViewsCardComponent extends AngularDisposable implements OnI
private _executionState: CellExecutionState; private _executionState: CellExecutionState;
private _pendingReinitialize: boolean = false; private _pendingReinitialize: boolean = false;
public _cellToggleMoreActions: ViewCellToggleMoreActions;
@Input() card: INotebookViewCard; @Input() card: INotebookViewCard;
@Input() cells: ICellModel[]; @Input() cells: ICellModel[];
@Input() model: NotebookModel; @Input() model: NotebookModel;
@@ -121,7 +118,14 @@ export class NotebookViewsCardComponent extends AngularDisposable implements OnI
this._actionbar.dispose(); this._actionbar.dispose();
} }
this._actionbar = new Taskbar(this._actionbarRef.nativeElement); this._actionbar = new Taskbar(this._actionbarRef.nativeElement, {
actionViewItemProvider: action => {
if (action.id === ViewCellToggleMoreAction.ID) {
return this._instantiationService.createInstance(ViewCellToggleMoreActionViewItem, action, this._actionbar.actionRunner, context);
}
return undefined;
}
});
this._actionbar.context = { target: this._actionbarRef.nativeElement }; this._actionbar.context = { target: this._actionbarRef.nativeElement };
if (this.cell.cellType === CellTypes.Code) { if (this.cell.cellType === CellTypes.Code) {
@@ -132,10 +136,8 @@ export class NotebookViewsCardComponent extends AngularDisposable implements OnI
let hideButton = new HideCellAction(this.hide, this); let hideButton = new HideCellAction(this.hide, this);
taskbarContent.push({ action: hideButton }); taskbarContent.push({ action: hideButton });
let moreActionsContainer = DOM.$('li.action-item'); const viewCellToggleMoreAction = this._instantiationService.createInstance(ViewCellToggleMoreAction);
this._cellToggleMoreActions = this._instantiationService.createInstance(ViewCellToggleMoreActions); taskbarContent.push({ action: viewCellToggleMoreAction });
this._cellToggleMoreActions.onInit(moreActionsContainer, context);
taskbarContent.push({ element: moreActionsContainer });
this._actionbar.setContent(taskbarContent); this._actionbar.setContent(taskbarContent);
} }

View File

@@ -0,0 +1,8 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { localize } from 'vs/nls';
export const moreActionsLabel = localize('moreActionsLabel', "More");

View File

@@ -5,7 +5,7 @@
import * as TypeMoq from 'typemoq'; import * as TypeMoq from 'typemoq';
import * as assert from 'assert'; import * as assert from 'assert';
import { CellToggleMoreActions, RunCellsAction, removeDuplicatedAndStartingSeparators, AddCellFromContextAction, CollapseCellAction, ConvertCellAction } from 'sql/workbench/contrib/notebook/browser/cellToolbarActions'; import { CellToggleMoreActionViewItem, RunCellsAction, removeDuplicatedAndStartingSeparators, AddCellFromContextAction, CollapseCellAction, ConvertCellAction, CellToggleMoreAction } from 'sql/workbench/contrib/notebook/browser/cellToolbarActions';
import { NotebookService } from 'sql/workbench/services/notebook/browser/notebookServiceImpl'; import { NotebookService } from 'sql/workbench/services/notebook/browser/notebookServiceImpl';
import { INotificationService } from 'vs/platform/notification/common/notification'; import { INotificationService } from 'vs/platform/notification/common/notification';
import { TestNotificationService } from 'vs/platform/notification/test/common/testNotificationService'; import { TestNotificationService } from 'vs/platform/notification/test/common/testNotificationService';
@@ -16,7 +16,6 @@ import { NullAdsTelemetryService } from 'sql/platform/telemetry/common/adsTeleme
import { CellContext } from 'sql/workbench/contrib/notebook/browser/cellViews/codeActions'; import { CellContext } from 'sql/workbench/contrib/notebook/browser/cellViews/codeActions';
import { INotebookService } from 'sql/workbench/services/notebook/browser/notebookService'; import { INotebookService } from 'sql/workbench/services/notebook/browser/notebookService';
import { MockContextKeyService } from 'vs/platform/keybinding/test/common/mockKeybindingService'; import { MockContextKeyService } from 'vs/platform/keybinding/test/common/mockKeybindingService';
import * as DOM from 'vs/base/browser/dom';
import { IContextMenuService } from 'vs/platform/contextview/browser/contextView'; import { IContextMenuService } from 'vs/platform/contextview/browser/contextView';
import { ContextMenuService } from 'vs/platform/contextview/browser/contextMenuService'; import { ContextMenuService } from 'vs/platform/contextview/browser/contextMenuService';
import { CellModel } from 'sql/workbench/services/notebook/browser/models/cell'; import { CellModel } from 'sql/workbench/services/notebook/browser/models/cell';
@@ -147,21 +146,16 @@ suite('CellToolbarActions', function (): void {
instantiationService.stub(IContextMenuService, TypeMoq.Mock.ofType(ContextMenuService).object); instantiationService.stub(IContextMenuService, TypeMoq.Mock.ofType(ContextMenuService).object);
}); });
test('CellToggleMoreActions with Code CellType', function (): void { test('CellToggleMoreActionViewItem with Code CellType displays correct number of actions', function (): void {
const testContainer = DOM.$('div');
cellModelMock.setup(x => x.cellType).returns(() => 'code'); cellModelMock.setup(x => x.cellType).returns(() => 'code');
const action = new CellToggleMoreActions(instantiationService); const action = new CellToggleMoreActionViewItem(new CellToggleMoreAction(), undefined, contextMock.object, undefined, instantiationService);
action.onInit(testContainer, contextMock.object); assert.equal(action.getValidActions().length, 18);
assert.strictEqual(action['_moreActions']['viewItems'][0]['_action']['_actions'].length, 18, 'Unexpected number of valid elements');
}); });
test('CellToggleMoreActions with Markdown CellType', function (): void { test('CellToggleMoreActionViewItem with Markdown CellType displays correct number of actions', function (): void {
const testContainer = DOM.$('div');
cellModelMock.setup(x => x.cellType).returns(() => 'markdown'); cellModelMock.setup(x => x.cellType).returns(() => 'markdown');
const action = new CellToggleMoreActions(instantiationService); const action = new CellToggleMoreActionViewItem(new CellToggleMoreAction(), undefined, contextMock.object, undefined, instantiationService);
action.onInit(testContainer, contextMock.object); assert.equal(action.getValidActions().length, 7);
// Markdown elements don't show the code-cell related actions such as Run Cell
assert.strictEqual(action['_moreActions']['viewItems'][0]['_action']['_actions'].length, 7, 'Unexpected number of valid elements');
}); });
}); });