README.md

react-textarea-autocomplete 📝

Enhanced textarea to achieve autocomplete functionality.

---

This package provides React Component to achieve GitHub's like functionality in comments regarding the textarea autocomplete. It can be used for example for emoji autocomplete or for @mentions. The render function (for displaying text enhanced by this textarea) is beyond the scope of this package and it should be solved separately.

Installation

This module is distributed via npm and should be installed as one of your project's dependencies:

yarn add @webscopeio/react-textarea-autocomplete

This package also depends on react and prop-types. Please make sure you have those installed as well.

Options

These two props are different than with normal <textarea />, the rest is pretty same: className, value, onChange,...

Option	Default	Type	Description
loadingComponent	required	React Component	Gets data props which is already fetched (and displayed) suggestion
trigger	required	Object (Trigger type)	Define triggers and their corresponding behavior

Trigger type

{
    [triggerChar: string]: {
        ?output: (item: Object | string, trigger: ?string) => string,
        dataProvider: (token: string) => Promise<Array<Object | string>> | Array<Object | string>,
        component: ReactClass<*>,
    },
}

• dataProvider is called after each keystroke to get data what the suggestion list should display (array or promise resolving array)
• component is the component for render the item in suggestion list. It has selected and entity props provided by React Textarea Autocomplete
• output (optional) this function defines text which will be placed into textarea after the user makes a selection. (default behavior for string type of item is string: current trigger char + item)

Example of usage

import React, { Component } from 'react';

// import React Textarea Autocomplete
import ReactTextareaAutocomplete from 'react-textarea-autocomplete';
import 'react-textarea-autocomplete/dist/default-style.css';

import es from 'emoji-search';
import R from 'ramda';

const SmileItemComponent = props =>
  (<div>
    {props.entity.char} {props.entity.name}
  </div>);
  
const Loading = ({ data }) => <div>Loading</div>;

class App extends Component {
  render() {
    return (
      <div className="App">
        <div style={{ height: 200, width: 500 }}>
          <ReactTextareaAutocomplete
            loadingComponent={Loading}
            trigger={{
              ':': {
                output: (item, trigger) => `:${item.name}:`,
                dataProvider: (token) => {
                  if (!token) {
                    return [];
                  }
                  return R.take(10, es(token));
                },
                component: SmileItemComponent,
              },
            }}
          />
        </div>
      </div>
    );
  }
}

export default App;

Development

Run yarn to fetch dependencies.

Run yarn dev for bundling.

In the folder run yarn link and then in your project folder yarn link react-textarea-autocomplete to link together.

Your PR's are welcomed! ❤️

License

MIT