react-native-safe-area-context 用法

react-native-safe-area-context 主要用于处理异形屏的适配 ,React Navigation 的适配就是使用该组件进行处理的。 React Navigation V5 版是通过 safeAreaInsets 属性进行设置的,新版将该功能提取出来,通过 组件、Hook 方式处理,这样做的好处是:无需自行监听屏幕旋转,会自动更新同步渲染界面,处理起来也更加灵活。

安装

yarn add react-native-safe-area-context
npx pod-install

使用

SafeAreaProvider

这是一个提供者,本身不会对布局产生任何影响,但只有在该组件包裹下的子组件才能使用 react-native-safe-area-context 提供的功能,通常,可以直接包裹在根组件上。React Navigation 本身已经使用该组件作了包裹,所以在配合 React Navigation 使用时,无需再进行包裹了,直接使用即可。独立使用时,可使用类似如下的代码:

import { SafeAreaProvider } from 'react-native-safe-area-context';

function App() {
  // 通常可以在 APP 最外层使用,也可以在深层使用,但只有子组件才能API
  // 注意:不要把该组件放到有动画或滚动的组件下级,比如 Animated 或 ScrollView
  // 支持 View 的所有属性,并支持额外的一个 initialMetrics 属性
  return <SafeAreaProvider initialMetrics={null}>...</SafeAreaProvider>;
}

initialWindowMetrics

上面 SafeAreaProviderinitialMetrics 属性需要提供一个 Object 值,提供相关的尺寸位置信息,默认为自动获取,无需提供。默认提供的信息可以通过该 Hook 获取

import { initialWindowMetrics } from 'react-native-safe-area-context';

function HookComponent() {
  // 数据格式
  // {
  //    frame: { x: number, y: number, width: number, height: number },
  //    insets: { top: number, left: number, right: number, bottom: number },
  // }
  const insets = initialWindowMetrics();
  
  ...
}

useSafeAreaFrame / SafeAreaFrameContext

获取离当前组件最近的 SafeAreaProvider 尺寸信息

import { 
   useSafeAreaFrame,
   SafeAreaFrameContext
} from 'react-native-safe-area-context';

// 函数式组件
function HookComponent() {
  // 获取 SafeAreaProvider 的宽高、偏移 x,y
  const {x, y, width, height} = useSafeAreaFrame();
  
  // ...
}

// class 组件
class ClassComponent extends React.Component {
  render() {
    return (
      <SafeAreaFrameContext.Consumer>
        {(frame) => <View ... />}
      </SafeAreaFrameContext.Consumer>
    );
  }
}

useSafeAreaInsets / SafeAreaInsetsContext

获取当前屏幕异形部分的尺寸

import { 
  useSafeAreaInsets,
  SafeAreaInsetsContext
} from 'react-native-safe-area-context';

// 函数式组件
function HookComponent() {
  // 该 Hook 返回屏幕四个方向上异形的尺寸
  // 若屏幕旋转,该值也会自动更新,促使组件同步更新
  const {left, right, top, bottom} = useSafeAreaInsets();

  return <View style={{ paddingBottom: Math.max(bottom, 16) }} />;
}

// class 组件
class ClassComponent extends React.Component {
  render() {
    return (
      <SafeAreaInsetsContext.Consumer>
        {(insets) => <View style={{ paddingTop: insets.top }} />}
      </SafeAreaInsetsContext.Consumer>
    );
  }
}

withSafeAreaInsets

上面两组分别是使用 Hook / Context 方式获取相关尺寸数值应用到 FunctionClass 组件,对于 AreaInsets 还可使用 withSafeAreaInsets 应用到高阶组件。

class MyConmpoent extends React.Component {
  render() {
    const {insets} = this.props;
    return <View style={{ paddingTop: insets.top }} />
  }
}

export default withSafeAreaInsets(MyConmpoent);

SafeAreaView

以上都是比较灵活的方式,自行获取数值进行处理。还有另外一种较为方便的方式,在 SafeAreaProvider 任何层级内都可以使用 SafeAreaView,该组件与 View 相同,默认添加了 padding 属性,在 View 四周添加了空白用以避开屏幕异形的部分,该组件会在屏幕旋转、或数值发生变动时自动更新。

import { SafeAreaView } from 'react-native-safe-area-context';

function SomeComponent() {
  // 支持 edges / mode 两个属性
  // edges: 设置要添加空白的方向,数组形式
  // mode:添加空白的方式,支持 padding(默认) / margin
  return (
    <SafeAreaView 
        style={{ flex: 1, backgroundColor: 'red' }} 
        edges={['top', 'bottom', 'right', 'left']}
        mode="padding"
    >
      <View style={{ flex: 1, backgroundColor: 'blue' }} />
    </SafeAreaView>
  );
}

图解

react-native-safe-area-context 返回屏幕异形尺寸,针对的是“非矩形”的部分,而不是“刘海”、“针孔”。如下图,倒脚部分都算作异形,在竖屏时通常没啥问题,但在横屏时可能不符合设计预期,需注意。

页面演示

React Navigation 举例, 该组件已内置 react-native-safe-area-context,并在 HeaderBottomTab组件中处理了 top / bottom 方向的异形屏。在使用 React Navigation 时,如果是一般情况,在页面组件中无需刻意处理,如下图

竖屏演示

但碰到以下两种情况时,仍需手动处理

  • 页面组件未使用 HeaderBottomTab,这就与上面的普通组件没什么区别了,很好理解
  • 页面支持横屏,在横屏时,如未做任何处理,效果如下图
未对横屏进行处理

如果将页面组件包裹在 SafeAreaView 组件内,top / bottom 方向异形尺寸为 0left / right 方向会自动应用 padding,效果如下图,但很有可能,下图也不一定符合设计预期,比如 left 方向,圆角异形导致了 padding,但同时也浪费了不少可视区域,可通过 SafeAreaViewedges 属性进行设置。

页面组件使用 SafeAreaView
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容