GenUI

https://pub.dev/documentation/genui/latest/
Admin
GenUI is a Flutter package for building dynamic, conversational user interfaces powered by...
Tokens:106,051
Snippets:1,333
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Define ExampleBuilderCallback typedef

Source: https://pub.dev/documentation/genui/latest/genui/ExampleBuilderCallback.html

Defines the function signature for building catalog item examples.

```dart
typedef ExampleBuilderCallback = String Function();
```

--------------------------------

### AI-generated widget data examples

Source: https://pub.dev/documentation/genui/latest/index.html

Examples of JSON structures generated by the AI to represent UI components.

```json
{
  "Text": {
    "text": "Welcome to GenUI",
    "hint": "h1"
  }
}
```

```json
{
  "Image": {
    "url": "https://example.com/image.png",
    "hint": "mediumFeature"
  }
}
```

--------------------------------

### Initialize Conversation and Transport Adapter

Source: https://pub.dev/documentation/genui/latest/index.html

Demonstrates the setup of SurfaceController, A2uiTransportAdapter, and Conversation within a Flutter State object.

```dart
class _MyHomePageState extends State<MyHomePage> {
  late final SurfaceController _controller;
  late final A2uiTransportAdapter _transport;
  late final Conversation _conversation;

  @override
  void initState() {
    super.initState();

    // Create a SurfaceController with a widget catalog.
    _controller = SurfaceController(catalogs: [CoreCatalogItems.asCatalog()]);

    // Create transport adapter
    _transport = A2uiTransportAdapter(onSend: _onSendToLLM);

    // Create the Conversation to orchestrate everything.
    _conversation = Conversation(
      controller: _controller,
      transport: _transport,
    );

    // Listen to conversation events
    _conversation.events.listen((event) {
         if (event is ConversationSurfaceAdded) {
             _onSurfaceAdded(event);
         } else if (event is ConversationSurfaceRemoved) {
             _onSurfaceRemoved(event);
         }
    });
  }

  Future<void> _onSendToLLM(ChatMessage message) async {
     // Implement your LLM integration here.
     // For example, if using an HTTP client:
     // Note: history is now managed by the LLM client or passed if needed,
     // but typical adapters might just send the new message or the whole history.
     // A2uiTransportAdapter.onSend signature is Future<void> Function(ChatMessage message).
     final responseStream = myLlmClient.streamGenerateContent(message);
     await for (final chunk in responseStream) {
         _transport.addChunk(chunk);
     }
  }

  @override
  void dispose() {
    _textController.dispose();
    _conversation.dispose();
    _transport.dispose();
    _controller.dispose();
    super.dispose();
  }
}
```

--------------------------------

### Implementation of startsWith method

Source: https://pub.dev/documentation/genui/latest/genui/DataPath/startsWith.html

Checks if the current path starts with the provided path by comparing segments and absolute path status.

```dart
bool startsWith(DataPath other) {
  if (other.isAbsolute && !isAbsolute) {
    return false;
  }
  if (other.segments.length > segments.length) {
    return false;
  }
  for (var i = 0; i < other.segments.length; i++) {
    if (segments[i] != other.segments[i]) {
      return false;
    }
  }
  return true;
}
```

--------------------------------

### validateCatalogItemExamples()

Source: https://pub.dev/documentation/genui/latest/test_validation

Validates the examples for a single catalog item.

```APIDOC
## validateCatalogItemExamples()

### Description
Validates the examples for a single catalog item.

### Signature
`Future<List<ExampleValidationError>> validateCatalogItemExamples(CatalogItem item, Catalog catalog)`

### Parameters
- **item** (CatalogItem) - The catalog item to validate.
- **catalog** (Catalog) - The catalog containing the item.

### Returns
- **Future<List<ExampleValidationError>>** - A list of validation errors found during the process.
```

--------------------------------

### Define exampleIndex property

Source: https://pub.dev/documentation/genui/latest/test_validation/ExampleValidationError/exampleIndex.html

Declaration of the final integer property used to store the index of an example.

```dart
final int exampleIndex;
```

--------------------------------

### Implement Text CatalogItem

Source: https://pub.dev/documentation/genui/latest/genui/text.html

Defines the Text component schema, example data, and the widget builder logic for rendering styled Markdown text.

```dart
final text = CatalogItem(
  name: 'Text',
  dataSchema: S.object(
    description: 'A block of styled text.',
    properties: {
      'text': A2uiSchemas.stringReference(
        description:
            '''While simple Markdown is supported (without HTML or image references), utilizing dedicated UI components is generally preferred for a richer and more structured presentation.''',
      ),
      'variant': S.string(
        description: 'A hint for the base text style.',
        enumValues: ['h1', 'h2', 'h3', 'h4', 'h5', 'caption', 'body'],
      ),
    },
    required: ['text'],
  ),
  exampleData: [
    () => '''
      [
        {
          "id": "root",
          "component": "Text",
          "text": "Hello World"
        }
      ]
    ''',
  ],
  widgetBuilder: (itemContext) {
    final textData = _TextData.fromMap(itemContext.data as JsonMap);

    return BoundString(
      dataContext: itemContext.dataContext,
      value: textData.text,
      builder: (context, value) {
        final TextTheme textTheme = Theme.of(context).textTheme;
        final String variant = textData.variant ?? 'body';
        final TextStyle? baseStyle = switch (variant) {
          'h1' => textTheme.headlineLarge,
          'h2' => textTheme.headlineMedium,
          'h3' => textTheme.headlineSmall,
          'h4' => textTheme.titleLarge,
          'h5' => textTheme.titleMedium,
          'caption' => textTheme.bodySmall,
          _ => DefaultTextStyle.of(context).style,
        };
        final double verticalPadding = switch (variant) {
          'h1' => 20.0,
          'h2' => 16.0,
          'h3' => 12.0,
          'h4' => 8.0,
          'h5' => 4.0,
          _ => 0.0,
        };

        return Padding(
          padding: EdgeInsets.symmetric(vertical: verticalPadding),
          child: MarkdownBody(
            data: value ?? '',
            styleSheet: MarkdownStyleSheet.fromTheme(
              Theme.of(context),
            ).copyWith(p: baseStyle),
          ),
        );
      },
    );
  },
);
```

--------------------------------

### Implement asCatalog static method

Source: https://pub.dev/documentation/genui/latest/genui/BasicCatalogItems/asCatalog.html

