FeedbackUiOptions

@microblink/blinkid

---

@microblink/blinkid / FeedbackUiOptions

Type Alias: FeedbackUiOptions

FeedbackUiOptions = object

The options for the createBlinkIdFeedbackUi function.

Properties

helpTooltipHideDelay?

optional helpTooltipHideDelay: number | null

Time in ms before the help tooltip is hidden. If null, tooltip won't be auto hidden.

Default Value

5000

---

helpTooltipShowDelay?

optional helpTooltipShowDelay: number | null

Time in ms before the help tooltip is shown. If null, tooltip won't be auto shown.

Default Value

5000

---

localizationStrings?

optional localizationStrings: Partial<LocalizationStrings>

The localization strings.

---

preserveSdkInstance?

optional preserveSdkInstance: boolean

If set to true, the BlinkID instance will not be terminated when the feedback UI is unmounted.

Default Value

false

---

showDocumentFilteredModal?

optional showDocumentFilteredModal: boolean

If set to true, the document filtered modal will be shown.

Default Value

true

---

showHelpButton?

optional showHelpButton: boolean

If set to true, the help button will be shown.

Default Value

true

---

showHelpTooltipTimeout?

optional showHelpTooltipTimeout: number

The timeout for the help tooltip in ms.

Default Value

3000

Deprecated

This option will be removed in a future release. Use helpTooltipShowDelay instead.

---

showOnboardingGuide?

optional showOnboardingGuide: boolean

If set to true, the onboarding guide will be shown.

Default Value

true

---

showTimeoutModal?

optional showTimeoutModal: boolean

If set to true, the timeout modal will be shown.

Default Value

true

---

showUnsupportedDocumentModal?

optional showUnsupportedDocumentModal: boolean

If set to true, the document unsupported modal will be shown.

Default Value

true