@veracity/vui/dist/rating/rating.types.d.ts

Veracity UI is a React component library crafted for use within Veracity applications and pages. Based on Styled Components and @xstyled.

import { ThemingProps } from "../theme/types.js";
import "../theme/index.js";
import { SystemProps } from "../system/system.js";
import "../system/index.js";
//#region src/rating/rating.types.d.ts
type RatingProps = SystemProps & ThemingProps<'Rating'> & {
  /** The current rating value. */
  value: number;
  /** The maximum rating value. @default 5 */
  max?: number;
  /** Whether to display all stars up to the maximum value. @default true */
  showAll?: boolean;
  /** The color variant of the rating component. @default yellow */
  variant?: 'yellow' | 'blue';
  /** The size of the rating component. @default md */
  size?: 'sm' | 'md' | 'lg';
  /** Callback function that is called when the rating value changes. */
  onChange?: (value: number) => void;
  /** Whether the rating component is disabled. @default false */
  isDisabled?: boolean;
};
//#endregion
export { RatingProps };

//# sourceMappingURL=rating.types.d.ts.map