Initializes a Catalog with standard components and basic functions. Note that some items like audioPlayer and video require additional data handling.

```dart
static Catalog asCatalog({List<String> systemPromptFragments = const []}) {
  return Catalog(
    [
      audioPlayer,
      button,
      card,
      checkBox,
      column,
      dateTimeInput,
      divider,
      icon,
      image,
      list,
      modal,
      choicePicker,
      row,
      slider,
      tabs,
      text,
      textField,
      video,
    ],
    functions: BasicFunctions.all,
    catalogId: basicCatalogId,
    systemPromptFragments: [basicCatalogRules, ...systemPromptFragments],
  );
}
```

--------------------------------

### Initialize Catalog instance

Source: https://pub.dev/documentation/genui/latest/genui/Catalog/Catalog.html

Use this constructor to define a new catalog with a collection of items and optional configuration parameters.

```dart
const Catalog(
  this.items, {
  this.functions = const [],
  this.catalogId,
  this.systemPromptFragments = const [],
});
```

--------------------------------

### Validate Catalog Item Examples

Source: https://pub.dev/documentation/genui/latest/test_validation/validateCatalogItemExamples.html

Validates the examples for a single catalog item against the provided catalog schema. Returns a list of validation errors, where an empty list indicates success.

```dart
Future<List<ExampleValidationError>> validateCatalogItemExamples(
  CatalogItem item,
  Catalog catalog,
) async {
  final Schema schema = A2uiSchemas.updateComponentsSchema(catalog);
  final errors = <ExampleValidationError>[];

  for (var i = 0; i < item.exampleData.length; i++) {
    final String exampleJsonString = item.exampleData[i]();
    final List<Object?> exampleData;
    try {
      exampleData = jsonDecode(exampleJsonString) as List<Object?>;
    } catch (e) {
      errors.add(
        ExampleValidationError(i, 'Failed to parse as a JSON list', cause: e),
      );
      continue;
    }

    final List<Map<String, Object?>> components = exampleData
        .cast<JsonMap>()
        .map(Map<String, Object?>.from)
        .toList();

    if (components.every((c) => c['id'] != 'root')) {
      errors.add(
        ExampleValidationError(
          i,
          'Example must have a component with id "root"',
        ),
      );
    }

    final Map<String, Object?> surfaceUpdate = {
      surfaceIdKey: 'test-surface',
      'components': components,
    };

    final SchemaRegistry registry = createSchemaRegistryWithCommonTypes();

    final List<ValidationError> validationErrors = await schema.validate(
      surfaceUpdate,
      schemaRegistry: registry,
    );
    if (validationErrors.isNotEmpty) {
      errors.add(
        ExampleValidationError(
          i,
          'Schema validation failed',
          cause: validationErrors,
        ),
      );
    }
  }
  return errors;
}
```

--------------------------------

### Catalog constructor

Source: https://pub.dev/documentation/genui/latest/genui/Catalog/Catalog.html

Creates a new catalog instance with the specified items, functions, and configuration.

```APIDOC
## Catalog constructor

### Description
Creates a new catalog with the given list of items.

### Signature
const Catalog(Iterable<CatalogItem> items, {Iterable<ClientFunction> functions = const [], String? catalogId, List<String> systemPromptFragments = const []})

### Parameters
- **items** (Iterable<CatalogItem>) - Required - The list of items to include in the catalog.
- **functions** (Iterable<ClientFunction>) - Optional - A list of client functions available to the catalog. Defaults to an empty list.
- **catalogId** (String?) - Optional - A unique identifier for the catalog.
- **systemPromptFragments** (List<String>) - Optional - A list of system prompt fragments to be used. Defaults to an empty list.
```

--------------------------------

### String get description

Source: https://pub.dev/documentation/genui/latest/genui/ClientFunction/description.html

Retrieves the human-readable description of the function.

```APIDOC
## Property: description

### Description
A human-readable description of what the function does and how to use it.

### Signature
`String get description`
```

--------------------------------

### systemPromptJoined

Source: https://pub.dev/documentation/genui/latest/genui/PromptBuilder-class.html

Returns the system prompt as a single string.

```APIDOC
## String systemPromptJoined({String sectionSeparator})

### Description
Concatenates the system prompt fragments into a single string using the specified separator.

### Parameters
- **sectionSeparator** (String) - Optional - The string used to separate sections (default: '\n-------------------------------------\n\n').
```

--------------------------------

### String get surfaceId

Source: https://pub.dev/documentation/genui/latest/genui/UiEvent/surfaceId.html

Retrieves the ID of the surface that this event originated from.

```APIDOC
## String get surfaceId

### Description
Returns the unique identifier (String) of the surface that triggered the UI event.

### Signature
`String get surfaceId`
```

--------------------------------

### all

Source: https://pub.dev/documentation/genui/latest/genui/BasicFunctions/all.html

Retrieves a list of all available basic functions within the GenUI library.

```APIDOC
## all

### Description
Returns a list of all basic functions available for use in the GenUI library.

### Signature
List<ClientFunction> get all

### Returns
- **List<ClientFunction>** - A collection containing all predefined client functions such as validation, formatting, and utility operations.
```

--------------------------------

### String get surfaceId

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceContext/surfaceId.html

Retrieves the ID of the surface this context is bound to.

```APIDOC
## surfaceId

### Description
Returns the unique identifier (String) of the surface associated with the current context.

### Signature
`String get surfaceId`
```

--------------------------------

### Surface constructor

Source: https://pub.dev/documentation/genui/latest/genui/Surface/Surface.html

Creates a new instance of Surface with the provided configuration.

```APIDOC
## Surface constructor

### Description
Creates a new Surface instance. This constructor is used to initialize the surface with a required context and optional builder and delegate configurations.

### Signature
const Surface({Key? key, required SurfaceContext surfaceContext, WidgetBuilder? defaultBuilder, ActionDelegate actionDelegate = const DefaultActionDelegate()})

### Parameters
- **key** (Key?) - Optional - The widget key.
- **surfaceContext** (SurfaceContext) - Required - The context for the surface.
- **defaultBuilder** (WidgetBuilder?) - Optional - A builder for the default widget content.
- **actionDelegate** (ActionDelegate) - Optional - The delegate to handle actions, defaults to DefaultActionDelegate.
```

--------------------------------

### DataPath get path

Source: https://pub.dev/documentation/genui/latest/genui/ExecutionContext/path.html

