View configuration reference

NutrientViewConfiguration(opens in a new tab) is the new configuration API for Nutrient Flutter viewer widgets. It’s currently used by the NutrientInstantView(opens in a new tab) widget and will replace PdfConfiguration(opens in a new tab) as the standard configuration object going forward.

NutrientViewConfiguration(opens in a new tab) controls the viewer’s layout, user interface (UI) chrome, editing capabilities, and appearance. All fields are optional — unset fields fall through to the native SDK’s built-in defaults, so only set the values that differ from the defaults. Options that apply to all platforms are top-level fields; options specific to one platform are grouped under androidConfig(opens in a new tab), iosConfig(opens in a new tab), or webConfig(opens in a new tab).

NutrientInstantView(
  serverUrl: serverUrl,
  jwt: jwt,
  configuration: const NutrientViewConfiguration(
    pageLayoutMode: PageLayoutMode.single,
    thumbnailBarMode: ThumbnailBarMode.floating,
    enableAnnotationEditing: true,
    enableFormEditing: true,
    androidConfig: AndroidViewConfiguration(
      showSearchAction: true,
      showOutlineAction: true,
    ),
    iosConfig: IOSViewConfiguration(
      spreadFitting: SpreadFitting.adaptive,
    ),
  ),
)

Cross-platform fields

The following fields apply to Android, iOS, and Web unless otherwise noted.

Layout

PageTransition values

UI chrome

Editing

Zoom

These fields apply to iOS and Web. Android doesn’t expose zoom constraints through its configuration builder. See minimumZoomScale(opens in a new tab) and maximumZoomScale(opens in a new tab).

AndroidViewConfiguration

AndroidViewConfiguration(opens in a new tab) holds options that only apply to the Android platform. Pass it as NutrientViewConfiguration.androidConfig(opens in a new tab). It’s silently ignored on iOS and Web.

androidConfig: AndroidViewConfiguration(
  showSearchAction: true,
  showOutlineAction: true,
  showBookmarksAction: false,
  inlineSearch: true,
  enableDocumentEditor: false,
  darkThemeResource: 'MyApp_Dark',
  defaultThemeResource: 'MyApp_Light',
)

IOSViewConfiguration

IOSViewConfiguration(opens in a new tab) holds options that only apply to the iOS platform. Pass it as NutrientViewConfiguration.iosConfig(opens in a new tab). It’s silently ignored on Android and Web.

iosConfig: IOSViewConfiguration(
  spreadFitting: SpreadFitting.adaptive,
  leftBarButtonItems: ['closeButtonItem'],
  rightBarButtonItems: ['annotationButtonItem', 'searchButtonItem'],
)

Bar button item identifiers

WebViewConfiguration

WebViewConfiguration(opens in a new tab) holds options specific to the Web platform. It’s typed as Object? in the platform interface to avoid a circular package dependency — import it from package:nutrient_flutter and pass it as webConfig(opens in a new tab). Common options include showToolbar(opens in a new tab), showAnnotations(opens in a new tab), readOnly(opens in a new tab), and theme(opens in a new tab).

import 'package:nutrient_flutter/nutrient_flutter.dart';

NutrientViewConfiguration(
  webConfig: WebViewConfiguration(
    showToolbar: true,
    showAnnotations: true,
    readOnly: false,
    theme: 'DARK',
  ),
)

Common WebViewConfiguration fields

For advanced web-only options (callbacks, rendering hooks, performance toggles, and other low-level NutrientViewer.load() options), refer to the complete WebViewConfiguration API reference(opens in a new tab).