Doc Core

Guia de customização para a Doc Core em React Native.

Telas Customizáveis

É possível personalizar as telas de instrução e permissão, fornecendo componentes de views customizadas.

1. Tela de Instruções / 2. Tela de Permissão

(1. Tela de Instruções / 2. Tela de Permissão)

1. Tela de Instruções

Para incorporar uma tela de instruções personalizável, é necessário criar um componente que retorne a nossa tela, passando o componente personalizado CustomInstructionView para Liveness2dView..

<Liveness2dView
   options={options}
   navigation={navigation}
	 loading={loading}
   callbackView="Home"
   CustomInstructionView={<InstructionsView navigation={navigation} />} //  <--------
   onSuccess={onSuccess} 
   onError={onError} 
/>

Componente Botão de Ação: <DocCoreBackButton> </DocCoreBackButton>

Para iniciar a jornada da Doc Core, é necessário importar o componente e envolver seu botão ou imagem quando o usuário clicar em 'Voltar' dentro do seu componente personalizado.

<DocCoreBackButton>
  <Image
    source={require('../../../assets/images/left-arrow.png')}
    style={styles.leftArrow}
	/>
</DocCoreBackButton>

Componente Botão de Ação: <DocCoreContinueButton> </DocCoreContinueButton>

Para iniciar a jornada da Doc Core, é necessário importar o componente e envolver seu botão, texto ou imagem, quando o usuário clicar em 'Continuar' ou em algum documento dentro do seu componente personalizado.

<DocCoreContinueButton style={{}}>
      <Text style={styles.nextText}>Continuar</Text>
</DocCoreContinueButton>

2. Tela de Permissões

Para incluir uma tela de permissão, adicione o componente da sua tela como parâmetro para CustomPermissionView.

<DocumentsCopyView
   options={options}
   navigation={navigation}
	 loading={loading}
   callbackView="Home"
       CustomPermissionView={<PermissionView navigation={navigation} />} //  <--------
   onSuccess={onSuccess} 
   onError={onError} 
/>

Componente Botão de Ação:: <DocCorePermissionButton> </DocCorePermissionButton>

Para executar a verificação de permissão para o usuário, importe o componente e envolva seu botão, texto ou imagem de permissão dentro do seu componente personalizado.

<DocCorePermissionButton style={{}}>
    <Text style={styles.nextText}>Verificar Permissão</Text>
</DocCorePermissionButton>

Objeto do Tema

No React Native, utilizamos um objeto para realizar diversas alterações no tema.

1. Theme

Objeto de customização responsável pelas cores da jornada da Doc Core

theme: {
      setCaptureInstructionGuideText: 'textGUIDE',
      setCaptureInstructionGuideBackgroundColor: '#DD0101',
      setCaptureInstructionGuideTextColor: '#4bb75f',
},

1.1 Propriedades customizáveis

Abaixo, estão mapeadas as propriedades para customização do ThemeBuilder.

Customizações de telas ThemeBuilder

2. Tela de Loading

Tela de Loading
PropriedadeTipagemDescrição
(1)setLoadingBackgroundColorstring?Cor de fundo da tela de carregamento
(2)setLoadingSpinnerColorstring?Cor do indicador de carregamento
(2)setLoadingSpinnerWidthnumber?Largura do indicador de carregamento
(2)setLoadingSpinnerScalenumber?Fator de escala do indicador de carregamento

3. Tela de Captura

