update doc and ignore file (#2289)

This commit is contained in:
BeADre 2022-01-26 23:38:19 +08:00 committed by GitHub
parent 79b4fffb69
commit 5ec8a8e2bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions

1
.gitignore vendored
View File

@ -9,6 +9,7 @@ test/unit/coverage
package-lock.json package-lock.json
playground/temp playground/temp
yarn.lock yarn.lock
.DS_Store
.vscode .vscode
.idea .idea
*.swp *.swp

View File

@ -21,9 +21,9 @@ target-container-selector
| 名称 | 类型 | 默认值 | 说明 | | 名称 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| bottom | `number` | `40` | BackTop 距离页面底部的高度 | | bottom | `number \| string` | `40` | BackTop 距离页面底部的高度 |
| listen-to | `string \| HTMLElement` | `undefined` | 监听滚动的元素,如果为 `undefined` 会监听距离最近的一个可滚动的祖先节点 | | listen-to | `string \| HTMLElement` | `undefined` | 监听滚动的元素,如果为 `undefined` 会监听距离最近的一个可滚动的祖先节点 |
| right | `number` | `40` | BackTop 距离页面右侧的宽度 | | right | `number \| string` | `40` | BackTop 距离页面右侧的宽度 |
| show | `boolean` | `undefined` | 是否显示 BackTop受控 | | show | `boolean` | `undefined` | 是否显示 BackTop受控 |
| to | `string \| HTMLElement` | `'body'` | BackTop 渲染的容器节点 | | to | `string \| HTMLElement` | `'body'` | BackTop 渲染的容器节点 |
| visibility-height | `number` | `180` | 滚动时触发显示回到顶部的高度 | | visibility-height | `number` | `180` | 滚动时触发显示回到顶部的高度 |