Skip to content

Commit

Permalink
更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
afc163 committed Sep 9, 2013
1 parent 02dac6e commit d5792cf
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ Tip 模块继承自 [popup](http://aralejs.org/popup/),可使用包括 [overla

## 配置说明

### trigger `element|string`
### trigger `selector`

触发点元素。

### triggerType `string`

触发方式,[ hover | click ]
触发方式,[`hover`|`click`|`focus`]

### content `string|function`

Expand All @@ -36,15 +36,16 @@ Tip 模块继承自 [popup](http://aralejs.org/popup/),可使用包括 [overla

### theme `string`

配色主题,内置黄色、蓝色和白色三种提示框样式[ yellow | blue | white ],默认为黄色
配色主题,内置黄色、蓝色和白色三种提示框样式 [`yellow`|`blue`|`white`],默认为 `yellow`

### inViewport `boolean`

当弹出层显示在屏幕外时,是否自动转换浮层位置,默认为 false。

### align `object`

参照 Overlay 的 [align](http://aralejs.org/overlay/#align-object) 配置,当指定此参数用于定位,`arrowPosition` 属性则失效。
参照 Overlay 的 [align](http://aralejs.org/overlay/#align-object) 配置,
指定此定位参数时,认为开发者要自定义提示框位置,此时 `arrowPosition` 属性失效。

---

Expand Down
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"family": "arale",
"keywords": [
"widget",
"bubble"
"bubble",
"popup"
],
"description": "提示框组件,专注于带箭头的气泡框显示、隐藏、动画等交互功能。",
"homepage": "http://aralejs.org/tip",
Expand All @@ -15,12 +16,12 @@
],
"repository": {
"type": "git",
"url": "https://github.com/aralejs/tip.git"
"url": "https://github.com/aralejs/tip"
},
"bugs": {
"url": "https://github.com/aralejs/tip/issues"
},
"license": "",
"license": "MIT",
"spm": {
"alias": {
"$": "$",
Expand Down

0 comments on commit d5792cf

Please sign in to comment.