Added different Select Fields (#1583)

* Added different Select Fields - Switched FormGroup to react-select - Added multi and freeform to select, now it can take customized user input and insert it as options * Fixed tests * Small nit based on comments
apache · Nov 13, 2016 · 2133056 · 2133056
1 parent 4155a9d
commit 2133056
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 32 deletions.
diff --git a/superset/assets/javascripts/explorev2/components/FieldSet.jsx b/superset/assets/javascripts/explorev2/components/FieldSet.jsx
@@ -14,7 +14,7 @@ const propTypes = {
   places: PropTypes.number,
   validators: PropTypes.any,
   onChange: React.PropTypes.func,
-  value: PropTypes.oneOf([PropTypes.string, PropTypes.bool, PropTypes.array]).isRequired,
+  value: PropTypes.oneOfType([PropTypes.string, PropTypes.bool, PropTypes.array]).isRequired,
 };
 
 const defaultProps = {
@@ -40,10 +40,11 @@ export default class FieldSet extends React.Component {
       />);
   }
 
-  renderSelectField() {
+  renderSelectField(selectProps) {
     return (
       <SelectField
         {...this.props}
+        {...selectProps}
       />);
   }
 
@@ -56,18 +57,18 @@ export default class FieldSet extends React.Component {
 
   render() {
     const type = this.props.type;
-    const selectTypes = [
-      'SelectField',
-      'SelectCustomMultiField',
-      'SelectMultipleSortableField',
-      'FreeFormSelectField',
-    ];
+    const selectProps = {
+      SelectCustomMultiField: { multi: true, freeForm: true },
+      SelectMultipleSortableField: { multi: true, freeForm: false },
+      SelectField: { multi: false, freeForm: false },
+      FreeFormSelectField: { multi: false, freeForm: true },
+    };
     let field;
 
     if (type === 'CheckboxField') {
       field = this.renderCheckBoxField();
-    } else if (selectTypes.includes(type)) {
-      field = this.renderSelectField();
+    } else if (Object.keys(selectProps).includes(type)) {
+      field = this.renderSelectField(selectProps[type]);
     } else if (['TextField', 'IntegerField'].includes(type)) {
       field = this.renderTextField();
     } else if (type === 'TextAreaField') {

diff --git a/superset/assets/javascripts/explorev2/components/SelectField.jsx b/superset/assets/javascripts/explorev2/components/SelectField.jsx
@@ -1,18 +1,23 @@
 import React, { PropTypes } from 'react';
-import { FormGroup, FormControl } from 'react-bootstrap';
 import ControlLabelWithTooltip from './ControlLabelWithTooltip';
 import { slugify } from '../../modules/utils';
+import Select, { Creatable } from 'react-select';
+
 
 const propTypes = {
   name: PropTypes.string.isRequired,
   choices: PropTypes.array,
-  value: PropTypes.string,
+  value: PropTypes.oneOfType([PropTypes.string, PropTypes.array]),
   label: PropTypes.string,
   description: PropTypes.string,
   onChange: PropTypes.func,
+  multi: PropTypes.bool,
+  freeForm: PropTypes.bool,
 };
 
 const defaultProps = {
+  multi: false,
+  freeForm: false,
   value: '',
   label: null,
   description: null,
@@ -21,25 +26,44 @@ const defaultProps = {
 
 export default class SelectField extends React.Component {
   onChange(opt) {
-    this.props.onChange(this.props.name, opt.target.value);
+    let optionValue = opt ? opt.value : null;
+    // if multi, return options values as an array
+    if (this.props.multi) {
+      optionValue = opt ? opt.map((o) => o.value) : null;
+    }
+    this.props.onChange(this.props.name, optionValue);
   }
-
   render() {
+    const options = this.props.choices.map((c) => ({ value: c[0], label: c[1] }));
+    if (this.props.freeForm) {
+      // For FreeFormSelect, insert value into options if not exist
+      const values = this.props.choices.map((c) => c[0]);
+      if (values.indexOf(this.props.value) === -1) {
+        options.push({ value: this.props.value, label: this.props.value });
+      }
+    }
+
+    const selectProps = {
+      multi: this.props.multi,
+      name: `select-${this.props.name}`,
+      placeholder: `Select (${this.props.choices.length})`,
+      options,
+      value: this.props.value,
+      autosize: false,
+      onChange: this.onChange.bind(this),
+    };
+    //  Tab, comma or Enter will trigger a new option created for FreeFormSelect
+    const selectWrap = this.props.freeForm ?
+      (<Creatable {...selectProps} />) : (<Select {...selectProps} />);
+
     return (
-      <FormGroup controlId={`formControlsSelect-${slugify(this.props.label)}`}>
+      <div id={`formControlsSelect-${slugify(this.props.label)}`}>
         <ControlLabelWithTooltip
           label={this.props.label}
           description={this.props.description}
         />
-        <FormControl
-          componentClass="select"
-          placeholder="select"
-          onChange={this.onChange.bind(this)}
-          value={this.props.value}
-        >
-          {this.props.choices.map((c) => <option key={c[0]} value={c[0]}>{c[1]}</option>)}
-        </FormControl>
-      </FormGroup>
+        {selectWrap}
+      </div>
     );
   }
 }

diff --git a/superset/assets/javascripts/explorev2/stores/store.js b/superset/assets/javascripts/explorev2/stores/store.js
@@ -1278,23 +1278,23 @@ export const fields = {
   },
 
   series_height: {
-    type: 'SelectCustomMultiField',
+    type: 'FreeFormSelectField',
     label: 'Series Height',
     default: 25,
     choices: formatSelectOptions([10, 25, 40, 50, 75, 100, 150, 200]),
     description: 'Pixel height of each series',
   },
 
   x_axis_format: {
-    type: 'SelectCustomMultiField',
+    type: 'FreeFormSelectField',
     label: 'X axis format',
     default: 'smart_date',
     choices: TIME_STAMP_OPTIONS,
     description: D3_FORMAT_DOCS,
   },
 
   y_axis_format: {
-    type: 'SelectCustomMultiField',
+    type: 'FreeFormSelectField',
     label: 'Y axis format',
     default: '.3s',
     choices: D3_TIME_FORMAT_OPTIONS,

diff --git a/superset/assets/spec/javascripts/explorev2/components/SelectField_spec.js b/superset/assets/spec/javascripts/explorev2/components/SelectField_spec.js
@@ -1,6 +1,6 @@
 /* eslint-disable no-unused-expressions */
 import React from 'react';
-import { FormControl } from 'react-bootstrap';
+import Select, { Creatable } from 'react-select';
 import sinon from 'sinon';
 import { expect } from 'chai';
 import { describe, it, beforeEach } from 'mocha';
@@ -21,13 +21,18 @@ describe('SelectField', () => {
     wrapper = shallow(<SelectField {...defaultProps} />);
   });
 
-  it('renders a FormControl', () => {
-    expect(wrapper.find(FormControl)).to.have.lengthOf(1);
+  it('renders a Select', () => {
+    expect(wrapper.find(Select)).to.have.lengthOf(1);
   });
 
   it('calls onChange when toggled', () => {
-    const select = wrapper.find(FormControl);
-    select.simulate('change', { target: { value: 50 } });
+    const select = wrapper.find(Select);
+    select.simulate('change', { value: 50 });
     expect(defaultProps.onChange.calledWith('row_limit', 50)).to.be.true;
   });
+
+  it('renders a Creatable for freeform', () => {
+    wrapper = shallow(<SelectField {...defaultProps} freeForm />);
+    expect(wrapper.find(Creatable)).to.have.lengthOf(1);
+  });
 });