Skip to content

Commit 0756e9c

Browse files
committed
docs(sheet): fix event doc
1 parent 088070c commit 0756e9c

File tree

4 files changed

+31
-24
lines changed

4 files changed

+31
-24
lines changed

src/components/input-pin/InputPin.vue

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,9 @@ export default defineComponent({
142142
143143
function onKeyDown (event: KeyboardEvent) {
144144
const target = event.target as HTMLInputElement
145-
if (props.readonly || props.disabled) return
145+
146+
if (props.readonly || props.disabled)
147+
return
146148
147149
if (target.value && [...event.key].length === 1 && !event.ctrlKey && !event.metaKey) {
148150
event.preventDefault()

src/components/modal/index.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -669,28 +669,28 @@ Modal use local CSS variables on `.modal` for enhanced real-time customization.
669669

670670
### Props
671671

672-
| Props | Type | Default | Description |
673-
|----------------------------|:---------:|:-------:|------------------------------------------------------------|
674-
| `v-model` | `Boolean` | `false` | Show / Hide modal |
675-
| `title` | `String` | - | Modal Title |
676-
| `text` | `String` | - | Text inside of Modal Body |
677-
| `dismissable` | `Boolean` | `true` | Show / Hide dismiss button |
678-
| `size` | `String` | `md` | Size of modal, valid value is `sm`, `md`, `lg` and `xl` |
679-
| `banner` | `Boolean` | `false` | Give modal no-padding to place image for specific purpose |
680-
| `no-close-on-esc` | `Boolean` | `false` | No close modal while Escape was pressed |
681-
| `no-close-on-backdrop` | `Boolean` | `false` | No close modal while Modal Backdrop was clicked |
682-
| `modal-body-scrollable` | `Boolean` | `false` | Scrollable modal body when content is to long |
683-
| `centered` | `Boolean` | `false` | Handle center vertically of the viewport |
672+
| Props | Type | Default | Description |
673+
|-----------------------|:---------:|:-------:|-----------------------------------------------------------|
674+
| `modelValue` | `Boolean` | `false` | `v-model` value for show / hide modal |
675+
| `title` | `String` | - | Modal Title |
676+
| `text` | `String` | - | Text inside of Modal Body |
677+
| `dismissable` | `Boolean` | `true` | Show / Hide dismiss button |
678+
| `size` | `String` | `md` | Size of modal, valid value is `sm`, `md`, `lg` and `xl` |
679+
| `banner` | `Boolean` | `false` | Give modal no-padding to place image for specific purpose |
680+
| `noCloseOnEsc` | `Boolean` | `false` | No close modal while Escape was pressed |
681+
| `noCloseOnBackdrop` | `Boolean` | `false` | No close modal while Modal Backdrop was clicked |
682+
| `modalBodyScrollable` | `Boolean` | `false` | Scrollable modal body when content is to long |
683+
| `centered` | `Boolean` | `false` | Handle center vertically of the viewport |
684684

685685
### Slots
686-
| Name | Description |
687-
|-----------|--------------------------------------------------------------------------------------------------|
688-
| `header ` | Content (in the form of— permalink or button) to place in Modal Header |
689-
| `footer ` | Content (in the form of— permalink or button) to place in Modal Footer |
686+
| Name | Description |
687+
|-----------|------------------------------------------------------------------------|
688+
| `header ` | Content (in the form of— permalink or button) to place in Modal Header |
689+
| `footer ` | Content (in the form of— permalink or button) to place in Modal Footer |
690690

691691
### Events
692692

693-
| Name | Arguments | Description |
694-
|-------------|-----------|---------------------------------|
695-
| `close` | - | Event when close button clicked |
693+
| Name | Arguments | Description |
694+
|---------|-----------|---------------------------------|
695+
| `close` | - | Event when close button clicked |
696696

src/components/sheet/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ There are 4 sizes you can use, `sm`, `md`, `lg` and `xl`. Default is `sm`.
190190
| Props | Type | Default | Description |
191191
|---------------------|:---------:|:-------:|----------------------------------------------------------------|
192192
| `position` | `String` | `left` | Sheet positions, valid value: `left`, `right`, `top`, `bottom` |
193+
| `size` | `String` | `sm` | Sheet size, valid value: `sm`, `md`, `lg`, `xl` |
194+
| `noCloseOnEsc` | `Boolean` | `false` | No close modal while Escape was pressed |
193195
| `noCloseOnBackdrop` | `Boolean` | `false` | Disabled close when click on backdrop |
194196

195197
### Slots
@@ -200,10 +202,9 @@ There are 4 sizes you can use, `sm`, `md`, `lg` and `xl`. Default is `sm`.
200202

201203
### Events
202204

203-
| Name | Arguments | Description |
204-
|--------|-----------|-------------------------|
205-
| `show` | - | Event when sheet shown |
206-
| `hide` | - | Event when sheet hidden |
205+
| Name | Arguments | Description |
206+
|---------|-----------|-------------------------------|
207+
| `close` | - | Event when sheet wµill closed |
207208

208209
## See Also
209210

src/core/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,7 @@ export {
122122
export {
123123
defineAccordion,
124124
} from '../components/accordion'
125+
126+
export {
127+
useVModel,
128+
} from '../components/input'

0 commit comments

Comments
 (0)