# number-counter

> Number Counter is package for count number upward and downward.

Latest version **1.0.3** (published 2019-04-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install number-counter
pnpm add number-counter
yarn add number-counter
bun add number-counter
```

## 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 | 2019-04-02 |
| First published | 2019-04-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 169.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Akash Chavda |
| Maintainers | akash_chavda |
| Keywords | counter, npm, number-counter, react, up-counter, down-counter, upward, downward |

## Links

- npm: https://www.npmjs.com/package/number-counter
- Repository: https://github.com/skychavda/number-counter-npm
- Homepage: https://github.com/skychavda/number-counter-npm#readme
- Issues: https://github.com/skychavda/number-counter-npm/issues
- npm.io page: https://npm.io/package/number-counter

## Dependencies (3)

- [react](https://npm.io/package/react.md) >=15.6.0
- [webpack](https://npm.io/package/webpack.md) ^4.12.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2019-04-02
- 1.0.2 — 2019-04-02
- 1.0.1 — 2019-04-02

## README

# Number Counter

> This will help you make counter and it will compatible with all browser.
> It has flexibility to count upward as well as downward.


## Installation
```
npm install number-counter 
```

## Usage
```
import NumberCounter from 'number-counter';
```

### Demo example 
```
<NumberCounter end={100} delay={4}/>
```

This will start a counter and transition from `0` to `100` on render.

### Render prop example
```
// import number counter
import NumberCounter from 'number-counter';

class App extends Component {
  render() {
    return (
      <div className="App">
        <header className="App-header">
        
          // number counter for upward count.
          <NumberCounter end={100} delay={5} className="increment" preFix="Up revenue:" postFix="$"/>
          
          // number counter for downward count.
          <NumberCounter start={100} delay={5} className="increment" preFix="Down revenue:" postFix="$" reverse={true}/>
          
        </header>
      </div>
    );
  }
}

export default App;
``` 

![demo-counter](./counter-demo.gif)

[View Demo](https://github.com/skychavda/number-counter-npm)

## API

### Props

Name | Type | Description | Default
:--- | :--- | :--- | :---
start | number | Starting value of counter.| `start={0}`
end | number | Ending value of counter. | `end={10}`
className | string | CSS class name of element. | `null`
delay | number | Duration in second. | `2s`
preFix | string | Append text before counter value. | `null`
postFix | string | Append text after counter value. | `null`
reverse | boolean | Count downward. | `false`

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