new-react-stars/dist/index.d.ts

Simple star rating component for your React projects

import React from 'react';

/** ReactStars component */
interface ReactStarsProps {
    /** Class name */
    className?: string;
    /** Editable
     * @default true
     */
    edit?: boolean;
    /** Half
     * @default true
     */
    half?: boolean;
    /** Value
     * @default 0
     */
    value?: number;
    /** Count
     * @default 5
     */
    count?: number;
    /** Character
     * @default "★"
     */
    char?: string;
    /** Size
     * @default 15
     */
    size?: number;
    /** Color 1
     * @default "gray"
     */
    color1?: string;
    /** Color 2
     * @default "#ffd700
     */
    color2?: string;
    /** On change event */
    onChange?: (value: number) => void;
}
declare const ReactStars: React.FC<ReactStarsProps>;

export { ReactStars, type ReactStarsProps };