GenUiProp class

Per-parameter overrides for a GenUiWidget constructor parameter.

The annotation is optional. Without it, the schema property takes the parameter name and its description comes from the parameter's doc comment (or, failing that, the corresponding field's doc comment). It may be placed on the constructor parameter or, for this.x parameters, on the field.

const Panel({
  @GenUiProp(description: 'Title shown in the header.') required this.title,
  @GenUiProp(ignore: true) this.elevation = 2,
});

Annotations

• @Target.new({TargetKind.parameter, TargetKind.field})

Constructors

GenUiProp({String? description, String? name, bool ignore = false, bool template = false})

Creates a GenUiProp annotation.

const

Properties

description → String?

The description of the schema property.

final

hashCode → int

The hash code for this object.

no setter, inherited

ignore → bool

Whether to exclude the parameter from the schema entirely.

final

name → String?

The schema property name.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

template → bool

Whether this list of children may be written as a template.

final

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