mui/base_5
API
Generated with
mui/base_5/io.github.nafg.scalajs.facades.mui.base/Slider/Props

Props

io.github.nafg.scalajs.facades.mui.base.Slider.Props
class Props extends PropTypes

Attributes

Graph
Supertypes
trait PropTypes
class Object
trait Matchable
class Any

Members list

Type members

Classlikes

object orientation extends Prop[String]

The component orientation.

The component orientation.

Attributes

Supertypes
class Prop[String]
class Object
trait Matchable
class Any
Self type
object track extends Prop[Any]

The track presentation:

The track presentation:

  • normal the track will render a bar representing the slider value.
  • inverted the track will render a bar representing the remaining slider value.
  • false the track will render without a bar.

Attributes

Supertypes
class Prop[Any]
class Object
trait Matchable
class Any
Self type
track.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 aria-label: Prop[Any]

The label of the slider.

The label of the slider.

Attributes

def aria-labelledby: Prop[String]

The id of the element containing a label for the slider.

The id of the element containing a label for the slider.

Attributes

def aria-valuetext: Prop[Any]

A string value that provides a user-friendly name for the current value of the slider.

A string value that provides a user-friendly name for the current value of the slider.

Attributes

def defaultValue: Prop[Seq[Double] | Double]

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

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

Attributes

def disableSwap: Prop[Boolean]

If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.

If true, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.

Attributes

def disabled: Prop[Boolean]

If true, the component is disabled.

If true, the component is disabled.

Attributes

def getAriaLabel: Prop[Any => Any]

Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.

Value parameters

{number}

index The thumb label's index to format.

Attributes

def getAriaValueText: Prop[Any => Any]

Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. 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 slider. This is important for screen reader users.

Value parameters

{number}

index The thumb label's index to format.

Attributes

def isRtl: Prop[Boolean]

If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).

If true the Slider will be rendered right-to-left (with the lowest value on the right-hand side).

Attributes

def marks: Prop[Seq[Object] | Boolean]

Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.

Marks indicate predetermined values to which the user can move the slider. If true the marks are spaced according the value of the step prop. If an array, it should contain objects with value and an optional label keys.

Attributes

def max: Prop[Double]

The maximum allowed value of the slider. Should not be equal to min.

The maximum allowed value of the slider. Should not be equal to min.

Attributes

def min: Prop[Double]

The minimum allowed value of the slider. Should not be equal to max.

The minimum allowed value of the slider. Should not be equal to max.

Attributes

def name: Prop[String]

Name attribute of the hidden input element.

Name attribute of the hidden input element.

Attributes

def onChange: Prop[Any => Any]

Callback function that is fired when the slider's value changed.

Callback function that is fired when the slider's value changed.

Value parameters

{Event}

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.

{number

| number[]} value The new value.

{number}

activeThumb Index of the currently moved thumb.

Attributes

def onChangeCommitted: Prop[Any => Any]

Callback function that is fired when the mouseup is triggered.

Callback function that is fired when the mouseup is triggered.

Value parameters

{React.SyntheticEvent

| Event} event The event source of the callback. Warning: This is a generic event not a change event.

{number

| number[]} value The new value.

Attributes

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

A transformation function, to change the scale of the slider.

A transformation function, to change the scale of the slider.

Value parameters

{any}

x

Attributes

def slotProps: Prop[Object]

The props used for each slot inside the Slider.

The props used for each slot inside the Slider.

Attributes

def slots: Prop[Object]

The components used for each slot inside the Slider. Either a string to use a HTML element or a component.

The components used for each slot inside the Slider. Either a string to use a HTML element or a component.

Attributes

def step: Prop[Double]

The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.

The granularity with which the slider can step through values. (A "discrete" slider.) The min prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.

When step is null, the thumb can only be slid onto marks provided with the marks prop.

Attributes

def style: Prop[Object]
def tabIndex: Prop[Double]

Tab index attribute of the hidden input element.

Tab index attribute of the hidden input element.

Attributes

def value: Prop[Seq[Double] | Double]

The value of the slider. For ranged sliders, provide an array with two values.

The value of the slider. For ranged sliders, provide an array with two values.

Attributes

def valueLabelFormat: Prop[Any => Any | String]

The format function the value label's value.

The format function the value label's value.

When a function is provided, it should have the following signature:

  • {number} value The value label's value to format
  • {number} index The value label's index to format

Value parameters

{any}

x

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