A maintenance component displays a screen to users when they are undergoing scheduled maintenance.
Examples
Basic maintenance
To provide users with basic information regarding maintenance. A basic maintenance state should contain an appropriate and informative titleText. defaultBodyText will be used by default.
Maintenance in progress
We are currently undergoing scheduled maintenance. Thank you for understanding.
Custom maintenance
To override the default bodyText and footer link, specify your own using bodyText and customFooter. You may add a startTime, endTime and timeZone that will be displayed as shown below. timeZone will be set to UTC by default.
Maintenance in progress
We are currently undergoing scheduled maintenance and will be unavailable from 6am to 8am UTC.
Props
Maintenance
| Name | Type | Default | Description |
|---|---|---|---|
| bodyText | React.ReactNode | Custom body text | |
| customFooter | React.ReactNode | 'For more information please visit' | Custom footer content |
| defaultBodyText | React.ReactNode | 'We are currently undergoing scheduled maintenance. Thank you for understanding.' | A default bodyText used if no bodyText is provided |
| endTime | string | End time in a specific time zone | |
| headingLevel | No type info | 'h5' | |
| ouiaId | string | number | 'Maintenance' | Custom OUIA ID |
| redirectLinkText | string | 'status.redhat.com.' | Information link title |
| redirectLinkUrl | string | 'https://status.redhat.com' | Information link |
| startTime | string | Start time in a specific time zone | |
| timeZone | string | 'UTC' | Time zone specification |
| titleText | string | 'Maintenance in progress' | The title for the maintenance message |
