String matches bold about react-select

[craigmichaelmartin]

Thanks @arvinsingla!! Here is @bvaughn's helpful example updated for v2:

import React from 'react';
import Select from 'react-select';
import Highlighter from 'react-highlight-words';

const options = [];

function formatOptionLabel ({label}, {inputValue}) {
  return (
    <Highlighter
      searchWords={[inputValue]}
      textToHighlight={label}
    />
  );
}

function render () {
  return (
    <Select
      options={options}
      formatOptionLabel={formatOptionLabel}
      {...otherProps}
    />
  );
}

Test it out in codesandbox

[bvaughn]

Hi all!

This is possible using a custom optionRenderer and a 3rd party library like react-highlight-words.

import React from 'react';
import Select from 'react-select';
import Highlighter from 'react-highlight-words';

const options = [];
let inputValue;

function optionRenderer (option) {
  return (
    <Highlighter
      searchWords={[inputValue]}
      textToHighlight={option.label}
    />
  );
}

function render () {
  return (
    <Select
      onInputChange={(value) => inputValue = inputValue}
      options={options}
      optionRenderer={optionRenderer}
      {...otherProps}
    />
  );
}

Example:

I don't think this functionality belongs in react-select. It's useful to keep the base component as simple as possible in order to keep in maintainable and bug-free. Since it's easy to add this functionality using 3rd party libraries (like shown above) I'm going to close this issue for now.

Cheers! 😄

[xseman]

This should work without react-highlight-words

function formatOptionLabel ({label}, {inputValue}) {
    const highlighted = option.label.replace(
        new RegExp(labelMeta.inputValue, 'gi'),
        highlighted => `<mark>${highlighted}</mark>`
    );
    return (
        <span dangerouslySetInnerHTML={{ __html: highlighted }} />
    );
};

[arvinsingla]

@raviteja83 I used formatOptionLabel in v2 to accomplish this.

[rkichenama]

I have been able to get a highlight effect on the options through a sort of kludge of onInputChange and optionRender. Essentially, whenever the input changes, I capture it and use it to construct an array of spans that wrap the matching text with a specific class I can style (react-select-match).

Highlighter = (function () {
  function Highlighter () {
    this.input = '';
  };
  Highlighter.prototype = {
    wrap (t, c) {
      return (
        <span className={c}>{t}</span>
      );
    },
    chop (v, i) {
      var
        regexp = new RegExp(i, 'i'),
        mark = v.search(regexp),
        len = i.length;
      if (mark === -1) {
        return [this.wrap(v)];
      } else {
        return [].concat(
          this.wrap(v.substr(0, mark)),
          this.wrap(v.substr(mark, len), 'react-select-match'),
          this.chop(v.substr(mark + len), i)
        );
      }
    },
    onInputChange (inp) {
      this.input = inp
        .replace(/^ +/, '')
        .replace(/ +$/, '')
      ;
    },
    optionRenderer (val) {
      if (this.input && this.input.length) {
        var looking = this.input,
          resp =this.chop(val.label, this.input);
        console.log(resp);
        return resp;
      }
      else {
        return val.label;
      }
    },
  };
  return Highlighter;
}());

...

var highlighter = new Highlighter();

<Select
  onInputChange={highlighter.onInputChange.bind(highlighter)}
  optionRenderer={highlighter.optionRenderer.bind(highlighter)}
  />

[JedWatson]

Maybe we should highlight the match with a different background color? bolding parts of the word would make the letter spacing jump around a bit, I think. Good idea though, if it's a <span class="matched-text"> (or similar) then themes can do whatever they like.

[dlong500]

Any progress on this yet? I like the idea of a span tag around matched text.

[dcousens]

@dlong500 it might be easier to add this functionality through other means, rather than adding all this rich text handling in the component it self.

As it stands, you could probably handle this in the async search options callback to update the list to have bolded [relevant] values, but that doesn't really work for the non-async case.

[dlong500]

@dcousens I agree it would be possible to handle this outside the component for async operations, but even then it would be much more pleasant if the component could wrap a span tag around any matching text. I don't like the idea of having to mix CSS tags into a function that would otherwise only be returning raw data. Plus it means a lot of code duplication if you've got to implement that functionality all over the place.

[Siyfion]

I too, think that this would be a really nice addition to the core package, maybe just a toggleable option if nothing else? As this is quite "normal" behaviour for a typeahead I would say.

[untone]

Sorry for late, but i have questions about it.

1. Can i use both optionRenderer and optionComponent in one time?
2. It is possible to pass onInputChange value to optionComponent?

[bvaughn]

Can i use both optionRenderer and optionComponent in one time?

Yes. OptionComponent specifies the component class-type used to render the option-wrapper. (The default is Option.) optionRenderer renders the children/content inside of the option. Look here to see what I'm talking about.

It is possible to pass onInputChange value to optionComponent?

No. Input is handled separately, outside of the scope of a single option. It has nothing to do with the optionComponent.

[untone]

Oh, react-highlight-words still use babel v5 :(

[raviteja83]

@bvaughn How can this be used with v2? CustomOption does not get value of the option. can you suggest a possible way to do the same in v2?

[bvaughn]

No idea. Haven't used v2. Sorry!