import React from "react"; import BaseWidget, { WidgetProps, WidgetState } from "./BaseWidget"; import { WidgetType } from "constants/WidgetConstants"; import { EventType } from "constants/AppsmithActionConstants/ActionConstants"; import DropDownComponent from "components/designSystems/blueprint/DropdownComponent"; import _ from "lodash"; import { ValidationResponse, ValidationTypes, } from "constants/WidgetValidation"; import { Intent as BlueprintIntent } from "@blueprintjs/core"; import * as Sentry from "@sentry/react"; import withMeta, { WithMeta } from "./MetaHOC"; import { IconName } from "@blueprintjs/icons"; import { EvaluationSubstitutionType } from "entities/DataTree/dataTreeFactory"; function defaultOptionValueValidation( value: unknown, props: DropdownWidgetProps, ): ValidationResponse { if (props.selectionType === "SINGLE_SELECT") { if (typeof value === "string") return { isValid: true, parsed: value.trim() }; if (value === undefined || value === null) return { isValid: false, parsed: "", message: "This value does not evaluate to type: string", }; return { isValid: true, parsed: value }; } else { let values: string[] = []; if (typeof value === "string") { try { values = JSON.parse(value); if (!Array.isArray(values)) { throw new Error(); } } catch { values = value.length ? value.split(",") : []; if (values.length > 0) { values = values.map((_v: string) => _v.trim()); } } } if (Array.isArray(value)) { values = Array.from(new Set(value)); } return { isValid: true, parsed: values, }; } } class DropdownWidget extends BaseWidget { static getPropertyPaneConfig() { return [ { sectionName: "General", children: [ { helpText: "Allows users to select either a single option or multiple options", propertyName: "selectionType", label: "Selection Type", controlType: "DROP_DOWN", options: [ { label: "Single Select", value: "SINGLE_SELECT", }, { label: "Multi Select", value: "MULTI_SELECT", }, ], isBindProperty: false, isTriggerProperty: false, }, { helpText: "Allows users to select either a single option or multiple options. Values must be unique", propertyName: "options", label: "Options", controlType: "INPUT_TEXT", placeholderText: 'Enter [{"label": "label1", "value": "value2"}]', isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.ARRAY, params: { children: { type: ValidationTypes.OBJECT, params: { allowedKeys: [ { name: "label", type: ValidationTypes.TEXT, default: "", }, { name: "value", type: ValidationTypes.TEXT, default: "", }, ], }, }, }, }, evaluationSubstitutionType: EvaluationSubstitutionType.SMART_SUBSTITUTE, }, { helpText: "Selects the option with value by default", propertyName: "defaultOptionValue", label: "Default Option", controlType: "INPUT_TEXT", placeholderText: "Enter option value", isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.FUNCTION, params: { fn: defaultOptionValueValidation, expected: { type: "value or Array of values", example: `value1 | ['value1', 'value2']`, }, }, }, }, { propertyName: "isFilterable", label: "Filterable", helpText: "Makes the dropdown list filterable", controlType: "SWITCH", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.BOOLEAN }, }, { propertyName: "isRequired", label: "Required", helpText: "Makes input to the widget mandatory", controlType: "SWITCH", isJSConvertible: true, isBindProperty: true, isTriggerProperty: false, validation: { type: ValidationTypes.BOOLEAN }, }, { 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 }, }, ], }, { sectionName: "Actions", children: [ { helpText: "Triggers an action when a user selects an option", propertyName: "onOptionChange", label: "onOptionChange", controlType: "ACTION_SELECTOR", isJSConvertible: true, isBindProperty: true, isTriggerProperty: true, }, ], }, ]; } static getDerivedPropertiesMap() { return { isValid: `{{this.isRequired ? this.selectionType === 'SINGLE_SELECT' ? !!this.selectedOption : !!this.selectedIndexArr && this.selectedIndexArr.length > 0 : true}}`, selectedOption: `{{ this.selectionType === 'SINGLE_SELECT' ? _.find(this.options, { value: this.selectedOptionValue }) : undefined}}`, selectedOptionArr: `{{this.selectionType === "MULTI_SELECT" ? this.options.filter(opt => _.includes(this.selectedOptionValueArr, opt.value)) : undefined}}`, selectedIndex: `{{ _.findIndex(this.options, { value: this.selectedOption.value } ) }}`, selectedIndexArr: `{{ this.selectedOptionValueArr.map(o => _.findIndex(this.options, { value: o })) }}`, value: `{{ this.selectionType === 'SINGLE_SELECT' ? this.selectedOptionValue : this.selectedOptionValueArr }}`, selectedOptionValues: `{{ this.selectionType === 'MULTI_SELECT' ? this.selectedOptionValueArr : [] }}`, selectedOptionLabels: `{{ this.selectionType === "MULTI_SELECT" ? this.selectedOptionValueArr.map(o => { const index = _.findIndex(this.options, { value: o }); return this.options[index]?.label; }) : [] }}`, selectedOptionLabel: `{{(()=>{const index = _.findIndex(this.options, { value: this.selectedOptionValue }); return this.selectionType === "SINGLE_SELECT" ? this.options[index]?.label : ""; })()}}`, }; } static getDefaultPropertiesMap(): Record { return { selectedOptionValue: "defaultOptionValue", selectedOptionValueArr: "defaultOptionValue", }; } static getMetaPropertiesMap(): Record { return { selectedOptionValue: undefined, selectedOptionValueArr: undefined, }; } getSelectedOptionValueArr(): string[] { return Array.isArray(this.props.selectedOptionValueArr) ? this.props.selectedOptionValueArr : []; } getDropdownPosition = (node: HTMLDivElement | null) => { if (Boolean(node?.closest(".bp3-modal-widget"))) { return document.querySelector(".bp3-modal-widget") as HTMLElement; } return document.querySelector(".appsmith_widget_0") as HTMLElement; }; getPageView() { const options = _.isArray(this.props.options) ? this.props.options : []; const selectedIndex = _.findIndex(this.props.options, { value: this.props.selectedOptionValue, }); const computedSelectedIndexArr = this.props.selectedIndexArr || []; const { componentHeight, componentWidth } = this.getComponentDimensions(); return ( -1 ? selectedIndex : undefined} selectedIndexArr={computedSelectedIndexArr} selectionType={this.props.selectionType} widgetId={this.props.widgetId} width={componentWidth} /> ); } onOptionSelected = (selectedOption: DropdownOption) => { let isChanged = true; if (this.props.selectionType === "SINGLE_SELECT") { // Check if the value has changed. If no option // selected till now, there is a change if (this.props.selectedOption) { isChanged = !(this.props.selectedOption.value === selectedOption.value); } if (isChanged) { this.props.updateWidgetMetaProperty( "selectedOptionValue", selectedOption.value, { triggerPropertyName: "onOptionChange", dynamicString: this.props.onOptionChange, event: { type: EventType.ON_OPTION_CHANGE, }, }, ); } } else if (this.props.selectionType === "MULTI_SELECT") { const selectedOptionValueArr = this.getSelectedOptionValueArr(); const isAlreadySelected = selectedOptionValueArr.includes( selectedOption.value, ); let newSelectedValue = [...selectedOptionValueArr]; if (isAlreadySelected) { newSelectedValue = newSelectedValue.filter( (v) => v !== selectedOption.value, ); } else { newSelectedValue.push(selectedOption.value); } this.props.updateWidgetMetaProperty( "selectedOptionValueArr", newSelectedValue, { triggerPropertyName: "onOptionChange", dynamicString: this.props.onOptionChange, event: { type: EventType.ON_OPTION_CHANGE, }, }, ); } }; onOptionRemoved = (removedIndex: number) => { const newSelectedValue = this.getSelectedOptionValueArr().filter( (v: string) => _.findIndex(this.props.options, { value: v }) !== removedIndex, ); this.props.updateWidgetMetaProperty( "selectedOptionValueArr", newSelectedValue, { triggerPropertyName: "onOptionChange", dynamicString: this.props.onOptionChange, event: { type: EventType.ON_OPTION_CHANGE, }, }, ); }; getWidgetType(): WidgetType { return "DROP_DOWN_WIDGET"; } } export type SelectionType = "SINGLE_SELECT" | "MULTI_SELECT"; export interface DropdownOption { label: string; value: string; icon?: IconName; subText?: string; id?: string; onSelect?: (option: DropdownOption) => void; children?: DropdownOption[]; intent?: BlueprintIntent; } export interface DropdownWidgetProps extends WidgetProps, WithMeta { placeholderText?: string; label?: string; selectedIndex?: number; selectedIndexArr?: number[]; selectionType: SelectionType; selectedOption: DropdownOption; options?: DropdownOption[]; onOptionChange?: string; defaultOptionValue?: string | string[]; isRequired: boolean; isFilterable: boolean; selectedOptionValue: string; selectedOptionValueArr: string[]; selectedOptionLabels: string[]; selectedOptionLabel: string; } export default DropdownWidget; export const ProfiledDropDownWidget = Sentry.withProfiler( withMeta(DropdownWidget), );