Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
基础浮层组件。
JavaScript
branch: master
Failed to load latest commit information.
examples chore: update doc
src update deps
tests update deps
.gitignore update doc
.travis.yml fix travis
HISTORY.md migrate spm@3.x
README.md update doc
overlay.js export overlay
package.json update deps

README.md

Overlay


spm package Build Status Coverage Status

基础浮层组件,提供浮层显示隐藏、定位和 IE6 下 select 遮挡、窗口 resize 时重新定位、点击页面空白处浮层消失等等特性,是所有浮层类组件的基类。

如果要开发一个浮层类的 UI 组件,可以基于它进行扩展,dialog、autocomplete、popup、select、calendar 等模块均继承了 Overlay 。


Overlay 继承了 widget,可使用其中包括 baseclasseventsattributeaspect 的属性和方法。

配置说明

element element

页面 dom 节点,只读。

template string

浮层容器的模板,如<div class="myoverlay"></div>,只读。和 element 属性二者择一即可。

zIndex string|number

浮层的 z-index 属性。

width string|number

浮层宽度(px)。

height string|number

浮层高度(px)。

id string

浮层的初始化 id 。

className string

浮层的初始化 className 。

style object

浮层的初始化 style 对象。

parentNode element

浮层的父元素,默认为document.body,只读。

align object

定位对象,形似下面代码。这块的定位原理可参照 arale/position 组件的 pin 方法。

{
    selfXY: [0, 0],     // element 的定位点,默认为左上角
    baseElement: Position.VIEWPORT,     // 基准定位元素,默认为当前可视区域
    baseXY: [0, 0]      // 基准定位元素的定位点,默认为左上角
}

方法说明

render()

生成浮层的dom结构和样式并插入文档流。

show()

显示浮层,第一次调用时会进行render()操作。

hide()

隐藏浮层。

get(key)

获得属性值。

set(key, value)

非只读属性都可以通过set方法修改,并会立刻反映到浮层上。API 里的所有属性都可以修改。

最佳实践

注意 务必将浮层元素在 CSS 上设置 position: absolute or fixed, 并且设置有效的 left/top 值. 以避免当没有设置 left/top 时, 在浮层元素插入到页面底部后, 瞬间出现浏览器滚动条后, 获取可视区域宽高错误, 以致定位有几像素偏差的问题.

  1. 直接使用:

    var overlay = new Overlay({
        template: '<div class="overlay"></div>',
        width: 500,
        height: 200,
        zIndex: 99,
        style: 'border:1px solid red;color:green;',
        parentNode: '#c',
        align: {
            selfXY: ['-100%', 0],
            baseElement: '#a',
            baseXY: [0, 0]
        }
    });
    overlay.show();
    // 修改元素样式
    overlay.set('style', {
        backgroundColor: 'red',
        border: '1px solid green'
    });
    // 非只读属性都可以通过 set 方法进行更新
    overlay.set('width', 500);
    overlay.set('className', 'myclass');
  2. 继承使用:

    继承使用时,如果需要覆盖父类的 setup、show、hide 方法,强烈建议这样Dialog.superclass.show.call(this);调用一下父类的方法,否则可能造成一些特性的丢失。

    var Overlay = require('overlay');
    var Dialog = Overlay.extend({
        attrs: {
            trigger: null,
            triggerType: 'click',
            hasMask: false,
            onComfirm: function() {},
            onClose: function() {}
        },
        setup: function() {
            Dialog.superclass.setup.call(this);            
        },
        show: function() {
            Dialog.superclass.show.call(this);
            // add sth.
        }
    });
  3. Mask 组件的使用:

    var mask = require('mask');
    mask.show();
    //mask.hide();

    改变默认配置:

    mask.set({ backgroundColor:'red', opacity:0.5 }).show();
  4. 点击页面空白处浮层消失的功能。

    这个功能常用于提示层和弹出菜单等,要使用这个特性,需要调用 overlay 的私有方法 _blurHide()。

    这个方法接受一个参数(元素数组),表示点击到这些元素上浮层不消失。示例如下:

    setup: function() {
        Popup.superclass.setup.call(this);
        this._blurHide([this.get('trigger')]);
    },
Something went wrong with that request. Please try again.