Anatomy
Anatomy summary lists and describes all the elements within a component (including nested components).
|
Element |
Description |
Optional? |
|---|---|---|
|
1. Status Icon |
Predefined icon correlating to the health status of a machine. |
No |
|
2. Status Label |
Predefined text describing health status of a machine: - Healthy: completes a health check without any errors or warnings. - Healthy with warnings: completes a health check but encounters a non-critical failure during the health check. - Unavailable: is not contactable by Octopus during a health check. - Unhealthy: completes a health check but encounters a critical failure while running the health check script. - Unknown: health checks are turned off, so health check status cannot be determined. |
Yes |
Variants
Variants contain different versions of the component depending on specific properties, such as state, size, colour, optional iconography, etc.
| Property | Values | Default |
|---|---|---|
| size Variant | medium | small | medium |
| status Variant | healthy | healthy with warnings | unhealthy | unavailable | unknown | disabled | healthy |
| hasLabel Variant | true | false | true |
Component dependencies
This component is internally dependent on the following components:
Related components
Badge
Badges highlight the status of a corresponding object
Counter Badge
Used to add a count to an associated item.
Help and support