Never Pummel Muskoxen

    @types/react-star-rating-component
    TypeScript icon, indicating that this package has built-in type declarations

    1.4.1 • Public • Published

    Installation

    npm install --save @types/react-star-rating-component

    Summary

    This package contains type definitions for react-star-rating-component (https://github.com/voronianski/react-star-rating-component#readme).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-star-rating-component.

    index.d.ts

    // Type definitions for react-star-rating-component 1.4
    // Project: https://github.com/voronianski/react-star-rating-component#readme
    // Definitions by: Cody Sand <https://github.com/marpstar>
    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
    // TypeScript Version: 2.8
    
    import * as React from "react";
    
    interface StarRatingComponentProps {
      /** name of the radio input */
      name: string;
    
      /** the value of the star rating to display. i.e. the number of filled stars */
      value: number;
    
      /** number of icons in rating, default `5` */
      starCount?: number | undefined;
    
      onStarClick?: ((nextValue: number, prevValue: number, name: string) => void) | undefined;
    
      onStarHover?: ((nextValue: number, prevValue: number, name: string) => void) | undefined;
    
      onStarHoverOut?: ((nextValue: number, prevValue: number, name: string) => void) | undefined;
    
      /** render method for the full-star icon */
      renderStarIcon?: ((
        nextValue: number,
        prevValue: number,
        name: string
      ) => React.ReactNode | string) | undefined;
    
      /** render method for the half-star icon */
      renderStarIconHalf?: ((
        nextValue: number,
        prevValue: number,
        name: string
      ) => React.ReactNode | string) | undefined;
    
      /** color of selected icons */
      starColor?: string | undefined;
    
      /** color of non-selected icons */
      emptyStarColor?: string | undefined;
    
      /** is component available for editing, default `true` */
      editing?: boolean | undefined;
    }
    
    declare class StarRatingComponent extends React.Component<
      StarRatingComponentProps
    > {}
    
    export = StarRatingComponent;

    Additional Details

    • Last updated: Thu, 08 Jul 2021 22:41:35 GMT
    • Dependencies: @types/react
    • Global values: none

    Credits

    These definitions were written by Cody Sand.

    Keywords

    none

    Install

    npm i @types/react-star-rating-component

    DownloadsWeekly Downloads

    4,694

    Version

    1.4.1

    License

    MIT

    Unpacked Size

    6 kB

    Total Files

    4

    Last publish

    Collaborators

    • types