Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrRatingProps

Hierarchy

Hierarchy

  • IIgrRatingProps

Properties

Properties

Optional allowReset

allowReset?: string | boolean

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

Optional change

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

Type declaration

Optional children

children?: ReactNode

Optional className

className?: string

Optional defaultValue

defaultValue?: any

The initial value of the component.

Optional disabled

disabled?: string | boolean

The disabled state of the component

Optional hover

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

Type declaration

Optional hoverPreview

hoverPreview?: string | boolean

Sets hover preview behavior for the component

Optional id

id?: string

Optional invalid

invalid?: string | boolean

Control the validity of the control.

Optional label

label?: string

The label of the control.

Optional max

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.

Default

5

Optional name

name?: string

The name attribute of the control.

Optional readOnly

readOnly?: string | boolean

Makes the control a readonly field.

Optional single

single?: string | boolean

Toggles single selection visual mode.

Default

false

Optional step

step?: string | number

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

Default

1

Optional style

style?: CSSProperties

Optional value

value?: string | number

The current value of the component

Default

0

Optional valueFormat

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.