core/io.github.themeanimator.theme/Theme

Theme

sealed class Theme

Represents the available theme modes for the application.

This sealed class defines three theme modes: Light, Dark, and System. Each theme mode provides specific behavior for determining its opposite theme and maintaining persistence through ordinal values.

Inheritors

Light

Dark

System

Types

Companion

object Companion

Dark

object Dark : Theme

Dark theme mode that forces the application to use dark colors.

Light

object Light : Theme

Light theme mode that forces the application to use light colors.

System

object System : Theme

System theme mode that follows the system's theme preference.

Properties

ordinal

abstract val ordinal: Int

The unique ordinal identifier for this theme mode.

Functions

isDark

@Composable

fun Theme.isDark(): Boolean

Determines if this theme resolves to a dark appearance.

opposite

abstract fun opposite(isSystemInDarkTheme: Boolean): Theme

Returns the opposite theme based on the current theme and system settings.