# ng-alphabetic-filter

> A to Z Button Filter Directive

Latest version **1.0.3** (published 2021-05-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install ng-alphabetic-filter
pnpm add ng-alphabetic-filter
yarn add ng-alphabetic-filter
bun add ng-alphabetic-filter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-05-15 |
| First published | 2019-01-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 (+17 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Punit Soni |
| Maintainers | punityo |
| Keywords | filter, alphabetic filter, angular filter, a to z filter |

## Links

- npm: https://www.npmjs.com/package/ng-alphabetic-filter
- Repository: https://github.com/PunitSoniME/ng-alphabetic-filter
- Issues: https://github.com/PunitSoniME/ng-alphabetic-filter/issues
- npm.io page: https://npm.io/package/ng-alphabetic-filter

## Dependencies (2)

- [angular](https://npm.io/package/angular.md) ^1.7.5
- [bootstrap](https://npm.io/package/bootstrap.md) 3.3.7

## Recent versions

- 1.0.3 (latest) — 2021-05-15
- 1.0.2 — 2020-12-01
- 1.0.1 — 2019-01-02
- 1.0.0 — 2019-01-01

## README

# Angular Alphabetic Filter directive

Directive to use filter functionality using A-Z buttons

# How to install
    npm i ng-alphabetic-filter --save

# Path
    <script src="./node_modules/ng-alphabetic-filter/ng-alphabetic-filter.js" ></script>

# How to use
    js - angular.module("my-app", ['ng-alphabetic-filter']);
    html - <alphabetic-filter data="dataSource" property-to-filter="name"></alphabetic-filter>

# Dependencies
    angularjs > 1.x.x

# Required fields
    data
    property-to-filter ( property-to-filter is case sensitive )
    
# Other properties

| Property | Description / Value | Required |
| -------- | ----- | -------- |
| data | DataSource | Yes |
| property-to-filter | Property name of the object to do filter | Yes |
| bootstrap-button-color | 'btn btn-default' / 'btn btn-primary' / 'btn btn-success' / 'btn btn-warning', 'btn btn-info' / 'btn btn-danger' | No |
| bootstrap-button-size | 'btn-xs' / 'btn-sm' / 'btn-md' / 'btn-lg' / 'btn-xl' | No |
| clear-button-color | 'btn btn-danger' | No |

# Example
    <alphabetic-filter
        data="vm.dataSource"
        property-to-filter="name"
        bootstrap-button-color="btn btn-primary"
        bootstrap-button-size="btn-md"
        clear-button-color="btn btn-danger"
        >
    </alphabetic-filter>


# Check above example here
### https://punitsonime.github.io/ng-alphabetic-filter

# Note
- To use bootstrap-button-color, bootstrap-button-size, clear-button-color properties bootstrap is required.
- Currently working on only fields which have string value

# How to test this directive
 Install browser-sync globally to run local server
 
    - npm i browser-sync -g
    - Now run "npm start" command after installing ng-alphabetic-filter package.

---
_Source: https://npm.io/package/ng-alphabetic-filter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._