c29fd2db19
* Adds canDisplayValue to property controls * Adds tests * add fn for LocationSearch & ActionSelector * Adds CSV value support in ButtonTabControl
65 lines
2.3 KiB
TypeScript
65 lines
2.3 KiB
TypeScript
/***
|
|
* Controls are rendered in the property panel from the property config
|
|
* Controls are higher order components that update a widgets property
|
|
*/
|
|
import { Component } from "react";
|
|
import _ from "lodash";
|
|
import { EditorTheme } from "components/editorComponents/CodeEditor/EditorConfig";
|
|
import { PropertyPaneControlConfig } from "constants/PropertyControlConstants";
|
|
import { CodeEditorExpected } from "components/editorComponents/CodeEditor";
|
|
|
|
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
class BaseControl<P extends ControlProps, S = {}> extends Component<P, S> {
|
|
updateProperty(propertyName: string, propertyValue: any) {
|
|
if (!_.isNil(this.props.onPropertyChange))
|
|
this.props.onPropertyChange(propertyName, propertyValue);
|
|
}
|
|
deleteProperties(propertyPaths: string[]) {
|
|
if (this.props.deleteProperties) {
|
|
this.props.deleteProperties(propertyPaths);
|
|
}
|
|
}
|
|
batchUpdateProperties = (updates: Record<string, unknown>) => {
|
|
if (this.props.onBatchUpdateProperties) {
|
|
this.props.onBatchUpdateProperties(updates);
|
|
}
|
|
};
|
|
|
|
// Checks whether a particular value can be displayed UI from JS edit mode
|
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
static canDisplayValueInUI(config: ControlData, value: any): boolean {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
export interface ControlBuilder<T extends ControlProps> {
|
|
buildPropertyControl(controlProps: T): JSX.Element;
|
|
}
|
|
|
|
export interface ControlProps extends ControlData, ControlFunctions {
|
|
key?: string;
|
|
additionalAutoComplete?: Record<string, Record<string, unknown>>;
|
|
}
|
|
export interface ControlData
|
|
extends Omit<PropertyPaneControlConfig, "additionalAutoComplete"> {
|
|
propertyValue?: any;
|
|
errorMessage?: string;
|
|
expected?: CodeEditorExpected;
|
|
evaluatedValue: any;
|
|
widgetProperties: any;
|
|
useValidationMessage?: boolean;
|
|
parentPropertyName: string;
|
|
parentPropertyValue: unknown;
|
|
additionalDynamicData: Record<string, Record<string, unknown>>;
|
|
}
|
|
export interface ControlFunctions {
|
|
onPropertyChange?: (propertyName: string, propertyValue: string) => void;
|
|
onBatchUpdateProperties?: (updates: Record<string, unknown>) => void;
|
|
openNextPanel: (props: any) => void;
|
|
deleteProperties: (propertyPaths: string[]) => void;
|
|
theme: EditorTheme;
|
|
hideEvaluatedValue?: boolean;
|
|
}
|
|
|
|
export default BaseControl;
|