Skip to main content

Notification Rules

This section describes the BfmNotificationRulesComponent component.

Composition

The BfmNotificationRulesComponent is composed of the following components:

Usage

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

notification-rules.component.ts
import { BfmNotificationRulesComponent } from '@celerofinancas/ui-user-kit';

@Component({
standalone: true,
selector: 'notification-rules',
imports: [BfmNotificationRulesComponent],
templateUrl: './notification-rules.component.html',
})
export class NotificationRulesComponent {}

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

notification-rules.component.html
<bfm-notification-rules 
[activeMailingOptions]="activeMailingOptions"
[companyPk]="companyPk"
[companyRelatedPk]="companyRelatedPk"
[configurationTypeText]="configurationTypeText"
[documentTypeOptions]="documentTypeOptions"
[hasCustomMailing]="hasCustomMailing"
[saveConfigurationText]="saveConfigurationText"
/>

Inputs

The BfmNotificationRulesComponent component has the following inputs:

activeMailingOptions

Company's or CompanyRelater's active mailing options

TypeDefault
MailingOption[] of @celerofinancas/core-ts[]

companyPk

Company primary key for mailing options

TypeDefault
stringnull

companyRelatedPk

Company related primary key for mailing options

TypeDefault
stringnull

configurationTypeText

Configuration type text

TypeDefault
string'Tipo de configuração'

documentTypeOptions

Notifications' document type options

Type
Readonly Array of any

Default value:

[
{
documentType: DOCUMENT_TYPES.bill,
label: 'Boleto',
visible: this.activeModules.bill,
},
{
documentType: DOCUMENT_TYPES.invoice,
label: 'Nota Fiscal',
visible: this.activeModules.invoice,
},
{
documentType: DOCUMENT_TYPES.creditCardBilling,
label: 'Cartão de crédito',
visible: this.activeModules.card,
},
]

hasCustomMailing

Whether the CompanyRelated has custom mailing options enabled - Default to: false

TypeDefault
booleanfalse

saveConfigurationText

Save configuration text - Default to: 'Salvar alterações'

TypeDefault
string'Salvar alterações'

Events

The BfmNotificationRulesComponent component has no events.