Header
Overview
Standard Header wrapper component that spaces evenly it’s child components This includes the telescopeSelector component which can be suppressed if not required.
import { Header } from '@ska-telescope/ska-gui-components';
...
<Header testId="testId" title="SOME TITLE">
<Grid item>THIS</Grid>
<Grid item>IS</Grid>
<Grid item>THE</Grid>
<Grid item>FOOTER</Grid>
</Header>
Property |
Type |
Required |
default |
|
---|---|---|---|---|
ariaDescription |
string |
No |
Used by Screen Readers |
|
ariaTitle |
string |
No |
AlertCard |
Used by Screen Readers |
docs |
{ tooltip: string; url: string; } |
No |
Displays docs icon if a url is provided |
|
selectTelescope |
boolean |
No |
true |
Allows the selection of telescope to be suppressed |
showHelp |
boolean |
No |
false |
Allows the help to be displayed if there is content to be displayed |
testId |
string |
Yes |
Identifier for testing purposes |
|
title |
string |
No |
Title of the application, which is forced to upper case |
|
toolTip |
|
|
|
|
Property |
Type |
Required |
default |
|
---|---|---|---|---|
skao |
string |
No |
‘SKAO WebSite’ |
ToolTip for the SKAO Logo |
mode |
string |
No |
‘Light / Dark Mode’ |
ToolRip for the Theme mode |
Constants
none
Testing Identifier
Provided by the property testId