Add type definitions

Author: Alex Casillas

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-loading-dots",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "A React Native loading component with dots or custom components and smooth animation",
   "repository": {
     "type": "git",
@@ -9,6 +9,7 @@
   "author": "Alex Casillas",
   "license": "MIT",
   "main": "src/react-native-loading-dots.js",
+  "types": "src/react-native-loading-dots.d.ts",
   "peerDependencies": {
     "react": "^18.2.0",
     "react-native": "^0.73.4"

src/react-native-loading-dots.d.ts

@@ -0,0 +1,18 @@
+export interface LoadingDotsProps {
+  /** Number of dots to display */
+  dots?: number;
+  /** Array of color strings for the dots */
+  colors?: string[];
+  /** Size of each dot */
+  size?: number;
+  /** Height of the bounce animation for the dots */
+  bounceHeight?: number;
+  /** Border radius of the dots */
+  borderRadius?: number;
+  /** Custom components to use instead of default dots */
+  components?: React.ReactNode[];
+}
+
+declare const LoadingDots: (props: LoadingDotsProps) => JSX.Element;
+
+export default LoadingDots;

src/react-native-loading-dots.js

@@ -3,6 +3,17 @@ import { StyleSheet, Animated, Easing } from "react-native";
 
 const defaultColors = ["#4dabf7", "#3bc9db", "#38d9a9", "#69db7c"];
 
+/**
+ * React Component that creates a smooth loading animation with dots
+ * or custom components
+ * @param {number} dots
+ * @param {string[]} colors
+ * @param {number} size
+ * @param {number} bounceHeight
+ * @param {number} borderRadius
+ * @param {React.ReactNode[]} components
+ * @returns React.JSX.Element
+ */
 function LoadingDots({
   dots = 4,
   colors = defaultColors,