PHPackages                             idno/mentionjs - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. idno/mentionjs

ActiveLibrary

idno/mentionjs
==============

Known adoption of mention.js abandonware

1.0.0(6y ago)29.0k↓33.3%1MITJavaScript

Since Nov 3Pushed 6y ago1 watchersCompare

[ Source](https://github.com/idno/mentionjs)[ Packagist](https://packagist.org/packages/idno/mentionjs)[ RSS](/packages/idno-mentionjs/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (1)

Mention.js
==========

[](#mentionjs)

[![](https://camo.githubusercontent.com/af27724b4574b397573ff2c348d64419c15a41787c0573edb190ee034b32124b/687474703a2f2f692e696d6775722e636f6d2f704376714c2e706e67)](https://camo.githubusercontent.com/af27724b4574b397573ff2c348d64419c15a41787c0573edb190ee034b32124b/687474703a2f2f692e696d6775722e636f6d2f704376714c2e706e67)

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](http://jakiestfu.github.com/Mention.js/).**

Dependencies
------------

[](#dependencies)

- [jQuery](https://github.com/jquery/jquery)
- [Typeahead](https://github.com/twitter/bootstrap)

Usage
-----

[](#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
-----------

[](#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:

[](#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
--------------------------------

[](#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
--------------

[](#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
--------

[](#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

[](#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.

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity26

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 95.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2388d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b819f4bdf7f1a836be6ca2c32d8f8aadd59fae9d00c32f2cba5341809e6c436e?d=identicon)[mapkyca](/maintainers/mapkyca)

---

Top Contributors

[![jakiestfu](https://avatars.githubusercontent.com/u/1041792?v=4)](https://github.com/jakiestfu "jakiestfu (40 commits)")[![kickandrew](https://avatars.githubusercontent.com/u/698517?v=4)](https://github.com/kickandrew "kickandrew (1 commits)")[![mapkyca](https://avatars.githubusercontent.com/u/124070?v=4)](https://github.com/mapkyca "mapkyca (1 commits)")

### Embed Badge

![Health badge](/badges/idno-mentionjs/health.svg)

```
[![Health](https://phpackages.com/badges/idno-mentionjs/health.svg)](https://phpackages.com/packages/idno-mentionjs)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)