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

Props

io.github.nafg.scalajs.facades.mui.TextField.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 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 margin extends Prop[String]

If dense or normal, will adjust vertical spacing of this and contained components.

If dense or normal, will adjust vertical spacing of this and contained components.

Attributes

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

Props applied to the FormHelperText element.

Props applied to the FormHelperText element.

Attributes

def InputLabelProps: Prop[Object]

Props applied to the InputLabel element. Pointer events like onClick are enabled if and only if shrink is true.

Props applied to the InputLabel element. Pointer events like onClick are enabled if and only if shrink is true.

Attributes

def InputProps: Prop[Object]

Props applied to the Input element. It will be a FilledInput, OutlinedInput or Input component depending on the variant prop value.

Props applied to the Input element. It will be a FilledInput, OutlinedInput or Input component depending on the variant prop value.

Attributes

def SelectProps: Prop[Object]

Props applied to the Select element.

Props applied to the Select element.

Attributes

def `type`: Prop[String]

Type of the input element. It should be a valid HTML5 input type.

Type of the input element. It should be a valid HTML5 input type.

Attributes

def autoComplete: Prop[String]

This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.

This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.

Attributes

def autoFocus: Prop[Boolean]

If true, the input element is focused during the first mount.

If true, the input element is focused during the first mount.

Attributes

def children: Prop[VdomNode]
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[Any]

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

If true, the label is displayed in an error state.

If true, the label is displayed in an error state.

Attributes

def fullWidth: Prop[Boolean]

If true, the input will take up the full width of its container.

If true, the input will take up the full width of its container.

Attributes

def helperText: Prop[VdomNode]

The helper text content.

The helper text content.

Attributes

def id: Prop[String]

The id of the input element. Use this prop to make label and helperText accessible for screen readers.

The id of the input element. Use this prop to make label and helperText accessible for screen readers.

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 label: Prop[VdomNode]

The label content.

The label content.

Attributes

def maxRows: Prop[Double | String]

Maximum number of rows to display when multiline option is set to true.

Maximum number of rows to display when multiline option is set to true.

Attributes

def minRows: Prop[Double | String]

Minimum number of rows to display when multiline option is set to true.

Minimum number of rows to display when multiline option is set to true.

Attributes

def multiline: Prop[Boolean]

If true, a textarea element is rendered instead of an input.

If true, a textarea element is rendered instead of an input.

Attributes

def name: Prop[String]

Name attribute of the input element.

Name attribute of the input element.

Attributes

def onChange: Prop[ReactEventFromInput => Callback]

Callback fired when the value is changed.

Callback fired when the value is changed.

Value parameters

{object}

event The event source of the callback. You can pull out the new value by accessing event.target.value (string).

Attributes

def onClick: Prop[ReactMouseEventFromHtml => Callback]
def placeholder: Prop[String]

The short hint displayed in the input before the user enters a value.

The short hint displayed in the input before the user enters a value.

Attributes

def required: Prop[Boolean]

If true, the label is displayed as required and the input element is required.

If true, the label is displayed as required and the input element is required.

Attributes

def rows: Prop[Double | String]

Number of rows to display when multiline option is set to true.

Number of rows to display when multiline option is set to true.

Attributes

def select: Prop[Boolean]

Render a Select element while passing the Input element to Select as input parameter. If this option is set you must pass the options of the select as children.

Render a Select element while passing the Input element to Select as input parameter. If this option is set you must pass the options of the select as children.

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 input element, required for a controlled component.

The value of the input element, required for a controlled component.

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