GenKeys class

build_runner annotation for generating key classes

keyClasses is an optional parameter to explicitly list the names of the key classes to be generated. If the list is empty, all keys within the annotated class will be placed in a respective generated key class. This parameter is typically only used when the source code contains keys that are declared elsewhere, so do not need to be generated.

E.g., below, a key class would not be generated for "YourWidgetKeys"

@GenKeys((keyClasses: ['MyWidgetKeys']) // <- Optionally specify the key class to generate
class MyWidget {
  @override
  Widget build(BuildContext context) {
    return Row(children: <Widget> [
      Text('Hello', key: MyWidgetKeys.helloText), // <- Generates this key
      Text('There', key: YourWidgetKeys.buttonText), // <- But not this one
    ]);
  }
}

Constructors

GenKeys({List<String> keyClasses = const []})

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

keyClasses → List<String>

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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