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

Props

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

Attributes

Graph
Supertypes
trait PropTypes
class Object
trait Matchable
class Any

Members list

Type members

Classlikes

object color extends Prop[String]

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Attributes

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

The size of the component. small is equivalent to the dense checkbox styling.

The size of the component. small is equivalent to the dense checkbox styling.

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 checked: Prop[Boolean]

If true, the component is checked.

If true, the component is checked.

Attributes

def checkedIcon: Prop[VdomNode]

The icon to display when the component is checked.

The icon to display when the component is checked.

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 defaultChecked: Prop[Boolean]

The default checked state. Use when the component is not controlled.

The default checked state. Use when the component is not controlled.

Attributes

def disableRipple: Prop[Boolean]

If true, the ripple effect is disabled.

If true, the ripple effect is disabled.

Attributes

def disabled: Prop[Boolean]

If true, the component is disabled.

If true, the component is disabled.

Attributes

def icon: Prop[VdomNode]

The icon to display when the component is unchecked.

The icon to display when the component is unchecked.

Attributes

def id: Prop[String]

The id of the input element.

The id of the input element.

Attributes

def indeterminate: Prop[Boolean]

If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.

If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.

Attributes

def indeterminateIcon: Prop[VdomNode]

The icon to display when the component is indeterminate.

The icon to display when the component is indeterminate.

Attributes

def inputProps: Prop[Object]

Attributes applied to the input element.

Attributes applied to the input element.

Attributes

def inputRef: Prop[Any]

Pass a ref to the input element.

Pass a ref to the input element.

Attributes

def onChange: Prop[Any => Any]

Callback fired when the state is changed.

Callback fired when the state is changed.

Value parameters

{React.ChangeEvent<HTMLInputElement>}

event The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).

Attributes

def onClick: Prop[ReactMouseEventFromHtml => Callback]
def required: Prop[Boolean]

If true, the input element is required.

If true, the input element is required.

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[Any]

The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.

The value of the component. The DOM API casts this to a string. The browser uses "on" as the default 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