> For the complete documentation index, see [llms.txt](https://docs.isxander.dev/yet-another-config-lib/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.isxander.dev/yet-another-config-lib/gui-builder/controllers.md).
# Controllers
## Built-in controllers
{% hint style="warning" %}
This is an incomplete list of controllers!
{% endhint %}
There are many different built-in controllers to get you set up quickly.
BooleanController
A toggleable controller that displays a different `Text` based on the state of the option.
```java
.controller(BooleanControllerBuilder::create)
```
* `valueFormatter` parameter is a function to return `Text` based on the state of the option. *(optional)*
* `coloured` parameter is a boolean that colours the returned text red or green based on the state. *(optional)*
To pass extra parameters, you need to construct a `BooleanController` like so.
.controller(opt -> BooleanControllerBuilder.create(opt)
.valueFormatter(val -> val ? Component.literal("Amazing") : Component.literal("Not Amazing"))
.coloured(true))
TickBoxController
A toggleable controller that displays a tick box.
```java
.controller(TickBoxControllerBuilder::create)
```
There are no optional parameters for this controller.
<Number>SliderController
Replace `` with either `Double`, `Float`, `Integer` and `Long`.
Slider controllers take a minimum, a maximum and a step for the slider in their respected number types.
```java
.controller(opt -> FloatSliderController.create(opt)
.range(0, 10)
.step(1)
.valueFormatter(val -> Component.literal(val + " ticks"))) // sliders can also take a formatter
```
EnumController
A controller that allows you to cycle through Enum constants.
```java
.controller(opt -> EnumControllerBuilder.create(opt)
.enumClass(Alphabet.class))
```
Enums can implement the `NameableEnum` interface to automatically name each constant without a value formatter function.
```java
public enum Alphabet implements NameableEnum {
A,
B,
C;
@Override
public Component getDisplayName() {
return Component.translatable("mymod.alphabet." + name().toLowerCase());
}
}
```
Or alternatively, just pass a `valueFormatter` to the controller as usual;
```java
.controller(opt -> EnumControllerBuilder.create(opt)
.enumClass(Alphabet.class)
.valueFormatter(v -> Component.translatable("mymod.alphabet." + v.name().toLowerCase())))
```
StringController
An input box that allows users to input text as a `String`. This allows for highlighting text with the keyboard and strings that are longer than the option itself, similarly to Minecraft's `EditBox`
```java
.controller(StringControllerBuilder::create)
```
This controller has no arguments, though its functionality can be extended by creating your own controller, implementing `IStringController`, more on this here.
ColorController
A controller that allows users to input colors as RGB hex format, with a preview.
```java
.controller(ColorControllerBuilder::create)
```
* `allowAlpha` parameter adds an alpha channel to the hex format as RGBA.
```java
.controller(opt -> ColorControllerBuilder.create(opt)
.alpha(true))
```
<Number>FieldController
Replace `` with either `Double`, `Float`, `Long` or `Integer`.
Similar to [`StringController`](#stringcontroller), but forces a number format, doubles and floats allow decimals, but longs and integers do not.
```java
.controller(SliderControllerBuilder::create)
```
It also has a optional range where you can specify the upper and lower bound if necessary. And like usual has a value formatter.
```java
.controller(opt -> SliderControllerBuilder.create(opt)
.min(0).max(10)
.valueFormatter(...))
```
## Creating a custom Controller