Constructor
new InputRange(props)
Parameters:
Name | Type | Description |
---|---|---|
props |
Object | React component props |
- Source:
Extends
- React.Component
Members
(static) defaultProps
Default props of InputRange
Properties:
Name | Type | Description |
---|---|---|
defaultClassNames |
Object.<string, string> | |
defaultValue |
Range | number | |
disabled |
boolean | |
maxValue |
number | |
minValue |
number | |
step |
number | |
value |
Range | number |
- Source:
(static) propTypes
Accepted propTypes of InputRange
Properties:
Name | Type | Description |
---|---|---|
ariaLabelledby |
function | |
classNames |
function | |
defaultValue |
function | |
disabled |
function | |
maxValue |
function | |
minValue |
function | |
name |
function | |
onChange |
function | |
onChangeComplete |
function | |
step |
function | |
value |
function |
- Source:
isMultiValue :boolean
Return true if the component accepts a range of values
Type:
- boolean
- Source:
trackClientRect :ClientRect
Return the clientRect of the component's track
Type:
- ClientRect
- Source:
Methods
decrementValue(key)
Decrement the value of a slider by key name
Parameters:
Name | Type | Description |
---|---|---|
key |
string | max/min |
- Source:
handleInteractionEnd(event)
Handle the end of any user-triggered event
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
- Source:
handleInteractionStart(event)
Handle the start of any user-triggered event
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
- Source:
handleKeyDown(event)
Handle any keydown event received by the component
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
- Source:
handleKeyUp(event)
Handle any keyup event received by the component
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
- Source:
handleMouseDown(event)
Handle any mousedown event received by the component
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
- Source:
handleMouseUp(event)
Handle any mouseup event received by the component
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
- Source:
handleSliderKeyDown(event, slider)
Handle any keydown event received by the slider
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
slider |
Slider | React component |
- Source:
handleSliderMouseMove(event, slider)
Handle any mousemove event received by the slider
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
slider |
Slider | React component |
- Source:
handleTouchEnd(event)
Handle any touchend event received by the component
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
- Source:
handleTouchStart(event)
Handle any touchstart event received by the component
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
- Source:
handleTrackMouseDown(event, slider, position)
Handle any mousedown event received by the track
Parameters:
Name | Type | Description |
---|---|---|
event |
SyntheticEvent | User event |
slider |
Slider | React component |
position |
Point | Mousedown position |
- Source:
incrementValue(key)
Increment the value of a slider by key name
Parameters:
Name | Type | Description |
---|---|---|
key |
string | max/min |
- Source:
render() → {string}
Render method of the component
- Source:
Returns:
Component JSX
- Type
- string
updatePosition(key, position)
Update the position of a slider by key
Parameters:
Name | Type | Description |
---|---|---|
key |
string | min/max |
position |
Point | x/y |
- Source:
updatePositions(positions)
Update the position of sliders
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
positions |
Object |
Properties
|
- Source:
updateValue(key, value)
Update the value of a slider by key
Parameters:
Name | Type | Description |
---|---|---|
key |
string | max/min |
value |
number | New value |
- Source:
updateValues(values)
Update the values of all sliders
Parameters:
Name | Type | Description |
---|---|---|
values |
Object | number | Object if multi-value, number if single-value |
- Source: