jQuery-chosen - Push custom option attribute of selected option to list

Question

I've an option list like bellow

<select data-placeholder="Choose users" style="width:350px;" multiple class="chosen-select" tabindex="8">
    <option data-user-id="1">User1</option>
    <option data-user-id="3">User2</option>
    <option data-user-id="6">User3</option>
    <option data-user-id="14">User4</option>
</select>

I can select multiple options using chosen plugin . Each selected value entered into new <li> element like the follow:

<li class="search-choice"><span>User</span><a class="search-choice-close" data-option-array-index="2"></a></li>

Is there any way to push data-user-id from the option to the above <li> .

Can I do it without hacking chosen plugin?

Below you will find my solution by changing a little bit chosen plugin

Answer 1

Inside with SelectParser.prototype.add_option I got my custom attribute using jquery and then I've pushed it as an option.

The SelectParser.prototype.add_option looks like:

SelectParser.prototype.add_option = function(option, group_position, group_disabled) {
  if (option.nodeName.toUpperCase() === "OPTION") {
    if (option.text !== "") {
      if (group_position != null) {
        this.parsed[group_position].children += 1;
      }
      this.parsed.push({
        user_id: $(option).attr('data-user-id'),
        array_index: this.parsed.length,
        options_index: this.options_index,
        value: option.value,
        text: option.text,
        html: option.innerHTML,
        title: option.title ? option.title : void 0,
        selected: option.selected,
        disabled: group_disabled === true ? group_disabled : option.disabled,
        group_array_index: group_position,
        group_label: group_position != null ? this.parsed[group_position].label : null,
        classes: option.className,
        style: option.style.cssText
      });
    } else {
      this.parsed.push({
        array_index: this.parsed.length,
        options_index: this.options_index,
        empty: true
      });
    }
    return this.options_index += 1;
  }
};

As you noticed I put only this user_id: $(option).attr('data-user-id'), line of code.

Then to push the data-user-id to the <li> list I add this line 'data-user-id': item.user_id to Chosen.prototype.choice_build so at then end it looks like:

  Chosen.prototype.choice_build = function(item) {
      var choice, close_link,
        _this = this;
      choice = $('<li />', {
        "class": "search-choice"
      }).html("<span>" + (this.choice_label(item)) + "</span>");
      if (item.disabled) {
        choice.addClass('search-choice-disabled');
      } else {
        close_link = $('<a />', {
          "class": 'search-choice-close',
          'data-option-array-index': item.array_index,
          'data-user-id': item.user_id
        });
        close_link.bind('click.chosen', function(evt) {
          return _this.choice_destroy_link_click(evt);
        });
        choice.append(close_link);
      }
      return this.search_container.before(choice);
    };

That's it! You can push as many custom attribute as you want with this way.

Answer 2

I've tested this with chosen_v1.8.7. As @panagiotis-koursaris pointed on his answer, it's ok to add the line user_id: $(option).attr('data-user-id') to the first function:

SelectParser.prototype.add_option = function(option, group_position, group_disabled) { 
if (option.nodeName.toUpperCase() === "OPTION") { 
    if (option.text !== "") { 
      if (group_position != null) { 
        this.parsed[group_position].children += 1; 
      } 
      this.parsed.push({ 
        user_id: $(option).attr('data-user-id'), 
        array_index: this.parsed.length, 
        options_index: this.options_index, 
        value: option.value, 
        text: option.text, 
        html: option.innerHTML, 
        title: option.title ? option.title : void 0, 
        selected: option.selected, 
        disabled: group_disabled === true ? group_disabled : option.disabled, 
        group_array_index: group_position, 
        group_label: group_position != null ? this.parsed[group_position].label : null, 
        classes: option.className, 
        style: option.style.cssText 
      }); 
    } else { 
      this.parsed.push({ 
        array_index: this.parsed.length, 
        options_index: this.options_index, 
        empty: true 
      }); 
    } 
    return this.options_index += 1; 
  } 
};

But also you need to add this line option_el.setAttribute("data-user-id", option.user_id); to AbstractChosen.prototype.result_add_option:

AbstractChosen.prototype.result_add_option = function(option) {
      var classes, option_el;
      if (!option.search_match) {
        return '';
      }
      if (!this.include_option_in_results(option)) {
        return '';
      }
      classes = [];
      if (!option.disabled && !(option.selected && this.is_multiple)) {
        classes.push("active-result");
      }
      if (option.disabled && !(option.selected && this.is_multiple)) {
        classes.push("disabled-result");
      }
      if (option.selected) {
        classes.push("result-selected");
      }
      if (option.group_array_index != null) {
        classes.push("group-option");
      }
      if (option.classes !== "") {
        classes.push(option.classes);
      }
      option_el = document.createElement("li");
      option_el.className = classes.join(" ");
      if (option.style) {
        option_el.style.cssText = option.style;
      }
      option_el.setAttribute("data-option-array-index", option.array_index);
      // Add the line below
      option_el.setAttribute("data-user-id", option.user_id);
      option_el.innerHTML = option.highlighted_html || option.html;
      if (option.title) {
        option_el.title = option.title;
      }
      return this.outerHTML(option_el);
    };

Answer 3

I would suggest using the value attribute instead of a data attribute.

<select data-placeholder="Choose users" style="width:350px;" multiple class="chosen-select" tabindex="8">
    <option value="1">User1</option>
    <option value="3">User2</option>
    <option value="6">User3</option>
    <option value="14">User4</option>
</select>

And then you can retrieve the id using

$('select').val(); //use a name or id attribute to make this selector more specific..