Skip to main content

ToastOverlay

Content

Do not use this component directly!

Use showToast to present this component because it's linked to navigation.

Represents a simple toast overlay which animatedly appears for 3 seconds with presented text and the animatedly disappears.

Params

NameTypeRequiredDefault valueDescription
textstringTrue-Text which will be shown
textStyleTextStyleFalseUndefinedStyle of text
iconImageURISourceFalseUndefinedIcon which will be shown on the lft side from message
iconStyleImageStyleFalseUndefinedIcon style
loadingbooleanFalseUndefinedShows activity indicator
locationbottom or topFalsetop on iOS, bottom on AndroidLocation of toast

Usage example

  const showTopToast = useCallback(() => {
showToast({
text: "Toast message text",
location: "top",
});
}, []);

const showBottomToast = useCallback(() => {
showToast({
text: "Toast message text",
location: "bottom",
});
}, []);

const showBottomToastLoading = useCallback(() => {
showToast({
text: "Loading message",
location: "bottom",
loading: true,
});
}, []);

const showBottomToastIcon = useCallback(() => {
showToast({
text: "Message with icon",
location: "bottom",
icon: ImageResources.camera,
iconStyle: {tintColor: Colors.red},
});
}, []);

return (
<ScrollView style={CommonStyles.flexPlatformBackground} contentContainerStyle={CommonStyles.flexColumnCenterStretch}>
<PrimaryButton type={ButtonType.solid} label={"Show top toast"} onPress={showTopToast} />
<PrimaryButton type={ButtonType.solid} label={"Show bottom toast"} onPress={showBottomToast} />
<PrimaryButton type={ButtonType.solid} label={"Show loading"} onPress={showBottomToastLoading} />
<PrimaryButton type={ButtonType.solid} label={"Show icon"} onPress={showBottomToastIcon} />
</ScrollView>
);