Retrieves the DataPath associated with the current context.

```APIDOC
## DataPath get path

### Description
Retrieves the DataPath associated with the current execution context.

### Signature
`DataPath get path;`
```

--------------------------------

### SurfaceDefinition.fromCore(SurfaceModel surface)

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceDefinition/SurfaceDefinition.fromCore.html

Creates a snapshot from a live core surface model.

```APIDOC
## SurfaceDefinition.fromCore

### Description
Creates a snapshot from a live core surface model.

### Signature
SurfaceDefinition.fromCore(SurfaceModel<ComponentApi> surface)

### Parameters
- **surface** (SurfaceModel<ComponentApi>) - Required - The live core surface model to convert into a snapshot.
```

--------------------------------

### startsWith(DataPath other)

Source: https://pub.dev/documentation/genui/latest/genui/DataPath-class.html

Checks if the current path starts with the specified DataPath.

```APIDOC
## startsWith(DataPath other)

### Description
Returns whether this path starts with the other path.

### Method
`bool startsWith(DataPath other)`
```

--------------------------------

### Initialize PromptBuilder with custom configuration

Source: https://pub.dev/documentation/genui/latest/genui/PromptBuilder/custom.html

Use this method to create a custom PromptBuilder instance by providing the required catalog and surface operations.

```dart
static PromptBuilder custom({
  required Catalog catalog,
  required SurfaceOperations allowedOperations,
  Iterable<String> systemPromptFragments = const [],
  String importancePrefix = defaultImportancePrefix,
  TechnicalPossibilities technicalPossibilities =
      const TechnicalPossibilities(),
  JsonMap? clientDataModel,
}) {
  final ({String commonTypes, String serverToClient}) schemas =
      _loadSchemas();
  return _BasicPromptBuilder(
    catalog: catalog,
    systemPromptFragments: systemPromptFragments,
    allowedOperations: allowedOperations,
    importancePrefix: importancePrefix,
    clientDataModel: clientDataModel,
    technicalPossibilities: technicalPossibilities,
    commonTypesSchema: schemas.commonTypes,
    serverToClientSchema: schemas.serverToClient,
  );
}
```

--------------------------------

### String get name

Source: https://pub.dev/documentation/genui/latest/genui/FormatDateFunction/name.html

Retrieves the name of the function as used in expressions, which is 'formatDate'.

```APIDOC
## name

### Description
The name of the function as used in expressions (e.g. 'stringFormat').

### Signature
`String get name`

### Returns
- **String**: The function name, which is 'formatDate'.
```

--------------------------------

### String get name

Source: https://pub.dev/documentation/genui/latest/genui/FormatCurrencyFunction/name.html

Retrieves the name of the function as used in expressions, which is 'formatCurrency'.

```APIDOC
## name

### Description
The name of the function as used in expressions (e.g. 'stringFormat').

### Signature
`String get name`

### Returns
- **String**: The function name, which is 'formatCurrency'.
```

--------------------------------

### UiPart.create

Source: https://pub.dev/documentation/genui/latest/genui/UiPart-class.html

Static method to create a DataPart compatible with GenUI.

```APIDOC
## UiPart.create({required SurfaceDefinition definition, String? surfaceId}) -> DataPart

### Description
Creates a DataPart object that is compatible with the GenUI framework.

### Parameters
- **definition** (SurfaceDefinition) - Required - The JSON definition of the UI.
- **surfaceId** (String?) - Optional - The unique ID for this UI surface.
```

--------------------------------

### Define systemPromptFragments implementation

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceOperations/systemPromptFragments.html

Initializes the system prompt fragments by adding UI control instructions and output format requirements.

```dart
late final Iterable<String> systemPromptFragments = () {
  final parts = <String>[];

  parts.add(_fenced(_controllingUI, sectionName: 'CONTROLLING THE UI'));

  parts.add(
    _fenced('''
When constructing UI, you must output a VALID A2UI JSON object representing one of the A2UI message types ($_operationsFormatted).
- You can treat the A2UI schema as a specification for the JSON you typically output.
- The JSON block must be valid and complete.
- Ensure your JSON is fenced with ```json and ```.
''', sectionName: 'OUTPUT FORMAT'),
  );

  return parts;
}();
```

--------------------------------

### Initialize TextPart

Source: https://pub.dev/documentation/genui/latest/genui/TextPart/TextPart.html

Use this constructor to instantiate a new TextPart object with the required text string.

```dart
const TextPart(this.text);
```

--------------------------------

### Stream<A2uiMessage> get incomingMessages

Source: https://pub.dev/documentation/genui/latest/genui/Transport/incomingMessages.html

Accesses the stream of incoming messages from the AI service.

```APIDOC
## Stream<A2uiMessage> get incomingMessages

### Description
A stream of parsed `core.A2uiMessage`s received from the AI service.

### Signature
`Stream<core.A2uiMessage> get incomingMessages;`
```

--------------------------------

### Iterable<String> get activeSurfaceIds

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceController/activeSurfaceIds.html

Retrieves the IDs of the currently active surfaces from the registry.

```APIDOC
## activeSurfaceIds

### Description
Returns an iterable collection of strings containing the IDs of the currently active surfaces.

### Signature
`Iterable<String> get activeSurfaceIds`

### Returns
- **Iterable<String>** - A collection of surface IDs currently managed by the registry.
```

--------------------------------

### Initialize A2UiClientCapabilities

Source: https://pub.dev/documentation/genui/latest/genui/A2UiClientCapabilities/A2UiClientCapabilities.html

Use this constructor to define client capabilities, providing the required supported catalog IDs and optional inline catalogs.

```dart
const A2UiClientCapabilities({
  required this.supportedCatalogIds,
  this.inlineCatalogs,
});
```

--------------------------------

### SurfaceDefinition.fromCore Implementation

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceDefinition/SurfaceDefinition.fromCore.html

Creates a snapshot from a live core surface model by mapping components and theme data.

```dart
factory SurfaceDefinition.fromCore(core.SurfaceModel surface) {
  return SurfaceDefinition(
    surfaceId: surface.id,
    catalogId: surface.catalog.id,
    components: {
      for (final core.ComponentModel component in surface.componentsModel.all)
        component.id: Component.fromCore(component),
    },
    theme: surface.theme.isEmpty ? null : JsonMap.from(surface.theme),
  );
}
```

