SettingsSchema

Schema definition for a settings data class. Generated by KSP from annotated properties.

Properties

abstract val default: T

Default instance of the settings class

All fields (both @Setting and @Persisted)

Find field by DataStore key

Find field by property name

Group visible UI fields by category, sorted by order.

open fun isEnabled(model: T, field: SettingField<T, *>): Boolean

Check if a setting is enabled based on its dependency

open fun orderedCategories(platform: SettingPlatform = currentPlatform): List<KClass<*>>

Get ordered list of categories with visible fields

Get fields that can be reset

Get fields in a category that can be reset

All fields with UI metadata (excludes @Persisted-only)

open fun visibleUiFields(platform: SettingPlatform = currentPlatform): List<SettingField<T, *>>

All UI fields visible on the current platform.