Skip to content

Commit d7ffaa4

Browse files
committed
docs: update README and types for RTL support clarification
1 parent fef29ae commit d7ffaa4

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ An extremely lightweight, opinionated toast component for React Native.
1616
- Promise handling with automatic loading → success/error states
1717
- Toast stacking with configurable limits
1818
- **Works above modals** - automatic on iOS, simple setup on Android
19-
- **RTL support** - perfect for Arabic and other RTL languages
19+
- **RTL support** - code-level RTL for when you're not using native RTL (`I18nManager`)
2020
- Completely customizable - colors, icons, styles, animations
2121
- Full Expo compatibility
2222

@@ -181,7 +181,7 @@ Customize all toasts globally via the `config` prop on `<BreadLoaf />`:
181181
<BreadLoaf
182182
config={{
183183
position: 'bottom',
184-
rtl: false, // Enable for RTL languages
184+
rtl: false, // Code-level RTL — not needed if using native RTL (I18nManager)
185185
stacking: true,
186186
maxStack: 3,
187187
defaultDuration: 4000,

packages/react-native-bread/src/types.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,11 @@ export interface ToastTheme {
4343
position: ToastPosition;
4444
/** Extra offset from safe area edge (in addition to safe area insets) */
4545
offset: number;
46-
/** Enable right-to-left layout (reverses icon/text order) */
46+
/**
47+
* Enable right-to-left layout at the code level (reverses icon/text order and text alignment).
48+
* Only needed when you handle RTL in JavaScript — native RTL (e.g. via `I18nManager.forceRTL`)
49+
* already flips the entire layout automatically, so this option is unnecessary in that case.
50+
*/
4751
rtl: boolean;
4852
/** Whether to show multiple toasts stacked (default: true). When false, only one toast shows at a time. */
4953
stacking: boolean;

0 commit comments

Comments
 (0)