redwood-schema/app.cash.redwood.schema/Widget

Widget

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Widget(val tag: Int, val reservedProperties: IntArray = [], val reservedChildren: IntArray = [])

Annotates a data class which represents a widget in a UI tree. Each widget in a Schema must have a unique tag among all @Widget annotations in the Schema.

All the properties in the class must be annotated with either Property or Children.

@Widget(1)
data class Box(
  @Property(1) val orientation: Orientation,
  @Children val children: () -> Unit,
)

Properties

reservedChildren

val reservedChildren: IntArray

Children tags which are reserved. These cannot be used by a @Children annotation. This is useful for ensuring tags from old, retired children are not accidentally reused.

reservedProperties

val reservedProperties: IntArray

Property tags which are reserved. These cannot be used by a @Property annotation. This is useful for ensuring tags from old, retired properties are not accidentally reused.

tag

val tag: Int