@yamada-ui/react/dist/types/components/rating/rating.d.ts

React UI components of the Yamada, by the Yamada, for the Yamada built with React and Emotion

import { ReactNodeOrFunction } from "../../utils/index.types.js";
import { FunctionOrValue, Merge } from "../../utils/index.js";
import { ThemeProps } from "../../core/system/index.types.js";
import { CSSProps } from "../../core/css/index.types.js";
import { Component, HTMLStyledProps } from "../../core/components/index.types.js";
import "../../core/index.js";
import { RatingStyle } from "./rating.style.js";
import { UseRatingItemProps, UseRatingProps } from "./use-rating.js";
import "../../index.js";

//#region src/components/rating/rating.d.ts
interface RatingProps extends Merge<Omit<HTMLStyledProps, "children" | "color">, UseRatingProps>, ThemeProps<RatingStyle> {
  /**
   * The color of the filled icons.
   */
  color?: FunctionOrValue<number, CSSProps["color"]>;
  /**
   * The empty icon for the rating.
   */
  emptyIcon?: ReactNodeOrFunction<number>;
  /**
   * The filled icon for the rating.
   */
  filledIcon?: ReactNodeOrFunction<number>;
  /**
   * Props for the rating group.
   */
  groupProps?: FunctionOrValue<number, RatingGroupProps>;
  /**
   * Props for the rating item.
   */
  iconProps?: FunctionOrValue<number, RatingIconProps>;
  /**
   * Props for the input element.
   */
  inputProps?: FunctionOrValue<number, HTMLStyledProps<"input">>;
  /**
   * Props for the rating item.
   */
  itemProps?: FunctionOrValue<number, RatingItemProps>;
}
/**
 * `Rating` is a component used to allow users to provide ratings.
 *
 * @see https://yamada-ui.com/docs/components/rating
 */
declare const Rating: Component<"div", RatingProps>;
interface RatingGroupProps extends HTMLStyledProps {
  value: number;
}
interface RatingItemProps extends HTMLStyledProps<"label">, UseRatingItemProps {}
interface RatingIconProps extends HTMLStyledProps {}
//#endregion
export { Rating, RatingProps };
//# sourceMappingURL=rating.d.ts.map