office-ui-fabric-react/lib/components/Rating/Rating.Props.d.ts

Reusable React components for building experiences for Office 365.

import * as React from 'react';
/**
 * Rating component props.
 */
export interface IRatingProps extends React.HTMLProps<HTMLElement> {
    /**
     * Selected rating, has to be an integer between min and max
     */
    rating?: number;
    /**
     * Minimum rating, defaults to 1, has to be >= 0
     */
    min?: number;
    /**
     * Maximum rating, defaults to 5, has to be >= min
     */
    max?: number;
    /**
     * Custom icon, defaults to FavoriteStar
     */
    icon?: string;
    /**
     * Size of rating, defaults to small
     */
    size?: RatingSize;
    /**
     * Callback when the rating has changed
     */
    onChanged?: (rating: number) => void;
    /**
     * Optional label for star ratings, will be read by screen readers, defaults to 'Star'.
     */
    ariaLabelIcon?: string;
    /**
     * Optional id of label describing this instance of Rating
     */
    ariaLabelId?: string;
}
export declare enum RatingSize {
    Small = 0,
    Large = 1,
}