# Toggle

The **Toggle** **Object** is a **2D GUI Object** that has two states: checked or unchecked. Its initial state and colors can be customized in the [**Attributes**](#attributes).

![Toggle.](/files/TbJUugvCRqdVtb9Uptfv)

![Toggle example.](/files/UYB4HKdnwf4lSRpptgTF)

## Attributes

The **Object's** **Attributes** can be used to fully customize the **Object**. Explained below, they are:

* [**Transformation**](#transformation)
* [**Toggle**](#toggle)
* [**Code**](#code)
* [**Tag**](#tag)

### Transformation

![Transformation Attributes.](/files/GUoxOJPsoCEtsN0tCIN6)

The `Transformation` **Attributes** deal with placement, rotation, and size in *XY* space. More information can be found [here](/incari-studio/2023.1/objects-and-types/attributes/common-attributes/transformation.md).

### Toggle

![Toggle Attributes.](/files/Ur8TrU9oziW7ONDkqP5u)

The `Toggle` **Attributes** provide crucial data for a **Toggle Object**.

* `Is checked` can be enabled or disabled. Enabled toggles it on and disabled toggles it off.
* `Handle Color` is the color of the **Toggle's** handle. It is the small circle which appears on the background of the **Toggle**.
* `Background Color Checked` is the color of the background when `Is checked` is enabled.
* `Background Color Unchecked` is the color of the background when `Is checked` is disabled.

### Code

![Code Attributes.](/files/mTGkstlUkeLvJQw7Petc)

The `Code` **Attributes** allow for more customizability. This can override any stylesheet provided in the [**Project Settings**](/incari-studio/2023.1/modules/project-settings/style.md) or a [**Scene2D**](/incari-studio/2023.1/objects-and-types/project-objects/scene2d.md).

To address these in the **Logic**, please refer to the [**Object 2D Nodes**](/incari-studio/2023.1/toolbox/incari/object2d.md).

* `Class names` contain the *CSS* class names of the **Object**.
* `Stylesheet` contains the *CSS* stylesheet of the **Object**.

### Tag

![Tag Attributes.](/files/TPt8ylPfENI8h1ezukwe)

This **Attribute** manages the *tags* for the **Toggle**. See more on *tags* [here.](/incari-studio/2023.1/objects-and-types/attributes/common-attributes/tag.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.incari.com/incari-studio/2023.1/objects-and-types/scene2d-objects/gui/toggle.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
