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';

<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.
control	UseFormControl	✅	The control option yielded on calling the useForm hook.
onValueChange	(e: SyntheticEvent, newValue: number OR null) => 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		Render form label above the form field in FormLabel component.
formLabelProps	FormLabelProps		FormLabelProps to customise FormLabel component for a field. Multiple fields can be configured using the ConfigProvider component.
helperText	ReactNode		Optional helperText to render under RHFSelect or RHFNativeSelect field.
errorMessage	ReactNode		Error message to be shown for a field in FormHelperText component.
hideErrorMessage	boolean		Prevent replacing of form HelperText by error message during validation trigger.
formHelperTextProps	FormHelperTextProps		FormHelperTextProps to customise FormHelperText component for a field. Multiple fields can be configured using the ConfigProvider component.