GenUiComponent class

A ComponentImplementation generated from an annotated widget, with the examples the generator wrote for it.

An example is a surface that shows the component on its own: the JSON list of components an updateComponents message carries, with root first and any child it needs after it. The testing tools render every example, and genUiExampleInstructions writes them into a catalog's instructions, which is where an agent reads them.

Inheritance

Constructors

GenUiComponent({required String name, required Schema schema, required ComponentWidgetBuilder builder, List<String> examples = const []})
Creates a component with examples.
const

Properties

allowedChildren → List<String>?
The component types this one may contain, from the definition's allowedChildren, or null when any child is allowed.
finalinherited
allowedParents → List<String>?
The component types that may contain this one, from the definition's allowedParents, or null when any parent is allowed.
finalinherited
builder → ComponentWidgetBuilder
Builds the widget for a resolved node of this component.
finalinherited
examples → List<String>
The examples, each a JSON list of components with root first.
final
hashCode → int
The hash code for this object.
no setterinherited
metadata → Map<String, Object?>?
Optional catalog-level component definition metadata (v1.0+).
finalinherited
name → String
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schema → Schema
The JSON schema of the component's definition.
finalinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited