组件

hippy-react 的组件接近终端，语法上接近 React Native。

Image

[Image 范例]

图片组件，用于显示单张图片。

注意： 必须指定样式中的宽度和高度，否则无法工作。

基本用法

直接加载远程图片：

<Image
  style={{ width: 200, height: 200 }}
  source={{ uri: 'http://res.imtt.qq.com/flower-h5/qb_icon_new.png' }}
  resizeMode={Image.resizeMode.cover}
/>;

或者使用终端的本地图片加载能力：

import icon from './qb_icon_new.png';
<Image
  style={{ width: 200, height: 200 }}
  source={{ uri: icon }}
  resizeMode={Image.resizeMode.cover}
/>

本地图片还有另外一种形式：通过 base64 图片引用进来也可以支持，直接通过加载时定义 Loader，用 url-loader 加载即可。

参数

方法

getSize

(uri: string, success: (width: number, height: number) => void, failure?: ErrorFunction) => void 在显示图片前获取图片的宽高(以像素为单位)。如果图片地址不正确或下载失败, 此方法也会失败。

要获取图片的尺寸, 首先需要加载或下载图片(同时会被缓存起来)。这意味着理论上你可以用这个方法来预加载图片，虽然此方法并没有针对这一用法进行优化，而且将来可能会换一些实现方案使得并不需要完整下载图片即可获取尺寸。所以更好的预加载方案是使用下面那个专门的预加载方法。

不适用于静态图片资源。

• uri: string - 图片的地址
• success: (width: number, height: number) => void - 此函数会在获取图片与其宽高成功后被回调
• failure: ErrorFunction - 此函数会在如获取图片失败等异常情况被回调

prefetch

(url: string) => void 预加载一个远程图片，将其下载到本地磁盘缓存。

• uri: string - 图片的地址

ListView

[ListView 范例]

可复用垂直列表功能，尤其适合大量条目的数据渲染。

参数

方法

scrollToContentOffset

(xOffset: number, yOffset: number: animated: boolean) => void 通知 ListView 滑动到某个具体坐标偏移值(offset)的位置。

• xOffset: number - 滑动到 X 方向的 offset
• yOffset: numbere - 滑动到 Y 方向的 offset
• animated: boolean - 滑动过程是否使用动画

scrollToIndex

(xIndex: number, yIndex: number: animated: boolean) => void 通知 ListView 滑动到第几个 item。

• xIndex: number - 滑动到 X 方向的第 xIndex 个 item
• yIndex: numbere - 滑动到 Y 方向的 xIndex 个 item
• animated: boolean - 滑动过程是否使用动画

Modal

[Modal 范例]

模态弹窗组件。

参数

Navigator

导航容器。通过这个组件，你可以实现一个app页面的导航、跳转等功能。

该组件通过启动一个新的 Hippy 实例实现，在 2.0 下实例之间可能无法互相通信，iOS 上也必须作为根节点包裹所有子组件，使用有很大限制。

参数

方法

clear

() => void 清空 Navigator 的历史栈

getCurrentPage

() => Object 获取当前 Navigator 的页面，会返回 routeName , component 和 initProps 等属性值

pop

(options: Object) => void 在 Navigator 返回上一个页面

• options: Object
  • toDirection: left | right | top | bottom - 自定义页面pop 的方向

push

(options: Object) => void 进入一个新的页面

• options: Object
  • routeName: string - 路由名称
  • component: ReactComponent - 新页面组件
  • initProps: Object - 初始化参数
  • toDirection: left | right | top | bottom - 自定义页面pop 的方向

RefreshWrapper

[RefreshWrapper 范例]

包裹住 ListView 提供下滑刷新功能的组件.

RefreshWrapper 现在只支持包裹一个 ListView 组件，暂不支持别的组件的下滑刷新功能。

参数

方法

refreshCompleted

() => void 调用此方法，告知 RefreshWrapper 已经刷新完毕，RefreshWrapper 将会收起刷新栏。

startRefresh

() => void 调用此方法，手工告知 RefreshWrapper 开始刷新，展开刷新栏。

ScrollView

[Scroll 范例]

滚动视图组件，用于展示不确定高度的内容，它可以将一系列不确定高度的子组件装到一个确定高度的容器中，使用者可通过上下或左右滚动操作查看组件宽高之外的内容。

一个包装了平台的 ScrollView（滚动视图）的组件，同时还集成了触摸锁定的“响应者”系统。

注意：记住 ScrollView 必须有一个确定的高度才能正常工作，因为它实际上所做的就是将一系列不确定高度的子组件装进一个确定高度的容器（通过滚动操作）。要给一个 ScrollView 确定一个高度的话，要么直接给它设置高度（不建议），要么确定所有的父容器都有确定的高度。一般来说我们会给 ScrollView 设置 flex: 1 以使其自动填充父容器的空余空间，但前提条件是所有的父容器本身也设置了flex或者指定了高度，否则就会导致无法正常滚动，你可以使用元素查看器来查找问题的原因。

