# beating-heart-icon

> A flat beating heart icon

Latest version **1.1.3** (published 2023-04-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install beating-heart-icon
pnpm add beating-heart-icon
yarn add beating-heart-icon
bun add beating-heart-icon
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2023-04-09 |
| First published | 2023-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | thaddg |
| Maintainers | thaddg |

## Links

- npm: https://www.npmjs.com/package/beating-heart-icon
- Repository: https://github.com/ThaddG/beating-heart-icon
- Homepage: https://github.com/ThaddG/beating-heart-icon#readme
- Issues: https://github.com/ThaddG/beating-heart-icon/issues
- npm.io page: https://npm.io/package/beating-heart-icon

## Recent versions

- 1.1.3 (latest) — 2023-04-09
- 1.1.2 — 2023-04-04
- 1.1.1 — 2023-04-04
- 1.1.0 — 2023-04-04

## README

# Beating Heart Icon

A customizable React component that displays a beating heart icon. The component allows you to change the size, color, fill style, and animation speed.

## Installation

npm\
```npm install beating-heart-icon```\
or using yarn\
```yarn add beating-heart-icon```

## Usage

```tsx
import React from 'react';
import BeatingHeartIcon from 'beating-heart-icon';

const App: React.FC = () => {
  return (
    <div>
      <BeatingHeartIcon size={50} color="red" filled animationSpeed={500} />
      <BeatingHeartIcon size={75} color="blue" animationSpeed={1000} />
      <BeatingHeartIcon size={100} color="green" filled animationSpeed={1500} />
    </div>
  );
};

export default App;
```

## Props

| Prop           | Type    | Default | Description                                                  |
| -------------- | ------- | ------- | ------------------------------------------------------------ |
| size           | number  | 50      | The width and height of the icon in pixels.                  |
| color          | string  | 'red'   | The color of the heart icon.                                 |
| filled         | boolean | false   | Whether the heart icon should be filled or outlined.         |
| animationSpeed | number  | 500     | The speed of the beating animation in milliseconds (between 150 and 1000). |


## License

MIT

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