ja

jquery-alphaindex

jQuery plugin to create alphabetical indexes for your lists

Showing:

Popularity

Downloads/wk

0

GitHub Stars

12

Maintenance

Last Commit

5yrs ago

Contributors

0

Package

Dependencies

1

Size (min+gzip)

0.8KB

License

BSD-3-Clause

Type Definitions

Tree-Shakeable

No?

Categories

Readme

jquery-alphaindex

https://github.com/idlesign/jquery-alphaindex

npm

Description

jQuery plugin to create alphabetical indexes for your lists.

An alphabetical index may help your users to navigate through a long list of items.

Demo

Usage

  1. Include jQuery.

  2. Include jquery.alphaindex.js or jquery.alphaindex.min.js.

  3. Make a list:

    <ul id="my-list">
        <li>Joker James</li>
        <li>Anderson Ann</li>
        <li>Johnson John</li>
    </ul>
  1. Initialize an index:
    var myIndex = $('#my-list').makeAlphaIndex(),
        $indexBar = myIndex.alphaIndexBar;  // bar object, if you need it

    myIndex.alphaIndexToggle('a');  // toggle A indexed
    myIndex.alphaIndexToggle(true);  // show all
    myIndex.alphaIndexToggle(false);  // hide all
    myIndex.alphaIndexToggle();  // toggle all

Options

  • showItemsCount - Show number of items over each letter in index bar. Default: true.
  • activateFirstIndex - Show list item belonging to the first letter in index bar after load. Default: true.

Styling

  • List is marked with .alpha-index-list.
  • Index bar is marked with .alpha-index-bar.
  • Index bar current item is marked with .current.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100