bootstrap-suggest

A jQuery plugin for bootstrap that pops-up a dropdown in textarea or input textbox.

Install

Several quick start options are available:

download latest release
npm: npm install --save bootstrap-suggest
bower: bower install bootstrap-suggest

** Make sure to link bootstrap-suggest.js and bootstrap-suggest.css to your project

Usage

Markup

<div class="form-group">
   <label for="comment">start typing with @</label>
   <textarea class="form-control" rows="5" id="comment"></textarea>
</div>

Data

var users = [
  {username: 'lodev09', fullname: 'Jovanni Lo'},
  {username: 'foo', fullname: 'Foo User'},
  {username: 'bar', fullname: 'Bar User'},
  {username: 'twbs', fullname: 'Twitter Bootstrap'},
  {username: 'john', fullname: 'John Doe'},
  {username: 'jane', fullname: 'Jane Doe'},
];

Init

$('#comment').suggest('@', {
  data: users,
  map: function(user) {
    return {
      value: user.username,
      text: '<strong>'+user.username+'</strong> <small>'+user.fullname+'</small>'
    }
  }
})

via Promise or ajax

Ajax is supported by having the data function return a jqXHR object. The function takes a single parameter containing the mention text string.

$('#comment').suggest('@', {
  data: function(q) {
    if (q) {
      return $.getJSON("users/data.json", { q: q });
    }
  },
  // ...
})

via "provide" function

A provide function is provided for you to call on after securing your data (don't return anything to the data option function to avoid conflict)

$('#comment').suggest('@', {
  data: function(q, provide) {
    if (q) {
      $.getJSON("users/data.json", { q: q }, function(data) {
        // simply call provide and pass on your data!
        provide.call(data);
      });

      // we aren't returning any
    }
  },
  // ...
})

Advanced

Add delay search while typing

timeout = null;
$('#comment').suggest('@', {
  data: function(q, lookup) {
    var processData = function() {
      $.getJSON("users/lookup.json", { q: q }, function(data) {
        lookup.call(data);
      });
    };

    if (timeout) {
      clearTimeout(timeout);
      timeout = null;
    }

    timeout = setTimeout(processData, 500);
  },
  // ...
})

API

http://lodev09.github.io/bootstrap-suggest/#api

Credits

All bugs, feature requests, pull requests, feedback, etc., are welcome!

Bootstrap Components

Copyright & License

Released under the Apache License, Version 2.0. See LICENSE file.

mepawan / bootstrap-suggest Goto Github PK