MultiDataList

Image to be displayed

MultiDataList creates a multiple checkbox list UI component that is connected to a database field. It is used for filtering results based on the current selection(s) from a list of data items.

Note

This component behaves similar to the MultiList component except the list items are user defined with the data prop, ideal for showing curated items in a list layout.

Example uses:

  • select one or multiple items from a list of categories for filtering e-commerce search results.
  • filtering restaurants by one or more cuisine choices.

Usage

Basic Usage

<MultiDataList
  componentId="MeetupTops"
  dataField="group.group_topics.topic_name_raw.raw"
  data={
    [{
      label: "Social",
      value: "Social"
    }, {
      label: "Travel",
      value: "Travel"
    }, {
      label: "Outdoors",
      value: "Outdoors"
    }]
  }
  title="Meetups"
/>

Usage With All Props

<MultiDataList
    componentId="MeetupTops"
  dataField="group.group_topics.topic_name_raw.raw"
  data={
    [{
      label: "Social",
      value: "Social"
    }, {
      label: "Travel",
      value: "Travel"
    }, {
      label: "Outdoors",
      value: "Outdoors"
    }]
  }
  title="Meetups"
  showSearch={true}
  showCheckbox={true}
  placeholder="Filter meetups"
  defaultValue={["Social"]}
  selectAllLabel="All meetups"
  showFilter={true}
  filterLabel="Price"
  URLParams={false}
/>

Props

  • componentId String
    unique identifier of the component, can be referenced in other components’ react prop.

  • dataField String
    data field to be connected to the component’s UI view.

  • data Object Array
    collection of UI labels with associated value to be matched against the database field.

  • nestedField String [optional]
    use to set the nested mapping field that allows arrays of objects to be indexed in a way that they can be queried independently of each other. Applicable only when dataField is a part of nested type.

  • title String or JSX [optional]
    title of the component to be shown in the UI.

  • showSearch Boolean [optional]
    whether to display a searchbox to filter the data list. Defaults to false.

  • showCheckbox Boolean [optional]
    whether to display a checkbox button beside the list item. Defaults to true.

  • placeholder String [optional]
    placeholder to be displayed in the searchbox. Defaults to “Search”.

  • defaultValue String Array [optional]
    selects initial items from the list on mount.

  • value String Array [optional]
    controls the current value of the component. It selects the item from the list (on mount and on update). Use this prop in conjunction with onChange function.

  • selectAllLabel String [optional]
    if provided displays an additional option to select all list values.

  • showFilter Boolean [optional]
    show as filter when a value is selected in a global selected filters view. Defaults to true.

  • showCount Boolean [optional]
    show a count of the number of occurences besides each list item. Defaults to false.

  • filterLabel String [optional]
    An optional label to display for the component in the global selected filters view. This is only applicable if showFilter is enabled. Default value used here is componentId.

  • URLParams Boolean [optional]
    enable creating a URL query string parameter based on the selected value of the list. This is useful for sharing URLs with the component state. Defaults to false.

  • renderItem Function [optional]
    customize the rendered list via a function which receives the item label, count & isSelected and expects a JSX or String back. For example:

    renderItem={(label, count, isSelected) => (
        <div>
            {label}
            <span style={{
                marginLeft: 5, color: isSelected ? 'red' : 'dodgerblue' 
            }}>
                {count}
            </span>
        </div>
    )}
    
  • render Function [optional]
    an alternative callback function to renderItem, where user can define how to render the view based on all the data changes.
    It accepts an object with these properties:

    • data: array An array of results obtained from the applied query.
    • value: array current selected values.
    • handleChange: function A callback function can be used to mark the list value as selected.

      <MultiDropdownList
      render={({
      data,
      handleChange,
      }) => data.map(item => (
          <div onClick={() => handleChange(item.key)} key={item.key}>
              <span>{item.key}</span>
              <span>{item.doc_count}</span>
          </div>
        )
      )}
      />
      

      Or you can also use render function as children

      <MultiDropdownList>
      {
          ({
              data,
              value,
              handleChange,
          }) => (
              // return UI to be rendered
          )
      }
      </MultiDropdownList>
      
  • renderError String or JSX or Function [optional] can be used to render an error message in case of any error.

    renderError={(error) => (
            <div>
                Something went wrong!<br/>Error details<br/>{error}
            </div>
        )
    }
    
  • renderNoResults Function [optional]
    can be used to render a message in case of no list items.

    renderNoResults={() => <p>No Results Found!</p>}
    
  • onChange function [optional]
    is a callback function which accepts component’s current value as a parameter. It is called when you are using the value props and the component’s value changes. This prop is used to implement the controlled component behavior.

  • onError Function [optional]
    gets triggered in case of an error and provides the error object, which can be used for debugging or giving feedback to the user if needed.

Demo


Styles

MultiDataList component supports innerClass prop with the following keys:

  • title
  • input
  • list
  • checkbox
  • label
  • count

Read more about it here.

Extending

MultiDataList component can be extended to

  1. customize the look and feel with className, style,
  2. update the underlying DB query with customQuery, defaultQuery,
  3. connect with external interfaces using beforeValueChange, onValueChange and onQueryChange.
<MultiDataList
  ...
  className="custom-class"
  style={{"paddingBottom": "10px"}}
  customQuery={
    function(value, props) {
      return {
        query: {
          match: {
            data_field: "this is a test"
          }
        }
      }
    }
  }
  defaultQuery={
    function(value, props) {
      return {
          timeout: '1s'
      }
    }
  }
  beforeValueChange={
    function(value) {
      // called before the value is set
      // returns a promise
      return new Promise((resolve, reject) => {
        // update state or component props
        resolve()
        // or reject()
      })
    }
  }
  onValueChange={
    function(value) {
      console.log("current value: ", value)
      // set the state
      // use the value with other js code
    }
  }
  onQueryChange={
    function(prevQuery, nextQuery) {
      // use the query with other js code
      console.log('prevQuery', prevQuery);
      console.log('nextQuery', nextQuery);
    }
  }
/>
  • className String
    CSS class to be injected on the component container.
  • style Object
    CSS styles to be applied to the MultiDataList component.
  • customQuery Function
    takes value and props as parameters and returns the data query to be applied to the component, as defined in Elasticsearch Query DSL. Note: customQuery is called on value changes in the MultiDataList component as long as the component is a part of react dependency of at least one other component.
  • defaultQuery Function
    takes value and props as parameters and returns the data query to be applied to the source component, as defined in Elasticsearch Query DSL, which doesn’t get leaked to other components.
    Read more about it here.
  • beforeValueChange Function
    is a callback function which accepts component’s future value as a parameter and returns a promise. It is called everytime before a component’s value changes. The promise, if and when resolved, triggers the execution of the component’s query and if rejected, kills the query execution. This method can act as a gatekeeper for query execution, since it only executes the query after the provided promise has been resolved.
  • onValueChange Function
    is a callback function which accepts component’s current value as a parameter. It is called everytime the component’s value changes. This prop is handy in cases where you want to generate a side-effect on value selection. For example: You want to show a pop-up modal with the valid discount coupon code when list item(s) is/are selected in a “Discounted Price” MultiDataList.
  • onQueryChange Function
    is a callback function which accepts component’s prevQuery and nextQuery as parameters. It is called everytime the component’s query changes. This prop is handy in cases where you want to generate a side-effect whenever the component’s query would change.

Examples

MultiDataList with default props