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

Props

io.github.nafg.scalajs.facades.mui.Select.Props
class Props extends WithChildren[VdomNode]

Attributes

Graph
Supertypes
trait WithChildren[VdomNode]
trait PropTypes
class Object
trait Matchable
class Any

Members list

Type members

Classlikes

object value extends Prop[String | Any]

The input value. Providing an empty string will select no options. Set to an empty string '' if you don't want any of the available options to be selected.

The input value. Providing an empty string will select no options. Set to an empty string '' if you don't want any of the available options to be selected.

If the value is an object it must have reference equality with the option in order to be selected. If the value is not an object, the string representation must match with the string representation of the option in order to be selected.

Attributes

Supertypes
class Prop[String | Any]
class Object
trait Matchable
class Any
Self type
value.type
object variant extends Prop[String]

The variant to use.

The variant to use.

Attributes

Supertypes
class Prop[String]
class Object
trait Matchable
class Any
Self type
variant.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 IconComponent: Prop[ElementType]

The icon that displays the arrow.

The icon that displays the arrow.

Attributes

def SelectDisplayProps: Prop[Object]

Props applied to the clickable div element.

Props applied to the clickable div element.

Attributes

def autoWidth: Prop[Boolean]

If true, the width of the popover will automatically be set according to the items inside the menu, otherwise it will be at least the width of the select input.

If true, the width of the popover will automatically be set according to the items inside the menu, otherwise it will be at least the width of the select input.

Attributes

def children: Prop[VdomNode]

The option elements to populate the select with. Can be some MenuItem when native is false and option when native is true.

The option elements to populate the select with. Can be some MenuItem when native is false and option when native is true.

⚠️The MenuItem elements must be direct descendants when native is false.

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

If true, the component is initially open. Use when the component open state is not controlled (i.e. the open prop is not defined). You can only use it when the native prop is false (default).

If true, the component is initially open. Use when the component open state is not controlled (i.e. the open prop is not defined). You can only use it when the native prop is false (default).

Attributes

def defaultValue: Prop[Any]

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

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

Attributes

def displayEmpty: Prop[Boolean]

If true, a value is displayed even if no items are selected.

If true, a value is displayed even if no items are selected.

In order to display a meaningful value, a function can be passed to the renderValue prop which returns the value to be displayed when no items are selected.

⚠️ When using this prop, make sure the label doesn't overlap with the empty displayed value. The label should either be hidden or forced to a shrunk state.

Attributes

def id: Prop[String]

The id of the wrapper element or the select element when native.

The id of the wrapper element or the select element when native.

Attributes

def input: Prop[VdomElement]

An Input element; does not have to be a material-ui specific Input.

An Input element; does not have to be a material-ui specific Input.

Attributes

def inputProps: Prop[Object]

Attributes applied to the input element. When native is true, the attributes are applied on the select element.

Attributes applied to the input element. When native is true, the attributes are applied on the select element.

Attributes

def label: Prop[VdomNode]

See OutlinedInput#label

See OutlinedInput#label

Attributes

def labelId: Prop[String]

The ID of an element that acts as an additional label. The Select will be labelled by the additional label and the selected value.

The ID of an element that acts as an additional label. The Select will be labelled by the additional label and the selected value.

Attributes

def multiple: Prop[Boolean]

If true, value must be an array and the menu will support multiple selections.

If true, value must be an array and the menu will support multiple selections.

Attributes

def native: Prop[Boolean]

If true, the component uses a native select element.

If true, the component uses a native select element.

Attributes

def onChange: Prop[Any => Any]

Callback fired when a menu item is selected.

Callback fired when a menu item is selected.

Value parameters

{SelectChangeEvent<Value>}

event The event source of the callback. You can pull out the new value by accessing event.target.value (any). Warning: This is a generic event, not a change event, unless the change event is caused by browser autofill.

{object}

[child] The react element that was selected when native is false (default).

Attributes

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

Callback fired when the component requests to be closed. Use it in either controlled (see the open prop), or uncontrolled mode (to detect when the Select collapses).

Callback fired when the component requests to be closed. Use it in either controlled (see the open prop), or uncontrolled mode (to detect when the Select collapses).

Value parameters

{object}

event The event source of the callback.

Attributes

def onOpen: Prop[Any => Any]

Callback fired when the component requests to be opened. Use it in either controlled (see the open prop), or uncontrolled mode (to detect when the Select expands).

Callback fired when the component requests to be opened. Use it in either controlled (see the open prop), or uncontrolled mode (to detect when the Select expands).

Value parameters

{object}

event The event source of the callback.

Attributes

def open: Prop[Boolean]

If true, the component is shown. You can only use it when the native prop is false (default).

If true, the component is shown. You can only use it when the native prop is false (default).

Attributes

def renderValue: Prop[Any => VdomNode]

Render the selected value. You can only use it when the native prop is false (default).

Render the selected value. You can only use it when the native prop is false (default).

Value parameters

{any}

value The value provided to the component.

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

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