mui/material_5
API
Generated with
mui/material_5/io.github.nafg.scalajs.facades.mui/Rating/Props

Props

io.github.nafg.scalajs.facades.mui.Rating.Props
class Props extends PropTypes

Attributes

Graph
Supertypes
trait PropTypes
class Object
trait Matchable
class Any

Members list

Type members

Classlikes

object size extends Prop[String]

The size of the component.

The size of the component.

Attributes

Supertypes
class Prop[String]
class Object
trait Matchable
class Any
Self type
size.type

Inherited classlikes

object dyn extends Dynamic

Attributes

Inherited from:
PropTypes
Supertypes
trait Dynamic
class Object
trait Matchable
class Any

Value members

Concrete methods

def IconContainerComponent: Prop[ElementType]

The component containing the icon.

The component containing the icon.

Attributes

def classes: Prop[Object]

Override or extend the styles applied to the component.

Override or extend the styles applied to the component.

Attributes

def defaultValue: Prop[Double]

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

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

Attributes

def disabled: Prop[Boolean]

If true, the component is disabled.

If true, the component is disabled.

Attributes

def emptyIcon: Prop[VdomNode]

The icon to display when empty.

The icon to display when empty.

Attributes

def emptyLabelText: Prop[VdomNode]

The label read when the rating input is empty.

The label read when the rating input is empty.

Attributes

def getLabelText: Prop[Any => Any]

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.

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.

For localization purposes, you can use the provided translations.

Value parameters

{number}

value The rating label's value to format.

Attributes

def highlightSelectedOnly: Prop[Boolean]

If true, only the selected icon will be highlighted.

If true, only the selected icon will be highlighted.

Attributes

def icon: Prop[VdomNode]

The icon to display.

The icon to display.

Attributes

def max: Prop[Double]

Maximum rating.

Maximum rating.

Attributes

def name: Prop[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 generated IDs.

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 generated IDs.

Attributes

def onChange: Prop[Any => Any]

Callback fired when the value changes.

Callback fired when the value changes.

Value parameters

{React.SyntheticEvent}

event The event source of the callback.

{number|null}

value The new value.

Attributes

def onChangeActive: Prop[Any => Any]

Callback function that is fired when the hover state changes.

Callback function that is fired when the hover state changes.

Value parameters

{React.SyntheticEvent}

event The event source of the callback.

{number}

value The new value.

Attributes

def onClick: Prop[ReactMouseEventFromHtml => Callback]
def precision: Prop[Any]

The minimum increment value change allowed.

The minimum increment value change allowed.

Attributes

def readOnly: Prop[Boolean]

Removes all hover effects and pointer events.

Removes all hover effects and pointer events.

Attributes

def style: Prop[Object]
def sx: Prop[Seq[Any => Any | Object | Boolean] | Any => Any | Object]

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

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

Attributes

def value: Prop[Double]

The rating value.

The rating value.

Attributes

Inherited methods

def of[A : Writer](implicit evidence$1: Writer[A], name: Name): Prop[A]

Attributes

Inherited from:
PropTypes

Inherited fields

val key: Prop[Key]

Attributes

Inherited from:
PropTypes
Generated with