GenUiExampleSurface class
Renders one catalog item's generated example, through a real surface.
The example is the only sample of a component the package has that the
model also sees: it is what few-shot prompting shows the model and what
DebugCatalogView puts on screen. Rendering it through a
SurfaceController, rather than calling the widget directly, is what makes
a test of it a test of the whole path — schema, bindings, actions and all.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- GenUiExampleSurface
Constructors
- GenUiExampleSurface({Key? key, required Catalog catalog, required CatalogItem item, int exampleIndex = 0})
-
Creates a GenUiExampleSurface.
const
Properties
- catalog → Catalog
-
The catalog the example is composed against.
final
- exampleIndex → int
-
Which of
CatalogItem.exampleDatato render, for an item that declares more than one.final - hashCode → int
-
The hash code for this object.
no setterinherited
- item → CatalogItem
-
The item whose example is rendered.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< GenUiExampleSurface> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited