Skip to main content

Checking Account Dropdown

This section describes the BfmCheckingAccountDropdownComponent component.

Composition​

The BfmCheckingAccountDropdownComponent has no any composition component.

Usage​

You need to import it in your module and use it in your template.

checking-account-dropdown.component.ts
import { BfmCheckingAccountDropdownComponent } from '@celerofinancas/ui-cash-flow';

@Component({
standalone: true,
selector: 'checking-account-dropdown',
imports: [BfmCheckingAccountDropdownComponent],
templateUrl: './checking-account-dropdown.component.html',
})
export class CheckingAccountDropdownComponent {}

Then, in your template, you can use the component like this:

checking-account-dropdown.component.html
<bfm-checking-account-dropdown
[autoSelectAccount]="true"
[autoSelectSingleAccount]="true"
[blacklists]="{}"
[checkingAccounts]="checkingAccounts"
[companyPk]="'companyPk'"
[companyRelatedPk]="'companyRelatedPk'"
[formControl]="formControl"
[formControlName]="'formControlName'"
[isShortFormat]="false"
[keyField]="'keyField'"
[pixKeyMaskOptions]="pixKeyMaskOptions"
[pixPk]="'pixPk'"
[placeholder]="'Nenhuma conta vinculada'"
[showCreationOption]="false"
[showOnlyAccounts]="false"
[showOnlyPixKeys]="false"
[whitelists]="{}"
/>

Inputs​

The BfmCheckingAccountDropdownComponent component has the following inputs:

autoSelectAccount​

Whether it should auto select the checking account

TypeDefault
booleanfalse

autoSelectSingleAccount​

Whether it should auto select the checking account if it's the only one available

TypeDefault
booleanfalse

blacklists​

Object of blacklists for each checking account property

TypeDefault
Record<string>{}

checkingAccounts​

CheckingAccounts list

TypeDefault
CheckingAccount[][]

companyPk​

Company PK

TypeDefault
stringnull

companyRelatedPk​

CompanyRelatedPk

TypeDefault
stringnull

formControl​

CVA form control

TypeDefault
UntypedFormControlnull

formControlName​

CVA form control name

TypeDefault
stringnull

isShortFormat​

Controls whether humanized message will be in short format

TypeDefault
booleanfalse

keyField​

Checking account's field which will be saved to the form control

TypeDefault
stringnull

pixKeyMaskOptions​

Pix key mask options

Type
{ [x: number]: string; }

Default value:

{ 
[PIX_KEY_TYPE.cpfCnpj]: '000.000.000-00||00.000.000/0000-00',
[PIX_KEY_TYPE.phoneNumber]: '(00)00000-0000'
}

pixPk​

Pix pk to be selected

TypeDefault
stringnull

placeholder​

Placeholder text for the dropdown

TypeDefault
string'Nenhuma conta vinculada'

showCreationOption​

Show creation option

TypeDefault
booleanfalse

showOnlyAccounts​

Displays accounts without display pix keys in checking account list

TypeDefault
booleanfalse

showOnlyPixKeys​

Displays only pix keys in checking account list

TypeDefault
booleanfalse

whitelists​

Object of whitelists for each checking account property

TypeDefault
Record<string>{}

Events​

The BfmCheckingAccountDropdownComponent component has the following Events:

createCheckingAccount​

Create checking account option

Type
EventEmitter