For the complete documentation index, see llms.txt. This page is also available as Markdown.

Personalização de texto

As strings que o fluxo do Smart Capture renderiza — instruções, botões, mensagens de erro e rótulos de acessibilidade — podem ser substituídas por sua própria redação, sem precisar fazer um fork do SDK.

Visão geral

Todo texto exibido no fluxo Smart Capture é um recurso normal de string do Android com um ID de recurso fixo. Você envia sua própria redação declarando uma string com o mesmo nome no módulo do app Android do React Native. Você inclui apenas as chaves que realmente quer alterar; todo o resto mantém a tradução do próprio SDK.

Isso funciona por causa de como o Android mescla os recursos: quando seu app e a biblioteca Smart Capture declaram uma string com o mesmo nome, o recurso do seu app prevalece na compilação. Nenhuma API em tempo de execução — customLocalization na configuração TypeScript não faz nada no Android.

Os IDs dos recursos são internos à versão atual do SDK nativo e podem mudar entre as versões. Verifique novamente esta lista após atualizar.

API

O Android não usa um campo TypeScript para strings. A personalização é o nome do recurso:

Mecanismo
Onde
Descrição

Substituição de recurso de string

android/app/src/main/res/values/strings.xml (ou values-<locale>/)

Declare um <string> (ou <plurals>) com o mesmo nome do SDK.

Quando você não declara um determinado nome, o SDK usa sua própria string.

<!-- android/app/src/main/res/values/strings.xml -->
<resources>
    <string name="certta_smart_capture_instructions_title">Prepare seu documento de identidade</string>
    <string name="certta_smart_capture_select_validation_type_capture_title">Abrir câmera</string>
</resources>

Todo o restante nessas telas mantém a redação do próprio SDK.

Adicionando suas strings

  1. Crie ou reutilize strings.xml no módulo do app Android — android/app/src/main/res/values/ e, para cada localidade, values-<locale>/.

  2. Adicione apenas as chaves que você quer substituir. As chaves omitidas não são um erro e não exibem uma chave bruta na tela.

  3. Recompile o app. Seus recursos substituem automaticamente os padrões do SDK.

Ordem de resolução

Para cada chave, o Android resolve nesta ordem:

  1. A string do seu app com esse ID de recurso, na pasta de localidade que corresponde ao idioma do dispositivo.

  2. A string do seu app com esse ID na pasta padrão values/ pasta (se você a tiver substituído lá).

  3. A tabela própria do SDK para o idioma do dispositivo.

  4. O padrão do SDK, que é inglês.

Substituições parciais são suportadas e recomendadas. Declarar um nome que o SDK não usa é ignorado.

O SDK oferece inglês, espanhol e português. Em um dispositivo cujo idioma não seja nenhum desses, o texto do SDK é exibido em inglês.

Localização

O idioma exibido acompanha a localidade do dispositivo em relação às pastas de recursos que seu app empacota. O Smart Capture não expõe um alternador de idioma próprio.

Localidade
Pasta de recursos

Inglês (padrão/fallback)

values/

Espanhol

values-es/

Português

values-pt/

Adicionando um idioma que o SDK não oferece

Crie values-<locale>/strings.xml no módulo do app Android e substitua as chaves que o usuário verá. As chaves que você omitir voltam para o inglês, então traduza todas as chaves que devem aparecer nesse idioma.

Especificadores de formato

certta_smart_capture_camera_wrong_document_back_expected_hint. Sua substituição deve manter os mesmos marcadores e a mesma estrutura. Eliminá-los, ou alterar o plural <item> quantidades, gera saída incorreta em tempo de execução.

Referência de chaves

Todas as chaves têm o prefixo certta_smart_capture_ para evitar conflitos. Os valores mostrados são os padrões em inglês.

Instruções de captura

Mensagens de documento inválido

Nomes dos tipos de documento

Rótulos de acessibilidade dos documentos

Pré-visualização da captura

Carrossel de instruções — compartilhado

Carrossel de instruções — modo de captura

Carrossel de instruções — modo de upload

Seleção do método de validação

Folha de ajuda da câmera

Tela de permissão negada

Tela de revisão do upload

Folha de exclusão de arquivo

Alertas de validação do upload

Tela de sucesso

Compartilhado / genérico

Visão geral

As strings que o fluxo Smart Capture renderiza — instruções, botões, mensagens de erro e a maioria dos rótulos do VoiceOver — podem ser substituídas pela sua própria redação, sem fazer fork do SDK.

Você fornece uma .strings tabela no target do app iOS e informa ao SDK o nome dela via TypeScript. Você inclui apenas as chaves que realmente quer alterar; todo o resto mantém a tradução do próprio SDK.

