RHFRating

Ratings provide insight regarding others' opinions and experiences, and can allow the user to submit a rating of their own. RHFRating extends the Rating component, so it accepts almost all props of Rating and can be customized accordingly!

Usage

import RHFRating, { RHFRatingProps } from '@nish1896/rhf-mui-components/mui/rating';

<RHFRating
  fieldName="rating"
  control={control}
  errorMessage={errors?.rating?.message}
/>

Examples

• RHFRating
• Rating
• Complete Form

API

RHFRatingProps extends RatingProps and accepts the following additional props:

Name	Type	Required	Description
fieldName	string	✅	React Hook Form requires name as a key for the registration process. This is a required prop for all components.
control	UseFormControl	✅	The control option yielded on calling the useForm hook.
registerOptions	RegisterOptions		Register options for validation if using react-hook-form without any validation libraries like yup or Joi.
required	boolean		Indicates that the field is mandatory by adding an asterisk symbol (*) to the formLabel. This visual cue helps users quickly identify required fields in the form.
onValueChange	(newValue: number OR null, event) => void		An optional callback function that returns the changed value of rating component
label	ReactNode		The text to render in FormLabel component. By default, the value of fieldName such as firstName will be transformed to display "First Name".
showLabelAboveFormField	boolean		Renders the form label above the field by default. Set this prop to false to hide the label.
formLabelProps	FormLabelProps		FormLabelProps to customise FormLabel component for a field. Multiple fields can be configured using the ConfigProvider component.
helperText	ReactNode		The content to display within the FormHelperText component below the field. If the field validation fails, this content will be overridden by the corresponding error message.
errorMessage	ReactNode		Error message to be shown for a field in FormHelperText component.
hideErrorMessage	boolean		A flag to prevent replacement of helper text of a field by the error message when the validation is triggered.
formHelperTextProps	FormHelperTextProps		FormHelperTextProps to customise FormHelperText component for a field. Multiple fields can be configured using the ConfigProvider component.