Cross-platform options

This list is generated from the InAppWebViewOptions API Reference.

  • allowFileAccessFromFileURLs: Sets whether cross-origin requests in the context of a file scheme URL should be allowed to access content from other file scheme URLs. Note that some accesses such as image HTML elements don't follow same-origin rules and aren't affected by this setting. (READ MORE)
  • allowUniversalAccessFromFileURLs: Sets whether cross-origin requests in the context of a file scheme URL should be allowed to access content from any origin. This includes access to content from other file scheme URLs or web contexts. Note that some access such as image HTML elements doesn't follow same-origin rules and isn't affected by this setting. (READ MORE)
  • applicationNameForUserAgent: Append to the existing user-agent. Setting userAgent will override this. (READ MORE)
  • cacheEnabled: Sets whether WebView should use browser caching. The default value is true. (READ MORE)
  • clearCache: Set to true to have all the browser's cache cleared before the new WebView is opened. The default value is false. (READ MORE)
  • contentBlockers: List of ContentBlocker that are a set of rules used to block content in the browser window. (READ MORE)
  • disableContextMenu: Set to true to disable context menu. The default value is false. (READ MORE)
  • disableHorizontalScroll: Set to true to disable horizontal scroll. The default value is false. (READ MORE)
  • disableVerticalScroll: Set to true to disable vertical scroll. The default value is false. (READ MORE)
  • horizontalScrollBarEnabled: Define whether the horizontal scrollbar should be drawn or not. The default value is true. (READ MORE)
  • incognito: Set to true to open a browser window with incognito mode. The default value is false. (READ MORE)
  • javaScriptCanOpenWindowsAutomatically: Set to true to allow JavaScript open windows without user interaction. The default value is false. (READ MORE)
  • javaScriptEnabled: Set to true to enable JavaScript. The default value is true. (READ MORE)
  • mediaPlaybackRequiresUserGesture: Set to true to prevent HTML5 audio or video from autoplaying. The default value is true. (READ MORE)
  • minimumFontSize: Sets the minimum font size. The default value is 8 for Android, 0 for iOS. (READ MORE)
  • preferredContentMode: Sets the content mode that the WebView needs to use when loading and rendering a webpage. The default value is UserPreferredContentMode.RECOMMENDED. (READ MORE)
  • resourceCustomSchemes: List of custom schemes that the WebView must handle. Use the WebView.onLoadResourceCustomScheme event to intercept resource requests with custom scheme. (READ MORE)
  • supportZoom: Set to false if the WebView should not support zooming using its on-screen zoom controls and gestures. The default value is true. (READ MORE)
  • transparentBackground: Set to true to make the background of the WebView transparent. If your app has a dark theme, this can prevent a white flash on initialization. The default value is false. (READ MORE)
  • useOnDownloadStart: Set to true to be able to listen at the WebView.onDownloadStart event. The default value is false. (READ MORE)
  • useOnLoadResource: Set to true to be able to listen at the WebView.onLoadResource event. The default value is false. (READ MORE)
  • userAgent: Sets the user-agent for the WebView. (READ MORE)
  • useShouldInterceptAjaxRequest: Set to true to be able to listen at the WebView.shouldInterceptAjaxRequest event. The default value is false. (READ MORE)
  • useShouldInterceptFetchRequest: Set to true to be able to listen at the WebView.shouldInterceptFetchRequest event. The default value is false. (READ MORE)
  • useShouldOverrideUrlLoading: Set to true to be able to listen at the WebView.shouldOverrideUrlLoading event. The default value is false. (READ MORE)
  • verticalScrollBarEnabled: Define whether the vertical scrollbar should be drawn or not. The default value is true. (READ MORE)

Android-specific options