--------------------------------

### String get name

Source: https://pub.dev/documentation/genui/latest/genui/ClientFunction/name.html

Retrieves the name of the function as used in expressions (e.g., 'stringFormat').

```APIDOC
## Property: name

### Description
The name of the function as used in expressions (e.g. 'stringFormat').

### Signature
`String get name`
```

--------------------------------

### Initialize Component instance

Source: https://pub.dev/documentation/genui/latest/genui/Component/Component.html

Defines the required parameters for creating a new Component object.

```dart
const Component({
  required this.id,
  required this.type,
  required this.properties,
});
```

--------------------------------

### bool get isCancelled

Source: https://pub.dev/documentation/genui/latest/genui/CancellationSignal/isCancelled.html

Returns a boolean value indicating the cancellation status of the operation.

```APIDOC
## bool get isCancelled

### Description
Returns a boolean value indicating whether the operation has been cancelled.

### Returns
- **bool** - True if the operation has been cancelled, false otherwise.
```

--------------------------------

### asCatalog

Source: https://pub.dev/documentation/genui/latest/genui/BasicCatalogItems/asCatalog.html

Creates a catalog with all basic catalog items. Note that some items like audioPlayer, image, and video require additional data to display correctly.

```APIDOC
## Catalog asCatalog({List<String> systemPromptFragments})

### Description
Creates a catalog with all basic catalog items. Some items (audioPlayer, image, video) require additional data to be properly displayed. If the app does not work with such data, use asNoAssetCatalog instead.

### Parameters
- **systemPromptFragments** (List<String>) - Optional - A list of system prompt fragments to be included in the catalog configuration.
```

--------------------------------

### Override hashCode implementation

Source: https://pub.dev/documentation/genui/latest/genui/TextPart/hashCode.html

Example of overriding the hashCode getter to reflect the state of a text property.

```dart
@override
int get hashCode => text.hashCode;
```

--------------------------------

### configureLogging(Level level, void Function(Level, String)? logCallback, bool enableHierarchicalLogging)

Source: https://pub.dev/documentation/genui/latest/genui/configureLogging.html

Configures the logging for the GenUI package, allowing users to set the log level and provide a custom callback function for processing log records.

```APIDOC
## configureLogging

### Description
Configures the logging for the GenUI package. This function should be called by applications using the GenUI package to configure the desired log level and to listen for log messages.

### Signature
`Logger configureLogging({Level level = Level.INFO, void Function(Level, String)? logCallback, bool enableHierarchicalLogging = true})`

### Parameters
- **level** (Level) - Optional - The logging level to set (defaults to Level.INFO).
- **logCallback** (void Function(Level, String)?) - Optional - A callback function to handle log messages. If not provided, messages are printed to the console.
- **enableHierarchicalLogging** (bool) - Optional - Whether to enable hierarchical logging (defaults to true).
```

--------------------------------

### Implement asNoAssetCatalog

Source: https://pub.dev/documentation/genui/latest/genui/BasicCatalogItems/asNoAssetCatalog.html

This implementation creates a catalog by filtering out audio, image, and video items from the base catalog.

```dart
static Catalog asNoAssetCatalog({
  List<String> systemPromptFragments = const [],
}) => asCatalog(
  systemPromptFragments: systemPromptFragments,
).copyWithout(itemsToRemove: [audioPlayer, image, video]);
```

--------------------------------

### Override hashCode implementation

Source: https://pub.dev/documentation/genui/latest/genui/Parts/hashCode.html

Example of overriding the hashCode property using DeepCollectionEquality to represent object state.

```dart
@override
int get hashCode => const DeepCollectionEquality().hash(_parts);
```

--------------------------------

### bool get isUserAction

Source: https://pub.dev/documentation/genui/latest/genui/UiEvent/isUserAction.html

A getter that returns true if the event contains a 'name' key, identifying it as a UserActionEvent.

```APIDOC
## bool get isUserAction

### Description
Returns a boolean indicating whether the current UiEvent is a UserActionEvent. Since extension types are erased at runtime, this property checks for the existence of the 'name' key in the event's JSON representation to act as the discriminator.

### Signature
`bool get isUserAction`

### Returns
- **bool** - True if the event is a UserActionEvent, false otherwise.
```

--------------------------------

### SurfaceOperations(bool create, bool update, bool delete, bool dataModel)

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceOperations/SurfaceOperations.html

Initializes a new instance of SurfaceOperations. At least one of create, update, or delete must be set to true.

```APIDOC
## SurfaceOperations Constructor

### Description
Initializes the configuration for surface operations. Requires at least one of the primary CRUD operations to be enabled.

### Signature
SurfaceOperations({bool create = false, bool update = false, bool delete = false, bool dataModel = false})

### Parameters
- **create** (bool) - Optional - Enables create operations. Defaults to false.
- **update** (bool) - Optional - Enables update operations. Defaults to false.
- **delete** (bool) - Optional - Enables delete operations. Defaults to false.
- **dataModel** (bool) - Optional - Enables data model operations. Defaults to false.

### Assertions
- Throws an assertion error if create, update, and delete are all false.
```

--------------------------------

### systemPromptFragment()

Source: https://pub.dev/documentation/genui/latest/genui/TechnicalPossibilities-class.html

Generates the system prompt fragments corresponding to the enabled technical possibilities.

```APIDOC
## systemPromptFragment() -> Iterable<String>

### Description
Returns an iterable of strings representing the system prompt fragments based on the current configuration of the TechnicalPossibilities instance.
```

--------------------------------

### validateCatalogItemExamples(CatalogItem item, Catalog catalog)

Source: https://pub.dev/documentation/genui/latest/test

Validates the examples associated with a specific catalog item against the provided catalog.

```APIDOC
## validateCatalogItemExamples(CatalogItem item, Catalog catalog)

### Description
Validates the examples for a single catalog item.

### Parameters
- **item** (CatalogItem) - The catalog item to validate.
- **catalog** (Catalog) - The catalog context for validation.

### Returns
- **Future<List<ExampleValidationError>>** - A future that resolves to a list of validation errors found during the process.
```

--------------------------------

### Override operator == implementation

Source: https://pub.dev/documentation/genui/latest/genui/Parts/operator_equals.html

Example implementation of the equality operator using DeepCollectionEquality to compare internal state.