Dois trechos de texto ficam fora dessa tabela: as abreviações dos tipos de documento (RG, CNH, RNE, CTPS, CRLV) e a tela de permissão negada da câmera, que é compartilhada com outros produtos CAF. Nenhum dos dois pode ser alterado por meio de customLocalization.

API

O React Native expõe um único campo opcional em CerttaSmartCaptureConfiguration:

Parâmetro
Tipo
Padrão
Descrição

customLocalization

string

null

Nome da sua .strings tabela — o nome do arquivo sem a extensão. Carregada do bundle principal do app (Bundle.main).

Quando customLocalization é omitido, o SDK usa suas próprias strings.

Adicionando sua tabela de strings

  1. Crie um .strings arquivo no target do app iOS — por exemplo MySmartCapture.strings — e coloque-o no <language>.lproj/ diretório de cada localidade que você oferece suporte (ios/<App>/en.lproj/, ios/<App>/pt-BR.lproj/, …).

  2. Adicione apenas as chaves que você quer substituir. As chaves omitidas não são um erro e não exibem uma chave bruta na tela.

  3. Passe o nome do arquivo sem a extensão como customLocalization.

Todo o restante na tela de instruções mantém a redação do próprio SDK.

Ordem de resolução

Para cada chave, o SDK resolve nesta ordem:

  1. Sua customLocalization tabela no bundle principal do app.

  2. A tabela própria do SDK para o idioma do dispositivo.

  3. O valor padrão compilado no SDK, que é o português brasileiro.

Tabelas parciais são suportadas e recomendadas. Informar um nome de tabela que não exista também é seguro — cada chave volta para o texto do próprio SDK.

O SDK oferece inglês, espanhol e português brasileiro. Em um dispositivo cujos idiomas preferidos não incluam nenhum desses, o texto do SDK é exibido em português brasileiro.

Localização

O SDK resolve strings por meio da busca padrão do iOS, então o idioma exibido segue os idiomas preferidos do usuário conforme negociado com as localizações declaradas pelo seu app — o Smart Capture não expõe um alternador de idioma próprio.

Sua tabela personalizada é resolvida por localidade exatamente da mesma forma: uma chave é lida do <language>.lproj/ diretório que corresponde ao idioma resolvido, com fallback para a região de desenvolvimento da sua tabela e, depois, para o texto do próprio SDK.

Adicionando um idioma que o SDK não oferece

Crie o .lproj diretório para esse idioma no app iOS, adicione sua tabela ali e garanta que o idioma esteja listado nas localizações do app. As chaves omitidas voltam para o português brasileiro, então traduza todas as chaves que o usuário verá.

Substituindo um idioma que o SDK já oferece

Não há como remover uma tradução embutida. Para alterar a redação de um idioma já incluído, substitua as chaves dessa localidade na sua própria tabela.

Especificadores de formato

Alguns valores contêm especificadores de formato como %@, %d, ou %1$d. Sua substituição deve manter os mesmos especificadores. Eliminá-los ou reordená-los sem sintaxe posicional produz saída incorreta.

.stringsdict as regras de plural não são consultadas. As variações de plural devem ser tratadas pelas chaves listadas abaixo.

Mensagens de tipo de arquivo para upload

Chave
Usado quando

smart_capture.upload.file_invalid_extension.message

allowedUploadTypes não está definido, vazio ou lista todos os cinco formatos.

smart_capture.upload.file_invalid_extension.message_format

allowedUploadTypes restringe o conjunto; %@ recebe a lista de extensões.

smart_capture.list.or

Conectivo disjuntivo usado para unir a lista (e as listas de tipos de documento).

Referência de chaves

Todas as chaves têm o prefixo smart_capture. para evitar conflitos. Os valores mostrados são os padrões em inglês.

Um arquivo pronto para copiar .strings é publicado junto com o SDK nativo: SmartCapture/SmartCaptureLocalizable.stringsComece a partir dele e depois apague as chaves que você não pretende substituir.

Instruções de captura

Mensagens de documento inválido

Nomes dos tipos de documento

Os outros tipos de documento são exibidos pelas siglas brasileiras — RG, CNH, RNE, CTPS e CRLV — que não podem ser personalizadas. Os nomes no VoiceOver ficam em Acessibilidade — nomes dos documentos.

Pré-visualização da captura

Carrossel de instruções — compartilhado

Carrossel de instruções — modo de captura

Carrossel de instruções — modo de upload

Seleção do método de validação

Seleção da origem do upload

Folha de ajuda da câmera

Tela de revisão do upload

Folha de exclusão de arquivo

Alertas de validação do upload

Falha no envio do upload

Acessibilidade — captura e pré-visualização

Acessibilidade — instruções e método de validação

Acessibilidade — upload

Acessibilidade — nomes dos documentos

Atualizado