This list is generated from the AndroidInAppWebViewOptions API Reference.

  • allowContentAccess: Enables or disables content URL access within WebView. Content URL access allows WebView to load content from a content provider installed in the system. The default value is true. (READ MORE)
  • allowFileAccess: Enables or disables file access within WebView. Note that this enables or disables file system access only. Assets and resources are still accessible using file:///android_asset and file:///android_res. The default value is true. (READ MORE)
  • appCachePath: Sets the path to the Application Caches files. In order for the Application Caches API to be enabled, this option must be set a path to which the application can write. This option is used one time: repeated calls are ignored. (READ MORE)
  • blockNetworkImage: Sets whether the WebView should not load image resources from the network (resources accessed via http and https URI schemes). The default value is false. (READ MORE)
  • blockNetworkLoads: Sets whether the WebView should not load resources from the network. The default value is false. (READ MORE)
  • builtInZoomControls: Set to true if the WebView should use its built-in zoom mechanisms. The default value is true. (READ MORE)
  • cacheMode: Overrides the way the cache is used. The way the cache is used is based on the navigation type. For a normal page load, the cache is checked and content is re-validated as needed. When navigating back, content is not revalidated, instead the content is just retrieved from the cache. The default value is AndroidCacheMode.LOAD_DEFAULT. (READ MORE)
  • clearSessionCache: Set to true to have the session cookie cache cleared before the new window is opened. (READ MORE)
  • cursiveFontFamily: Sets the cursive font family name. The default value is "cursive". (READ MORE)
  • databaseEnabled: Set to true if you want the database storage API is enabled. The default value is true. (READ MORE)
  • defaultFixedFontSize: Sets the default fixed font size. The default value is 16. (READ MORE)
  • defaultFontSize: Sets the default font size. The default value is 16. (READ MORE)
  • defaultTextEncodingName: Sets the default text encoding name to use when decoding html pages. The default value is "UTF-8". (READ MORE)
  • disabledActionModeMenuItems: Disables the action mode menu items according to menuItems flag. (READ MORE)
  • disableDefaultErrorPage: Sets whether the default Android error page should be disabled. The default value is false. (READ MORE)
  • displayZoomControls: Set to true if the WebView should display on-screen zoom controls when using the built-in zoom mechanisms. The default value is false. (READ MORE)
  • domStorageEnabled: Set to true if you want the DOM storage API is enabled. The default value is true. (READ MORE)
  • fantasyFontFamily: Sets the fantasy font family name. The default value is "fantasy". (READ MORE)
  • fixedFontFamily: Sets the fixed font family name. The default value is "monospace". (READ MORE)
  • forceDark: Set the force dark mode for this WebView. The default value is AndroidForceDark.FORCE_DARK_OFF. (READ MORE)
  • geolocationEnabled: Sets whether Geolocation API is enabled. The default value is true. (READ MORE)
  • hardwareAcceleration: Boolean value to enable Hardware Acceleration in the WebView. The default value is true. (READ MORE)
  • horizontalScrollbarThumbColor: Sets the horizontal scrollbar thumb color. (READ MORE)
  • horizontalScrollbarTrackColor: Sets the horizontal scrollbar track color. (READ MORE)
  • initialScale: Sets the initial scale for this WebView. 0 means default. The behavior for the default scale depends on the state of useWideViewPort and loadWithOverviewMode. If the content fits into the WebView control by width, then the zoom is set to 100%. For wide content, the behavior depends on the state of loadWithOverviewMode. If its value is true, the content will be zoomed out to be fit by width into the WebView control, otherwise not. If initial scale is greater than 0, WebView starts with this value as initial scale. Please note that unlike the scale properties in the viewport meta tag, this method doesn't take the screen density into account. The default is 0. (READ MORE)
  • layoutAlgorithm: Sets the underlying layout algorithm. This will cause a re-layout of the WebView. (READ MORE)
  • loadsImagesAutomatically: Sets whether the WebView should load image resources. Note that this method controls loading of all images, including those embedded using the data URI scheme. Note that if the value of this setting is changed from false to true, all images resources referenced by content currently displayed by the WebView are loaded automatically. The default value is true. (READ MORE)
  • loadWithOverviewMode: Sets whether the WebView loads pages in overview mode, that is, zooms out the content to fit on screen by width. This setting is taken into account when the content width is greater than the width of the WebView control, for example, when useWideViewPort is enabled. The default value is false. (READ MORE)
  • minimumLogicalFontSize: Sets the minimum logical font size. The default is 8. (READ MORE)
  • mixedContentMode: Configures the WebView's behavior when a secure origin attempts to load a resource from an insecure origin. (READ MORE)
  • needInitialFocus: Tells the WebView whether it needs to set a node. The default value is true. (READ MORE)
  • networkAvailable: Informs WebView of the network state. This is used to set the JavaScript property window.navigator.isOnline and generates the online/offline event as specified in HTML5, sec. 5.7.7. (READ MORE)
  • offscreenPreRaster: Sets whether this WebView should raster tiles when it is offscreen but attached to a window. Turning this on can avoid rendering artifacts when animating an offscreen WebView on-screen. Offscreen WebViews in this mode use more memory. The default value is false. (READ MORE)
  • overScrollMode: Sets the WebView's over-scroll mode. Setting the over-scroll mode of a WebView will have an effect only if the WebView is capable of scrolling. The default value is AndroidOverScrollMode.OVER_SCROLL_IF_CONTENT_SCROLLS. (READ MORE)
  • regexToCancelSubFramesLoading: Regular expression used by WebView.shouldOverrideUrlLoading event to cancel navigation requests for frames that are not the main frame. If the url request of a subframe matches the regular expression, then the request of that subframe is canceled. (READ MORE)
  • rendererPriorityPolicy: Sets the renderer priority policy for this WebView. (READ MORE)
  • safeBrowsingEnabled: Sets whether Safe Browsing is enabled. Safe Browsing allows WebView to protect against malware and phishing attacks by verifying the links. Safe Browsing is enabled by default for devices which support it. (READ MORE)
  • sansSerifFontFamily: Sets the sans-serif font family name. The default value is "sans-serif". (READ MORE)
  • saveFormData: Sets whether the WebView should save form data. In Android O, the platform has implemented a fully functional Autofill feature to store form data. Therefore, the Webview form data save feature is disabled. Note that the feature will continue to be supported on older versions of Android as before. The default value is true. (READ MORE)
  • scrollBarDefaultDelayBeforeFade: Defines the delay in milliseconds that a scrollbar waits before fade out. (READ MORE)
  • scrollBarFadeDuration: Defines the scrollbar fade duration in milliseconds. (READ MORE)
  • scrollbarFadingEnabled: Defines whether scrollbars will fade when the view is not scrolling. The default value is true. (READ MORE)
  • scrollBarStyle: Specifies the style of the scrollbars. The scrollbars can be overlaid or inset. When inset, they add to the padding of the view. And the scrollbars can be drawn inside the padding area or on the edge of the view. For example, if a view has a background drawable and you want to draw the scrollbars inside the padding specified by the drawable, you can use SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to appear at the edge of the view, ignoring the padding, then you can use SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. The default value is AndroidScrollBarStyle.SCROLLBARS_INSIDE_OVERLAY. (READ MORE)
  • serifFontFamily: Sets the serif font family name. The default value is "sans-serif". (READ MORE)
  • standardFontFamily: Sets the standard font family name. The default value is "sans-serif". (READ MORE)
  • supportMultipleWindows: Sets whether the WebView supports multiple windows. If set to true, WebView.onCreateWindow event must be implemented by the host application. The default value is false. (READ MORE)
  • textZoom: Sets the text zoom of the page in percent. The default value is 100. (READ MORE)
  • thirdPartyCookiesEnabled: Boolean value to enable third party cookies in the WebView. Used on Android Lollipop and above only as third party cookies are enabled by default on Android Kitkat and below and on iOS. The default value is true. (READ MORE)
  • useHybridComposition: Set to true to enable Flutter's new Hybrid Composition. The default value is false. Hybrid Composition is supported starting with Flutter v1.20+. (READ MORE)
  • useOnRenderProcessGone: Set to true to be able to listen at the WebView.androidOnRenderProcessGone event. The default value is false. (READ MORE)
  • useShouldInterceptRequest: Set to true to be able to listen at the WebView.androidShouldInterceptRequest event. The default value is false. (READ MORE)
  • useWideViewPort: Set to true if the WebView should enable support for the "viewport" HTML meta tag or should use a wide viewport. When the value of the setting is false, the layout width is always set to the width of the WebView control in device-independent (CSS) pixels. When the value is true and the page contains the viewport meta tag, the value of the width specified in the tag is used. If the page does not contain the tag or does not provide a width, then a wide viewport will be used. The default value is true. (READ MORE)
  • verticalScrollbarPosition: Sets the position of the vertical scroll bar. The default value is AndroidVerticalScrollbarPosition.SCROLLBAR_POSITION_DEFAULT. (READ MORE)
  • verticalScrollbarThumbColor: Sets the vertical scrollbar thumb color. (READ MORE)
  • verticalScrollbarTrackColor: Sets the vertical scrollbar track color. (READ MORE)

