<commit_before>jquery-alphaindex
=================
https://github.com/idlesign/jquery-alphaindex

[![npm](https://img.shields.io/npm/v/jquery-alphaindex.svg)]() [![npm](https://img.shields.io/npm/dt/jquery-alphaindex.svg)]()

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.


Usage
-----

Make a list:

```html
    <ul id="my-list">
        <li><NAME></li>
        <li><NAME></li>
        <li><NAME></li>
    </ul>
```

Initialize an index:

```javascript
    var myIndex = $('#my-list').makeAlphaIndex(),
        indexBar = myIndex.alphaIndexBar;
```

Demo
----

* Demo page is available in sources: demo/demo.html.
* Hosted demo: https://idlesign.github.io/jquery-alphaindex/demo/demo.html


Styling
-------

* List is marked with ``.alpha-index-list``.
* Index bar is marked with ``.alpha-index-bar``.
* Index bar current item is marked with ``.current``.<commit_msg>Readme updated.<commit_after>jquery-alphaindex
=================
https://github.com/idlesign/jquery-alphaindex

[![npm](https://img.shields.io/npm/v/jquery-alphaindex.svg)]() [![npm](https://img.shields.io/npm/dt/jquery-alphaindex.svg)]()

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.


Usage
-----

1. Include ``jQuery``.

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

3. Make a list:

```html
    <ul id="my-list">
        <li><NAME></li>
        <li><NAME></li>
        <li><NAME></li>
    </ul>
```

4. Initialize an index:

```javascript
    var myIndex = $('#my-list').makeAlphaIndex(),
        indexBar = myIndex.alphaIndexBar;  // bar object, if you need it

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

Demo
----

* Demo page is available in sources: demo/demo.html.
* Hosted demo: https://idlesign.github.io/jquery-alphaindex/demo/demo.html


Styling
-------

* List is marked with ``.alpha-index-list``.
* Index bar is marked with ``.alpha-index-bar``.
* Index bar current item is marked with ``.current``.
{'fraction_non_alphanumeric': 0.19217830109335576, 'fraction_numerical': 0.001682085786375105, 'mean_word_length': 3.1663747810858145, 'pattern_counts': {'":': 0, '<': 25, '<?xml version=': 0, '>': 25, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3153514', 'n_tokens_mistral': 812, 'n_tokens_neox': 770, 'n_words': 193}