为 React Native 应用提供从右到左的布局支持

2016年8月19日 ·7 分钟阅读

Facebook 软件工程师实习生

在将应用发布到应用商店后，国际化是进一步扩大受众范围的下一步。全球超过 20 个国家和地区的人们使用从右到左 (RTL) 的语言。因此，使你的应用支持 RTL 对他们来说是必要的。

我们很高兴地宣布，React Native 已经改进以支持 RTL 布局。现在，在 react-native master 分支中即可使用此功能，并且将在下一个候选版本 v0.33.0-rc 中提供。

这涉及更改 RN 使用的核心布局引擎 css-layout、RN 核心实现以及特定的开源 JS 组件以支持 RTL。

为了在生产环境中对 RTL 支持进行实战测试，最新版本的 **Facebook 广告管理工具** 应用（第一个 100% 使用 RN 的跨平台应用）现在提供阿拉伯语和希伯来语版本，并为 iOS 和 Android 提供 RTL 布局。以下是它在这些 RTL 语言中的外观

RN 中支持 RTL 的概览更改

css-layout 已经具有布局的 start 和 end 概念。在从左到右 (LTR) 布局中，start 表示 left，end 表示 right。但在 RTL 中，start 表示 right，end 表示 left。这意味着我们可以使 RN 依赖于 start 和 end 计算来计算正确的布局，包括 position、padding 和 margin。

此外，css-layout 已经使每个组件的方向继承自其父组件。这意味着，我们只需要将根组件的方向设置为 RTL，整个应用就会翻转。

下图描述了高级别的更改

这些包括

css-layout 对绝对定位的 RTL 支持
在 RN 核心实现中将 left 和 right 映射到阴影节点的 start 和 end
并公开一个桥接实用程序模块来帮助控制 RTL 布局

通过此更新，当你允许应用使用 RTL 布局时

每个组件布局都将水平翻转
如果你使用的是支持 RTL 的开源组件，某些手势和动画将自动具有 RTL 布局
可能需要极少的额外工作才能使你的应用完全支持 RTL

使应用支持 RTL

要支持 RTL，你应该首先将 RTL 语言包添加到你的应用中。
- 请参阅 iOS 和 Android 的通用指南。

通过在原生代码开头调用 allowRTL() 函数来允许应用使用 RTL 布局。我们提供此实用程序，以便仅在您的应用准备就绪时才应用 RTL 布局。以下是一个示例

iOS

// in AppDelegate.m
  [[RCTI18nUtil sharedInstance] allowRTL:YES];

Android

// in MainActivity.java
  I18nUtil sharedI18nUtilInstance = I18nUtil.getInstance();
  sharedI18nUtilInstance.allowRTL(context, true);

对于 Android，您需要在 AndroidManifest.xml 文件的 <application> 元素中添加 android:supportsRtl="true"。

现在，当您重新编译您的应用并将设备语言更改为 RTL 语言（例如阿拉伯语或希伯来语）时，您的应用布局应该会自动更改为 RTL。

编写支持 RTL 的组件

通常，大多数组件已经支持 RTL，例如

从左到右布局

从右到左布局

但是，有几种情况需要注意，您需要使用 I18nManager。在 I18nManager 中，有一个常量 isRTL 来判断应用的布局是否是 RTL，以便您可以根据布局进行必要的更改。

具有方向含义的图标

如果您的组件包含图标或图像，它们在 LTR 和 RTL 布局中的显示方式相同，因为 RN 不会翻转您的源图像。因此，您应该根据布局样式翻转它们。

从左到右布局

从右到左布局

以下是根据方向翻转图标的两种方法

向图像组件添加 transform 样式

<Image
  source={...}
  style={{transform: [{scaleX: I18nManager.isRTL ? -1 : 1}]}}
/>

或者，根据方向更改图像源

let imageSource = require('./back.png');
if (I18nManager.isRTL) {
  imageSource = require('./forward.png');
}
return <Image source={imageSource} />;

手势和动画

在 Android 和 iOS 开发中，当您更改为 RTL 布局时，手势和动画与 LTR 布局相反。目前，在 RN 中，手势和动画不是在 RN 核心代码级别支持，而是在组件级别支持。好消息是，其中一些组件现在已经支持 RTL，例如 SwipeableRow 和 NavigationExperimental。但是，其他带有手势的组件需要手动支持 RTL。

