diff --git a/docs/components/content/examples/SlideoverExample.vue b/docs/components/content/examples/SlideoverExample.vue deleted file mode 100644 index 6d154e5c..00000000 --- a/docs/components/content/examples/SlideoverExample.vue +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - - - Title - - - - - - - - - - diff --git a/docs/components/content/examples/SlideoverExampleBasic.vue b/docs/components/content/examples/SlideoverExampleBasic.vue new file mode 100644 index 00000000..14e0d6e1 --- /dev/null +++ b/docs/components/content/examples/SlideoverExampleBasic.vue @@ -0,0 +1,15 @@ + + + + + + + + + + + + + diff --git a/docs/components/content/examples/SlideoverExampleCard.vue b/docs/components/content/examples/SlideoverExampleCard.vue new file mode 100644 index 00000000..39081456 --- /dev/null +++ b/docs/components/content/examples/SlideoverExampleCard.vue @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/components/content/examples/SlideoverExampleDisableOverlay.vue b/docs/components/content/examples/SlideoverExampleDisableOverlay.vue new file mode 100644 index 00000000..c13de9b0 --- /dev/null +++ b/docs/components/content/examples/SlideoverExampleDisableOverlay.vue @@ -0,0 +1,15 @@ + + + + + + + + + + + + + diff --git a/docs/components/content/examples/SlideoverExampleDisableTransition.vue b/docs/components/content/examples/SlideoverExampleDisableTransition.vue new file mode 100644 index 00000000..b3ca92d7 --- /dev/null +++ b/docs/components/content/examples/SlideoverExampleDisableTransition.vue @@ -0,0 +1,15 @@ + + + + + + + + + + + + + diff --git a/docs/components/content/examples/SlideoverExamplePreventClose.vue b/docs/components/content/examples/SlideoverExamplePreventClose.vue new file mode 100644 index 00000000..68fdf4f4 --- /dev/null +++ b/docs/components/content/examples/SlideoverExamplePreventClose.vue @@ -0,0 +1,24 @@ + + + + + + + + + + + + Slideover + + + + + + + + + + diff --git a/docs/content/6.overlays/1.modal.md b/docs/content/6.overlays/1.modal.md index ce55f398..1b6baca6 100644 --- a/docs/content/6.overlays/1.modal.md +++ b/docs/content/6.overlays/1.modal.md @@ -68,6 +68,8 @@ const isOpen = ref(false) ### Disable overlay +Set the `overlay` prop to `false` to disable it. + ::component-example #default :modal-example-disable-overlay @@ -94,6 +96,8 @@ const isOpen = ref(false) ### Disable transition +Set the `transition` prop to `false` to disable it. + ::component-example #default :modal-example-disable-transition @@ -120,6 +124,8 @@ const isOpen = ref(false) ### Prevent close +Use the `prevent-close` prop to disable the outside click alongside the `esc` keyboard shortcut. + ::component-example #default :modal-example-prevent-close @@ -153,6 +159,22 @@ const isOpen = ref(false) ``` :: +You can still handle the `esc` shortcut yourself by using our [defineShortcuts](/getting-started/shortcuts#defineshortcuts) composable. + +```vue + +``` + ## Props :component-props diff --git a/docs/content/6.overlays/2.slideover.md b/docs/content/6.overlays/2.slideover.md index 99c970cf..d4ad0b5e 100644 --- a/docs/content/6.overlays/2.slideover.md +++ b/docs/content/6.overlays/2.slideover.md @@ -8,9 +8,11 @@ headlessui: ## Usage +Use a `v-model` to control the Slideover state. + ::component-example #default -:slideover-example +:slideover-example-basic #code ```vue + + + + + + + + + + + + + + + + + + + + +``` +:: + +### Disable overlay + +Set the `overlay` prop to `false` to disable it. + +::component-example +#default +:slideover-example-disable-overlay + +#code +```vue + + + + + + + + + + + + + +``` +:: + +### Disable transition + +Set the `transition` prop to `false` to disable it. + +::component-example +#default +:slideover-example-disable-transition + +#code +```vue + + + + + + + + + + + + + +``` +:: + +### Prevent close + +Use the `prevent-close` prop to disable the outside click alongside the `esc` keyboard shortcut. + +::component-example +#default +:slideover-example-prevent-close + +#code +```vue + + + + + + + + + + + + Slideover + + + + + + + + + + +``` +:: + +You can still handle the `esc` shortcut yourself by using our [defineShortcuts](/getting-started/shortcuts#defineshortcuts) composable. + +```vue + +``` + ## Props :component-props diff --git a/src/runtime/components/overlays/Slideover.vue b/src/runtime/components/overlays/Slideover.vue index 6da73ecb..2d186c9d 100644 --- a/src/runtime/components/overlays/Slideover.vue +++ b/src/runtime/components/overlays/Slideover.vue @@ -1,6 +1,6 @@ - + !preventClose && close(e)"> @@ -55,6 +55,10 @@ export default defineComponent({ type: Boolean, default: true }, + preventClose: { + type: Boolean, + default: false + }, ui: { type: Object as PropType>, default: () => appConfig.ui.slideover