Skip to content

Commit

Permalink
docs(*): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@bindoon
bindoon committed Nov 17, 2021
1 parent 4a3c201 commit 462a8eb
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/balloon/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@
| visible | 弹层当前显示的状态 | Boolean | - | |
| defaultVisible | 弹层默认显示的状态 | Boolean | false | |
| onVisibleChange | 弹层在显示和隐藏触发的事件<br/><br/>**签名**:<br/>Function(visible: Boolean, type: String) => void<br/>**参数**:<br/>_visible_: {Boolean} 弹层是否隐藏和显示<br/>_type_: {String} 触发弹层显示或隐藏的来源， closeClick 表示由自带的关闭按钮触发； fromTrigger 表示由trigger的点击触发； docClick 表示由document的点击触发 | Function | func.noop | |
| v2 | 开启 v2 版本 | Boolean | - | |
| arrowPointToCenter | 【v2] 箭头是否指向目标元素的中心 | Boolean | false | |
| v2 | 开启 v2 版本 | Boolean | - | 1.25 |
| arrowPointToCenter | [v2] 箭头是否指向目标元素的中心 | Boolean | false | 1.25 |
| closable | 是否显示关闭按钮 | Boolean | true | |
| align | 弹出层位置<br/><br/>**可选值**:<br/>'t'(上)<br/>'r'(右)<br/>'b'(下)<br/>'l'(左)<br/>'tl'(上左)<br/>'tr'(上右)<br/>'bl'(下左)<br/>'br'(下右)<br/>'lt'(左上)<br/>'lb'(左下)<br/>'rt'(右上)<br/>'rb'(右下) | Enum | 'b' | |
| offset | 弹层相对于trigger的定位的微调, 接收数组[hoz, ver], 表示弹层在 left / top 上的增量<br/>e.g. [100, 100] 表示往右(RTL 模式下是往左) 、下分布偏移100px | Array | [0, 0] | |
Expand Down
4 changes: 2 additions & 2 deletions docs/overlay/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Popup 是对 Overlay 的封装，它接收某个节点作为触发节点，弹
| wrapperStyle | 弹层的根节点的内联样式 | Object | - | |
| animation | 配置动画的播放方式，支持 { in: 'enter-class', out: 'leave-class' } 的对象参数，如果设置为 false，则不播放动画。 请参考 Animate 组件的文档获取可用的动画名 | Object/Boolean | { in: 'expandInDown', out: 'expandOutUp' } | |
| v2 | 开启 v2 版本 | Boolean | - | 1.25 |
| points | align 的数组形式，和 align 互斥使用 | Array | - | 1.25 |
| points | [v2] align 的数组形式，不能和 align 同时使用 | Array | - | 1.25 |

### Overlay.Popup

Expand All @@ -109,7 +109,7 @@ Popup 是对 Overlay 的封装，它接收某个节点作为触发节点，弹
| target | 弹层定位的参照元素 | any | target 属性，即触发元素 | | | | | | | | | | | |
| followTrigger | 是否跟随trigger滚动 | Boolean | false | | | | | | | | | | | |
| v2 | 开启 v2 版本 | Boolean | - | | | | | | | | | | | |
| placement | 快捷位置，包含 'tl' | 't' | 'tr' | 'rt' | 'r' | 'rb' | 'bl' | 'b' | 'br' | 'lt' | 'l' | 'lb' | String | - |
| placement | [v2] 快捷位置，包含 'tl' | 't' | 'tr' | 'rt' | 'r' | 'rb' | 'bl' | 'b' | 'br' | 'lt' | 'l' | 'lb' | String | - |

## 无障碍键盘操作指南

Expand Down
2 changes: 1 addition & 1 deletion src/balloon/tooltip.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
import Overlay from '../overlay';
import BalloonInner from './inner';
import { normalMap, edgeMap } from './alignMap';
import { getDisabledCompatibleTrigger } from './util';
import { getDisabledCompatibleTrigger, log } from './util';

const { Popup } = Overlay;

Expand Down
2 changes: 1 addition & 1 deletion src/overlay/overlay.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ class Overlay extends Component {
*/
v2: PropTypes.bool,
/**
* align 的数组形式，和 align 互斥使用
* [v2] align 的数组形式，不能和 align 同时使用
* @version 1.25
*/
points: PropTypes.array,
Expand Down
2 changes: 1 addition & 1 deletion src/overlay/popup.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ class Popup extends Component {
*/
v2: PropTypes.bool,
/**
* 快捷位置，包含 'tl' | 't' | 'tr' | 'rt' | 'r' | 'rb' | 'bl' | 'b' | 'br' | 'lt' | 'l' | 'lb'
* [v2] 快捷位置，包含 'tl' | 't' | 'tr' | 'rt' | 'r' | 'rb' | 'bl' | 'b' | 'br' | 'lt' | 'l' | 'lb'
*/
placement: PropTypes.string,
};
Expand Down

0 comments on commit 462a8eb

Please sign in to comment.