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.
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:
<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
| Type | Default |
|---|---|
boolean | false |
autoSelectSingleAccount
Whether it should auto select the checking account if it's the only one available
| Type | Default |
|---|---|
boolean | false |
blacklists
Object of blacklists for each checking account property
| Type | Default |
|---|---|
Record<string> | {} |
checkingAccounts
CheckingAccounts list
| Type | Default |
|---|---|
| CheckingAccount[] | [] |
companyPk
Company PK
| Type | Default |
|---|---|
string | null |
companyRelatedPk
CompanyRelatedPk
| Type | Default |
|---|---|
string | null |
formControl
CVA form control
| Type | Default |
|---|---|
UntypedFormControl | null |
formControlName
CVA form control name
| Type | Default |
|---|---|
string | null |
isShortFormat
Controls whether humanized message will be in short format
| Type | Default |
|---|---|
boolean | false |
keyField
Checking account's field which will be saved to the form control
| Type | Default |
|---|---|
string | null |
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
| Type | Default |
|---|---|
string | null |
placeholder
Placeholder text for the dropdown
| Type | Default |
|---|---|
string | 'Nenhuma conta vinculada' |
showCreationOption
Show creation option
| Type | Default |
|---|---|
boolean | false |
showOnlyAccounts
Displays accounts without display pix keys in checking account list
| Type | Default |
|---|---|
boolean | false |
showOnlyPixKeys
Displays only pix keys in checking account list
| Type | Default |
|---|---|
boolean | false |
whitelists
Object of whitelists for each checking account property
| Type | Default |
|---|---|
Record<string> | {} |
Events
The BfmCheckingAccountDropdownComponent component has the following Events:
createCheckingAccount
Create checking account option
| Type |
|---|
EventEmitter |