NativeComponent class

Embeds a native SwiftUI / UIKit component (iOS only).

NativeComponent(
  type: NativeComponentType.glassButton,
  config: NativeComponentConfig(
    title: 'Continue',
    image: NativeImage.symbol('arrow.right'),
    style: NativeStyle(tintColor: Colors.teal, cornerRadius: 20),
  ),
  onEvent: (event) => debugPrint('$event'),
)

Changing config updates the native view in place, without recreating it.

Inheritance

Constructors

NativeComponent({Key? key, required NativeComponentType type, NativeComponentConfig config = const NativeComponentConfig(), ValueChanged<NativeEvent>? onEvent, ValueChanged<NativeComponentController>? onCreated, Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers, Widget? fallback})
Shows a built-in component.
NativeComponent.custom({Key? key, required String id, NativeComponentConfig config = const NativeComponentConfig(), ValueChanged<NativeEvent>? onEvent, ValueChanged<NativeComponentController>? onCreated, Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers, Widget? fallback})
Shows a component registered from Swift with NativeComponentRegistry.register(MyView.self).
const

Properties

componentId → String
Native identifier of the component.
final
config → NativeComponentConfig
Content and appearance; changes are applied to the native view live.
final
fallback → Widget?
Shown on platforms other than iOS.
final
gestureRecognizers → Set<Factory<OneSequenceGestureRecognizer>>?
Gestures the native view should win. Defaults to all gestures, which suits full-screen components; pass an empty set inside Flutter scroll views.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onCreated → ValueChanged<NativeComponentController>?
Called once the native view exists.
final
onEvent → ValueChanged<NativeEvent>?
Called for every event the native component emits.
final
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<NativeComponent>
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

Constants

viewType → const String
The platform view type registered by the plugin.