redwood-schema/app.cash.redwood.schema

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Children(val tag: Int)

Annotates a Widget property as representing child widgets which are contained within the enclosing widget. Children in a Widget class must have a unique tag among all @Children annotations in the class. The type of the property must be () -> Unit.

Default

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Default(val expression: String)

Annotates a Property with an associated default expression. The expression is not type-checked and will be used verbatim in the generated code.

LayoutModifier

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class LayoutModifier(val tag: Int, val scopes: KClass<*>)

Annotates a data class which represents a layout modifier for a Widget. Each layout modifier in a Schema must have a unique tag among all LayoutModifier annotations in the Schema. Additionally, each layout modifier must be associated with at least one scope.

Property

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Property(val tag: Int)

Annotates a Widget property which represents a property on the associated UI widget. Properties in a Widget class must have a unique tag among all @Property annotations in the class.

Schema

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Schema(val members: Array<KClass<*>>, val dependencies: Array<Schema.Dependency> = [])

Annotates an otherwise unused type with a set of Widget-annotated or LayoutModifier-annotated classes which are all part of this schema.

Widget

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Widget(val tag: Int)

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.