polyui/org.polyfrost.polyui.color/Colors

Colors

interface Colors

Colors

Colors is the color storage for PolyUI. All PolyUI drawables use these colors. or even changed on the fly using the field in the PolyUI instance, bringing theming to PolyUI.

Since

0.17.0

Inheritors

DarkTheme

LightTheme

Types

Brand

class Brand(val fg: Colors.Palette, val accent: Colors.Palette)

Component

class Component(val bg: Colors.Palette, val bgDeselected: Color)

OnBrand

class OnBrand(val fg: Colors.Palette, val accent: Colors.Palette)

Page

class Page(val bg: Colors.Palette, val bgOverlay: Color, val fg: Colors.Palette, val fgOverlay: Color, val border20: Color, val border10: Color, val border5: Color)

Palette

open class Palette(val normal: Color, val hovered: Color, val pressed: Color, val disabled: Color)

A color palette represents a set of four colors in PolyUI representing the four key states that a component can have.

State

class State(val danger: Colors.Palette, val warning: Colors.Palette, val success: Colors.Palette)

Text

class Text(val primary: Colors.Palette, val secondary: Colors.Palette)

Properties

brand

abstract val brand: Colors.Brand

component

abstract val component: Colors.Component

name

abstract val name: String

onBrand

abstract val onBrand: Colors.OnBrand

page

abstract val page: Colors.Page

state

abstract val state: Colors.State

text

abstract val text: Colors.Text

Functions

getNewColor

open fun getNewColor(currentColor: Color, current: Colors): Color?

Calculate and return the new Color for the given currentColor based on the current and new Colors. This is useful for theming, where you want to change the color of a component based on the current theme. If the currentColor is not found in the current Colors, it will return null.

getNewPalette

open fun getNewPalette(currentPalette: Colors.Palette?, current: Colors): Colors.Palette?

Calculate and return the new Palette for the given currentPalette based on the current and new Colors. This is useful for theming, where you want to change the palette of a component based on the current theme. If the currentPalette is not found in the current Colors, it will return null.