Banner
A banner informs merchants about important changes or persistent conditions. Use if you need to communicate to merchants in a prominent way, without blocking other actions.
Name | Type | Description | Options |
---|---|---|---|
title | string |
The text displayed inside the banner. | |
variant | BannerVariant? |
Determines the banner's appearance. | information : Use to provide information.confirmation : Use to indicate success.alert : Use to indicate a warning.error : Use to indicate an error. |
action | string? |
Overwrite the action text. Defaults to "Dismiss". | |
onPress | () => void? |
Overwrite the default onPress. Defaults to dismissing the banner. | |
visible | boolean |
Determines the banner's visibility. |
- Use when needing to communicate to merchants in a way that is persistent but non-interruptive.
- Only one banner should be visible at a time.