WebViewWidget class

Displays a native WebView as a Widget.

Platform-Specific Features

This class contains an underlying implementation provided by the current platform. Once a platform implementation is imported, the examples below can be followed to use features provided by a platform's implementation.

Below is an example of setting platform-specific creation parameters for iOS and Android:

final WebViewController controller = WebViewController();

PlatformWebViewWidgetCreationParams params =
    PlatformWebViewWidgetCreationParams(
  controller: controller.platform,
  layoutDirection: TextDirection.ltr,
  gestureRecognizers: const <Factory<OneSequenceGestureRecognizer>>{},
);

if (WebViewPlatform.instance is WebKitWebViewPlatform) {
  params = WebKitWebViewWidgetCreationParams
      .fromPlatformWebViewWidgetCreationParams(
    params,
  );
} else if (WebViewPlatform.instance is AndroidWebViewPlatform) {
  params = AndroidWebViewWidgetCreationParams
      .fromPlatformWebViewWidgetCreationParams(
    params,
  );
}

final WebViewWidget webViewWidget =
    WebViewWidget.fromPlatformCreationParams(
  params: params,
);

Below is an example of accessing the platform-specific implementation for iOS and Android:

final WebViewController controller = WebViewController();

final WebViewWidget webViewWidget = WebViewWidget(controller: controller);

if (WebViewPlatform.instance is WebKitWebViewPlatform) {
  final WebKitWebViewWidget webKitWidget =
      webViewWidget.platform as WebKitWebViewWidget;
} else if (WebViewPlatform.instance is AndroidWebViewPlatform) {
  final AndroidWebViewWidget androidWidget =
      webViewWidget.platform as AndroidWebViewWidget;
}

Inheritance

Available extensions

WidgetsExtension

Constructors

WebViewWidget({Key? key, required WebViewController controller, TextDirection layoutDirection = TextDirection.ltr, Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers = const <Factory<OneSequenceGestureRecognizer>>{}}): Constructs a WebViewWidget.
WebViewWidget.fromPlatform({Key? key, required PlatformWebViewWidget platform}): Constructs a WebViewWidget from a specific platform implementation.
WebViewWidget.fromPlatformCreationParams({Key? key, required PlatformWebViewWidgetCreationParams params}): Constructs a WebViewWidget from creation params for a specific platform.

Properties

gestureRecognizers → Set<Factory<OneSequenceGestureRecognizer>>: Specifies which gestures should be consumed by the web view.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
layoutDirection → TextDirection: The layout direction to use for the embedded WebView.
latefinal
platform → PlatformWebViewWidget: Implementation of PlatformWebViewWidget for the current platform.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

alignAtBottomCenter({Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
alignAtBottomLeft({Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
alignAtBottomRight({Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
alignAtCenter({Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
alignAtCenterLeft({Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
alignAtCenterRight({Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
alignAtLERP(Alignment a, Alignment b, double t, {Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
alignAtTopCenter({Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
alignAtTopLeft({Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
alignAtTopRight({Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
alignXY(double x, double y, {Key? key, double? heightFactor, double? widthFactor}) → Align: Available on Widget, provided by the WidgetsExtension extension
build(BuildContext context) → Widget: Describes the part of the user interface represented by this widget.
override
card({Color? backgroundColor, double? elevation, EdgeInsetsGeometry? margin}) → Widget: Available on Widget, provided by the WidgetsExtension extension
chip({required Color backgroundColor, double? width, double? height, Alignment? alignment, double borderWidth = 1, double radius = 12, Color borderColor = Colors.transparent, EdgeInsets padding = const EdgeInsets.symmetric(horizontal: 8, vertical: 6), EdgeInsetsGeometry? margin, BoxConstraints? constraints}) → Widget: Available on Widget, provided by the WidgetsExtension extension
container({double? width, double? height, Alignment? alignment, Color? backgroundColor, double borderWidth = 1, double radius = 1, Color borderColor = Colors.transparent, EdgeInsetsGeometry? padding, EdgeInsetsGeometry? margin, BoxConstraints? constraints}) → Widget: Available on Widget, provided by the WidgetsExtension extension
createElement() → StatelessElement: Creates a StatelessElement to manage this widget's location in the tree.
inherited
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
expanded({int flex = 1}) → Widget: Available on Widget, provided by the WidgetsExtension extension
fadeSlideIn({int milliseconds = 1000, double offset = 24}) → Widget: Available on Widget, provided by the WidgetsExtension extension
fit({Alignment alignment = Alignment.center}) → Widget: Available on Widget, provided by the WidgetsExtension extension
form(GlobalKey<FormState> key) → Widget: Available on Widget, provided by the WidgetsExtension extension
ltr() → Widget: Available on Widget, provided by the WidgetsExtension extension
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
onDoubleTap(GestureTapCallback? onPressed) → Widget: Available on Widget, provided by the WidgetsExtension extension
onLongPress(GestureTapCallback? onPressed) → Widget: Available on Widget, provided by the WidgetsExtension extension
onPress(VoidCallback onTap, {double pressedScale = 0.9, Duration duration = const Duration(milliseconds: 120)}) → Widget: Available on Widget, provided by the WidgetsExtension extension
onTap(GestureTapCallback? onPressed) → Widget: Available on Widget, provided by the WidgetsExtension extension
onTapInk(GestureTapCallback? onPressed) → Widget: Available on Widget, provided by the WidgetsExtension extension
pAll(double padding) → Widget: Available on Widget, provided by the WidgetsExtension extension
pLTRB(double left, double top, double right, double bottom) → Widget: Available on Widget, provided by the WidgetsExtension extension
pOnly({double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0}) → Widget: Available on Widget, provided by the WidgetsExtension extension
position({double? left, double? top, double? right, double? bottom, double? width, double? height}) → Widget: Available on Widget, provided by the WidgetsExtension extension
pSymmetric({double horizontal = 0.0, double vertical = 0.0}) → Widget: Available on Widget, provided by the WidgetsExtension extension
rotate(double scale) → Widget: Available on Widget, provided by the WidgetsExtension extension
rtl() → Widget: Available on Widget, provided by the WidgetsExtension extension
safeArea() → Widget: Available on Widget, provided by the WidgetsExtension extension
scale(double scale) → Widget: Available on Widget, provided by the WidgetsExtension extension
scrollable({Axis scrollDirection = Axis.vertical}) → Widget: Available on Widget, provided by the WidgetsExtension extension
showMenus(List<PopupMenuEntry<int>> items) → Widget: Available on Widget, provided by the WidgetsExtension extension
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
translate(Offset offset) → Widget: Available on Widget, provided by the WidgetsExtension extension

Operators

operator ==(Object other) → bool: The equality operator.
inherited