Interface IIgrRatingProps

Hierarchy

Hierarchy

  • IIgrRatingProps

Properties

allowReset?: string | boolean

Whether to reset the rating when the user selects the same value.

change?: ((s, e) => void)

Type declaration

children?: ReactNode
className?: string
disabled?: string | boolean

The disabled state of the component

hover?: ((s, e) => void)

Type declaration

hoverPreview?: string | boolean

Sets hover preview behavior for the component

id?: string
invalid?: string | boolean

Control the validity of the control.

label?: string

The label of the control.

max?: string | number

The maximum value for the rating. If there are projected symbols, the maximum value will be resolved based on the number of symbols.

name?: string

The name attribute of the control.

readOnly?: string | boolean

Makes the control a readonly field.

single?: string | boolean

Toggles single selection visual mode.

step?: string | number

The minimum value change allowed. Valid values are in the interval between 0 and 1 inclusive.

style?: CSSProperties
value?: string | number

The current value of the component

valueFormat?: string

A format string which sets aria-valuetext. Instances of '{0}' will be replaced with the current value of the control and instances of '{1}' with the maximum value for the control. Important for screen-readers and useful for localization.