Method SliderInt

Namespace

Velvet

Assembly

Velvet.Docs.dll

SliderInt(string?, int?, int?, int?, Action<int>?, string?, string?, bool?, Func<VisualElement, Action>?, Action<VisualElement>?, string?, string?, string?, IReadOnlyDictionary<string, string>?, IReadOnlyDictionary<string, string>?, SliderDirection?, bool?, int?, FiberEventBinding[]?)

Creates a SliderInt: Slider(string?, float?, float?, float?, Action<float>?, string?, string?, bool?, Func<VisualElement, Action>?, Action<VisualElement>?, string?, string?, string?, IReadOnlyDictionary<string, string>?, IReadOnlyDictionary<string, string>?, SliderDirection?, bool?, float?, FiberEventBinding[]?) over whole numbers, reporting an int.

public static ElementNode SliderInt(string? className = null, int? value = null, int? lowValue = null, int? highValue = null, Action<int>? onValueChanged = null, string? key = null, string? name = null, bool? enabled = null, Func<VisualElement, Action>? refCallback = null, Action<VisualElement>? onCreated = null, string? whileHoverClass = null, string? whileTapClass = null, string? whileFocusClass = null, IReadOnlyDictionary<string, string>? data = null, IReadOnlyDictionary<string, string>? aria = null, SliderDirection? direction = null, bool? inverted = null, int? step = null, FiberEventBinding[]? events = null)

Parameters

className string

CSS-like utility class string. Multiple classes separated by spaces.

value int?

Current slider value (controlled).

lowValue int?

Minimum value of the slider range.

highValue int?

Maximum value of the slider range.

onValueChanged Action<int>

Handler invoked when the slider value changes.

key string

Key used to disambiguate siblings at the same position.

name string

Element name assigned to UnityEngine.UIElements.VisualElement.name for query/debug.

enabled bool?

When false, disables the slider input.

refCallback Func<VisualElement, Action>

Callback invoked on mount with the created VisualElement; returned Action runs on unmount.

onCreated Action<VisualElement>

Callback invoked once when the SliderInt VisualElement is first created.

whileHoverClass string

USS class toggled while the pointer hovers the element.

whileTapClass string

USS class toggled while the pointer is pressed on the element.

whileFocusClass string

USS class toggled while the element holds keyboard/UI focus.

data IReadOnlyDictionary<string, string>

data-* attribute map matched by data-[...] variants.

aria IReadOnlyDictionary<string, string>

aria-* attribute map matched by aria-[...] variants.

direction SliderDirection?

Axis the slider runs along, as Slider(string?, float?, float?, float?, Action<float>?, string?, string?, bool?, Func<VisualElement, Action>?, Action<VisualElement>?, string?, string?, string?, IReadOnlyDictionary<string, string>?, IReadOnlyDictionary<string, string>?, SliderDirection?, bool?, float?, FiberEventBinding[]?)'s direction.

inverted bool?

When true, swaps the ends the low and high values sit at, as Slider(string?, float?, float?, float?, Action<float>?, string?, string?, bool?, Func<VisualElement, Action>?, Action<VisualElement>?, string?, string?, string?, IReadOnlyDictionary<string, string>?, IReadOnlyDictionary<string, string>?, SliderDirection?, bool?, float?, FiberEventBinding[]?)'s inverted.

step int?

Distance one arrow key moves the value, and the grid Home, End and the paging keys land on, counted from lowValue. Null is Radix's default of 1.

events FiberEventBinding[]

Event bindings applied to the element (Documentation~/react-migration.md owns the rule). The array is read and never written.

Returns

ElementNode

The created ElementNode representing this slider.

Exceptions

ArgumentOutOfRangeException

direction names no member of UnityEngine.UIElements.SliderDirection, or step is not above zero.