• Stars
    star
    751
  • Rank 58,867 (Top 2 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 11 years ago
  • Updated over 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Lightweight wrapper for adding @user mention functionality to Twitter Bootstraps Typeahead plugin

Mention.js

Lightweight (min: 1.92kb, full: 4.07kb) wrapper for adding @user mention functionality to Twitter Bootstraps Typeahead plugin.

This enables you to have Twitter-like user mentions in textareas

View the demo here.

Dependencies

Usage

The users parameter accepts an array of objects. Each object must have a username key in order for this script to work.

$("#multi-users").mention({
    delimiter: '@',
    users: [{
        username: "ashley"
    }, { 
        username: "roger"
    }, { 
        username: "frecklefart123"
    }]
});

Sensitivity

$("#multi-users").mention({
    sensitive: true,
    users: [{
        username: "sarah"
    }, { 
        username: "bigRat"
    }, { 
        username: "roger"
    }, { 
        username: "Ricky"
    }]
});

With sensitivity set to true, items are ordered by the following divisions of priority:

  • Highest: If first letter matches exactly
  • High: If first letter matches regardless of case
  • Med: If target has matching letters' case
  • Low: if target has matching character regardless of case

Sensitivity Examples:

If you were to query "@r", with sensitivity on, the resulting list will be ["roger", "Ricky", "sarah", "bigRat"], but if you were to query "@R", the resulting list would be ["Ricky", "roger", "bigRat", "sarah"]

Full Names, Images, and Query By

If you have a name and/or image key in one of your user objects, there name and image will appear as such in the dropdown list.

The queryBy parameter accepts an array of strings that represent keys in your user object that you would like to query against. For example, if you were to type in the name "@Scott", the script would match the username "@bigCat". username is required for this script to work.

$("#multi-users").mention({
    queryBy: ['name', 'username'],
    users: [{
        username: "sarah",
        name: "Sarah Jones",
        image: "http://placekitten.com/25/25"
    }, { 
        username: "bigCat",
        name: "Scott Pfaff",
        image: "http://placekitten.com/25/25"
    }, { 
        username: "coderDude",
        name: "Roger Penn",
        image: "http://placekitten.com/25/25"
    }]
});

Empty Querying

You may query for users simply by pressing your delimiter. For example, pressing the @ symbol will return all users that are a part of your users list, so long as those users adhere to the typeaheadOpts.items limit

$('#multi-users').mention({
    emptyQuery: true,
    typeaheadOpts: {
        items: 10 // Max number of items you want to show
    },
    users: [...]
});

Defaults

$("#multi-users").mention({
    users: [], // Array of Objects
    delimiter: '@', // Username Delimiter
    sensitive : true,
    queryBy: ['name', 'username'],
    typeaheadOpts: { // Settings for Typeahead
        matcher: _matcher, // Mention.js's custom matcher function, don't change
        updater: _updater, // Mention.js's custom updater function, don't change
        sorter: _sorter, // Mention.js's custom sorter function, don't change
    }
});
 

License

(The MIT license)

Copyright (c) 2013 Jacob Kelley

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

More Repositories

1

Snap.js

A Library for creating beautiful mobile shelfs in Javascript (Facebook and Path style side menus)
JavaScript
5,990
star
2

Medium.js

A tiny JavaScript library for making contenteditable beautiful (Like Medium's editor)
JavaScript
4,388
star
3

himawari.js

Download real-time images of Earth from the Himawari-8 satellite
JavaScript
1,806
star
4

Behave.js

A lightweight, cross browser library for adding IDE style behaviors to plain text areas
JavaScript
1,741
star
5

Blur.js

blur.js is a jQuery plugin that produces psuedo-transparent blurred elements over other elements.
JavaScript
926
star
6

off-the-rip

Downloads audio, artwork, and metadata from Soundcloud
JavaScript
455
star
7

Ripple.js

Adds Material style ripple to anything
JavaScript
277
star
8

AppScroll.js

AppScroll is a tiny (< 100 lines) JS library that fixes the "website dragging" issue caused on iDevices
JavaScript
251
star
9

Context.js

Contextual Menus with Twitters Bootstrap.css
JavaScript
249
star
10

Youtube-TV

A small, slick, library independent YouTube User/Playlist player
JavaScript
203
star
11

Sparky.js

Sparky.js is an idea about client-side Javascript organization.
JavaScript
197
star
12

Submodal

Add submodals to Bootstrap 3.x modals
JavaScript
184
star
13

stability-ts

DreamStudio Client written in TypeScript
TypeScript
156
star
14

Bits

Bits Editor is your personal playground to develop in HTML, CSS, and Javascript, all from your own server.
JavaScript
87
star
15

Github-Mobile

GitHub Mobile
79
star
16

Ratchet-Vine

A Ratchet template that attempts to recreat the beautiful Vine app
JavaScript
59
star
17

Shadow

An internal analytics engine used to track meta data and user relations for objects in your application
PHP
55
star
18

Blur.js-II

Javascript library for blurring HTML content with CSS and SVG
JavaScript
50
star
19

Throttle

A PHP function that can be used to throttle any actions you want, as to prevent flooding.
PHP
30
star
20

WebFontGenerator

This is a class to generate CSS3 web fonts with Font Forge and PHP
PHP
25
star
21

iTunes-Colors

Recreates the color-effect used in iTunes
25
star
22

Scenario.js

A lightweight A/B Testing library for use with MixPanel
JavaScript
21
star
23

Slow.js

slow.js is a small script used to slow down CSS transition durations by a predefined factor on a key press event.
JavaScript
21
star
24

Repo-Downloader

A small PHP class to download repo zipballs from GitHub
PHP
20
star
25

Architect.js

A simple scaffold for your client side JavaScript.
JavaScript
17
star
26

Formula.js

Turn hyperlinks into ajax requests, making links as powerful as forms.
JavaScript
14
star
27

Gift.js

A Javascript library for wrapping your websites up as a present
JavaScript
10
star
28

Rap

A wicked simple comment system
JavaScript
8
star
29

ParseObject.js

Simple function to parse a string and compare it against an object.
JavaScript
8
star
30

Hatchet

Hatchet is a mobile client for Y Combinator Hacker News, and was built with Ratchet. Currently, it is tailored for iOS devices.
JavaScript
7
star
31

stfu

Tools and scripts used to broaden my reach online
CSS
5
star
32

Sparky.js-Website

This is the website for Sparky.js
PHP
4
star
33

Brazzed

Add the Brazzers logo to any image for intensity...
PHP
4
star
34

sams-calendar-program

My Grandfathers Calendar Program read from two floppy disks.
Batchfile
3
star
35

stemmy

An experimental Typescript wrapper for demucs
TypeScript
2
star
36

Thought.js

Create a beautiful message for someone you care about.
JavaScript
2
star
37

trill

A multi-resource html5 audio player
1
star
38

Not-Enough-Juans

We need more Juans
JavaScript
1
star