PropriedadeTipagemDescrição
(1)setCaptureBackButtonColorsIconstring?Cor do ícone do botão Voltar
(1)setCaptureBackButtonColorsBackgroundstring?Cor de fundo do botão Voltar
(1)setCaptureBackButtonColorsBorderstring?Cor da borda do botão Voltar
(2)setCaptureCloseButtonColorsIconstring?Cor do ícone do botão Fechar
(2)setCaptureCloseButtonColorsBackgroundstring?Cor de fundo do botão Fechar
(2)setCaptureCloseButtonColorsBorderstring?Cor da borda do botão Fechar
(3)setCaptureFrontIndicatorColorstring?Cor do indicador frontal
(4)setCaptureFrontIndicatorFocusedStateTextColorstring?Cor do texto no estado focado do indicador frontal
(4)setCaptureFrontIndicatorUnfocusedStateColorstring?Cor no estado não focado do indicador frontal
(3)setCaptureBackIndicatorColorstring?Cor do indicador traseiro
(4)setCaptureBackIndicatorFocusedStateTextColorstring?Cor do texto no estado focado do indicador traseiro
(4)setCaptureBackIndicatorUnfocusedStateTextColorstring?Cor no estado não focado do indicador traseiro
(5)setCaptureInstructionTextColorstring?Cor do texto das instruções
(6)setCapturePreviewBorderColorForCapturestring?Cor da borda da pré-visualização para captura
(6)setCapturePreviewBorderColorForUncapturedStatestring?Cor da borda da pré-visualização para estado não capturado
(8)setCaptureCaptureButtonHighlightedStateColorsIconstring?Cor do ícone do botão de captura no estado destacado
(8)setCaptureCaptureButtonHighlightedStateColorsBackgroundstring?Cor de fundo do botão de captura no estado destacado
(8)setCaptureCaptureButtonHighlightedStateColorsBorderstring?Cor da borda do botão de captura no estado destacado
(8)setCaptureCaptureButtonNormalStateColorsIconstring?Cor do ícone do botão de captura no estado normal
(8)setCaptureCaptureButtonNormalStateColorsBackgroundstring?Cor de fundo do botão de captura no estado normal
(8)setCaptureCaptureButtonNormalStateColorsBorderstring?Cor da borda do botão de captura no estado normal
(8)setCaptureCaptureButtonDisabledStateColorsIconstring?Cor do ícone do botão de captura no estado desativado
(8)setCaptureCaptureButtonDisabledStateColorsBackgroundstring?Cor de fundo do botão de captura no estado desativado
(8)setCaptureCaptureButtonDisabledStateColorsBorderstring?Cor da borda do botão de captura no estado desativado
(9)setCaptureBottomSheetShapeColorstring?Cor da forma da folha inferior de captura
(9)setCaptureBottomSheetShapeCornerRadiusnumber?Raio da borda da forma da folha inferior de captura
(10)setCaptureTakeNewPictureButtonHighlightedStateColorsTextstring?Cor do texto do botão de tirar nova foto no estado destacado
(10)setCaptureTakeNewPictureButtonHighlightedStateColorsBackgroundstring?Cor de fundo do botão de tirar nova foto no estado destacado
(10)setCaptureTakeNewPictureButtonHighlightedStateColorsBorderstring?Cor da borda do botão de tirar nova foto no estado destacado
(10)setCaptureTakeNewPictureButtonNormalStateColorsTextstring?Cor do texto do botão de tirar nova foto no estado normal
(10)setCaptureTakeNewPictureButtonNormalStateColorsBackgroundstring?Cor de fundo do botão de tirar nova foto no estado normal
(10)setCaptureTakeNewPictureButtonNormalStateColorsBorderstring?Cor da borda do botão de tirar nova foto no estado normal
(10)setCaptureTakeNewPictureButtonDisabledStateColorsTextstring?Cor do texto do botão de tirar nova foto no estado desativado
(10)setCaptureTakeNewPictureButtonDisabledStateColorsBackgroundstring?Cor de fundo do botão de tirar nova foto no estado desativado
(10)setCaptureTakeNewPictureButtonDisabledStateColorsBorderstring?Cor da borda do botão de tirar nova foto no estado desativado
(11)setTextConfirmationstring?Texto da pergunta "A foto do documento ficou boa?"
(11)setTextConfirmationColorstring?Cor da pergunta "A foto do documento ficou boa?"
(12)setCaptureUsePictureButtonTextstring?Texto do botão "Sim"
(12)setCaptureUsePictureButtonConfirmationTextstring?Texto de confirmação do botão "Sim"
(12)setCaptureUsePictureButtonHighlightedStateColorsTextstring?Cor do texto do botão "Sim" no estado destacado
(12)setCaptureUsePictureButtonHighlightedStateColorsBackgroundstring?Cor de fundo do botão "Sim" no estado destacado
(12)setCaptureUsePictureButtonHighlightedStateColorsBorderstring?Cor da borda do botão "Sim" no estado destacado
(12)setCaptureUsePictureButtonNormalStateColorsTextstring?Cor do texto do botão "Sim" no estado normal
(12)setCaptureUsePictureButtonNormalStateColorsBackgroundstring?Cor de fundo do botão "Sim" no estado normal
(12)setCaptureUsePictureButtonNormalStateColorsBorderstring?Cor da borda do botão "Sim" no estado normal
(12)setCaptureUsePictureButtonDisabledStateColorsTextstring?Cor do texto do botão "Sim" no estado desativado
(12)setCaptureUsePictureButtonDisabledStateColorsBackgroundstring?Cor de fundo do botão "Sim" no estado desativado
(12)setCaptureUsePictureButtonDisabledStateColorsBorderstring?Cor da borda do botão "Sim" no estado desativad

4. Tela de Resultado

