An open API service indexing awesome lists of open source software.

https://github.com/faster-games/ui-components

A set of UI components for Unity's new UI Toolkit framework. 🎛🖊
https://github.com/faster-games/ui-components

unity unity3d unity3d-ui

Last synced: 2 months ago
JSON representation

A set of UI components for Unity's new UI Toolkit framework. 🎛🖊

Awesome Lists containing this project

README

          

# UI Components

A set of UI components for Unity's new UI Toolkit framework. 🎛🖊

![Project logo; A pink package on a grey background, next to the text "UI Components" in purple](./Documentation~/header.png)

![GitHub package.json version](https://img.shields.io/github/package-json/v/faster-games/ui-components)
[![openupm](https://img.shields.io/npm/v/com.faster-games.ui-components?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.faster-games.ui-components/)
[![CI](https://github.com/faster-games/ui-components/actions/workflows/main.yml/badge.svg)](https://github.com/faster-games/ui-components/actions/workflows/main.yml)
[![Discord](https://img.shields.io/discord/862006447919726604)](https://discord.gg/QfQE6rWQqq)

The new Unity UI Toolkit provides a browser-like way to create UI in Unity Games. However, this core set of tools doesn't come with much. As a result, I wanted to create a set of primitives I could reuse to reduce boilerplate. This is that set.

## Installing

This package supports [openupm](https://openupm.com/packages/com.faster-games.ui-components/) - you can install it using the following command:

```
openupm add com.faster-games.ui-components
```

Or by adding directly to your `manifest.json`:

> Note: You may also use specific versions by appending `#{version}` where version is a [Release tag](https://github.com/faster-games/ui-components/releases) - e.g. `#v1.2.0`.

```
dependencies: {
...
"com.faster-games.ui-components": "git+https://github.com/faster-games/ui-components.git"
}
```

Or by using [Package Manager](https://docs.unity3d.com/Manual/upm-ui-giturl.html) to "Add a package from Git URL", using the following url:

```
https://github.com/faster-games/ui-components.git
```

## Documentation

[Manual 📖](https://ui-components.faster-games.com/manual/getting-started.html) | [Scripting API 🔎](https://ui-components.faster-games.com/ref/FasterGames.UI.Components.html)

### Quickstart

- Learn about [UI Toolkit](https://docs.unity3d.com/Manual/UIElements.html).
- Leverage these components in your UI.

## Supporting the project

If this project saved you some time, and you'd like to see it continue to be invested in, consider [buying me a coffee. ☕](https://www.buymeacoffee.com/bengreenier) I do this full-time, and every little bit helps! 💙