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

Reusable React components for building experiences for Office 365.

import * as React from 'react';
import { IStyle, ITheme } from '../../Styling';
import { IStyleFunction } from '../../Utilities';
export interface IRating {
}
/**
 * Rating component props.
 */
export interface IRatingProps extends React.AllHTMLAttributes<HTMLElement> {
    /**
     * Optional callback to access the IRating interface. Use this instead of ref for accessing
     * the public methods and properties of the component.
     */
    componentRef?: (component: IRating) => void;
    /**
     * 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 format for star ratings, will be read by screen readers, defaults to ''.
     * Can be used like "{0} of {1} stars selected".
     * Where {0} will be subsituted by the current rating and {1} will be subsituted by the max rating.
     */
    ariaLabelFormat?: string;
    /**
     * Deprecated: Optional id of label describing this instance of Rating. Instead of this use getArialabel
     * @deprecated
     */
    ariaLabelId?: string;
    /**
     * Optional flag to mark rating control as readOnly
     */
    readOnly?: boolean;
    getAriaLabel?: (rating: number, max: number) => string;
    /**
     * Call to provide customized styling that will layer on top of the variant rules.
     */
    getStyles?: IStyleFunction<IRatingStyleProps, IRatingStyles>;
    /**
     * Theme (provided through customization.)
     */
    theme?: ITheme;
}
export declare enum RatingSize {
    Small = 0,
    Large = 1,
}
export interface IRatingStyleProps {
    disabled?: boolean;
    theme: ITheme;
}
export interface IRatingStyles {
    ratingStar?: IStyle;
    ratingStarBack?: IStyle;
    ratingStarFront?: IStyle;
    ratingButton?: IStyle;
    rootIsSmall?: IStyle;
    rootIsLarge?: IStyle;
    labelText?: IStyle;
    ratingFocusZone?: IStyle;
}