View configuration reference

NutrientViewConfiguration(opens in a new tab) configures Nutrient Flutter viewer widgets. NutrientInstantView(opens in a new tab) currently uses it, and it’ll replace PdfConfiguration(opens in a new tab) as the standard configuration object.

Use NutrientViewConfiguration(opens in a new tab) to control the viewer’s layout, user interface (UI) chrome, editing features, and appearance. All fields are optional. When you don’t set a field, the native SDK uses its built-in default. Set only the values you need to change.

The configuration groups fields by platform:

• Top-level fields apply to all supported platforms unless otherwise noted.
• androidConfig(opens in a new tab) contains Android-only options.
• iosConfig(opens in a new tab) contains iOS-only options.
• webConfig(opens in a new tab) contains Web-only options.

The following example configures layout, thumbnails, editing, and platform-specific options:

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

Use these fields to configure page flow, page layout, transitions, and the initial page.

PageTransition values

Use these values with pageTransition(opens in a new tab).

UI chrome

Use these fields to configure toolbar visibility, thumbnails, and the viewer theme.

Editing

Use these fields to configure text selection, annotations, form editing, and saving behavior.

Instant and AI Assistant

These fields apply to Android and iOS, and they only take effect on NutrientInstantView(opens in a new tab). They have no effect on Web or non-Instant documents.

Zoom

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

AndroidViewConfiguration

AndroidViewConfiguration(opens in a new tab) contains options that only apply to Android. Pass it as NutrientViewConfiguration.androidConfig(opens in a new tab). iOS and Web ignore it.

The following example configures Android toolbar items, search, document editing, and theme resources:

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) contains options that only apply to iOS. Pass it as NutrientViewConfiguration.iosConfig(opens in a new tab). Android and Web ignore it.

The following example configures spread fitting and navigation bar buttons on iOS:

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

Bar button item identifiers

Use these identifiers with leftBarButtonItems(opens in a new tab) and rightBarButtonItems(opens in a new tab).

WebViewConfiguration

WebViewConfiguration(opens in a new tab) contains options that only apply to Web. The platform interface declares it as Object? 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).

The following example configures toolbar visibility, annotation visibility, read-only mode, and the viewer theme on Web:

import 'package:nutrient_flutter/nutrient_flutter.dart';

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

Common WebViewConfiguration fields

Use these common fields to configure Web viewer behavior.

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