iOS-specific options

This list is generated from the IOSInAppWebViewOptions API Reference.

  • accessibilityIgnoresInvertColors: A Boolean value indicating whether the WebView ignores an accessibility request to invert its colors. The default value is false. (READ MORE)
  • allowingReadAccessTo: Used in combination with WebView.initialUrlRequest or WebView.initialData (using the file:// scheme), it represents the URL from which to read the web content. This URL must be a file-based URL (using the file:// scheme). Specify the same value as the URLRequest.url if you are using it with the WebView.initialUrlRequest parameter or the InAppWebViewInitialData.baseUrl if you are using it with the WebView.initialData parameter to prevent WebView from reading any other content. Specify a directory to give WebView permission to read additional files in the specified directory. (READ MORE)
  • allowsAirPlayForMediaPlayback: Set to true to allow AirPlay. The default value is true. (READ MORE)
  • allowsBackForwardNavigationGestures: Set to true to allow the horizontal swipe gestures trigger back-forward list navigations. The default value is true. (READ MORE)
  • allowsInlineMediaPlayback: Set to true to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the webkit-playsinline attribute to any <video> elements. The default value is false. (READ MORE)
  • allowsLinkPreview: Set to true to allow that pressing on a link displays a preview of the destination for the link. The default value is true. (READ MORE)
  • allowsPictureInPictureMediaPlayback: Set to true to allow HTML5 videos play picture-in-picture. The default value is true. (READ MORE)
  • alwaysBounceHorizontal: A Boolean value that determines whether bouncing always occurs when horizontal scrolling reaches the end of the content view. If this property is set to true and IOSInAppWebViewOptions.disallowOverScroll is false, horizontal dragging is allowed even if the content is smaller than the bounds of the scroll view. The default value is false. (READ MORE)
  • alwaysBounceVertical: A Boolean value that determines whether bouncing always occurs when vertical scrolling reaches the end of the content. If this property is set to true and IOSInAppWebViewOptions.disallowOverScroll is false, vertical dragging is allowed even if the content is smaller than the bounds of the scroll view. The default value is false. (READ MORE)
  • applePayAPIEnabled: Set to true to enable Apple Pay API for the WebView at its first page load or on the next page load (using InAppWebViewController.setOptions). The default value is false. (READ MORE)
  • automaticallyAdjustsScrollIndicatorInsets: Configures whether the scroll indicator insets are automatically adjusted by the system. The default value is false. (READ MORE)
  • contentInsetAdjustmentBehavior: Configures how safe area insets are added to the adjusted content inset. The default value is IOSUIScrollViewContentInsetAdjustmentBehavior.NEVER. (READ MORE)
  • dataDetectorTypes: Specifying a dataDetectoryTypes value adds interactivity to web content that matches the value. For example, Safari adds a link to “apple.com” in the text “Visit apple.com” if the dataDetectorTypes property is set to IOSWKDataDetectorTypes.LINK. The default value is IOSWKDataDetectorTypes.NONE. (READ MORE)
  • decelerationRate: A IOSUIScrollViewDecelerationRate value that determines the rate of deceleration after the user lifts their finger. The default value is IOSUIScrollViewDecelerationRate.NORMAL. (READ MORE)
  • disableLongPressContextMenuOnLinks: Set to true to disable the context menu (copy, select, etc.) that is shown when the user emits a long press event on a HTML link. This is implemented using also JavaScript, so it must be enabled or it won't work. The default value is false. (READ MORE)
  • disallowOverScroll: Set to true to disable the bouncing of the WebView when the scrolling has reached an edge of the content. The default value is false. (READ MORE)
  • enableViewportScale: Set to true to allow a viewport meta tag to either disable or restrict the range of user scaling. The default value is false. (READ MORE)
  • ignoresViewportScaleLimits: Set to true if you want that the WebView should always allow scaling of the webpage, regardless of the author's intent. The ignoresViewportScaleLimits property overrides the user-scalable HTML property in a webpage. The default value is false. (READ MORE)
  • isDirectionalLockEnabled: A Boolean value that determines whether scrolling is disabled in a particular direction. If this property is false, scrolling is permitted in both horizontal and vertical directions. If this property is true and the user begins dragging in one general direction (horizontally or vertically), the scroll view disables scrolling in the other direction. If the drag direction is diagonal, then scrolling will not be locked and the user can drag in any direction until the drag completes. The default value is false. (READ MORE)
  • isFraudulentWebsiteWarningEnabled: A Boolean value indicating whether warnings should be shown for suspected fraudulent content such as phishing or malware. According to the official documentation, this feature is currently available in the following region: China. The default value is true. (READ MORE)
  • isPagingEnabled: A Boolean value that determines whether paging is enabled for the scroll view. If the value of this property is true, the scroll view stops on multiples of the scroll view’s bounds when the user scrolls. The default value is false. (READ MORE)
  • limitsNavigationsToAppBoundDomains: A Boolean value that indicates whether the web view limits navigation to pages within the app’s domain. Check App-Bound Domains for more details. The default value is false. (READ MORE)
  • maximumZoomScale: A floating-point value that specifies the maximum scale factor that can be applied to the scroll view's content. This value determines how large the content can be scaled. It must be greater than the minimum zoom scale for zooming to be enabled. The default value is 1.0. (READ MORE)
  • mediaType: The media type for the contents of the web view. When the value of this property is null, the web view derives the current media type from the CSS media property of its content. If you assign a value other than null to this property, the web view uses the value you provide instead. The default value of this property is null. (READ MORE)
  • minimumZoomScale: A floating-point value that specifies the minimum scale factor that can be applied to the scroll view's content. This value determines how small the content can be scaled. The default value is 1.0. (READ MORE)
  • pageZoom: The scale factor by which the web view scales content relative to its bounds. The default value of this property is 1.0, which displays the content without any scaling. Changing the value of this property is equivalent to setting the CSS zoom property on all page content. (READ MORE)
  • scrollsToTop: A Boolean value that controls whether the scroll-to-top gesture is enabled. The scroll-to-top gesture is a tap on the status bar. When a user makes this gesture, the system asks the scroll view closest to the status bar to scroll to the top. The default value is true. (READ MORE)
  • selectionGranularity: The level of granularity with which the user can interactively select content in the web view. The default value is IOSWKSelectionGranularity.DYNAMIC (READ MORE)
  • sharedCookiesEnabled: Set true if shared cookies from HTTPCookieStorage.shared should used for every load request in the WebView. The default value is false. (READ MORE)
  • suppressesIncrementalRendering: Set to true if you want the WebView suppresses content rendering until it is fully loaded into memory. The default value is false. (READ MORE)
  • useOnNavigationResponse: Set to true to be able to listen to the WebView.iosOnNavigationResponse event. The default value is false. (READ MORE)