react-emotion-face 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,48 @@
+# react-emotion-face
+
+Animated cartoon emotion face React component library. 
+A cute, highly-customizable SVG character face that displays various emotions with fluid animations!
+
+## Installation
+
+```bash
+npm i react-emotion-face
+```
+
+## Usage
+
+```tsx
+import React, { useState } from 'react';
+import { EmotionFace } from 'react-emotion-face';
+
+function App() {
+  const [emotion, setEmotion] = useState('Happy');
+
+  return (
+    <div>
+      <EmotionFace 
+        emotion={emotion} 
+        size={250} 
+        animated={true} 
+        message="Hello world!"
+      />
+      
+      <button onClick={() => setEmotion('Sad')}>Make Sad</button>
+      <button onClick={() => setEmotion('Excited')}>Make Excited</button>
+      <button onClick={() => setEmotion('Angry')}>Make Angry</button>
+    </div>
+  );
+}
+```
+
+## Props
+
+- `emotion` (string) - The emotion to display (e.g., 'Happy', 'Sad', 'Angry', 'Surprised', 'Love', 'Tired', etc.)
+- `message` (string) - Optional text to display in a speech bubble above the face.
+- `size` (number) - Width and height of the component (default: 200).
+- `animated` (boolean) - Whether to play the idle animations matching each emotion (default: true).
+- `color` (string) - Optional hex color code to override the default skin color for the face.
+- `onEmotionChange` (function) - Callback `(emotion: string) => void` fired when the emotion state is applied inside the component.
+
+## Emotion Types
+This library includes over 20 pre-configured emotions: Happy, Sad, Angry, Mad, Surprised, Calm, Sleepy, Excited, Tired, Confused, Embarrassed, Nervous, Proud, Disgusted, Bored, Love, Silly, Sick, Scared, Furious, Shocked. Provide any corresponding key to switch the face seamlessly!

package/dist/index.d.ts

@@ -1,19 +1,21 @@
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 
-export declare type Emotion = 'happy' | 'sad' | 'angry' | 'mad' | 'surprised' | 'calm' | 'sleepy' | 'excited' | 'tired' | 'confused' | 'embarrassed' | 'nervous' | 'proud' | 'disgusted' | 'bored' | 'love' | 'silly' | 'determined' | 'shy' | 'anxious';
+export declare type Emotion = 'happy' | 'sad' | 'angry' | 'mad' | 'surprised' | 'calm' | 'sleepy' | 'excited' | 'tired' | 'confused' | 'embarrassed' | 'nervous' | 'proud' | 'disgusted' | 'bored' | 'love' | 'silly' | 'determined' | 'shy' | 'anxious' | 'laughing';
 
-export declare function EmotionFace({ emotion, message, size, animated, showBody, color, onEmotionChange, }: EmotionFaceProps): JSX_2.Element;
+export declare function EmotionFace({ emotion, message, size, animated, color, onEmotionChange, }: EmotionFaceProps): JSX_2.Element;
 
 export declare interface EmotionFaceProps {
     emotion: Emotion;
     message?: string;
     size?: number;
     animated?: boolean;
-    showBody?: boolean;
     color?: string;
     onEmotionChange?: (emotion: Emotion) => void;
 }
 
 export declare const EMOTIONS: Emotion[];
 
+/** Returns all available emotion strings. */
+export declare function getEmotions(): Emotion[];
+
 export { }