```dart
@override
bool operator ==(Object other) {
  if (identical(this, other)) return true;
  if (other.runtimeType != runtimeType) return false;
  const deepEquality = DeepCollectionEquality();
  return other is Parts && deepEquality.equals(other._parts, _parts);
}
```

--------------------------------

### asNoAssetCatalog

Source: https://pub.dev/documentation/genui/latest/genui/BasicCatalogItems/asNoAssetCatalog.html

Creates a basic catalog without items that require additional data, such as images, audio, or video.

```APIDOC
## asNoAssetCatalog

### Description
Creates a basic catalog without items that require additional data. This is useful for apps that do not work with images, audio, or video.

### Signature
`Catalog asNoAssetCatalog({List<String> systemPromptFragments = const []})`

### Parameters
- **systemPromptFragments** (List<String>) - Optional - A list of strings to be used as system prompt fragments.
```

--------------------------------

### A2UiClientCapabilities get clientCapabilities

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceController/clientCapabilities.html

Retrieves the A2UiClientCapabilities object which represents the capabilities of the client based on the currently managed catalogs.

```APIDOC
## Property: clientCapabilities

### Description
Evaluates and returns the client capabilities for the catalogs managed by the SurfaceController.

### Signature
`A2UiClientCapabilities get clientCapabilities`

### Returns
- **A2UiClientCapabilities** - An object containing the capabilities derived from the managed catalogs.
```

--------------------------------

### Implement buildWidget method

Source: https://pub.dev/documentation/genui/latest/genui/Catalog/buildWidget.html

Constructs a widget by looking up the type in the catalog and wrapping the result in a KeyedSubtree.

```dart
Widget buildWidget(CatalogItemContext itemContext) {
  final String widgetType = itemContext.type;
  final CatalogItem? item = items.firstWhereOrNull(
    (item) => item.name == widgetType,
  );
  if (item == null) {
    throw CatalogItemNotFoundException(widgetType, catalogId: catalogId);
  }

  genUiLogger.info('Building widget ${item.name} with id ${itemContext.id}');
  return KeyedSubtree(
    key: ValueKey(itemContext.id),
    child: item.widgetBuilder(
      CatalogItemContext(
        data: itemContext.data,
        id: itemContext.id,
        type: itemContext.type,
        buildChild: (String childId, [DataContext? childDataContext]) =>
            itemContext.buildChild(
              childId,
              childDataContext ?? itemContext.dataContext,
            ),
        dispatchEvent: itemContext.dispatchEvent,
        buildContext: itemContext.buildContext,
        dataContext: itemContext.dataContext,
        getComponent: itemContext.getComponent,
        getCatalogItem: (String type) =>
            items.firstWhereOrNull((item) => item.name == type),
        surfaceId: itemContext.surfaceId,
        reportError: itemContext.reportError,
      ),
    ),
  );
}
```

--------------------------------

### Initialize Surface instance

Source: https://pub.dev/documentation/genui/latest/genui/Surface/Surface.html

Creates a new Surface widget with the required surface context and optional configuration delegates.

```dart
const Surface({
  super.key,
  required this.surfaceContext,
  this.defaultBuilder,
  this.actionDelegate = const DefaultActionDelegate(),
});
```

--------------------------------

### Override hashCode implementation

Source: https://pub.dev/documentation/genui/latest/genui/Component/hashCode.html

Example of overriding the hashCode getter to include object properties, ensuring consistency with equality checks.

```dart
@override
int get hashCode =>
    Object.hash(id, type, const DeepCollectionEquality().hash(properties));
```

--------------------------------

### configureLogging

Source: https://pub.dev/documentation/genui/latest/genui

Configures the logging for the GenUI package.

```APIDOC
## configureLogging({Level level = Level.INFO, void logCallback(Level, String)?, bool enableHierarchicalLogging = true}) → Logger

### Description
Configures the logging for the GenUI package.
```

--------------------------------

### int get length

Source: https://pub.dev/documentation/genui/latest/genui/Parts/length.html

Retrieves the number of objects currently in the list. Valid indices range from 0 to length - 1.

```APIDOC
## int get length

### Description
Returns the number of objects in the list.

### Usage
```dart
final numbers = <int>[1, 2, 3];
print(numbers.length); // 3
```
```

--------------------------------

### A2UiClientCapabilities()

Source: https://pub.dev/documentation/genui/latest/genui/A2UiClientCapabilities/A2UiClientCapabilities.html

Creates a new instance of A2UiClientCapabilities with the specified supported catalog IDs and optional inline catalogs.

```APIDOC
## A2UiClientCapabilities()

### Description
Creates a new A2UiClientCapabilities instance to define the capabilities of the UI client.

### Parameters
- **supportedCatalogIds** (List<String>) - Required - A list of catalog identifiers supported by the client.
- **inlineCatalogs** (List<JsonMap>?) - Optional - A list of inline catalog definitions.
```

--------------------------------

### Implement Image CatalogItem

Source: https://pub.dev/documentation/genui/latest/genui/image.html

Defines the CatalogItem for the Image component, including its data schema, example data, and widget builder logic.

