UiKitView class

Embeds an iOS view in the Widget hierarchy.

Embedding UIViews is still in release preview, to enable the preview for an iOS app add a boolean field with the key 'io.flutter.embedded_views_preview' and the value set to 'YES' to the application's Info.plist file. A list of open issued with embedding UIViews is available on Github

Embedding iOS views is an expensive operation and should be avoided when a Flutter equivalent is possible.

The widget fills all available space, the parent of this object must provide bounded layout constraints.

The widget participates in Flutter's GestureArenas, and dispatches touch events to the platform view iff it won the arena. Specific gestures that should be dispatched to the platform view can be specified in the gestureRecognizers constructor parameter. If the set of gesture recognizers is empty, a gesture will be dispatched to the platform view iff it was not claimed by any other gesture recognizer.

The platform view's lifetime is the same as the lifetime of the State object for this widget. When the State is disposed the platform view (and auxiliary resources) are lazily released (some resources are immediately released and some by platform garbage collector). A stateful widget's state is disposed when the widget is removed from the tree or when it is moved within the tree. If the stateful widget has a key and it's only moved relative to its siblings, or it has a GlobalKey and it's moved within the tree, it will not be disposed.

Construction of UIViews is done asynchronously, before the UIView is ready this widget paints nothing while maintaining the same layout constraints.

If a conic path clipping is applied to a UIKitView, a quad path is used to approximate the clip due to limitation of Quartz.

Inheritance

Constructors

UiKitView({Key key, @required String viewType, PlatformViewCreatedCallback onPlatformViewCreated, PlatformViewHitTestBehavior hitTestBehavior: PlatformViewHitTestBehavior.opaque, TextDirection layoutDirection, dynamic creationParams, MessageCodec creationParamsCodec, Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers })
Creates a widget that embeds an iOS view. [...]
const

Properties

creationParams → dynamic
Passed as the arguments argument of -[FlutterPlatformViewFactory createWithFrame:viewIdentifier:arguments:] [...]
final
creationParamsCodec MessageCodec
The codec used to encode creationParams before sending it to the platform side. It should match the codec returned by -[FlutterPlatformViewFactory createArgsCodec:] [...]
final
gestureRecognizers Set<Factory<OneSequenceGestureRecognizer>>
Which gestures should be forwarded to the UIKit view. [...]
final
hitTestBehavior PlatformViewHitTestBehavior
How this widget should behave during hit testing. [...]
final
layoutDirection TextDirection
The text direction to use for the embedded view. [...]
final
onPlatformViewCreated PlatformViewCreatedCallback
Callback to invoke after the platform view has been created. [...]
final
viewType String
The unique identifier for iOS view type to be embedded by this widget. [...]
final
hashCode int
The hash code for this object. [...]
read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

createState() State<UiKitView>
Creates the mutable state for this widget at a given location in the tree. [...]
override
createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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.debug }) String
Returns a string representation of this object.
inherited
toStringDeep({String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug }) 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 ==(dynamic other) bool
The equality operator. [...]
inherited