import { HistoryEntryConfig } from '../providers/custom-history-entry-component/history-entry-component-types'; /** * @description * Registers a {@link HistoryEntryComponent} for displaying history entries in the Order/Customer * history timeline. * * @example * ```ts * import { Component } from '\@angular/core'; * import { * CustomerFragment, * CustomerHistoryEntryComponent, * registerHistoryEntryComponent, * SharedModule, * TimelineDisplayType, * TimelineHistoryEntry, * } from '\@vendure/admin-ui/core'; * * \@Component({ * selector: 'tax-id-verification-component', * template: ` *
* Tax ID {{ entry.data.taxId }} was verified * * * *
*
Tax ID {{ entry.data.taxId }} could not be verified
* `, * standalone: true, * imports: [SharedModule], * }) * class TaxIdHistoryEntryComponent implements CustomerHistoryEntryComponent { * entry: TimelineHistoryEntry; * customer: CustomerFragment; * * getDisplayType(entry: TimelineHistoryEntry): TimelineDisplayType { * return entry.data.valid ? 'success' : 'error'; * } * * getName(entry: TimelineHistoryEntry): string { * return 'Tax ID Verification Plugin'; * } * * isFeatured(entry: TimelineHistoryEntry): boolean { * return true; * } * * getIconShape(entry: TimelineHistoryEntry) { * return entry.data.valid ? 'check-circle' : 'exclamation-circle'; * } * } * * export default [ * registerHistoryEntryComponent({ * type: 'CUSTOMER_TAX_ID_VERIFICATION', * component: TaxIdHistoryEntryComponent, * }), * ]; * ``` * * @since 1.9.0 * @docsCategory custom-history-entry-components */ export declare function registerHistoryEntryComponent(config: HistoryEntryConfig): import("@angular/core").EnvironmentProviders;