一个说明手势 RTL 支持的好例子是 SwipeableRow。

手势示例

// SwipeableRow.js
_isSwipingExcessivelyRightFromClosedPosition(gestureState: Object): boolean {
  // ...
  const gestureStateDx = IS_RTL ? -gestureState.dx : gestureState.dx;
  return (
    this._isSwipingRightFromClosed(gestureState) &&
    gestureStateDx > RIGHT_SWIPE_THRESHOLD
  );
},

动画示例

// SwipeableRow.js
_animateBounceBack(duration: number): void {
  // ...
  const swipeBounceBackDistance = IS_RTL ?
    -RIGHT_SWIPE_BOUNCE_BACK_DISTANCE :
    RIGHT_SWIPE_BOUNCE_BACK_DISTANCE;
  this._animateTo(
    -swipeBounceBackDistance,
    duration,
    this._animateToClosedPositionDuringBounce,
  );
},

维护您的 RTL 就绪应用

即使在初始 RTL 兼容应用发布之后，您也可能需要迭代新功能。为了提高开发效率，I18nManager 提供了 forceRTL() 函数，以便在不更改测试设备语言的情况下进行更快的 RTL 测试。您可能希望在您的应用中为此提供一个简单的开关。以下是 RNTester 中 RTL 示例的一个示例

<RNTesterBlock title={'Quickly Test RTL Layout'}>
  <View style={styles.flexDirectionRow}>
    <Text style={styles.switchRowTextView}>forceRTL</Text>
    <View style={styles.switchRowSwitchView}>
      <Switch
        onValueChange={this._onDirectionChange}
        style={styles.rightAlignStyle}
        value={this.state.isRTL}
      />
    </View>
  </View>
</RNTesterBlock>;

_onDirectionChange = () => {
  I18nManager.forceRTL(!this.state.isRTL);
  this.setState({isRTL: !this.state.isRTL});
  Alert.alert(
    'Reload this page',
    'Please reload this page to change the UI direction! ' +
      'All examples in this app will be affected. ' +
      'Check them out to see what they look like in RTL layout.',
  );
};

处理新功能时，您可以轻松切换此按钮并重新加载应用以查看 RTL 布局。好处是您无需更改语言设置即可进行测试，但是某些文本对齐方式不会更改，如下一节所述。因此，在启动之前，始终建议在 RTL 语言环境中测试您的应用。

限制和未来计划

RTL 支持应该涵盖您应用中的大多数用户体验；但是，目前存在一些限制

文本对齐行为在 Android 和 iOS 中有所不同
- 在 iOS 中，默认文本对齐方式取决于活动的语言包，它们始终位于一侧。在 Android 中，默认文本对齐方式取决于文本内容的语言，即英语将左对齐，阿拉伯语将右对齐。
- 理论上，这应该在各个平台上保持一致，但是某些人在使用应用程序时可能更喜欢一种行为。可能需要进行更多用户体验研究才能找到文本对齐的最佳实践。

没有“真正的”左/右

如前所述，我们将 JS 端的 left/right 样式映射到 start/end，RTL 布局代码中的所有 left 在屏幕上都变为“右”，代码中的 right 在屏幕上变为“左”。这很方便，因为您不需要过多地更改产品代码，但这意味着无法在代码中指定“真正的左”或“真正的右”。将来，可能需要允许组件控制其方向，而不管语言如何。
使手势和动画的 RTL 支持对开发人员更加友好

目前，使手势和动画与 RTL 兼容仍然需要一些编程工作。将来，理想情况下是找到一种方法，使手势和动画的 RTL 支持对开发人员更加友好。

试一试！

查看 RNTester 中的 RTLExample 以了解更多关于 RTL 支持的信息，并让我们知道它如何为您工作！

最后，感谢您的阅读！我们希望 React Native 的 RTL 支持可以帮助您为国际用户扩展您的应用！

RN 中支持 RTL 的概览更改​

使应用支持 RTL​

编写支持 RTL 的组件​

具有方向含义的图标​

手势和动画​

手势示例​

动画示例​

维护您的 RTL 就绪应用​

限制和未来计划​

试一试！​