register-alert.mdx 634 B

123456789101112131415161718
  1. ---
  2. title: "RegisterAlert"
  3. generated: true
  4. ---
  5. <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-alert.ts" sourceLine="12" packageName="@vendure/admin-ui" since="2.2.0" />
  6. Registers an alert which can be displayed in the Admin UI alert dropdown in the top bar.
  7. The alert is configured using the [AlertConfig](/reference/admin-ui-api/alerts/alert-config#alertconfig) object.
  8. ```ts title="Signature"
  9. function registerAlert(config: AlertConfig): void
  10. ```
  11. Parameters
  12. ### config
  13. <MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/alerts/alert-config#alertconfig'>AlertConfig</a>`} />