# minuit

> minuit (also written minuit) is a client UI library for Minecraft mods on NeoForge and Fabric. A mod builds its settings or status screens from minuit components in plain Java (a PanelComponent subclass hosted by a MinuitScreen); players pick one theme (family, chroma, light or dark) for every mod that uses minuit. MIT licensed, mod id `minuit`, Maven coordinates `dev.dryaides:minuit-<loader>-<mc>:<version>`, dependency range [1.0,2.0).

For the whole reference in one file, read https://minuit.dryaides.com/llms-full.txt.

## Docs

- [README](https://minuit.dryaides.com/docs/readme.md): what minuit is, how to depend on it, Maven coordinates, layout
- [API](https://minuit.dryaides.com/docs/api.md): what is public API, a first screen, the standard widgets, forms
- [Themes](https://minuit.dryaides.com/docs/themes.md): families, chromas, variants, the player's choice, theme data files
- [Forms wire format](https://minuit.dryaides.com/docs/forms-wire.md): the bytes between a client and a server for server-driven forms

## Components

- [ButtonComponent](https://minuit.dryaides.com/components/button.md): Displays a button.
- [ToggleComponent](https://minuit.dryaides.com/components/toggle.md): Switches one setting on or off.
- [SliderComponent](https://minuit.dryaides.com/components/slider.md): Picks a whole number in a range.
- [DropdownComponent](https://minuit.dryaides.com/components/dropdown.md): Opens a list of choices.
- [TextFieldComponent](https://minuit.dryaides.com/components/textfield.md): A single line of text to edit.
- [TabsComponent](https://minuit.dryaides.com/components/tabs.md): Switches between parts of a screen.
- [ToggleGroupComponent](https://minuit.dryaides.com/components/toggle-group.md): A row of buttons where one or several can be on.
- [ListComponent](https://minuit.dryaides.com/components/list.md): A scrolling list of rows you draw yourself.
- [ProgressComponent](https://minuit.dryaides.com/components/progress.md): Shows how far a task has got.
- [MeterComponent and WaveComponent](https://minuit.dryaides.com/components/meter.md): Shows a sound level in decibels.
- [SpinnerComponent](https://minuit.dryaides.com/components/spinner.md): Shows that something is loading.
- [PanelComponent](https://minuit.dryaides.com/components/panel.md): The surface of a screen.
- [ScrollComponent](https://minuit.dryaides.com/components/scroll.md): Scrolls components that do not fit their box.
- [GridComponent](https://minuit.dryaides.com/components/grid.md): Cards in rows of a fixed number of columns.
- [SectionComponent](https://minuit.dryaides.com/components/section.md): A titled block the player can fold.
- [WindowComponent](https://minuit.dryaides.com/components/window.md): A panel in a window the player can move and scale.
- [RadialComponent](https://minuit.dryaides.com/components/radial.md): A wheel of choices around the cursor.
- [ReelComponent](https://minuit.dryaides.com/components/reel.md): A roulette that lands on one card.
- [ColorPickerComponent](https://minuit.dryaides.com/components/colorpicker.md): Picks a colour.
- [ItemPickerComponent](https://minuit.dryaides.com/components/itempicker.md): Lets the player pick any item in the game.
- [SlotGridComponent and PlayerInventoryComponent](https://minuit.dryaides.com/components/slots.md): The game's item slots, drawn in your theme.
- [ToastSpec](https://minuit.dryaides.com/components/toast.md): Shows a toast in the game's own stack, in the player's theme.
- [RichTextComponent](https://minuit.dryaides.com/components/richtext.md): Prints text with the game's colour and style codes, written with the section sign or &.
- [EntityPreviewComponent](https://minuit.dryaides.com/components/entity.md): Shows an entity or a block in 3D.
- [KeybindFieldComponent](https://minuit.dryaides.com/components/keybind.md): Rebinds one key or mouse button.

## Optional

- [Full reference](https://minuit.dryaides.com/llms-full.txt): README, API, themes, forms and every component in one file