Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
基础浮层组件。
JavaScript
tree: 7f37273c5a

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
dist
examples
src
tests
.gitignore
History.md
Makefile
README.md
package.json

README.md

Overlay


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


配置说明

element element

页面 dom 节点,只读。

template string

浮层容器的模板,如<div class="myoverlay"></div>,只读。

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 里的所有属性都可以修改。

最佳实践

  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. 继承使用:

    var Overlay = require('overlay');
    var Dialog = Overlay.extend({
        attrs: {
            trigger: null,
            triggerType: 'click',
            hasMask: false,
            onComfirm: function() {},
            onClose: function() {}
        },
        setup: function() {},
        show: function() {
            Dialog.superclass.show.call(this);
            // add sth.
        }
        delegateEvents: function() {}
    });
  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.