UXML element Slider

A Slider lets users select a floating-point value from a range of values. You can use a Slider to adjust a value, such as the volume of a sound or the brightness of a light. To set the value, you drag a thumb along a track, or click the track itself. A slider can also include a text input fieldA field that allows the user to input a Text string More info
See in Glossary, where you can modify the value directly.

Note: To align an element with other fields in an InspectorA Unity window that displays information about the currently selected GameObject, asset or project settings, allowing you to inspect and edit the values. More info
See in Glossary window, simply apply the .unity-base-field__aligned USS class to it. For more information, refer to BaseField.

Create a Slider

You can create a Slider with UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Builder, UXML, or C#. The following C# example creates a Slider with a default value, low value, and high value, and sets the direction of the slider:

var slider = new Slider();
slider.value = 0.5f;
slider.lowValue = 0;
slider.highValue = 100;
slider.direction = SliderDirection.Horizontal;

Set page size

The Slider control has a page-size property that controls how much the thumb moves, and how much the value changes, when you click the track to either side of the thumb.

If the page size value is 0, clicking the track moves the thumb to the cursor or pointer position, and updates the value accordingly.

If the page size value is greater than 0, clicking the track moves the thumb toward the cursor or pointer position by a specific amount. Slider controls treat page-size as a percentage of the total range.

For example, if the total range is 200, and the page size is 20, then the page size amount is 20% of 200, or 40. Each time you click the track, the thumb moves, and the value increases or decreases by 40.

Example

The following UXML example creates a Slider:

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <Slider
        label="UXML Slider"
        name="the-uxml-slider"
        low-value="0"
        high-value="100"
        page-size="1"
        value="42.2" />
</UXML>

The following C# example illustrates some of the customizable functionalities of the Slider:

/// <sample>
// Get a reference to the slider from UXML and assign it its value.
var uxmlSlider = container.Q<Slider>("the-uxml-slider");
uxmlSlider.value = 42.2f;

// Create a new slider, disable it, and give it a style class.
var csharpSlider = new Slider("C# Slider", 0, 100);
csharpSlider.SetEnabled(false);
csharpSlider.AddToClassList("some-styled-slider");
csharpSlider.value = uxmlSlider.value;
container.Add(csharpSlider);

// Mirror value of uxml slider into the C# field.
uxmlSlider.RegisterCallback<ChangeEvent<float>>((evt) =>
{
    csharpSlider.value = evt.newValue;
});
/// </sample>

To try this example live in Unity, go to Window > UI Toolkit > Samples.

C# base class and namespace

C# class: Slider
Namespace: UnityEngine.UIElements
Base class: BaseSlider_1

Inherited UXML attributes

This element inherits the following attributes from its base class:

This element also inherits the following attributes from VisualElement:

USS classes

The following table lists all the C# public property names and their related USS selector.

You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the VisualElement at every level of its hierarchy.

Additional resources

• UXML element SliderInt
• UXML element MinMaxSlider