DSSDK logo Document Scanner SDK

Customising the UI Pixelnetica™ Document Scanning SDK for Apple iOS

The ready-to-use screens ship with built-in English text. You can override any of it — to change wording or to localise into other languages — without touching the screens themselves.

How overriding works

Each piece of on-screen text is looked up by key in a strings table named PxUiStrings. The SDK checks your app’s main bundle first, and falls back to its own built-in default when you have not provided a value. So to override a string, you simply add a PxUiStrings.strings file to your app and define the keys you want to change — no API call required.

  1. Add a file named PxUiStrings.strings to your app target.
  2. Define any of the keys below with your own text.
  3. Leave out the keys you are happy with — the SDK’s defaults apply.
/* PxUiStrings.strings (in your app) */
"camera-label-searching" = "Point the camera at a document";
"image-editor-title" = "Adjust edges";

Localising

Localisation uses the standard iOS mechanism: provide PxUiStrings.strings inside each language’s .lproj folder in your app (for example de.lproj/PxUiStrings.strings). iOS picks the right table for the user’s language, and the SDK resolves the keys from it.

The keys

KeyWhere it appears
camera-init-failedShown when the camera cannot start
camera-label-searchingCamera guidance: looking for a document
camera-label-too-farCamera guidance: move closer
camera-label-too-distoredCamera guidance: reduce the viewing angle
camera-label-capturingCamera guidance: capturing
camera-label-manual-focusCamera guidance: tap-to-focus prompt
image-editor-titleTitle of the crop / page editor
editor-banner-no-document-detectedEditor banner when no document was detected
ocr-languagesOCR language picker: title
ocr-select-languages-descOCR language picker: description
ocr-avaiable-languagesOCR language picker: available-languages section
ocr-no-languages-installedOCR language picker: empty state
ocr-search-languagesOCR language picker: search field

Per-screen behaviour

Text is cross-cutting; other behaviour is set per screen through that screen’s configuration object — PxUiCameraScreenConfiguration, PxUiPageCropScreenConfiguration, PxUiOcrEditorScreenConfiguration, and PxUiLanguagePickerScreenConfiguration. Each is documented in its screen’s guide.

Deeper visual theming (custom colours, fonts, icons) is not available for the ready-to-use screens in this release; build on the core engine if you need a bespoke look.

See also

Top