Support default values for multi-choices type

docs/Changelog.rst

@@ -1,6 +1,7 @@
 2.5.0 (unreleased)
 ------------------
 
+- #137 Support default values for multi-choices type
 - #135 Fix non-UID keyed folder items can not be pre-selected by the server
 - #134 Fix APIError for non-UID listings
 - #133 Multiselect with duplicates support for interim fields

webpack/app/components/MultiChoice.coffee

@@ -6,13 +6,17 @@ class MultiChoice extends React.Component
   ###*
    * Multi-Choice Field for the Listing Table
    *
-   * A multi select field is identified by the column type "multichoice" in the listing
-   * view, e.g.  `self.columns = {"Result": {"type": "multichoice"}, ... }`
+   * A multi choice field is identified by the column type "multichoice" in the
+   * listing view, e.g.  `self.columns = {"Result": {"type": "multichoice"}, ... }`
    *
   ###
   constructor: (props) ->
     super(props)
 
+    # remember the initial value
+    @state =
+      value: props.defaultValue
+
     # bind event handler to the current context
     @on_change = @on_change.bind @
 
@@ -30,28 +34,56 @@ class MultiChoice extends React.Component
     uid = el.getAttribute("uid")
     # Extract the column_key attribute
     name = el.getAttribute("column_key") or el.name
-    # Prepare a list of UIDs
+    # Store the new values
     value = (input.value for input in checked)
+    @setState
+      value: value
 
     console.debug "MultiChoice::on_change: value=#{value}"
 
     # Call the *update* field handler
     if @props.update_editable_field
       @props.update_editable_field uid, name, value, @props.item
 
+  ###
+   * Converts the value to an array
+  ###
+  to_array: (value) ->
+    if not value
+      return []
+    if Array.isArray(value)
+      return value
+    parsed = JSON.parse value
+    if not Array.isArray(parsed)
+      # This might happen when a default value is set, e.g. 0
+      return [parsed]
+    return parsed
+
+
   ###*
-   * Select options builder
+   * Checkboxes list builder. Generates a list of checkboxes made of the
+   * options passed-in. The values are the ids of the options to be selected
+   * @param values {array} list of selected ResultValues
    * @param options {array} list of option objects, e.g.:
    *                        {"ResultText": ..., "ResultValue": ...}
   ###
-  build_options: ->
-    options = []
+  build_checkboxes: ->
+    checkboxes = []
+
+    # Convert the result to an array
+    values = @to_array @state.value
+
+    # filter out empties
+    values = values.filter (value) -> value isnt ""
+
+    # ensure safe comparison (strings)
+    values = values.map (value) -> value.toString()
 
     for option in @props.options
       value = option.ResultValue
       title = option.ResultText
-      selected = option.selected or no
-      options.push(
+      selected = value.toString() in values
+      checkboxes.push(
         <li key={value}>
           <input type="checkbox"
                  defaultChecked={selected}
@@ -65,13 +97,13 @@ class MultiChoice extends React.Component
                  {...@props.attrs}/> {title}
         </li>)
 
-    return options
+    return checkboxes
 
   render: ->
     <div className={@props.field_css or "multichoice"}>
       {@props.before and <span className={@props.before_css or "before_field"} dangerouslySetInnerHTML={{__html: @props.before}}></span>}
       <ul className="list-unstyled">
-        {@build_options()}
+        {@build_checkboxes()}
       </ul>
       {@props.after and <span className={@props.after_css or "after_field"} dangerouslySetInnerHTML={{__html: @props.after}}></span>}
     </div>

webpack/app/components/TableCell.coffee

@@ -690,23 +690,11 @@ class TableCell extends React.Component
     column_key = props.column_key or @get_column_key()
     item = props.item or @get_item()
     name = props.name or @get_name()
-
     value = props.value or @get_value()
-    # convert value to array
-    if value.length > 0
-      value = JSON.parse value
-
-    options = props.options or item.choices[column_key] or []
-    # mark selected options
-    options.forEach (option) ->
-      selected = no
-      if Array.isArray value
-        selected = value.indexOf(option.ResultValue) > -1
-      option.selected = selected
-
     formatted_value = props.formatted_value or @get_formatted_value()
     uid = props.uid or @get_uid()
     title = props.title or @props.column.title or column_key
+    options = props.options or item.choices[column_key] or []
 
     column = props.column or @get_column()
     item.help ?= {}
@@ -728,6 +716,7 @@ class TableCell extends React.Component
         uid={uid}
         item={item}
         name={fieldname}
+        defaultValue={value}
         column_key={column_key}
         title={title}
         help={help}