index.md

Getting started

Installation

• Plugin setup

Usage

• Integration with @backstage/plugin-search

Components

• Display latest announcements on a page
• Display a banner for the latest announcement
• Display announcements in a timeline

Customization

Overriding the AnnouncementCard

It is possible to specify the length of the title for announcements rendered on the AnnouncementsPage. You can do this by passing a cardOptions prop to the AnnouncementsPage component. The cardOptions prop accepts an object with the following properties:

{
  titleLength: number; // defaults to 50
}

Example

<AnnouncementsPage cardOptions={{ titleLength: 10 }} />

Overriding the AnnouncementsPage

It is possible to specify the Announcements within a specific category rendered on the AnnouncementsPage. You can do this by passing a category prop to the AnnouncementsPage component. The AnnouncementsPage prop accepts an value such as:

category = 'conferences';

Example

<AnnouncementsPage category="conferences" />

Overriding the AnnouncementCreateButton

It is possible to specify the text for the "New announcement" button rendered on the AnnouncementsPage. You can do this by passing a buttonOptions prop to the AnnouncementsPage component. The buttonOptions prop accepts an object with the following properties:

{
  name: string; // defaults to 'announcement'
}