Mobile Document Scanner API Reference / StringConfig

Interface: StringConfig

Defined in: src/views/utils/index.ts:411

Override the default user-facing strings displayed by the DocumentScanner. Every field is optional; unset fields fall back to the library default. Toolbar button labels (Re-take, Apply, Done, etc.) are not configured here — use correctionViewConfig.toolbarButtonsConfig and resultViewConfig.toolbarButtonsConfig for those.

Strings that include a {count} or {error} placeholder are noted inline; the placeholder is substituted at render time.

Properties

cameraSwitcherCameraLabel?

optional cameraSwitcherCameraLabel?: string

Defined in: src/views/utils/index.ts:450

Section heading above the list of cameras in the camera switcher menu.

Default Value

"Camera"

---

cameraSwitcherResolutionLabel?

optional cameraSwitcherResolutionLabel?: string

Defined in: src/views/utils/index.ts:452

Section heading above the list of resolutions in the camera switcher menu.

Default Value

"Resolution"

---

closeScannerBtnTitle?

optional closeScannerBtnTitle?: string

Defined in: src/views/utils/index.ts:447

Tooltip on the scanner view header close (X) button.

Default Value

"Close"

---

continuousScanDoneBtn?

optional continuousScanDoneBtn?: string

Defined in: src/views/utils/index.ts:425

Label of the "Done" button in continuous scanning mode. The literal substring {count} is replaced with the current scan count at render time.

Default Value

"Done ({count})"

---

downloadFilenamePrefix?

optional downloadFilenamePrefix?: string

Defined in: src/views/utils/index.ts:430

Filename prefix for downloaded images. Final filename is {prefix}-{timestamp}.png.

Default Value

"document"

---

filterBlackWhiteBtn?

optional filterBlackWhiteBtn?: string

Defined in: src/views/utils/index.ts:464

Result view filter menu: the black & white option.

Default Value

"Black & White"

---

filterGrayscaleBtn?

optional filterGrayscaleBtn?: string

Defined in: src/views/utils/index.ts:462

Result view filter menu: the grayscale option.

Default Value

"Grayscale"

---

filterInvertedBtn?

optional filterInvertedBtn?: string

Defined in: src/views/utils/index.ts:468

Result view filter menu: the inverted option.

Default Value

"Inverted"

---

filterOriginalBtn?

optional filterOriginalBtn?: string

Defined in: src/views/utils/index.ts:460

Result view filter menu: the "no filter" option.

Default Value

"Original"

---

filterSepiaBtn?

optional filterSepiaBtn?: string

Defined in: src/views/utils/index.ts:466

Result view filter menu: the sepia option.

Default Value

"Sepia"

---

initializingCameraMsg?

optional initializingCameraMsg?: string

Defined in: src/views/utils/index.ts:415

Loading overlay message shown while opening the camera.

Default Value

"Initializing camera..."

---

loadingMsg?

optional loadingMsg?: string

Defined in: src/views/utils/index.ts:413

Loading overlay message shown during initial DCV load.

Default Value

"Loading..."

---

processingImageMsg?

optional processingImageMsg?: string

Defined in: src/views/utils/index.ts:417

Loading overlay message shown while processing a captured or uploaded image.

Default Value

"Processing image..."

---

scanMoreBtn?

optional scanMoreBtn?: string

Defined in: src/views/utils/index.ts:458

Label of the continuous-mode "Scan More" button.

Default Value

"Scan More"

---

selectCameraBtnTitle?

optional selectCameraBtnTitle?: string

Defined in: src/views/utils/index.ts:443

Tooltip on the scanner view header button that opens the camera/resolution picker.

Default Value

"Select Camera or Resolution"

---

shareErrorAlert?

optional shareErrorAlert?: string

Defined in: src/views/utils/index.ts:440

Alert shown when the share/download flow throws. The literal substring {error} is replaced with the error message at render time.

Default Value

"Error processing image: {error}"

---

shareTitle?

optional shareTitle?: string

Defined in: src/views/utils/index.ts:428

title field passed to the Web Share API when sharing the corrected image.

Default Value

"Scanned Document"

---

takePhotoBtnTitle?

optional takePhotoBtnTitle?: string

Defined in: src/views/utils/index.ts:455

Tooltip / accessible label on the shutter (take photo) button.

Default Value

"Take Photo"

---

uploadImageBtnTitle?

optional uploadImageBtnTitle?: string

Defined in: src/views/utils/index.ts:445

Tooltip on the scanner view header button that uploads an image file.

Default Value

"Upload Image"

---

uploadShareFailedAlert?

optional uploadShareFailedAlert?: string

Defined in: src/views/utils/index.ts:433

Alert shown when the upload or share button handler throws.

Default Value

"Failed"