Props

io.github.nafg.scalajs.facades.mui.FilledInput.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 prop defaults to the value ('primary') inherited from the parent FormControl component.

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 prop defaults to the value ('primary') inherited from the parent FormControl component.

Attributes

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

If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.

If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.

Attributes

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

Override or extend the styles applied to the component.

Override or extend the styles applied to the component.

Attributes

def components: Prop[Object]

The components used for each slot inside.

The components used for each slot inside.

This prop is an alias for the slots prop. It's recommended to use the slots prop instead.

Attributes

def componentsProps: Prop[Object]

The extra props for the slot components. You can override the existing props or add new ones.

The extra props for the slot components. You can override the existing props or add new ones.

This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.

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

If true, the input will not have an underline.

If true, the input will not have an underline.

Attributes

def disabled: Prop[Boolean]

If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.

If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.

Attributes

def endAdornment: Prop[VdomNode]

End InputAdornment for this component.

End InputAdornment for this component.

Attributes

def error: Prop[Boolean]

If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.

If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.

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

If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element.

If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element.

Attributes

def id: Prop[String]

The id of the input element.

The id of the input element.

Attributes

def inputComponent: Prop[ElementType]

The component used for the input element. Either a string to use a HTML element or a component.

The component used for the input element. Either a string to use a HTML element or a component.

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 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 TextareaAutosize element is rendered.

If true, a TextareaAutosize element is rendered.

Attributes

def name: Prop[String]

Name attribute of the input element.

Name attribute of the input element.

Attributes

def onChange: Prop[Any => Any]

Callback fired when the value is changed.

Callback fired when the value is changed.

Value parameters

{React.ChangeEvent<HTMLTextAreaElement

| HTMLInputElement>} 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 readOnly: Prop[Boolean]

It prevents the user from changing the value of the field (not from interacting with the field).

It prevents the user from changing the value of the field (not from interacting with the field).

Attributes

def required: Prop[Boolean]

If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.

If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.

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 slotProps: Prop[Object]

The extra props for the slot components. You can override the existing props or add new ones.

The extra props for the slot components. You can override the existing props or add new ones.

This prop is an alias for the componentsProps prop, which will be deprecated in the future.

Attributes

def slots: Prop[Object]

The components used for each slot inside.

The components used for each slot inside.

This prop is an alias for the components prop, which will be deprecated in the future.

Attributes

def startAdornment: Prop[VdomNode]

Start InputAdornment for this component.

Start InputAdornment for this 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

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