Giter VIP home page Giter VIP logo

react-splicer's Introduction

React Splicer

A React.js component for suggesting and inserting Facebook-like "mentions" in a user input element.

Example use cases include:

  • Inserting mentions
  • Tagging

Installation

npm install react-splicer

This library is written as ES6 modules. You'll need to use Browserify or Webpack to consume it like any other modules from npm.

To run the example

Run npm install followed by gulp webserver. Open your browser and visit http://localhost:8080.

Tests

To run the tests npm test.

Note that tests are breaking on Node v0.12.0 and IO.js v1.5.0. To run the tests, you will have to switch to v0.10.x

This is a known issue with Jest.

How does it work?

let transformFn = function(text) {
  return `:${text}:`;
};

class App extends React.Component {
  constructor() {
    this.state = { result: null };
    this._callback = this._callback.bind(this);
  }

  render() {
    let data = ['Apple', 'Orange', 'Banana', 'Pineapple'],
        result = this.state.result;

    return (
      <div className="container">
        <Splicer
          charCount={2}
          data={data}
          transformFn={transformFn}
          callback={this._callback} />

        <div className="result">The result of the callback is:&nbsp;
          <span className="content">{result}</span>
        </div>
      </div>
    );
  }

  _callback(text) {
    return this.setState({ result: text });
  }
};

The <Splicer /> component requires the following propTypes:

charCount: The number of characters that needs to be entered before triggering a search for possible matches.

data: An array of strings containing all possible matches

transformFn: The function to run when a suggestion is selected. For example, transform the selected item into a element before inserting it.

callback: The function that will be fired with the contents of the user input element when the enter key is pressed.

TODO

  • Cross browser compatibility
  • Trigger keys
  • Accepting style options
  • Better test suite for logic involving cursor movements

react-splicer's People

Contributors

chenzihui avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

ada-lovecraft

react-splicer's Issues

Uncaught DOMException: Failed to execute 'setStart' on 'Range'

Hi,

Looks like a nice lib, unfortunately not ready for my usage yet (need cross-browser & trigger keys). In any case, wanted to let you know there's a bug (reproducible on the demo) when attempting to add both John and Johnny.

Attaching stack trace:
screenshot 2016-11-04 17 36 19

online demo please :)?

Hi-
Sounds interesting, but could you put up a demo? I ran the example, but it was not really clear what's going on.... a demo populated with realistic test data would get the use case across better.
Thanks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.