Skip to main content

Config

These are the available config options for a widget

{
// 'address' to screen. If you ommit it, 'shouldCheckSignerAddress' will be forced to true
address?: PureFIAddress;

// 'riskThresholds' is used for evaluation
// the status of wallet/contract from application perspective
// Possible values are in range [0..100]. 'low' is supposed to be less than 'high'
riskThresholds?: {
low?: number; // default is 25
high?: number; // default is 75
};

// 'shouldFlushOnSignerChange' instructs PureFIWidget whether it should
// or should not flush widget instance's state when signer changes
shouldFlushOnSignerChange?: boolean; // default is true

// 'shouldShowNotice' option is responsible for showing or not showing
// notice modal on every check
shouldShowNotice?: boolean; // default is true

// 'shouldCloseModalOnOverlayClick' option makes widget modals closable
// on overlay click
shouldCloseModalOnOverlayClick?: boolean; // default is true

// 'shouldCheckSignerAddress' instructs PureFIWidget whether it should
// or should not include signer address(user account) into screening
shouldCheckSignerAddress?: boolean; // default is false

// 'shouldShowUserRejectedError' defines to show or not to show
// error message if a user cancels 'sign message' request
shouldShowUserRejectedError?: boolean; // default is false

// 'shouldShowMissingSignerError' defines to show or not to show
// error message when signer is missing
shouldShowMissingSignerError?: boolean; // default is true

// 'i18n' can be used either to change or translate all the widget texts
// feel free to import { DefaultI18n } from '@purefi/verifier-widget'
// and check all the available options for replacing
i18n?: PureFII18n;
}