Required Documents Modal

This section describes the BfmRequiredDocumentsModalComponent component.

Usage

You must import the BfmRequiredDocumentsModalComponent and provide it to ModalService to open the modal.

info

Modals are not components. They must be used with the ModalService to be opened.

To a better understanding, check the Modals documentation.

required-documents-modal.component.ts

import { BfmRequiredDocumentsModalComponent } from '@celerofinancas/ui-charges';
import { ModalService } from "@celerofinancas/ui-modals";
import { Component, inject } from '@angular/core';

@Component({
  standalone: true,
  selector: 'required-documents',
  templateUrl: './required-documents.component.html',
})
export class RequiredDocumentsComponent {
  /**
   * Modal service for handling modals
   */
  private modalService = inject(ModalService);

  /**
   * Open the modal
   */
  public openModal(): void {
    this.modalService.open(BfmRequiredDocumentsModalComponent, {
      description: 'This is a description',
      listTitle: 'Documents required',
      documents: ['Document 1', 'Document 2'],
      keychainDocumentType: DOCUMENT_TYPES.CHARGE_KEYCHAIN,
      helpCenter: {
        label: 'Help Center',
        link: 'https://celerofinancas.com.br',
      },
    });
  };
}

Inputs

The BfmRequiredDocumentsModalComponent modalRef has the following inputs:

description

Modal description

Type	Default
string	N/A

listTitle

Title of the documents' list

Type	Default
string	N/A

documents

List of documents which are required for the integration

Type	Default
string[]	N/A

keychainDocumentType

Document type of the charge keychain that is being set up

Type	Default
DOCUMENT_TYPES	N/A

helpCenter

Help link for code integration

Type	Default
{ label: string; link: string; }	N/A

Events

The BfmRequiredDocumentsModalComponent modalRef has the following events:

onSubmit

Triggers when the user clicks on the modal's "submit" button

Type
void