```dart
final CatalogItem image = CatalogItem(
  name: 'Image',
  dataSchema: _schema(),
  exampleData: [
    () => '''
    [
      {
        "id": "root",
        "component": "Image",
        "url": {
          "path": "/imageUrl"
        },
        "variant": "mediumFeature"
      }
    ]
  ''',
  ],
  widgetBuilder: (itemContext) {
    final imageData = _ImageData.fromMap(itemContext.data as JsonMap);

    return BoundString(
      dataContext: itemContext.dataContext,
      value: imageData.url,
      builder: (context, value) {
        if (value == null || value.isEmpty) {
          genUiLogger.warning(
            'Image widget created with no URL at path: '
            '${itemContext.dataContext.path}',
          );
          return const SizedBox.shrink();
        }

        Widget child;
        if (value.startsWith('http')) {
          child = Image.network(
            value,
            fit: imageData.fit,
            frameBuilder:
                (
                  BuildContext context,
                  Widget child,
                  int? frame,
                  bool wasSynchronouslyLoaded,
                ) {
                  if (wasSynchronouslyLoaded) {
                    return child;
                  }
                  return AnimatedOpacity(
                    opacity: frame == null ? 0 : 1,
                    duration: const Duration(seconds: 1),
                    curve: Curves.easeOut,
                    child: child,
                  );
                },
            loadingBuilder:
                (
                  BuildContext context,
                  Widget child,
                  ImageChunkEvent? loadingProgress,
                ) {
                  if (loadingProgress == null) {
                    return child;
                  }
                  return Center(
                    child: CircularProgressIndicator(
                      value: loadingProgress.expectedTotalBytes != null
                          ? loadingProgress.cumulativeBytesLoaded /
                                loadingProgress.expectedTotalBytes!
                          : null,
                    ),
                  );
                },
            errorBuilder:
                (BuildContext context, Object error, StackTrace? stackTrace) {
                  return const Icon(Icons.broken_image);
                },
          );
        } else {
          child = Image.asset(
            value,
            fit: imageData.fit,
            frameBuilder:
                (
                  BuildContext context,
                  Widget child,
                  int? frame,
                  bool wasSynchronouslyLoaded,
                ) {
                  if (wasSynchronouslyLoaded) {
                    return child;
                  }
                  return AnimatedOpacity(
                    opacity: frame == null ? 0 : 1,
                    duration: const Duration(seconds: 1),
                    curve: Curves.easeOut,
                    child: child,
                  );
                },
            errorBuilder:
                (BuildContext context, Object error, StackTrace? stackTrace) {
                  return const Icon(Icons.broken_image);
                },
          );
        }

        if (imageData.variant == 'avatar') {
          child = CircleAvatar(child: child);
        }

        if (imageData.variant == 'header') {
          return SizedBox(width: double.infinity, child: child);
        }

        final double size = switch (imageData.variant) {
          'icon' || 'avatar' => 32.0,
          'smallFeature' => 50.0,
          'mediumFeature' => 150.0,
          'largeFeature' => 400.0,
          _ => 150.0,
        };

        return SizedBox(width: size, height: size, child: child);
      },
    );
  },
);
```

--------------------------------

### BasicFunctions.all

Source: https://pub.dev/documentation/genui/latest/genui/BasicFunctions-class.html

Retrieves a list of all available basic client-side functions.

```APIDOC
## Static Property: all

### Description
Returns a list of all basic functions available in the collection.

### Signature
`static List<ClientFunction> get all`

### Returns
- **List<ClientFunction>** - A list containing all registered client-side functions.
```

--------------------------------

### PromptBuilder.custom

Source: https://pub.dev/documentation/genui/latest/genui/PromptBuilder-class.html

Creates a custom prompt builder instance with specific surface operations and technical possibilities.

```APIDOC
## static PromptBuilder custom(Catalog catalog, SurfaceOperations allowedOperations, Iterable<String> systemPromptFragments, String importancePrefix, TechnicalPossibilities technicalPossibilities, JsonMap? clientDataModel)

### Description
Creates a custom prompt builder instance with defined allowed operations and technical constraints.

### Parameters
- **catalog** (Catalog) - Required - The catalog to use for the prompt.
- **allowedOperations** (SurfaceOperations) - Required - The operations allowed on the surface.
- **systemPromptFragments** (Iterable<String>) - Optional - Fragments to include in the system prompt.
- **importancePrefix** (String) - Optional - The prefix used for importance markers.
- **technicalPossibilities** (TechnicalPossibilities) - Optional - The technical possibilities allowed.
- **clientDataModel** (JsonMap) - Optional - Data model associated with the client.
```

--------------------------------

### Invalid StatefulWidget build pattern

Source: https://pub.dev/documentation/genui/latest/genui/BoundValueState/build.html

An example of an invalid pattern where closures capture the widget instance instead of the state, leading to stale data.

```dart
// (this is not valid Flutter code)
class MyButton extends StatefulWidgetX {
  MyButton({super.key, required this.color});

  final Color color;

  @override
  Widget build(BuildContext context, State state) {
    return SpecialWidget(
      handler: () { print('color: $color'); },
    );
  }
}
```

--------------------------------

### ChatMessage.system(String text, {List<StandardPart> parts, Map<String, Object?> metadata, FinishStatus? finishStatus})

Source: https://pub.dev/documentation/genui/latest/genui/ChatMessage/ChatMessage.system.html

Creates a new system message. If text is provided, it is converted to a TextPart and prepended to the parts list.

```APIDOC
## ChatMessage.system Constructor

### Description
Creates a system message. If `text` is not empty, it converts it to a `TextPart` and adds it as the first member of the `parts` list.

### Signature
`ChatMessage.system(String text, {List<StandardPart> parts = const [], Map<String, Object?> metadata = const {}, FinishStatus? finishStatus})`

### Parameters
- **text** (String) - Required - The primary text content of the system message.
- **parts** (List<StandardPart>) - Optional - A list of additional message parts. Defaults to an empty list.
- **metadata** (Map<String, Object?>) - Optional - A map of metadata associated with the message. Defaults to an empty map.
- **finishStatus** (FinishStatus?) - Optional - The completion status of the message.
```

--------------------------------

### Stream<String> get incomingText

Source: https://pub.dev/documentation/genui/latest/genui/Transport/incomingText.html

Accesses a stream of raw text chunks as they are received from the AI service. This is intended for handling streaming responses.

```APIDOC
## Stream<String> get incomingText

### Description
A stream of raw text chunks received from the AI service. This is typically used for "streaming" responses where the text is built up over time.

### Signature
`Stream<String> get incomingText`
```

--------------------------------

### SurfaceOperations.createAndUpdate

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceOperations/SurfaceOperations.createAndUpdate.html

Constructor for initializing SurfaceOperations with create and update capabilities enabled.

```APIDOC
## SurfaceOperations.createAndUpdate

### Signature
SurfaceOperations.createAndUpdate({required bool dataModel})

### Description
Initializes a new instance of SurfaceOperations with create and update operations enabled, while delete is disabled.

### Parameters
- **dataModel** (bool) - Required - The data model configuration for the operation.
```

--------------------------------

### Implementing didUpdateWidget in BoundValueState

Source: https://pub.dev/documentation/genui/latest/genui/BoundValueState/didUpdateWidget.html

Override didUpdateWidget to detect changes in widget properties and re-initialize internal state. Always call super.didUpdateWidget and ensure proper teardown and setup of dependencies.

```dart
@override
void didUpdateWidget(W oldWidget) {
  super.didUpdateWidget(oldWidget);
  if (widget.value != oldWidget.value ||
      widget.dataContext != oldWidget.dataContext) {
    _teardown();
    _setup();
  }
}
```

