Propriedades
Propriedades de configuração do componente SelphID Widget.
Estas propriedades permitem personalizar o comportamento do fluxo de captura de documento.
Constantes e tipagem
SelphID oferece tipos e constantes para facilitar sua implementação em ambientes tipados.
import { CameraType, CameraPreferred } from '@facephi/selphid-web-component'No React, o enum CameraPreferred (entre outros) também é exportado de @facephi/sdk-web-react.
Recomendação: Configure as propriedades por meio de JavaScript, JSX ou dos bindings do seu framework (React, Vue, Angular, etc.). Evite a configuração HTML nativa com atributos (
nombre-atributo="valor"), pois pode perder a tipagem e o formato esperado pelo componente.
Propriedades de configuração do SelphID Widget
Captura
allowUncertain: Aumenta a permissividade em documentos não reconhecidos.
allowUnknown: Permite capturar qualquer documento com fotografia.
barcode: Ativa o leitor de códigos de barras e QR.
barcodeSide: Lado do documento onde o código é lido.
blurredThreshold: Limiar de tolerância ao desfoque.
captureRetries: Número máximo de tentativas de captura.
captureTimeout: Tempo limite de captura por tentativa (segundos).
country: País do documento em ISO-2. Obsoleto: usar
countryFilter.countryFilter: Países permitidos em ISO-2. Recomendado:
enabledCountries.documentType: Tipos de documento admitidos na captura.
expectedSides: Número de lados do documento a capturar.
maxAllowedMismatches: Erros OCR permitidos por palavra.
progressiveMismatches: Aumento da permissividade em cada tentativa.
retryCurrentSide: Tenta novamente apenas o lado atual do documento.
rules: Regras para filtrar a captura por país.
Extração
anonymizationMode: Modo de anonimização dos dados extraídos.
capturePadding: Margem adicionada à imagem capturada.
cropFactor: Fator de escala do recorte do documento.
imageFormat: Formato das imagens retornadas.
imageQuality: Compressão JPEG (0.0–1.0).
tokenize: Ativa a tokenização dos resultados.
Câmera
cameraHeight: Resolução vertical preferida da câmera.
cameraId: Identificador da câmera.
cameraSwitch: Exibe o botão para trocar de câmera.
cameraType: Tipo de câmera (frontal ou traseira). Recomendado:
cameraPreferred.cameraWidth: Resolução horizontal preferida da câmera.
dpi: DPI das imagens extraídas.
externalCamera: Fluxo de vídeo externo para a captura.
Personalização
audible: Ativa a leitura de textos em voz alta.
cameraOverflow: Exibe toda a imagem da câmera como plano de fundo.
chooseDocument: Ativa a seleção prévia do documento. Recomendado:
showDocumentSelector.disableExit: Oculta o botão de fechar o widget. Recomendado:
showExitButton.disableTutorial: Desativa o acesso ao tutorial. Recomendado:
showTutorial.enableDocumentFlip: Ativa a animação de giro do documento.
initialTip: Exibe uma dica prévia à captura. Recomendado:
showPreviousTip.initialTipHeight: Altura da dica inicial em pixels.
initialTipWidth: Largura da dica inicial em pixels.
tipAnimations: Animações da dica inicial (mobile e desktop).
loadingAnimation: Caminho da animação de carregamento.
logo: Caminho do logo personalizado.
previewImage: Exibe pré-visualização após a captura. Recomendado:
showResultAfterCapture.tutorialAnimations: Animações personalizadas do tutorial.
tutorialModal: Exibe o tutorial em modo modal.
Configuração interna
advancedTracking: Ativa a geração de tracking avançado.
androidWebViewBehaviour: Comportamento em WebView do Android.
engineFallback: Habilita o motor secundário.
engineLocation: Caminho ou CDN dos recursos do motor.
errorTimer: Duração das telas de erro terminal.
settingsStrictness: Exibe erro se houver parâmetros configurados incorretamente.
Gravação de Vídeo
enableVideoTimer: Exibe temporizador durante a gravação.
videoRecord: Ativa a gravação de vídeo.
videoRecordAudio: Grava áudio na gravação local.
videoRecordQuality: Qualidade da gravação de vídeo.
videoRecordRate: Taxa de quadros da gravação remota.
videoRecordType: Tipo de gravação (local ou remota).
Ferramentas de desenvolvedor
Compatibilidade e validação de propriedades
Algumas propriedades foram renomeadas. O nome legacy continua sendo o principal e funcional nesta versão, enquanto o nome novo é o recomendado. Regras de resolução:
Precedência: se você definir ao mesmo tempo o nome legacy e o novo, prevalece o novo e um aviso de precedência é emitido no console.
Somente legacy: usar somente o nome legacy emite um aviso de depreciação no console. O nome legacy será removido na próxima versão major.
Propriedade desconhecida: uma propriedade não reconhecida se ignora em silêncio sempre.
Validação (settingsStrictness, por padrão tolerante): no modo tolerante, um valor inválido é substituído pelo seu valor padrão e um aviso é emitido; no modo estrito, interrompe o SDK com um erro bloqueante.
Atualizado