animated-fluent-emojis/dist/utils/types.d.ts

Animated Fluent Emojis is a React component library that brings Microsoft's Fluent emojis to life in your web applications. This library offers an easy way to integrate expressive and engaging animated emojis, enhancing user experience and visual appeal i

/**
 * Represents the animation properties of an emoji.
 * @interface
 */
export interface Animation {
    /** The frames per second of the animation. */
    fps: number;
    /** The total number of frames in the animation. */
    framesCount: number;
    /** The index of the first frame in the animation. */
    firstFrame: number;
}
/**
 * Represents an individual emoticon.
 * @interface
 */
export interface Emoticon {
    /** Unique identifier for the emoticon. */
    id: string;
    /** Human-readable description of the emoticon. */
    description: string;
    /** Array of shortcut strings to represent this emoticon. */
    shortcuts: string[];
    /** Unicode representation of the emoticon. */
    unicode: string;
    /** Entity tag for caching purposes. */
    etag: string;
    /** Whether this emoticon has diverse (skin tone) variants. */
    diverse: boolean;
    /** Animation properties for this emoticon. */
    animation: Animation;
    /** Array of keywords associated with this emoticon. */
    keywords: string[];
}
/**
 * Represents a category of emoticons.
 * @interface
 */
export interface Category {
    /** Unique identifier for the category. */
    id: string;
    /** The display title of the category. */
    title: string;
    /** A brief description of the category. */
    description: string;
    /** An array of Emoticon objects in this category. */
    emoticons: Emoticon[];
}
/**
 * Represents the entire manifest structure.
 * @interface
 */
export interface Manifest {
    /** An array of Category objects representing all emoji categories. */
    categories: Category[];
}
/**
 * Extends the Emoticon interface with category information.
 * @interface
 */
export interface EmojiManifest extends Emoticon {
    /** The category to which this emoji belongs. */
    category: string;
}
/**
 * Represents the properties for the Emoji component.
 * @interface
 */
export interface EmojiProps {
    /** The unique identifier of the emoji. */
    id: string;
    /** The size of the emoji in pixels. Default is 100. */
    size?: number;
    /** Whether to play the animation on hover. Default is false. */
    playOnHover?: boolean;
    /** The number of times to play the animation, or 'infinite'. Default is 2. */
    animationIterations?: number | 'infinite';
    /** Whether to automatically play the animation on mount. Default is true. */
    autoPlay?: boolean;
}
//# sourceMappingURL=types.d.ts.map