PropriedadeTipagemDescrição
(1)setResultBackgroundColorSuccessstring?Cor de fundo para o resultado de sucesso
(2)setResultBackgroundColorErrorstring?Cor de fundo para o resultado de erro
(4)setResultBackgroundColorTryAgainstring?Cor de fundo para a opção "Tentar Novamente"
(3)setResultMessageSuccessstring?Mensagem de sucesso
(3)setResultMessageErrorstring?Mensagem de erro
(3)setResultMessageTryAgainstring?Mensagem para a opção "Tentar Novamente"
(3)setResultMessageColorSuccessstring?Cor do texto para o resultado de sucesso
(3)setResultMessageColorErrorstring?Cor do texto para o resultado de erro
(3)setResultMessageColorTryAgainstring?Cor do texto para a opção "Tentar Novamente"
(4)setResultTryAgainButtonHighlightedStateColorsTextstring?Cor do texto da opção "Tentar Novamente" no estado destacado
(4)setResultTryAgainButtonHighlightedStateColorsBackgroundstring?Cor de fundo da opção "Tentar Novamente" no estado destacado
(4)setResultTryAgainButtonHighlightedStateColorsBorderstring?Cor da borda da opção "Tentar Novamente" no estado destacado
(4)setResultTryAgainButtonNormalStateColorsTextstring?Cor do texto da opção "Tentar Novamente" no estado normal
(4)setResultTryAgainButtonNormalStateColorsBackgroundstring?Cor de fundo da opção "Tentar Novamente" no estado normal
(4)setResultTryAgainButtonNormalStateColorsBorderstring?Cor da borda da opção "Tentar Novamente" no estado normal
(4)setResultTryAgainButtonTextstring?Texto para a opção "Tentar Novamente"

5. Tela de Instruções(Nativa)

Você pode utilizar o parâmetro nativeCustom no objeto de options assim você ativa a tela de instruções native e as propriedades customizáveis da tela.

{
    appkey: '',
    ticket: '',
    environment: 'HML',
    nativeCustom: true, // <---------
  }
PropriedadeTipagemDescrição
(1)setInstructionBackButtonColorsIconstring?Cor do botão voltar.
(1)setInstructionBackButtonColorsBackgroundstring?Cor de fundo do botão voltar.
(1)setInstructionBackButtonColorsBorderstring?Cor da borda do botão voltar.
(2)setInstructionBottomSheetColorstring?Cor de fundo da área de instruções.
(2)setInstructionBottomSheetRadiusnumber?Arredondamento das bordas da área de instruções.
(3)setInstructionTitleTextstring?Título da área de instruções.
(3)setInstructionTitleColorstring?Cor do título da área de instruções.
(3)setInstructionTitleFontstring?Fonte do título da área de instruções.
(4)setInstructionCaptionTextstring?Subtítulo da área de instruções.
(4)setInstructionCaptionColorstring?Cor do subtítulo da área de instruções.
(4)setInstructionCaptionFontstring?Fonte do subtítulo da área de instruções.
(5)setInstructionDocOptionBackgroundColorstring?Fundo do círculo do ícone.
(5)setInstructionDocOptionBorderColorstring?Cor da borda do círculo do ícone.
(5)setInstructionDocOptionBorderWidthnumber?Espessura da borda do círculo do ícone.
(5)setInstructionDocOptionBorderRadiusnumber?Arredondamento das bordas do círculo do ícone.
(6)setInstructionDocOptionTitleTextstring?Texto da primeira instrução.
(6)setInstructionDocOptionTitleColorstring?Cor do texto da primeira instrução.
(6)setInstructionDocOptionTitleFontstring?Fonte do texto da primeira instrução.
(7)setInstructionEnvOptionBackgroundColorstring?Fundo do círculo do ícone.
(7)setInstructionEnvOptionBorderColorstring?Cor da borda do círculo do ícone.
(7)setInstructionEnvOptionBorderWidthnumber?Espessura da borda do círculo do ícone.
(7)setInstructionEnvOptionBorderRadiusnumber?Arredondamento das bordas do círculo do ícone.
(8)setInstructionEnvOptionTitleTextstring?Texto da segunda instrução.
(8)setInstructionEnvOptionTitleColorstring?Cor do texto da segunda instrução.
(8)setInstructionEnvOptionTitleFontstring?Fonte do texto da segunda instrução.
(9)setInstructionContinueButtonBackgroundColorstring?Cor de fundo do botão continuar.
(9)setInstructionContinueButtonHighlightedBackgroundColorstring?Cor de fundo ao clicar no botão continuar.
(9)setInstructionContinueButtonBorderColorstring?Cor da borda do botão continuar.
(9)setInstructionContinueButtonHighlightedBorderColorstring?Cor da borda ao clicar no botão continuar.
(9)setInstructionContinueButtonContentColorstring?Cor do conteúdo do botão continuar.
(9)setInstructionContinueButtonHighlightedContentColorstring?Cor do conteúdo do botão ao clicar em continuar.
(9)setInstructionContinueButtonTextColorstring?Texto do botão continuar.
(9)setInstructionContinueButtonFontstring?Fonte do botão continuar.