注意： ScrollView 无法使用 onTouch 系列事件监听触屏行为，但可以用 onScroll 监听滚动行为。

参数

方法

scrollTo

(x: number, y: number, animated: boolean) => void 滚动到指定的 X，Y 偏移值，第三个参数为是否启用平滑滚动动画。

• x: number - X 偏移值
• y: number - Y 偏移值
• animated: boolean - 是否启用平滑滚动动画。

scrollToWithDuration

(x: number, y: number, duration: number) => void 经过指定的时间平滑滚动到 X、Y 偏移值。

• x: number - X 偏移值
• y: number - Y 偏移值
• duration: number - 毫秒为单位的滚动时间

TextInput

[TextInput 范例]

输入文本的基本组件。

本组件的属性提供了多种特性的配置，譬如自动完成、自动大小写、占位文字，以及多种不同的键盘类型（如纯数字键盘）等等。

差异性

由于系统组件层的差异，如果 TextInput 处于会被键盘遮住的位置，在呼出键盘后：

• iOS 则是正常的遮住
• Android 的表现为页面会被键盘顶起，顶起的幅度取决于 TextInput 的 Y 轴位置决定

关于解决此间的平台差异性，我们仍在讨论。

若有 iOS 对齐 Android 的键盘顶起的需求，建议参考 StackOverflow，在业务层解决。

Android 弹出后盖住界面的解决办法

在部分 Android 机型上，键盘弹出后也可能会产生盖住界面的情况，一般情况下可以通过修改 AndroidMainfest.xml 文件，在 activity 上增加 android:windowSoftInputMode=”adjustPan” 解决。

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.tencent.mtt.hippy.example"
>
    <application
        android:allowBackup="true"
        android:label="@string/app_name"
    >
        <!-- 注意 android:windowSoftInputMode="adjustPan" 写在 activity 的参数里-->
        <activity android:name=".MyActivity"
            android:windowSoftInputMode="adjustPan"
            android:label="@string/activity_name"
            android:configChanges="orientation|screenSize"
        >
        </activity>
    </application>
</manifest>

该参数的意义是：

• adjustResize: resize the page content
• adjustPan: move page content without resizing page content

详情请参考 Android 开发文档。

参数

方法

blur

() => void 让指定的 input 或 View 组件失去光标焦点，与 focus() 的作用相反。

clear

() => void 清空输入框的内容。

focus

() => void 指派 TextInput 获得焦点。

getValue

() => Promise<string> 获得文本框中的内容。

hideInputMethod

() => void 隐藏软键盘。

setValue

(value: string) => void 设置文本框内容。

• value: string - 文本框内容

showInputMethod

() => void 显示软键盘。

Text

[Text 范例]

文本组件，但不支持嵌套。

注意事项

需要注意的是，在 <Text> 中拼接字符串时，推荐使用 ES6 的模板字符串：

<Text>{ `现在时间是 ${new Date().toString()}` }</Text> // ✅

而不是

<Text>现在时间是 { new Date().toString() }</Text> // ❌

后者有可能在数据更新时不会更新界面。

属性

• ellipsizeMode 的参数含义：
  • head - 文字将会从头开始截断，保证字符串的最后的文字可以正常显示在 Text 组件的最后，而从开头给截断的文字，将以 “…” 代替，例如 “…wxyz”；
  • middle - “文字将会从中间开始截断，保证字符串的最后与最前的文字可以正常显示在Text组件的响应位置，而中间给截断的文字，将以 “…” 代替，例如 “ab…yz”
  • tail - 文字将会从最后开始截断，保证字符串的最前的文字可以正常显示在 Text 组件的最前，而从最后给截断的文字，将以 “…” 代替，例如 “abcd…”；
  • clip - 超过指定行数的文字会被直接截断，不显示“…”，

View

[View 范例]

最基础的容器组件，它是一个支持Flexbox布局、样式、一些触摸处理、和一些无障碍功能的容器，并且它可以放到其它的视图里，也可以有任意多个任意类型的子视图。不论在什么平台上，View 都会直接对应一个平台的原生视图。

属性

ViewPager

[ViewPager 范例]

支持横滑翻页的容器，它的每一个子容器组件会被视作一个单独的页面，并且会被拉伸宽度至 ViewPager 本身宽度。

参数

方法

setPage

(index: number) => void 通过传入一个index 值（数字），滑动到第 index 个页面（有动画）

• index: number - 指定滑动页面

setPageWithoutAnimation

(index: number) => void 通过传入一个index 值（数字），滑动到第 index 个页面（无动画）

• index: number - 指定滑动页面