blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

docs: improve teleport description (#8819)

Browse Source
This commit is contained in:
neverland 2021-06-07 19:25:06 +08:00 committed by GitHub
parent 851e0a89d7
commit b2a090344f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/action-sheet/README.md
View File

@ -189,7 +189,7 @@ export default {
| close-on-click-action | Whether to close when an action is clicked | _boolean_ | `false` |
| close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` |
| teleport | Return the mount node for ActionSheet | _string \| Element_ | - |
| teleport | Specifies a target element where ActionSheet will be mounted | _string \| Element_ | - |
### Data Structure of Action

2
src/calendar/README.md
View File

@ -280,7 +280,7 @@ Following props are supported when the poppable is true
| close-on-popstate | Whether to close when popstate | _boolean_ | `true` |
| close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` |
| teleport | Return the mount node for Calendar | _string \| Element_ | - |
| teleport | Specifies a target element where Calendar will be mounted | _string \| Element_ | - |
### Calendar Range Props

4
src/dialog/README.md
View File

@ -165,7 +165,7 @@ export default {
| allowHtml | Whether to allow HTML rendering in message | _boolean_ | `false` |
| beforeClose | Callback function before close | _(action) => boolean \| Promise_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | - |
| teleport | Return the mount node for Dialog | _string \| Element_ | `body` |
| teleport | Specifies a target element where Dialog will be mounted | _string \| Element_ | `body` |
### Props
@ -193,7 +193,7 @@ export default {
| allow-html | Whether to allow HTML rendering in message | _boolean_ | `false` |
| before-close | Callback function before close | _(action) => boolean \| Promise_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | - |
| teleport | Return the mount node for Dialog | _string \| Element_ | - |
| teleport | Specifies a target element where Dialog will be mounted | _string \| Element_ | - |
### Events

2
src/dropdown-menu/README.md
View File

@ -165,7 +165,7 @@ Use `active-color` prop to custom active color of the title and options.
| disabled | Whether to disable dropdown item | _boolean_ | `false` |
| lazy-render | Whether to lazy render util opened | _boolean_ | `true` |
| title-class | Title class | _string \| Array \| object_ | - |
| teleport | Return the mount node for menu | _string \| Element_ | - |
| teleport | Specifies a target element where DropdownItem will be mounted | _string \| Element_ | - |
### DropdownItem Events

4
src/image-preview/README.md
View File

@ -147,7 +147,7 @@ export default {
| closeIconPosition | Close icon position，can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| transition `v3.0.8` | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |
| overlay-style `v3.0.8` | Custom overlay style | _object_ | - |
| teleport | Return the mount node for ImagePreview | _string \| Element_ | - |
| teleport | Specifies a target element where ImagePreview will be mounted | _string \| Element_ | - |
### Props
@ -169,7 +169,7 @@ export default {
| close-icon-position | Close icon position，can be set to `top-left` `bottom-left` `bottom-right` | _string_ | `top-right` |
| transition `v3.0.8` | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |
| overlay-style `v3.0.8` | Custom overlay style | _object_ | - |
| teleport | Return the mount node for ImagePreview | _string \| Element_ | - |
| teleport | Specifies a target element where ImagePreview will be mounted | _string \| Element_ | - |
### Events

2
src/number-keyboard/README.md
View File

@ -181,7 +181,7 @@ export default {
| show-delete-key | Whether to show delete button | _boolean_ | `true` |
| blur-on-close `v3.0.6` | Whether to emit blur event when clicking close button | _boolean_ | `true` |
| hide-on-click-outside | Whether to hide keyboard when outside is clicked | _boolean_ | `true` |
| teleport | Return the mount node for NumberKeyboard | _string \| Element_ | - |
| teleport | Specifies a target element where NumberKeyboard will be mounted | _string \| Element_ | - |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` |
| random-key-order | Whether to shuffle the order of keys | _boolean_ | `false` |

2
src/popover/README.md
View File

@ -223,7 +223,7 @@ export default {
| close-on-click-action | Whether to close when clicking action | _boolean_ | `true` |
| close-on-click-outside | Whether to close when clicking outside | _boolean_ | `true` |
| close-on-click-overlay `v3.0.10` | Whether to close when clicking overlay | _boolean_ | `true` |
| teleport | Return the mount node for Popover | _string \| Element_ | `body` |
| teleport | Specifies a target element where Popover will be mounted | _string \| Element_ | `body` |
| icon-prefix `v3.0.17` | Icon className prefix | _string_ | `van-icon` |
### Data Structure of Action

2
src/popup/README.md
View File

@ -139,7 +139,7 @@ export default {
| icon-prefix `v3.0.18` | Icon className prefix | _string_ | `van-icon` |
| transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | - |
| transition-appear | Whether to apply transition on initial render | _boolean_ | `false` |
| teleport | Return the mount node for Popup | _string \| Element_ | - |
| teleport | Specifies a target element where Popup will be mounted | _string \| Element_ | - |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `false` |
### Events

2
src/share-sheet/README.md
View File

@ -182,7 +182,7 @@ export default {
| close-on-popstate | Whether to close when popstate | _boolean_ | `true` |
| close-on-click-overlay | Whether to close when overlay is clicked | _boolean_ | `true` |
| safe-area-inset-bottom | Whether to enable bottom safe area adaptation | _boolean_ | `true` |
| teleport | Return the mount node for ShareSheet | _string \| Element_ | - |
| teleport | Specifies a target element where ShareSheet will be mounted | _string \| Element_ | - |
### Data Structure of Option

2
src/toast/README.md
View File

@ -173,7 +173,7 @@ Toast.resetDefaultOptions('loading');
| onOpened | Callback function after opened | _Function_ | - |
| onClose | Callback function after close | _Function_ | - |
| transition | Transition, equivalent to `name` prop of [transition](https://v3.vuejs.org/api/built-in-components.html#transition) | _string_ | `van-fade` |
| teleport | Return the mount node for Toast | _string \| Element_ | `body` |
| teleport | Specifies a target element where Toast will be mounted | _string \| Element_ | `body` |
### Less Variables