kotlin-mui-material/mui.material/RatingOwnProps

RatingOwnProps

external interface RatingOwnProps : RatingSlotsAndSlotProps, PropsWithSx(source)

Inheritors

Properties

abstract var classes: RatingClasses?

Override or extend the styles applied to the component.

abstract var defaultValue: Any?

The default value. Use when the component is not controlled.

abstract var disabled: Boolean?

If true, the component is disabled.

abstract var emptyIcon: ReactNode?

The icon to display when empty.

abstract var emptyLabelText: ReactNode?

The label read when the rating input is empty.

abstract var getLabelText: (value: Number) -> String?

Accepts a function which returns a string value that provides a user-friendly name for the current value of the rating. This is important for screen reader users.

highlightSelectedOnly

abstract var highlightSelectedOnly: Boolean?

If true, only the selected icon will be highlighted.

abstract var icon: ReactNode?

The icon to display.

IconContainerComponent

abstract var IconContainerComponent: ElementType<IconContainerProps>?

The component containing the icon.

abstract var key: Key?

abstract var max: Number?

Maximum rating.

abstract var name: String?

The name attribute of the radio input elements. This input name should be unique within the page. Being unique within a form is insufficient since the name is used to generate IDs.

abstract var onChange: (event: SyntheticEvent<*, *>, value: Number?) -> Unit?

Callback fired when the value changes.

abstract var onChangeActive: (event: SyntheticEvent<*, *>, value: Number) -> Unit?

Callback function that is fired when the hover state changes.

abstract var precision: Number?

The minimum increment value change allowed.

abstract var readOnly: Boolean?

Removes all hover effects and pointer events.

abstract var size: Size?

The size of the component.

abstract var slotProps: RatingSlotProps?

abstract var slots: RatingSlots?

abstract override var sx: SxProps<Theme>?

The system prop that allows defining system overrides as well as additional CSS styles.

abstract var value: Number?

The rating value.

Functions

open inline operator fun Props?.unaryPlus()