import { Alignment } from "@blueprintjs/core"; import { LabelPosition } from "components/constants"; import { EventType } from "constants/AppsmithActionConstants/ActionConstants"; import type { WidgetType } from "constants/WidgetConstants"; import type { ValidationResponse } from "constants/WidgetValidation"; import { ValidationTypes } from "constants/WidgetValidation"; import type { Stylesheet } from "entities/AppTheming"; import { EvaluationSubstitutionType } from "entities/DataTree/dataTreeFactory"; import equal from "fast-deep-equal/es6"; import type { LoDashStatic } from "lodash"; import { findIndex, isArray, isNil, isNumber, isString } from "lodash"; import React from "react"; import { AutocompleteDataType } from "utils/autocomplete/AutocompleteDataType"; import { isAutoLayout } from "utils/autoLayout/flexWidgetUtils"; import { GRID_DENSITY_MIGRATION_V1, MinimumPopupRows } from "widgets/constants"; import { isAutoHeightEnabledForWidget, DefaultAutocompleteDefinitions, } from "widgets/WidgetUtils"; import type { WidgetProps, WidgetState } from "../../BaseWidget"; import BaseWidget from "../../BaseWidget"; import SelectComponent from "../component"; import type { DropdownOption } from "../constants"; import derivedProperties from "./parseDerivedProperties"; import type { AutocompletionDefinitions } from "widgets/constants"; export function defaultOptionValueValidation( value: unknown, props: SelectWidgetProps, _: LoDashStatic, ): ValidationResponse { let isValid; let parsed; let message = { name: "", message: "" }; const isServerSideFiltered = props.serverSideFiltering; // TODO: validation of defaultOption is dependent on serverSideFiltering and options, this property should reValidated once the dependencies change //this issue is been tracked here https://github.com/appsmithorg/appsmith/issues/15303 let options = props.options; /* * Function to check if the object has `label` and `value` */ const hasLabelValue = (obj: any) => { return ( _.isPlainObject(value) && obj.hasOwnProperty("label") && obj.hasOwnProperty("value") && _.isString(obj.label) && (_.isString(obj.value) || _.isFinite(obj.value)) ); }; /* * When value is "{label: 'green', value: 'green'}" */ if (typeof value === "string") { try { const parsedValue = JSON.parse(value); if (_.isObject(parsedValue)) { value = parsedValue; } } catch (e) {} } if (_.isString(value) || _.isFinite(value) || hasLabelValue(value)) { /* * When value is "", "green", 444, {label: "green", value: "green"} */ isValid = true; parsed = value; } else { isValid = false; parsed = undefined; message = { name: "TypeError", message: 'value does not evaluate to type: string | number | { "label": "label1", "value": "value1" }', }; } if (isValid && !_.isNil(parsed) && parsed !== "") { if (!Array.isArray(options) && typeof options === "string") { try { const parsedOptions = JSON.parse(options); if (Array.isArray(parsedOptions)) { options = parsedOptions; } else { options = []; } } catch (e) { options = []; } } const parsedValue = (parsed as any).hasOwnProperty("value") ? (parsed as any).value : parsed; const valueIndex = _.findIndex( options, (option) => option.value === parsedValue, ); if (valueIndex === -1) { if (!isServerSideFiltered) { isValid = false; message = { name: "ValidationError", message: `Default value is missing in options. Please update the value.`, }; } else { if (!hasLabelValue(parsed)) { isValid = false; message = { name: "ValidationError", message: `Default value is missing in options. Please use {label : , value : < string | num>} format to show default for server side data.`, }; } } } } return { isValid, parsed, messages: [message], }; } class SelectWidget extends BaseWidget { constructor(props: SelectWidgetProps) { super(props); } static getAutocompleteDefinitions(): AutocompletionDefinitions { return { "!doc": "Select is used to capture user input/s from a specified list of permitted inputs. A Select can capture a single choice", "!url": "https://docs.appsmith.com/widget-reference/dropdown", isVisible: DefaultAutocompleteDefinitions.isVisible, filterText: { "!type": "string", "!doc": "The filter text for Server side filtering", }, selectedOptionValue: { "!type": "string", "!doc": "The value selected in a single select dropdown", "!url": "https://docs.appsmith.com/widget-reference/dropdown", }, selectedOptionLabel: { "!type": "string", "!doc": "The selected option label in a single select dropdown", "!url": "https://docs.appsmith.com/widget-reference/dropdown", }, isDisabled: "bool", isValid: "bool", isDirty: "bool", options: "[$__dropdownOption__$]", }; } static getPropertyPaneContentConfig() { return [ { sectionName: "Data", children: [ { helpText: "Allows users to select a single option. Values must be unique", propertyName: "options", label: "Options", controlType: "INPUT_TEXT", placeholderText: '[{ "label": "label1", "value": "value1" }]', isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.ARRAY, params: { unique: ["value"], children: { type: ValidationTypes.OBJECT, params: { required: true, allowedKeys: [ { name: "label", type: ValidationTypes.TEXT, params: { default: "", requiredKey: true, }, }, { name: "value", type: ValidationTypes.TEXT, params: { default: "", requiredKey: true, }, }, ], }, }, }, }, evaluationSubstitutionType: EvaluationSubstitutionType.SMART_SUBSTITUTE, }, { helpText: "Selects the option with value by default", propertyName: "defaultOptionValue", label: "Default selected value", controlType: "SELECT_DEFAULT_VALUE_CONTROL", placeholderText: '{ "label": "label1", "value": "value1" }', isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.FUNCTION, params: { fn: defaultOptionValueValidation, expected: { type: 'value1 or { "label": "label1", "value": "value1" }', example: `value1 | { "label": "label1", "value": "value1" }`, autocompleteDataType: AutocompleteDataType.STRING, }, }, }, dependencies: ["serverSideFiltering", "options"], }, ], }, { sectionName: "Label", children: [ { helpText: "Sets the label text of the widget", propertyName: "labelText", label: "Text", controlType: "INPUT_TEXT", placeholderText: "Enter label text", isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.TEXT }, }, { helpText: "Sets the label position of the widget", propertyName: "labelPosition", label: "Position", controlType: "ICON_TABS", fullWidth: true, options: [ { label: "Left", value: LabelPosition.Left }, { label: "Top", value: LabelPosition.Top }, { label: "Auto", value: LabelPosition.Auto }, ], hidden: isAutoLayout, defaultValue: LabelPosition.Top, isBindProperty: false, isTriggerProperty: false, validation: { type: ValidationTypes.TEXT }, }, { helpText: "Sets the label alignment of the widget", propertyName: "labelAlignment", label: "Alignment", controlType: "LABEL_ALIGNMENT_OPTIONS", fullWidth: false, options: [ { startIcon: "align-left", value: Alignment.LEFT, }, { startIcon: "align-right", value: Alignment.RIGHT, }, ], isBindProperty: false, isTriggerProperty: false, validation: { type: ValidationTypes.TEXT }, hidden: (props: SelectWidgetProps) => props.labelPosition !== LabelPosition.Left, dependencies: ["labelPosition"], }, { helpText: "Sets the label width of the widget as the number of columns", propertyName: "labelWidth", label: "Width (in columns)", controlType: "NUMERIC_INPUT", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, min: 0, validation: { type: ValidationTypes.NUMBER, params: { natural: true, }, }, hidden: (props: SelectWidgetProps) => props.labelPosition !== LabelPosition.Left, dependencies: ["labelPosition"], }, ], }, { sectionName: "Search & filters", children: [ { propertyName: "isFilterable", label: "Allow searching", helpText: "Makes the dropdown list filterable", controlType: "SWITCH", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.BOOLEAN }, }, { helpText: "Enables server side filtering of the data", propertyName: "serverSideFiltering", label: "Server side filtering", controlType: "SWITCH", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.BOOLEAN }, }, { helpText: "Trigger an action on change of filterText", hidden: (props: SelectWidgetProps) => !props.serverSideFiltering, dependencies: ["serverSideFiltering"], propertyName: "onFilterUpdate", label: "onFilterUpdate", controlType: "ACTION_SELECTOR", isJSConvertible: true, isBindProperty: true, isTriggerProperty: true, }, ], }, { sectionName: "Validations", children: [ { propertyName: "isRequired", label: "Required", helpText: "Makes input to the widget mandatory", controlType: "SWITCH", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.BOOLEAN }, }, ], }, { sectionName: "General", children: [ { helpText: "Show help text or details about current selection", propertyName: "labelTooltip", label: "Tooltip", controlType: "INPUT_TEXT", placeholderText: "Add tooltip text here", isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.TEXT }, }, { helpText: "Sets a Placeholder Text", propertyName: "placeholderText", label: "Placeholder", controlType: "INPUT_TEXT", placeholderText: "Enter placeholder text", isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.TEXT }, }, { helpText: "Controls the visibility of the widget", propertyName: "isVisible", label: "Visible", controlType: "SWITCH", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.BOOLEAN }, }, { propertyName: "isDisabled", label: "Disabled", helpText: "Disables input to this widget", controlType: "SWITCH", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.BOOLEAN }, }, { propertyName: "animateLoading", label: "Animate loading", controlType: "SWITCH", helpText: "Controls the loading of the widget", defaultValue: true, isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.BOOLEAN }, }, ], }, { sectionName: "Events", children: [ { helpText: "when a user selects an option", propertyName: "onOptionChange", label: "onOptionChange", controlType: "ACTION_SELECTOR", isJSConvertible: true, isBindProperty: true, isTriggerProperty: true, }, { helpText: "when the dropdown opens", propertyName: "onDropdownOpen", label: "onDropdownOpen", controlType: "ACTION_SELECTOR", isJSConvertible: true, isBindProperty: true, isTriggerProperty: true, }, { helpText: "when the dropdown closes", propertyName: "onDropdownClose", label: "onDropdownClose", controlType: "ACTION_SELECTOR", isJSConvertible: true, isBindProperty: true, isTriggerProperty: true, }, ], }, ]; } static getPropertyPaneStyleConfig() { return [ { sectionName: "Label styles", children: [ { propertyName: "labelTextColor", label: "Font color", helpText: "Control the color of the label associated", controlType: "COLOR_PICKER", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.TEXT }, }, { propertyName: "labelTextSize", label: "Font size", helpText: "Control the font size of the label associated", controlType: "DROP_DOWN", defaultValue: "0.875rem", hidden: isAutoLayout, options: [ { label: "S", value: "0.875rem", subText: "0.875rem", }, { label: "M", value: "1rem", subText: "1rem", }, { label: "L", value: "1.25rem", subText: "1.25rem", }, { label: "XL", value: "1.875rem", subText: "1.875rem", }, { label: "XXL", value: "3rem", subText: "3rem", }, { label: "3XL", value: "3.75rem", subText: "3.75rem", }, ], isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.TEXT }, }, { propertyName: "labelStyle", label: "Emphasis", helpText: "Control if the label should be bold or italics", controlType: "BUTTON_GROUP", options: [ { icon: "text-bold", value: "BOLD", }, { icon: "text-italic", value: "ITALIC", }, ], isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.TEXT }, }, ], }, { sectionName: "Border and shadow", children: [ { propertyName: "borderRadius", label: "Border radius", helpText: "Rounds the corners of the icon button's outer border edge", controlType: "BORDER_RADIUS_OPTIONS", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.TEXT }, }, { propertyName: "boxShadow", label: "Box shadow", helpText: "Enables you to cast a drop shadow from the frame of the widget", controlType: "BOX_SHADOW_OPTIONS", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.TEXT }, }, ], }, ]; } static getStylesheetConfig(): Stylesheet { return { accentColor: "{{appsmith.theme.colors.primaryColor}}", borderRadius: "{{appsmith.theme.borderRadius.appBorderRadius}}", boxShadow: "none", }; } static getDefaultPropertiesMap(): Record { return { value: "defaultOptionValue", label: "defaultOptionValue", filterText: "", }; } static getMetaPropertiesMap(): Record { return { value: undefined, label: undefined, filterText: "", isDirty: false, }; } // https://github.com/appsmithorg/appsmith/issues/13664#issuecomment-1120814337 static getDerivedPropertiesMap() { return { isValid: `{{(()=>{${derivedProperties.getIsValid}})()}}`, selectedOptionValue: `{{(()=>{${derivedProperties.getSelectedOptionValue}})()}}`, selectedOptionLabel: `{{(()=>{${derivedProperties.getSelectedOptionLabel}})()}}`, }; } componentDidMount() { super.componentDidMount(); } componentDidUpdate(prevProps: SelectWidgetProps): void { // Reset isDirty to false if defaultOptionValue changes if ( !equal(this.props.defaultOptionValue, prevProps.defaultOptionValue) && this.props.isDirty ) { this.props.updateWidgetMetaProperty("isDirty", false); } } isStringOrNumber = (value: any): value is string | number => isString(value) || isNumber(value); getPageView() { const options = isArray(this.props.options) ? this.props.options : []; const isInvalid = "isValid" in this.props && !this.props.isValid && !!this.props.isDirty; const dropDownWidth = MinimumPopupRows * this.props.parentColumnSpace; const selectedIndex = findIndex(this.props.options, { value: this.props.selectedOptionValue, }); const { componentHeight, componentWidth } = this.getComponentDimensions(); return ( 1 ) } disabled={this.props.isDisabled} dropDownWidth={dropDownWidth} filterText={this.props.filterText} hasError={isInvalid} height={componentHeight} isDynamicHeightEnabled={isAutoHeightEnabledForWidget(this.props)} isFilterable={this.props.isFilterable} isLoading={this.props.isLoading} isValid={this.props.isValid} label={this.props.selectedOptionLabel} labelAlignment={this.props.labelAlignment} labelPosition={this.props.labelPosition} labelStyle={this.props.labelStyle} labelText={this.props.labelText} labelTextColor={this.props.labelTextColor} labelTextSize={this.props.labelTextSize} labelTooltip={this.props.labelTooltip} labelWidth={this.getLabelWidth()} onDropdownClose={this.onDropdownClose} onDropdownOpen={this.onDropdownOpen} onFilterChange={this.onFilterChange} onOptionSelected={this.onOptionSelected} options={options} placeholder={this.props.placeholderText} resetFilterTextOnClose={!this.props.serverSideFiltering} selectedIndex={selectedIndex > -1 ? selectedIndex : undefined} serverSideFiltering={this.props.serverSideFiltering} value={this.props.selectedOptionValue} widgetId={this.props.widgetId} width={componentWidth} /> ); } onOptionSelected = (selectedOption: DropdownOption) => { let isChanged = true; // Check if the value has changed. If no option // selected till now, there is a change if (!isNil(this.props.selectedOptionValue)) { isChanged = this.props.selectedOptionValue !== selectedOption.value; } if (isChanged) { if (!this.props.isDirty) { this.props.updateWidgetMetaProperty("isDirty", true); } this.props.updateWidgetMetaProperty("label", selectedOption.label ?? ""); this.props.updateWidgetMetaProperty("value", selectedOption.value ?? "", { triggerPropertyName: "onOptionChange", dynamicString: this.props.onOptionChange, event: { type: EventType.ON_OPTION_CHANGE, }, }); } // When Label changes but value doesnt change, Applies to serverside Filtering if (!isChanged && this.props.selectedOptionLabel !== selectedOption.label) { this.props.updateWidgetMetaProperty("label", selectedOption.label ?? ""); } }; onFilterChange = (value: string) => { this.props.updateWidgetMetaProperty("filterText", value); if (this.props.onFilterUpdate && this.props.serverSideFiltering) { super.executeAction({ triggerPropertyName: "onFilterUpdate", dynamicString: this.props.onFilterUpdate, event: { type: EventType.ON_FILTER_UPDATE, }, }); } }; onDropdownOpen = () => { if (this.props.onDropdownOpen) { super.executeAction({ triggerPropertyName: "onDropdownOpen", dynamicString: this.props.onDropdownOpen, event: { type: EventType.ON_DROPDOWN_OPEN, }, }); } }; onDropdownClose = () => { if (this.props.onDropdownClose) { super.executeAction({ triggerPropertyName: "onDropdownClose", dynamicString: this.props.onDropdownClose, event: { type: EventType.ON_DROPDOWN_CLOSE, }, }); } }; static getWidgetType(): WidgetType { return "SELECT_WIDGET"; } } export interface SelectWidgetProps extends WidgetProps { placeholderText?: string; labelText: string; labelPosition?: LabelPosition; labelAlignment?: Alignment; labelWidth?: number; selectedIndex?: number; options?: DropdownOption[]; onOptionChange?: string; onDropdownOpen?: string; onDropdownClose?: string; defaultOptionValue?: any; value?: any; label?: any; isRequired: boolean; isFilterable: boolean; selectedOptionLabel: string; serverSideFiltering: boolean; onFilterUpdate: string; isDirty?: boolean; filterText: string; } export default SelectWidget;