Skip to content

Commit c3a9e02

Browse files
committed
docs: update README with prop definitions and default values;
1 parent ccc41df commit c3a9e02

File tree

2 files changed

+22
-9
lines changed

2 files changed

+22
-9
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,27 @@ For Nuxt 3, just wrap component in `<client-only>`
9090

9191
## Props
9292

93-
| Prop | Type | Description | Example | Defaults |
94-
| ------------------- | -------- | ----------------------------------------------------------------------------- | -------------------------------- | -------- |
95-
| snapPoints | Number[] | Defines custom snapping positions for the bottom sheet | `:snapPoints="[300, 600, 900]"` | true |
96-
| defaultSnapPoint | Number | Specifies the default snap point | `:default-snap-point="600"` | true |
97-
| blocking | Boolean | Controls whether the bottom sheet blocks interactions with underlying content | `:blocking="true"` | true |
98-
| canSwipeClose | Boolean | Enables or disables swipe gestures for closing the sheet | `:can-swipe-close="true"` | true |
99-
| canOverlayClose | Boolean | Allows tapping the overlay to close the sheet | `:can-overlay-close="true"` | true |
100-
| expandOnContentDrag | Boolean | Enables expanding the sheet by dragging its content | `:expand-on-content-drag="true"` | true |
93+
### Prop Definitions
94+
95+
| Prop | Type | Description | Example |
96+
| ------------------- | -------- | ----------------------------------------------------------------------------- | -------------------------------- |
97+
| snapPoints | Number[] | Defines custom snapping positions for the bottom sheet | `:snapPoints="[300, 600, 900]"` |
98+
| defaultSnapPoint | Number | Specifies the default snap point | `:default-snap-point="600"` |
99+
| blocking | Boolean | Controls whether the bottom sheet blocks interactions with underlying content | `:blocking="true"` |
100+
| canSwipeClose | Boolean | Enables or disables swipe gestures for closing the sheet | `:can-swipe-close="true"` |
101+
| canOverlayClose | Boolean | Allows tapping the overlay to close the sheet | `:can-overlay-close="true"` |
102+
| expandOnContentDrag | Boolean | Enables expanding the sheet by dragging its content | `:expand-on-content-drag="true"` |
103+
104+
### Default Values
105+
106+
| Prop | Default |
107+
| ------------------- | -------------------------- |
108+
| snapPoints | `minHeight` |
109+
| defaultSnapPoint | `minHeight / minSnapPoint` |
110+
| blocking | `true` |
111+
| canSwipeClose | `true` |
112+
| canOverlayClose | `true` |
113+
| expandOnContentDrag | `true` |
101114

102115
## Exposed methods
103116

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"url": "https://github.com/megaarmos/vue-spring-bottom-sheet/issues"
3333
},
3434
"private": false,
35-
"version": "1.0.1",
35+
"version": "1.0.3",
3636
"type": "module",
3737
"exports": {
3838
".": {

0 commit comments

Comments
 (0)