Add Slider component (#14774)

* initial

* more cleanup

* update types
This commit is contained in:
Charles Gagnon
2021-03-18 09:47:36 -07:00
committed by GitHub
parent 03d2ac7206
commit 88b7960d01
11 changed files with 506 additions and 8 deletions

View File

@@ -272,6 +272,14 @@ class ModelBuilderImpl implements azdata.ModelBuilder {
return builder;
}
slider(): azdata.ComponentBuilder<azdata.SliderComponent, azdata.SliderComponentProperties> {
const id = this.getNextComponentId();
const builder: ComponentBuilderImpl<azdata.SliderComponent, azdata.SliderComponentProperties> = this.getComponentBuilder(new SliderComponentWrapper(this._proxy, this._handle, id), id);
this._componentBuilders.set(id, builder);
return builder;
}
getComponentBuilder<T extends azdata.Component, TPropertyBag extends azdata.ComponentProperties>(component: ComponentWrapper, id: string): ComponentBuilderImpl<T, TPropertyBag> {
let componentBuilder: ComponentBuilderImpl<T, TPropertyBag> = new ComponentBuilderImpl<T, TPropertyBag>(component);
this._componentBuilders.set(id, componentBuilder);
@@ -2022,6 +2030,65 @@ class InfoBoxComponentWrapper extends ComponentWrapper implements azdata.InfoBox
}
}
class SliderComponentWrapper extends ComponentWrapper implements azdata.SliderComponent {
constructor(proxy: MainThreadModelViewShape, handle: number, id: string) {
super(proxy, handle, ModelComponentTypes.Slider, id);
this.properties = {};
this._emitterMap.set(ComponentEventType.onDidChange, new Emitter<number>());
this._emitterMap.set(ComponentEventType.onInput, new Emitter<number>());
}
public get min(): number | undefined {
return this.properties['min'];
}
public set min(v: number | undefined) {
this.setProperty('min', v);
}
public get max(): number | undefined {
return this.properties['max'];
}
public set max(v: number | undefined) {
this.setProperty('max', v);
}
public get step(): number | undefined {
return this.properties['step'];
}
public set step(v: number | undefined) {
this.setProperty('step', v);
}
public get value(): number | undefined {
return this.properties['value'];
}
public set value(v: number | undefined) {
this.setProperty('value', v);
}
public get showTicks(): boolean | undefined {
return this.properties['showTicks'];
}
public set showTicks(v: boolean | undefined) {
this.setProperty('showTicks', v);
}
public get onChanged(): vscode.Event<number> {
const emitter = this._emitterMap.get(ComponentEventType.onDidChange);
return emitter!.event;
}
public get onInput(): vscode.Event<number> {
const emitter = this._emitterMap.get(ComponentEventType.onInput);
return emitter!.event;
}
}
class GroupContainerComponentWrapper extends ComponentWrapper implements azdata.GroupContainer {
constructor(proxy: MainThreadModelViewShape, handle: number, type: ModelComponentTypes, id: string) {
super(proxy, handle, type, id);

View File

@@ -177,7 +177,8 @@ export enum ModelComponentTypes {
TabbedPanel,
Separator,
PropertiesContainer,
InfoBox
InfoBox,
Slider
}
export enum ModelViewAction {
@@ -242,7 +243,8 @@ export enum ComponentEventType {
onSelectedRowChanged,
onComponentCreated,
onCellAction,
onEnterKeyPressed
onEnterKeyPressed,
onInput
}
export interface IComponentEventArgs {

View File

@@ -0,0 +1,148 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import {
Component, Input, Inject, ChangeDetectorRef, forwardRef,
ViewChild, ElementRef, OnDestroy, AfterViewInit
} from '@angular/core';
import * as azdata from 'azdata';
import { ComponentBase } from 'sql/workbench/browser/modelComponents/componentBase';
import { IComponent, IComponentDescriptor, IModelStore, ComponentEventType } from 'sql/platform/dashboard/browser/interfaces';
import { onUnexpectedError } from 'vs/base/common/errors';
import { ILogService } from 'vs/platform/log/common/log';
import { Slider } from 'sql/base/browser/ui/slider/slider';
import { convertSize } from 'sql/base/browser/dom';
@Component({
selector: 'modelview-slider',
template: `
<div #slider [ngStyle]="CSSStyles"></div>
`
})
export default class SliderComponent extends ComponentBase<azdata.SliderComponentProperties> implements IComponent, OnDestroy, AfterViewInit {
@Input() descriptor: IComponentDescriptor;
@Input() modelStore: IModelStore;
private _slider: Slider;
@ViewChild('slider', { read: ElementRef }) private _sliderContainer: ElementRef;
constructor(
@Inject(forwardRef(() => ChangeDetectorRef)) changeRef: ChangeDetectorRef,
@Inject(forwardRef(() => ElementRef)) el: ElementRef,
@Inject(ILogService) logService: ILogService
) {
super(changeRef, el, logService);
}
ngAfterViewInit(): void {
this._slider = this._register(new Slider(this._sliderContainer.nativeElement, {
width: convertSize(this.width),
min: this.min,
max: this.max,
value: this.value,
step: this.step,
showTicks: this.showTicks
}));
this._register(this._slider.onChange(async e => {
this.value = this._slider.value;
await this.validate();
this.fireEvent({
eventType: ComponentEventType.onDidChange,
args: e
});
}));
this._register(this._slider.onInput(e => {
this.fireEvent({
eventType: ComponentEventType.onInput,
args: e
});
}));
this.baseInit();
}
private get sliderElement(): Slider {
return this._slider;
}
ngOnDestroy(): void {
this.baseDestroy();
}
/// IComponent implementation
public setLayout(layout: any): void {
this.layout();
}
public setProperties(properties: { [key: string]: any; }): void {
super.setProperties(properties);
this.setSliderProperties(this.sliderElement);
this.validate().catch(onUnexpectedError);
}
private setSliderProperties(slider: Slider): void {
slider.min = this.min;
slider.max = this.max;
slider.step = this.step;
slider.value = this.value;
slider.showTicks = this.showTicks;
slider.ariaLabel = this.ariaLabel;
slider.enabled = this.enabled;
slider.width = convertSize(this.width);
}
// CSS-bound properties
public get value(): number | undefined {
return this.getPropertyOrDefault<number>((props) => props.value, undefined);
}
public set value(newValue: number | undefined) {
this.setPropertyFromUI<number>((props, value) => props.value = value, newValue);
}
public get min(): number | undefined {
return this.getPropertyOrDefault<number>((props) => props.min, undefined);
}
public set min(newValue: number | undefined) {
this.setPropertyFromUI<number>((props, value) => props.min = value, newValue);
}
public get max(): number | undefined {
return this.getPropertyOrDefault<number>((props) => props.max, undefined);
}
public set max(newValue: number | undefined) {
this.setPropertyFromUI<number>((props, value) => props.max = value, newValue);
}
public get step(): number | undefined {
return this.getPropertyOrDefault<number | undefined>((props) => props.step, undefined);
}
public set step(newValue: number | undefined) {
this.setPropertyFromUI<number | undefined>((props, value) => props.step = value, newValue);
}
public get showTicks(): boolean | undefined {
return this.getPropertyOrDefault<boolean | undefined>((props) => props.showTicks, undefined);
}
public set showTicks(newValue: boolean | undefined) {
this.setPropertyFromUI<boolean | undefined>((props, value) => props.showTicks = value, newValue);
}
public focus(): void {
this.sliderElement.focus();
}
public get inputBoxCSSStyles(): azdata.CssStyles {
return this.mergeCss(super.CSSStyles, {
'width': this.getWidth()
});
}
}

View File

@@ -35,6 +35,7 @@ import { ModelComponentTypes } from 'sql/platform/dashboard/browser/interfaces';
import PropertiesContainerComponent from 'sql/workbench/browser/modelComponents/propertiesContainer.component';
import ListViewComponent from 'sql/workbench/browser/modelComponents/listView.component';
import InfoBoxComponent from 'sql/workbench/browser/modelComponents/infoBox.component';
import SliderComponent from 'sql/workbench/browser/modelComponents/slider.component';
export const DIV_CONTAINER = 'div-container';
registerComponentType(DIV_CONTAINER, ModelComponentTypes.DivContainer, DivContainer);
@@ -126,3 +127,6 @@ registerComponentType(PROPERTIESCONTAINER_COMPONENT, ModelComponentTypes.Propert
export const INFOBOX_COMPONENT = 'infobox-component';
registerComponentType(INFOBOX_COMPONENT, ModelComponentTypes.InfoBox, InfoBoxComponent);
export const SLIDER_COMPONENT = 'slider-component';
registerComponentType(SLIDER_COMPONENT, ModelComponentTypes.Slider, SliderComponent);