--------------------------------

### A2uiTransportAdapter Constructor

Source: https://pub.dev/documentation/genui/latest/genui/A2uiTransportAdapter-class.html

Creates a new instance of the A2uiTransportAdapter.

```APIDOC
## A2uiTransportAdapter({ManualSendCallback? onSend})

### Description
Creates a new A2uiTransportAdapter instance. Optionally accepts a callback to handle outgoing requests.

### Parameters
- **onSend** (ManualSendCallback?) - Optional - The callback to invoke when sendRequest is called.
```

--------------------------------

### Define and Implement TextField CatalogItem

Source: https://pub.dev/documentation/genui/latest/genui/textField.html

This snippet demonstrates the registration of a TextField component within the Catalog, including example data configurations and the widget builder logic for handling state and events.

```dart
final textField = CatalogItem(
  name: 'TextField',
  isImplicitlyFlexible: true,
  dataSchema: _schema,
  exampleData: [
    () => '''
      [
        {
          "id": "root",
          "component": "TextField",
          "value": "Hello World",
          "label": "Greeting"
        }
      ]
    ''',
    () => '''
      [
        {
          "id": "root",
          "component": "TextField",
          "value": "password123",
          "label": "Password",
          "textFieldType": "obscured"
        }
      ]
    ''',
  ],
  widgetBuilder: (itemContext) {
    final textFieldData = _TextFieldData.fromMap(itemContext.data as JsonMap);
    final Object? valueRef = textFieldData.value;
    final path = (valueRef is Map && valueRef.containsKey('path'))
        ? valueRef['path'] as String
        : '${itemContext.id}.value';
    return BoundString(
      dataContext: itemContext.dataContext,
      value: {'path': path},
      builder: (context, currentValue) {
        return BoundString(
          dataContext: itemContext.dataContext,
          value: textFieldData.label,
          builder: (context, label) {
            final String? effectiveValue =
                currentValue?.toString() ??
                (valueRef is String ? valueRef : null);

            return _TextField(
              initialValue: effectiveValue ?? '',
              label: label,
              checks: textFieldData.checks,
              context: itemContext.dataContext,
              textFieldType: textFieldData.variant,
              validationRegexp: textFieldData.validationRegexp,
              onChanged: (newValue) {
                if (textFieldData.variant == 'number') {
                  final num? numberValue = num.tryParse(newValue);
                  if (numberValue != null) {
                    itemContext.dataContext.update(DataPath(path), numberValue);
                    return;
                  }
                }
                itemContext.dataContext.update(DataPath(path), newValue);
              },
              onSubmitted: (newValue) async {
                final JsonMap? actionData = textFieldData.onSubmittedAction;
                if (actionData == null) {
                  return;
                }

                if (actionData.containsKey('event')) {
                  final eventMap = actionData['event'] as JsonMap;
                  final actionName = eventMap['name'] as String;
                  final contextDefinition = eventMap['context'] as JsonMap?;
                  final JsonMap resolvedContext = await resolveContext(
                    itemContext.dataContext,
                    contextDefinition,
                  );
                  itemContext.dispatchEvent(
                    UserActionEvent(
                      name: actionName,
                      sourceComponentId: itemContext.id,
                      context: resolvedContext,
                    ),
                  );
                } else if (actionData.containsKey('functionCall')) {
                  final funcMap = actionData['functionCall'] as JsonMap;
                  final callName = funcMap['call'] as String;
                  if (callName == 'closeModal') {
                    if (itemContext.buildContext.mounted) {
                      Navigator.of(itemContext.buildContext).pop();
                    }
                    return;
                  }
                  final Stream<Object?> resultStream = itemContext.dataContext
                      .resolve(funcMap);
                  await resultStream.first;
                }
              },
            );
          },
        );
      },
    );
  },
);
```

--------------------------------

### TextPart constructor

Source: https://pub.dev/documentation/genui/latest/genui/TextPart/TextPart.html

Initializes a new instance of the TextPart class with the provided text content.

```APIDOC
## TextPart constructor

### Description
Creates a new text part instance with the specified string content.

### Signature
const TextPart(String text)

### Parameters
- **text** (String) - Required - The text content to be stored in the part.
```

--------------------------------

### String get description

Source: https://pub.dev/documentation/genui/latest/genui/FormatStringFunction/description.html

Retrieves the human-readable description of the FormatStringFunction, detailing its capability to perform string interpolation using ${expression} syntax, including JSON Pointer paths and function calls.

