react-animated-waves 1.0.2 → 1.0.4

package/LICENSE

@@ -1,21 +1,18 @@
 MIT License
 
-Copyright (c) 2024 - PRESENT Rohit Agrawal
+Copyright (c) 2025 Rohit Agrawal
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 
+associated documentation files (the "Software"), to deal in the Software without restriction, including 
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the 
+following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial 
+portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO 
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE 
+USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,49 +1,42 @@
 <div align="center">
-<h2>React Animated Waves</h2>
-<p align="center" style="width: 80%; margin: auto">
-<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/agrawal-rohit/react-animated-waves/Publish.yml">
-<img alt="Codacy coverage" src="https://img.shields.io/codacy/coverage/09220ab3d193472ba76d1ad50f11ee51">
-<img alt="npm" src="https://img.shields.io/npm/dw/react-animated-waves">
-<img alt="Licence" src="https://img.shields.io/github/license/agrawal-rohit/react-animated-waves">
-</p>
-<sup align="center" style="width: 80%; margin: auto; font-size: 0.1rem !important;">
-(Planning to create your own NPM library? Check out my <a href="https://github.com/agrawal-rohit/npm-library-template">NPM library template</a> to kickstart your library development with best practices)
-</sup>
+  <h2>React Animated Waves</h2>
 </div>
 
-<br /><br />
+<div align="center">
+  <p align="center" style="width: 80%; margin: auto">
+    <a href="https://github.com/agrawal-rohit/grimoire"><img alt="Made with Grimoire" src="https://img.shields.io/badge/made_with-grimoire-7452A3"></a>
+    <img alt="Status" src="https://img.shields.io/github/actions/workflow/status/agrawal-rohit/react-animated-waves/ci.yml">
+    <img alt="Sonar Coverage" src="https://img.shields.io/sonar/coverage/agrawal-rohit_react-animated-waves?server=https%3A%2F%2Fsonarcloud.io">
+    <img alt="Downloads" src="https://img.shields.io/npm/dt/react-animated-waves">
+    <img alt="NPM bundle size" src="https://img.shields.io/bundlephobia/min/react-animated-waves">
+    <img alt="License" src="https://img.shields.io/github/license/agrawal-rohit/react-animated-waves" />
+  </p>
 
-![Aug-24-2024 22-55-33](https://github.com/user-attachments/assets/348b84bf-d2f8-406b-a162-e0a480c9e273)
+[Installation](#installation) • [Demo](#demo) • [Usage](#usage) • [Contributing](#contributing) • [License](#license)
 
-A lightweight and customizable React component that creates stunning animated wave effects. Perfect for enhancing audio visualizations, adding dynamic loading states, or creating eye-catching UI elements in your React apps.
+<img src="https://cdn.rohit.build/oss/react-animated-waves/github-readme-preview.gif" alt="Preview" style="width: 80%; margin: auto" />
 
-## Table of Contents
+</div>
 
-1. [Installation](#installation)
-2. [Usage](#usage)
-3. [Props](#props)
-4. [Contributing](#contributing)
-5. [License](#license)
+<br />
 
-## Installation
+`react-animated-waves` is an opinionated canvas-based React component for displaying wave animations. The colors and strength of the wave animations can be customized to support dynamic UIs such as audio visualizations, voice UIs, progress loaders, etc.
 
-**React Animated Waves** can be installed using either npm or yarn:
+## Installation
 
-**Using npm:**
+`react-animated-waves` can be installed using [npm](https://www.npmjs.com/) (or your favorite package manager):
 
 ```bash
-npm install --save react-animated-waves
+$ npm install react-animated-waves
 ```
 
-**Using yarn:**
+## Demo
 
-```bash
-yarn add react-animated-waves
-```
+Check out an interactive demo [here](https://codesandbox.io/p/sandbox/react-animated-waves-example-6z9hlh).
 
 ## Usage
 
-Import the `Waves` component from the library and use it in your React app. Check out an interactive demo [here](https://codesandbox.io/p/sandbox/react-animated-waves-example-6z9hlh).
+Import the `Waves` component from `react-animated-waves` and use it in your React app as follows:
 
 ```jsx
 import Waves from "react-animated-waves";
@@ -51,19 +44,19 @@ import Waves from "react-animated-waves";
 <Waves amplitude={20} colors={["#FF6AC6", "#436EDB", "#FF6AC6"]} />;
 ```
 
-## Props
+### Props
 
 The `Waves` component accepts the following props:
 
 | Prop        | Description                                                                 | Default       |
 | ----------- | --------------------------------------------------------------------------- | ------------- |
-| `amplitude` | Defines the height of the waveform. Higher values result in taller waves.   | `20`          |
-| `colors`    | An array of colors used to create a linear gradient effect on the waveform. | `['#436EDB']` |
+| `amplitude` | Defines the strength of the waveform. Higher values result in taller waves.   | `20`          |
+| `colors`    | An array of hex colors used to create a linear gradient effect on the waveform. | `['#436EDB']` |
 
 ## Contributing
 
-All contributions from the community are welcome. Please read the [contributing guide](CONTRIBUTING.md) for more information.
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to report issues, propose changes, and submit pull requests.
 
 ## License
 
-[MIT License](LICENSE).
+[MIT](LICENSE) © [Rohit Agrawal](https://github.com/agrawal-rohit)

package/dist/index.d.ts

@@ -1,10 +1,12 @@
-import React from "react";
+import * as react0 from "react";
+
+//#region src/waves.d.ts
 type WavesProps = React.DetailedHTMLProps<React.CanvasHTMLAttributes<HTMLCanvasElement>, HTMLCanvasElement> & {
-    /** The colors for the waveform */
-    colors?: string[];
-    /** The amplitude of the waveform */
-    amplitude?: number;
+  /** The colors for the waveform */
+  colors?: string[];
+  /** The amplitude of the waveform */
+  amplitude?: number;
 };
-declare const _default: React.NamedExoticComponent<WavesProps>;
-export default _default;
-//# sourceMappingURL=index.d.ts.map
+declare const Waves: react0.NamedExoticComponent<WavesProps>;
+//#endregion
+export { Waves };