Function StateSplash

StateSplash(__namedParameters: StateProps): Element
A Splash for displaying the status of state. State in this case is the object from a backend. This splash provides a visual representation as well as being a placeholder for state.

It is not the intent that this component be used for opportunistic UI, That is what skeletons are for. State splash should only be used for route hydration or as the final result of state. i.e. Nothing was found, error occurred etc.
Parameters
- __namedParameters: StateProps
  These props are for StateSplash.
  - Optionalbody?: string
    
    Text to use as a description
  - Optionalicon?: StateIcon
    
    Icon to display. There are occasions, that regardless of the value supplied to this prop, its value will be automatically set, they are:
    
    stackTrace has a value, this to EmptyStateStatus.danger
  - OptionalstackTrace?: string
    
    Stack trace message. When this prop is provided with a value, the icon is set to StateIcon.danger
  - Optionalstatus?: EmptyStateStatus
    
    Type of State. There are occasions, that regardless of the value supplied to this prop, its value will be automatically set, they are:
    
    icon has been set to StateIcon.danger will set this to EmptyStateStatus.danger
    
    icon has been set to StateIcon.warning will set this to EmptyStateStatus.warning
  - titleText: string
    
    Text to use for the state title.
Returns Element
Example
Example of loading spinner.
```
<StateSplash
     titleText = "Loading Data"
     icon = {StateIcon.loading}
/>
```
Example of an error.
```
<StateSplash
     body = {Exception.message}
     icon = {StateIcon.danger}
     stackTrace = {Exception.stack}
     titleText = "An Error Occurred"
/>
```
Since
0.13.0

Function StateSplash

Parameters

`Optional`body?: string

`Optional`icon?: StateIcon

`Optional`stackTrace?: string

`Optional`status?: EmptyStateStatus

titleText: string

Returns Element

Example

Since

Settings

Function StateSplash

Parameters

Optionalbody?: string

Optionalicon?: StateIcon

OptionalstackTrace?: string

Optionalstatus?: EmptyStateStatus

titleText: string

Returns Element

Example

Since

Settings

`Optional`body?: string

`Optional`icon?: StateIcon

`Optional`stackTrace?: string

`Optional`status?: EmptyStateStatus