Documentation

Support

Unity Studio

Open Unity Studio

Unity Studio

Toggle

Add a toggle (checkbox) to your User Interface (UI).
Read time 1 minuteLast updated 2 days ago

Use the Toggle element to create a checkbox that users can activate or deactivate in your User Interface (UI). This element is useful for settings, preferences, and other binary options. For example, you can use a toggle to let users enable or disable sound effects in your application.

Toggle properties

Property

Description

interactableEnable to allow the user to interact with the toggle. Disable to prevent interaction, which grays out the toggle.
isOnSet whether the toggle is on (checked) or off (unchecked) by default.
graphicAssign a graphic (such as an image) to visually represent the toggle's state.

Additional resources