Doc Core
Guia de customização para o Doc Core Flutter.
Telas Customizáveis
Podemos customizar as telas de instrução e a de permissão passando Widgets customizados.
1. Tela de Instruções
Para adicionar a tela de instruções customizável, temos que criar um Widget para retornar nossa tela passando os callbacks como parâmetros de onError e onSuccess e incluir o Widget nos parâmetros da classe de inicialização createDocumentscopyWidget.
OitiLiveness2d.createDocumentscopyWidget(
appKey: appKey,
ticket: ticket,
environment: environment,
themeBuilder: themeBuilder,
onSuccess: (result) => _onDocSuccess(result),
onError: (error) => _onDocError(error),
instructionWidget: instructionScreen(), // <---------
permissionWidget: CameraPermissionWidget(),
);
Widget instructionScreen() { // <---------
return InstructionWidget(
onError: (error) => _onDocError(error),
onSuccess: (result) => _onDocSuccess(result),
);
}Classe de Ação: DocumentsCopyActions().onContinue(BuildContext context)
DocumentsCopyActions().onContinue(BuildContext context)Você deve instanciar a classe inicialização quando o usuário clicar em CNH ou RG no onPress() de seu botão dentro do seu Widget customizado para iniciar a jornada da DocCore.
ElevatedButton(
onPressed: () {
try {
PermissionsActions().askPermission(context);
} catch (e) {
print(e.toString());
}
},
child: const Text("Verificar"),
)2. Tela de Permissões
Para adicionar uma tela de permissão, inclua o Widget da sua tela nos parâmetros da classe de inicialização createDocumentscopyWidget.
OitiLiveness2d.createDocumentscopyWidget(
appKey: appKey,
ticket: ticket,
environment: environment,
themeBuilder: themeBuilder,
onSuccess: (result) => _onDocSuccess(result),
onError: (error) => _onDocError(error),
permissionWidget: CameraPermissionWidget(), // <---------
);Classe de Ação: PermissionsActions().onContinue(BuildContext context)
PermissionsActions().onContinue(BuildContext context)Você deve instanciar a classe de permissão no onPress() de seu botão de permissão dentro do seu Widget customizado para executar a verificação de permissão para o usuário.
ElevatedButton(
onPressed: () {
try {
PermissionsActions().askPermission(context);
} catch (e) {
print(e.toString());
}
},
child: const Text("Verificar"),
)Builders
No Flutter utilizamos classes de construção para efetuar diversas mudanças no tema.
1. Theme Builder
Classe responsável pelas cores da jornada.
ThemeBuilder _themeCustomization() {
return ThemeBuilder()
..setCaptureBackgroundColor = "#DD0101"
..setCaptureCaptureButtonNormalStateColorsBorder = "#DD0101";
}1.1 Propriedades customizáveis
Abaixo, estão mapeadas as propriedades para customização do ThemeBuilder.
Tela de Loading
| Propriedade | Tipagem | Descrição | |
|---|---|---|---|
| (1) | setLoadingBackgroundColor | String? | Cor de fundo da tela de carregamento |
| (2) | setLoadingSpinnerColor | String? | Cor do indicador de carregamento |
| (2) | setLoadingSpinnerWidth | int? | Largura do indicador de carregamento |
| (2) | setLoadingSpinnerScale | int? | Fator de escala do indicador de carregamento |
Tela de Captura
| Propriedade | Tipagem | Descrição | |
|---|---|---|---|
| (1) | setCaptureBackButtonColorsIcon | String? | Cor do ícone do botão Voltar |
| (1) | setCaptureBackButtonColorsBackground | String? | Cor de fundo do botão Voltar |
| (1) | setCaptureBackButtonColorsBorder | String? | Cor da borda do botão Voltar |
| (2) | setCaptureCloseButtonColorsIcon | String? | Cor do ícone do botão Fechar |
| (2) | setCaptureCloseButtonColorsBackground | String? | Cor de fundo do botão Fechar |
| (2) | setCaptureCloseButtonColorsBorder | String? | Cor da borda do botão Fechar |
| (3) | setCaptureFrontIndicatorColor | String? | Cor do indicador frontal |
| (4) | setCaptureFrontIndicatorFocusedStateTextColor | String? | Cor do texto no estado focado do indicador frontal |
| (4) | setCaptureFrontIndicatorUnfocusedStateColor | String? | Cor no estado não focado do indicador frontal |
| (3) | setCaptureBackIndicatorColor | String? | Cor do indicador traseiro |
| (4) | setCaptureBackIndicatorFocusedStateTextColor | String? | Cor do texto no estado focado do indicador traseiro |
| (4) | setCaptureBackIndicatorUnfocusedStateTextColor | String? | Cor no estado não focado do indicador traseiro |
| (5) | setCaptureInstructionTextColor | String? | Cor do texto das instruções |
| (6) | setCapturePreviewBorderColorForCapture | String? | Cor da borda da pré-visualização para captura |
| (6) | setCapturePreviewBorderColorForUncapturedState | String? | Cor da borda da pré-visualização para estado não capturado |
| (8) | setCaptureCaptureButtonHighlightedStateColorsIcon | String? | Cor do ícone do botão de captura no estado destacado |
| (8) | setCaptureCaptureButtonHighlightedStateColorsBackground | String? | Cor de fundo do botão de captura no estado destacado |
| (8) | setCaptureCaptureButtonHighlightedStateColorsBorder | String? | Cor da borda do botão de captura no estado destacado |
| (8) | setCaptureCaptureButtonNormalStateColorsIcon | String? | Cor do ícone do botão de captura no estado normal |
| (8) | setCaptureCaptureButtonNormalStateColorsBackground | String? | Cor de fundo do botão de captura no estado normal |
| (8) | setCaptureCaptureButtonNormalStateColorsBorder | String? | Cor da borda do botão de captura no estado normal |
| (8) | setCaptureCaptureButtonDisabledStateColorsIcon | String? | Cor do ícone do botão de captura no estado desativado |
| (8) | setCaptureCaptureButtonDisabledStateColorsBackground | String? | Cor de fundo do botão de captura no estado desativado |
| (8) | setCaptureCaptureButtonDisabledStateColorsBorder | String? | Cor da borda do botão de captura no estado desativado |
| (9) | setCaptureBottomSheetShapeColor | String? | Cor da forma da folha inferior de captura |
| (9) | setCaptureBottomSheetShapeCornerRadius | int? | Raio da borda da forma da folha inferior de captura |
| (10) | setCaptureTakeNewPictureButtonHighlightedStateColorsText | String? | Cor do texto do botão de tirar nova foto no estado destacado |
| (10) | setCaptureTakeNewPictureButtonHighlightedStateColorsBackground | String? | Cor de fundo do botão de tirar nova foto no estado destacado |
| (10) | setCaptureTakeNewPictureButtonHighlightedStateColorsBorder | String? | Cor da borda do botão de tirar nova foto no estado destacado |
| (10) | setCaptureTakeNewPictureButtonNormalStateColorsText | String? | Cor do texto do botão de tirar nova foto no estado normal |
| (10) | setCaptureTakeNewPictureButtonNormalStateColorsBackground | String? | Cor de fundo do botão de tirar nova foto no estado normal |
| (10) | setCaptureTakeNewPictureButtonNormalStateColorsBorder | String? | Cor da borda do botão de tirar nova foto no estado normal |
| (10) | setCaptureTakeNewPictureButtonDisabledStateColorsText | String? | Cor do texto do botão de tirar nova foto no estado desativado |
| (10) | setCaptureTakeNewPictureButtonDisabledStateColorsBackground | String? | Cor de fundo do botão de tirar nova foto no estado desativado |
| (10) | setCaptureTakeNewPictureButtonDisabledStateColorsBorder | String? | Cor da borda do botão de tirar nova foto no estado desativado |
| (11) | setTextConfirmation | String? | Texto da pergunta "A foto do documento ficou boa?" |
| (11) | setTextConfirmationColor | String? | Cor da pergunta "A foto do documento ficou boa?" |
| (12) | setCaptureUsePictureButtonText | String? | Texto do botão "Sim" |
| (12) | setCaptureUsePictureButtonConfirmationText | String? | Texto de confirmação do botão "Sim" |
| (12) | setCaptureUsePictureButtonHighlightedStateColorsText | String? | Cor do texto do botão "Sim" no estado destacado |
| (12) | setCaptureUsePictureButtonHighlightedStateColorsBackground | String? | Cor de fundo do botão "Sim" no estado destacado |
| (12) | setCaptureUsePictureButtonHighlightedStateColorsBorder | String? | Cor da borda do botão "Sim" no estado destacado |
| (12) | setCaptureUsePictureButtonNormalStateColorsText | String? | Cor do texto do botão "Sim" no estado normal |
| (12) | setCaptureUsePictureButtonNormalStateColorsBackground | String? | Cor de fundo do botão "Sim" no estado normal |
| (12) | setCaptureUsePictureButtonNormalStateColorsBorder | String? | Cor da borda do botão "Sim" no estado normal |
| (12) | setCaptureUsePictureButtonDisabledStateColorsText | String? | Cor do texto do botão "Sim" no estado desativado |
| (12) | setCaptureUsePictureButtonDisabledStateColorsBackground | String? | Cor de fundo do botão "Sim" no estado desativado |
| (12) | setCaptureUsePictureButtonDisabledStateColorsBorder | String? | Cor da borda do botão "Sim" no estado desativad |
Tela de Resultado
| Propriedade | Tipagem | Descrição | |
|---|---|---|---|
| (1) | setResultBackgroundColorSuccess | String? | Cor de fundo para o resultado de sucesso |
| (2) | setResultBackgroundColorError | String? | Cor de fundo para o resultado de erro |
| (4) | setResultBackgroundColorTryAgain | String? | Cor de fundo para a opção "Tentar Novamente" |
| (3) | setResultMessageSuccess | String? | Mensagem de sucesso |
| (3) | setResultMessageError | String? | Mensagem de erro |
| (3) | setResultMessageTryAgain | String? | Mensagem para a opção "Tentar Novamente" |
| (3) | setResultMessageColorSuccess | String? | Cor do texto para o resultado de sucesso |
| (3) | setResultMessageColorError | String? | Cor do texto para o resultado de erro |
| (3) | setResultMessageColorTryAgain | String? | Cor do texto para a opção "Tentar Novamente" |
| (4) | setResultTryAgainButtonHighlightedStateColorsText | String? | Cor do texto da opção "Tentar Novamente" no estado destacado |
| (4) | setResultTryAgainButtonHighlightedStateColorsBackground | String? | Cor de fundo da opção "Tentar Novamente" no estado destacado |
| (4) | setResultTryAgainButtonHighlightedStateColorsBorder | String? | Cor da borda da opção "Tentar Novamente" no estado destacado |
| (4) | setResultTryAgainButtonNormalStateColorsText | String? | Cor do texto da opção "Tentar Novamente" no estado normal |
| (4) | setResultTryAgainButtonNormalStateColorsBackground | String? | Cor de fundo da opção "Tentar Novamente" no estado normal |
| (4) | setResultTryAgainButtonNormalStateColorsBorder | String? | Cor da borda da opção "Tentar Novamente" no estado normal |
| (4) | setResultTryAgainButtonText | String? | Texto para a opção "Tentar Novamente" |
Tela de Instruções
| Propriedade | Tipagem | Descrição |
|---|---|---|
| instructionTitleText | String? | Texto do título das instruções |
| instructionTitleColor | String? | Cor do título das instruções |
| instructionCaptionColor | String? | Cor da legenda das instruções |
| instructionCaptionText | String? | Texto da legenda das instruções |
| instructionBackgroundColor | String? | Cor de fundo das instruções |
| instructionBottomSheetBackgroundColor | String? | Cor de fundo da folha inferior de instruções |
| setCaptureBottomSheetBackground | String? | Configuração do fundo da folha inferior de captura |
Updated about 2 months ago
