Skip to main content
This document describes the configuration options available when initializing a DocumentEditor for customizing form behavior, including page management, field interactions.

​
Initialization with DocumentEditorConfig

The recommended way to initialize a DocumentEditor is with a single DocumentEditorConfig object. This groups every editor option — mode, event handler, license, schema validation, page behavior, and display — into one configuration surface. 
import Joyfill
import JoyfillModel

// 1. Page behavior
let pageConfig = PageConfig(
    navigation: true,
    enableDuplicates: false,
    enableDeletes: false,
    currentPageID: nil
)

// 2. Display & decorators
let decoratorConfig = DecoratorConfig(
    visibleLimitInFields: 2,
    visibleLimitInRows: 1
)

let displayConfig = DisplayConfig(
    singleClickRowEdit: false,
    decorators: decoratorConfig
)

// 3. Assemble the editor config
let config = DocumentEditorConfig(
    mode: .fill,
    events: handler,          // your FormChangeEvent handler (optional)
    license: "your-license",  // optional
    validateSchema: true,
    page: pageConfig,
    display: displayConfig
)

// 4. Create the editor
let editor = DocumentEditor(
    document: myDocument,
    config: config
)
Every parameter has a default, so you only set what you need: 
// Minimal — all defaults
let editor = DocumentEditor(document: myDocument)

// Just an event handler
let editor = DocumentEditor(
    document: myDocument,
    config: DocumentEditorConfig(events: handler)
)

​
DocumentEditorConfig

ParameterTypeDefaultDescription
modeMode.fillEditing mode. .fill allows editing; .readonly disables edits (and page duplication/deletion).
eventsFormChangeEvent?nilHandler that receives change, focus, upload, capture, and error events. See Event Handling.
licenseString?nilLicense token. A valid license enables licensed features such as Collection fields.
validateSchemaBooltrueWhen true, validates the document schema on init. See Schema Validation.
pagePageConfigPageConfig()Page-navigation and page-operation behavior.
displayDisplayConfigDisplayConfig()Field-interaction and decorator display behavior.

​
PageConfig

ParameterTypeDefaultDescription
navigationBooltrueShow the page navigation UI.
enableDuplicatesBoolfalseAllow users to duplicate pages (.fill mode only).
enableDeletesBoolfalseAllow users to delete pages (.fill mode only).
currentPageIDString?nilPage to open initially. nil falls back to the first valid page.

​
DisplayConfig

ParameterTypeDefaultDescription
singleClickRowEditBoolfalseOpen table/collection rows for editing with a single tap.
decoratorsDecoratorConfigDecoratorConfig()Controls how many decorators show inline before overflowing into a kebab menu.
The per-parameter initializer shown in the sections below (for example DocumentEditor(document:mode:events:...)) is deprecated. It still works and forwards its arguments into a DocumentEditorConfig, but new code should use the config-based initializer above.

​
Page Management

​
Page Navigation

Control the visibility of the page navigation UI. 
let editor = DocumentEditor(
    document: myDocument,
    navigation: true  // Show page navigation UI
)
ParameterTypeDefaultDescription
navigationBooltrueWhen true, displays the page navigation dropdown button that allows users to switch between pages.
Behavior:
  • Clicking the button opens a modal sheet showing all available pages
  • The page selector respects conditional logic - hidden pages are not shown in the list

​
Page Duplication

Control whether users can duplicate existing pages. 
import Joyfill
import JoyfillModel

let editor = DocumentEditor(
    document: myDocument,
    mode: .fill,  // Page duplication only works in .fill mode
    isPageDuplicateEnabled: true
)
ParameterTypeDefaultDescription
isPageDuplicateEnabledBoolfalseWhen true, users can duplicate pages via the page navigation UI. The duplicated page includes all field values from the original.
Behavior:
  • Duplicated pages retain all field values from the source page, including conditional logic
  • The new page is inserted immediately after the source page in the page order
  • Field IDs are regenerated for all fields on the duplicated page to ensure uniqueness

​
Page Deletion

Control whether users can delete pages from multi-page forms. 
let editor = DocumentEditor(
    document: myDocument,
    mode: .fill,  // Page deletion only works in .fill mode
    isPageDeleteEnabled: true
)
ParameterTypeDefaultDescription
isPageDeleteEnabledBoolfalseWhen true, users can delete pages via the page navigation UI. A confirmation dialog appears before deletion to prevent accidental data loss.
Behavior:
  • Delete is only available when there is more than one page (you cannot delete the last remaining page)
  • A confirmation dialog appears to user before deletion
  • Page deletion is permanent and cannot be undone
  • If the current page is deleted, the form automatically navigates to the next available page

​
Field Interactions

​
Single Click Row Edit

Simplify the process for opening table and collection rows for editing. 
let editor = DocumentEditor(
    document: myDocument,
    singleClickRowEdit: true
)
ParameterTypeDefaultDescription
singleClickRowEditBoolfalseWhen true, users can open a row for editing with a single tap. When false, users must go through multiple steps to edit a row.
Behavior:
  • Default (false): Users must follow multiple steps to open a row form
  • Enabled (true): Users can open the row form for editing with a single tap, providing a faster and easier editing experience
  • This setting applies to both Table fields and Collection fields
  • The edit behavior respects the form’s mode - in .readonly mode, rows cannot be edited regardless of this setting

​
Schema Validation

Control whether the document schema is validated during initialization. 
let editor = DocumentEditor(
    document: myDocument,
    validateSchema: true  // Validate schema on init
)
ParameterTypeDefaultDescription
validateSchemaBooltrueWhen true, validates the document schema version and structure during initialization. Validation errors are reported via the onError event handler.
Behavior:
  • If validation fails, editor.schemaError will contain error details
  • The form will display an error screen instead of the document
  • Validation errors are also sent to the events.onError() handler if configured
  • Set to false to skip validation (useful for testing or when you’re certain the document is valid)

​
Programmatic Page Operations

You can also perform page operations programmatically using the DocumentEditor API.

​
Duplicate a Page

// Duplicate a page programmatically
editor.duplicatePage(pageID: "page_123")

​
Navigate to a Page

// Switch to a different page
editor.currentPageID = "page_456"