---

title: dom type: references group: 内置模块 order: 9.03 version: 2.1

dom

dom 模块用于对 weex 页面里的组件节点进行一部分特定操作。

你可以使用该模块来获取某个组件的 bounding rect 布局信息，或者将 list 的某个子节点滚动到当前视口，或者添加一个 font-face rule，等等。

Note: API addRule 目前仅支持添加 ‘font-face’.

API

scrollToElement(ref, options)

让页面滚动到 ref 对应的组件，这个 API 只能用于可滚动组件的子节点，例如 <scroller>，<list> 等可滚动组件中。

要在你的 .vue 文件中使用这个 API，可以使用 weex.requireModule('dom').scrollToElement。

参数

• ref {Node}：你要滚动到的那个节点
• options {Object}:
• offset {number}: 一个到其可见位置的偏移距离，默认是 0
• animated {boolean} 0.10+：是否需要附带滚动动画，默认是true

示例

滚动到某层

getComponentRect(ref, callback) v0.9.4+

支持版本: >=0.9.4

通过标签的 ref 获得其布局信息，返回的信息在 callBack 中，格式参考如下：

{
  result: true,
  size: {
    bottom: 60,
    height: 15,
    left: 0,
    right: 353,
    top: 45,
    width: 353
  }
}

如果想要获取到 Weex 视口容器的布局信息，可以指定 ref 为字符串 'viewport'，即 getComponentRect('viewport', callback).

示例

获取 box 的布局信息

addRule(type, contentObject) v0.12.0+

支持版本: >=0.12.0

参考自定义字体。