1. Home
  2. Classes
  3. Settings.Slider

new Slider( name, note, min, max, value, onChange [, options ] )

Description

Creates a slider/range using discord's built in slider.

Parameters
Name Type Attributes Description
name string

name label of the setting
note string

help/note to show underneath or above the setting
min number

minimum value allowed
max number

maximum value allowed
value number

currently selected value
onChange callable

callback to fire when setting is changed, callback receives number
options object <optional>

object of options to give to the setting

Name Type Attributes Default Description
disabled boolean <optional>
 false

should the setting be disabled
fillStyles object <optional>

object of css styles to add to active slider
defaultValue number <optional>

value highlighted as default
keyboardStep number <optional>

step moved when using arrow keys
markers Array.<number> <optional>

array of vertical markers to show on the slider
stickToMarkers boolean <optional>

should the slider be forced to use markers
equidistant boolean <optional>

should the markers be scaled to be equidistant
onMarkerRender module:Settings~SliderMarkerValue <optional>

function to call to render the value in the marker
renderMarker module:Settings~SliderMarkerValue <optional>

alias of onMarkerRender
onValueRender module:Settings~SliderRenderValue <optional>

function to call to render the value in the tooltip
renderValue module:Settings~SliderRenderValue <optional>

alias of onValueRender
units string <optional>

can be used in place of onValueRender will use this string and render Math.round(value) + units
Details

Settings.SettingField

ui/settings/types/slider.js, line 23

Methods

getElement() → {HTMLElement}

Returns
  • root element for setting
Details

module:Settings.SettingField#getElement

module:Settings.SettingField#getElement

ui/settings/settingfield.js, line 33

onChange()

Description

Fires onchange to listeners

Details

module:Settings.SettingField#onChange

module:Settings.SettingField#onChange

ui/settings/settingfield.js, line 36

onAdded()

Description

Fired when root node added to DOM

Details

module:Settings.SettingField#onAdded

module:Settings.SettingField#onAdded

ui/settings/settingfield.js, line 41

onRemoved()

Description

Fired when root node removed from DOM

Details

module:Settings.SettingField#onRemoved

module:Settings.SettingField#onRemoved

ui/settings/settingfield.js, line 53