shared/xyz.malefic.fidget

Package-level declarations

Types

EmptyWidgetData

object EmptyWidgetData : WidgetData

Empty widget data for widgets that don't need external data.

FidgetGlanceReceiver

abstract class FidgetGlanceReceiver<T : WidgetData>(widgetKey: String) : GlanceAppWidgetReceiver

Base receiver for Fidget widgets. Extend this class in your app for each widget.

FidgetGlanceWidget

abstract class FidgetGlanceWidget<T : WidgetData>(widgetKey: String) : GlanceAppWidget

Base GlanceAppWidget for Fidget widgets. Create a subclass for each widget in your app.

FidgetWidgetBridge

object FidgetWidgetBridge

Bridge between Kotlin/Compose and iOS WidgetKit.

UpdatePolicy

sealed class UpdatePolicy

Defines how and when a widget should update its content.

WidgetConfig

data class WidgetConfig(val displayName: String, val description: String = "", val supportedFamilies: List<WidgetFamily> = listOf( WidgetFamily.Small, WidgetFamily.Medium, WidgetFamily.Large ), val updatePolicy: UpdatePolicy = UpdatePolicy.Periodic(), val configurable: Boolean = false)

Configuration for a Fidget widget.

WidgetConfiguration

data class WidgetConfiguration(val displayName: String, val description: String, val supportedFamilies: List<String>)

Widget configuration exposed to iOS. Contains metadata about the widget for WidgetKit configuration.

WidgetContext

data class WidgetContext<T : WidgetData>(val family: WidgetFamily, val data: T?)

Context provided to widget content composables.

WidgetData

interface WidgetData

Base interface for widget data/state. Implement this interface for your widget's data model.

WidgetDataProvider

interface WidgetDataProvider<T : WidgetData>

Provides data for widgets. Implementations should fetch and prepare data for widget rendering.

WidgetFamily

enum WidgetFamily : Enum<WidgetFamily>

Represents the different sizes/families a widget can support. Maps to iOS WidgetFamily and Android Glance widget sizes.

Functions

FidgetWidget

@Composable

fun FidgetWidget(configuration: WidgetConfig, content: @Composable (family: WidgetFamily) -> Unit)

Overload for widgets without data.

@Composable

fun <T : WidgetData> FidgetWidget(configuration: WidgetConfig, dataProvider: WidgetDataProvider<T>? = null, content: @Composable (context: WidgetContext<T>) -> Unit)

Creates a Fidget widget with the specified configuration.