docs: type highlight (#4264)

This commit is contained in:
neverland
2019-08-27 22:09:21 +08:00
committed by GitHub
parent a79750d00c
commit ecbdc2bede
129 changed files with 1493 additions and 1484 deletions
+30 -30
View File
@@ -118,43 +118,43 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| title | Title | `string` | - | - |
| message | Message | `string` | - | - |
| messageAlign | Message text aligncan be set to `left` `right` | `string` | `center` | - |
| className | Custom className | `any` | - | - |
| showConfirmButton | Whether to show confirm button | `boolean` | `true` | - |
| showCancelButton | Whether to show cancel button | `boolean` | `false` | - |
| cancelButtonText | Cancel button text | `string` | `Cancel` | - |
| cancelButtonColor | Cancel button color | `string` | `#000` | - |
| confirmButtonText | Confirm button text | `string` | `Confirm` | - |
| confirmButtonColor | Confirm button color | `string` | `#1989fa` | - |
| overlay | Whether to show overlay | `boolean` | `true` | - |
| closeOnPopstate | Whether to close when popstate | `boolean` | `false` | 2.0.5 |
| closeOnClickOverlay | Whether to close when click overlay | `boolean` | `false` | - |
| lockScroll | Whether to lock body scroll | `boolean` | `true` | - |
| title | Title | *string* | - | - |
| message | Message | *string* | - | - |
| messageAlign | Message text aligncan be set to `left` `right` | *string* | `center` | - |
| className | Custom className | *any* | - | - |
| showConfirmButton | Whether to show confirm button | *boolean* | `true` | - |
| showCancelButton | Whether to show cancel button | *boolean* | `false` | - |
| cancelButtonText | Cancel button text | *string* | `Cancel` | - |
| cancelButtonColor | Cancel button color | *string* | `#000` | - |
| confirmButtonText | Confirm button text | *string* | `Confirm` | - |
| confirmButtonColor | Confirm button color | *string* | `#1989fa` | - |
| overlay | Whether to show overlay | *boolean* | `true` | - |
| closeOnPopstate | Whether to close when popstate | *boolean* | `false` | 2.0.5 |
| closeOnClickOverlay | Whether to close when click overlay | *boolean* | `false` | - |
| lockScroll | Whether to lock body scroll | *boolean* | `true` | - |
| beforeClose | Callback before close,<br>call done() to close dialog,<br>call done(false) to cancel loading | (action: string, done: Function) => void | - | - |
| getContainer | Return the mount node for Dialog | `string | () => HTMLElement` | `body` | - |
| getContainer | Return the mount node for Dialog | *string \| () => HTMLElement* | `body` | - |
### Props
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Whether to show dialog | `boolean` | - | - |
| title | Title | `string` | - | - |
| message | Message | `string` | - | - |
| message-align | Message aligncan be set to `left` `right` | `string` | `center` | - |
| show-confirm-button | Whether to show confirm button | `boolean` | `true` | - |
| show-cancel-button | Whether to show cancel button | `boolean` | `false` | - |
| cancel-button-text | Cancel button text | `string` | `Cancel` | - |
| cancel-button-color | Cancel button color | `string` | `#000` | - |
| confirm-button-text | Confirm button text | `string` | `Confirm` | - |
| confirm-button-color | Confirm button color | `string` | `#1989fa` | - |
| overlay | Whether to show overlay | `boolean` | `true` | - |
| close-on-popstate | Whether to close when popstate | `boolean` | `false` | 2.0.5 |
| close-on-click-overlay | Whether to close when click overlay | `boolean` | `false` | - |
| lock-scroll | Whether to lock background scroll | `boolean` | `true` | - |
| v-model | Whether to show dialog | *boolean* | - | - |
| title | Title | *string* | - | - |
| message | Message | *string* | - | - |
| message-align | Message aligncan be set to `left` `right` | *string* | `center` | - |
| show-confirm-button | Whether to show confirm button | *boolean* | `true` | - |
| show-cancel-button | Whether to show cancel button | *boolean* | `false` | - |
| cancel-button-text | Cancel button text | *string* | `Cancel` | - |
| cancel-button-color | Cancel button color | *string* | `#000` | - |
| confirm-button-text | Confirm button text | *string* | `Confirm` | - |
| confirm-button-color | Confirm button color | *string* | `#1989fa` | - |
| overlay | Whether to show overlay | *boolean* | `true` | - |
| close-on-popstate | Whether to close when popstate | *boolean* | `false` | 2.0.5 |
| close-on-click-overlay | Whether to close when click overlay | *boolean* | `false` | - |
| lock-scroll | Whether to lock background scroll | *boolean* | `true` | - |
| before-close | Callback before close,<br>call done() to close dialog,<br>call done(false) to cancel loading | (action: string, done: Function) => void | - | - |
| get-container | Return the mount node for Dialog | `string | () => HTMLElement` | - | - |
| get-container | Return the mount node for Dialog | *string \| () => HTMLElement* | - | - |
### Events