```APIDOC
## Property: description

### Description
A human-readable description of what the function does and how to use it. It explains that the function performs string interpolation of data model values and other functions in the catalog functions list.

### Signature
`String get description`

### Details
The description specifies that the value string can contain interpolated expressions in the `${expression}` format. Supported expression types include:
- **JSON Pointer paths**: (e.g., `${/absolute/path}` or `${relative/path}`)
- **Client-side function calls**: (e.g., `${now()}`)

Function arguments must be named (e.g., `${formatDate(value:${/currentDate}, format:'MM-dd')}`). To include a literal `${` sequence, it must be escaped as `\${`.
```

--------------------------------

### Initialize SurfaceController

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceController/SurfaceController.html

Constructor for SurfaceController requiring a list of catalogs and an optional timeout duration.

```dart
SurfaceController({
  required this.catalogs,
  this.pendingUpdateTimeout = const Duration(minutes: 1),
}) {
  _processor = core.MessageProcessor<core.ComponentApi>(
    catalogs: catalogs.map(coreCatalogFor).toList(),
  );
  _processor.groupModel.onSurfaceCreated.addListener(_onCoreSurfaceCreated);
  _processor.groupModel.onSurfaceDeleted.addListener(_onCoreSurfaceDeleted);
}
```

--------------------------------

### SurfaceOperations.all(required bool dataModel)

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceOperations/SurfaceOperations.all.html

Initializes a new instance of SurfaceOperations with create, update, and delete operations enabled.

```APIDOC
## SurfaceOperations.all

### Description
Initializes the SurfaceOperations class with default create, update, and delete permissions enabled based on the provided data model configuration.

### Signature
SurfaceOperations.all({required bool dataModel})

### Parameters
- **dataModel** (bool) - Required - A boolean value indicating the data model configuration for the surface operations.
```

--------------------------------

### SurfaceController constructor

Source: https://pub.dev/documentation/genui/latest/genui/SurfaceController/SurfaceController.html

Initializes a new instance of the SurfaceController with the required catalogs and an optional timeout for pending updates.

```APIDOC
## SurfaceController constructor

### Description
Initializes a new SurfaceController instance. This controller sets up the message processor and listeners for surface creation and deletion events.

### Signature
SurfaceController({required Iterable<Catalog> catalogs, Duration pendingUpdateTimeout = const Duration(minutes: 1)})

### Parameters
- **catalogs** (Iterable<Catalog>) - Required - A collection of catalogs used to configure the message processor.
- **pendingUpdateTimeout** (Duration) - Optional - The duration to wait for pending updates before timing out. Defaults to 1 minute.
```

--------------------------------

### Initialize ExpressionParser

Source: https://pub.dev/documentation/genui/latest/genui/ExpressionParser/ExpressionParser.html

Instantiate the parser by providing the required ExecutionContext.

```dart
ExpressionParser(this.context);
```

--------------------------------

### Implementation of A2UiClientCapabilities.fromCatalogs

Source: https://pub.dev/documentation/genui/latest/genui/A2UiClientCapabilities/A2UiClientCapabilities.fromCatalogs.html

The factory implementation processes catalogs to extract supported IDs or inline definitions based on the inlineHandling parameter.

```dart
factory A2UiClientCapabilities.fromCatalogs(
  Iterable<Catalog> catalogs, {
  InlineCatalogHandling inlineHandling = InlineCatalogHandling.missingIds,
}) {
  final supportedIds = <String>[];
  final inlineDefinitions = <JsonMap>[];

  for (final catalog in catalogs) {
    if (inlineHandling == InlineCatalogHandling.all) {
      inlineDefinitions.add(catalog.toCapabilitiesJson());
      continue;
    }

    if (catalog.catalogId != null) {
      supportedIds.add(catalog.catalogId!);
    } else {
      if (inlineHandling == InlineCatalogHandling.none) {
        throw StateError(
          'Catalog provided without a catalogId, but '
          'inlineHandling is set to InlineCatalogHandling.none',
        );
      }
      inlineDefinitions.add(catalog.toCapabilitiesJson());
    }
  }

  return A2UiClientCapabilities(
    supportedCatalogIds: supportedIds,
    inlineCatalogs: inlineDefinitions.isNotEmpty ? inlineDefinitions : null,
  );
}
```

--------------------------------

### Initialize DataPart

Source: https://pub.dev/documentation/genui/latest/genui/DataPart/DataPart.html

Creates a new DataPart instance. If no name is provided, it defaults to a name derived from the MIME type.

```dart
DataPart(this.bytes, {required this.mimeType, String? name})
  : name = name ?? nameFromMimeType(mimeType);
```

--------------------------------

### DataPart constructor

Source: https://pub.dev/documentation/genui/latest/genui/DataPart/DataPart.html

Initializes a new instance of the DataPart class with the provided byte data, MIME type, and optional name.

```APIDOC
## DataPart constructor

### Description
Creates a new data part instance. If the name is not provided, it is automatically derived from the MIME type.

### Signature
DataPart(Uint8List bytes, {required String mimeType, String? name})

### Parameters
- **bytes** (Uint8List) - Required - The raw byte data for the part.
- **mimeType** (String) - Required - The MIME type of the data.
- **name** (String?) - Optional - The name of the data part. Defaults to a name derived from the MIME type if not provided.
```

--------------------------------

### OpenUrlFunction.executeSync

Source: https://pub.dev/documentation/genui/latest/genui/OpenUrlFunction-class.html

Executes the URL opening function synchronously.

```APIDOC
## executeSync(JsonMap args, ExecutionContext _)

### Description
Executes the function synchronously to open a URL.

### Parameters
- **args** (JsonMap) - The arguments required for the function.
- **_** (ExecutionContext) - The execution context for the function call.

### Returns
- **Object?** - The result of the execution.
```

--------------------------------

### Implementation of explainMessages

Source: https://pub.dev/documentation/genui/latest/genui/ProtocolMessages/explainMessages.html

This method maps over a set of ProtocolMessages to construct a formatted string containing names, explanations, and properties.

```dart
static String explainMessages(Set<ProtocolMessages> operations) {
  final String names = operations.map((e) => e.tickedName).join(', ');
  final String explanations = operations
      .map((e) => '- ${e.tickedName}: ${e.explanation.trim()}')
      .join('\n');
  final String properties = operations
      .map((e) => '- ${e.tickedName}: ${e.properties.trim()}')
      .join('\n');

  return '''
Supported messages are: $names.

$explanations

Properties:

$properties

''';
}
```

--------------------------------

### Component Constructors

Source: https://pub.dev/documentation/genui/latest/genui/Component-class.html

Methods to instantiate a new Component object.

```APIDOC
## Component Constructors

### Component({required String id, required String type, required JsonMap properties})
Creates a new Component instance.

### Component.fromCore(ComponentModel component)
Creates a snapshot from a live core component model.

### Component.fromJson(JsonMap json)
Creates a Component from a JSON map.
```

--------------------------------

### Retrieve all basic functions

Source: https://pub.dev/documentation/genui/latest/genui/BasicFunctions/all.html

Access the static list of all available ClientFunction instances.

```dart
static List<ClientFunction> get all => [
  requiredFunction,
  regexFunction,
  lengthFunction,
  numericFunction,
  emailFunction,
  formatStringFunction,
  openUrlFunction,
  formatNumberFunction,
  formatCurrencyFunction,
  formatDateFunction,
  pluralizeFunction,
  andFunction,
  orFunction,
  notFunction,
];
```

--------------------------------

### Initialize CatalogItemContext

Source: https://pub.dev/documentation/genui/latest/genui/CatalogItemContext/CatalogItemContext.html

Constructor definition requiring all necessary context parameters for widget building.

```dart
CatalogItemContext({
  required this.data,
  required this.id,
  required this.type,
  required this.buildChild,
  required this.dispatchEvent,
  required this.buildContext,
  required this.dataContext,
  required this.getComponent,
  required this.getCatalogItem,
  required this.surfaceId,
  required this.reportError,
});
```

--------------------------------

### Part()

Source: https://pub.dev/documentation/genui/latest/genui/Part/Part.html

The Part constructor creates a new instance of a Part.

```APIDOC
## Part()

### Description
Creates a new part instance.

### Signature
`const Part()`
```
Tokens:
Raw