mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-31 20:28:09 +01:00
docs(slideover): update
This commit is contained in:
@@ -1,4 +1,4 @@
|
|||||||
<script lang="ts" setup>
|
<script setup lang="ts">
|
||||||
const modal = useModal()
|
const modal = useModal()
|
||||||
|
|
||||||
defineProps<{
|
defineProps<{
|
||||||
@@ -1,20 +1,20 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
import { LazyExampleModalComponent } from '#components'
|
import { LazyModalExample } from '#components'
|
||||||
|
|
||||||
const count = ref(0)
|
const count = ref(0)
|
||||||
|
|
||||||
const modal = useModal()
|
const modal = useModal()
|
||||||
|
|
||||||
function openModal() {
|
function open() {
|
||||||
count.value++
|
count.value++
|
||||||
|
|
||||||
modal.open(LazyExampleModalComponent, {
|
modal.open(LazyModalExample, {
|
||||||
description: 'And you can even provide a description !',
|
description: 'And you can even provide a description!',
|
||||||
count: count.value
|
count: count.value
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<UButton label="Open" color="gray" variant="subtle" @click="openModal" />
|
<UButton label="Open" color="gray" variant="subtle" @click="open" />
|
||||||
</template>
|
</template>
|
||||||
|
|||||||
@@ -0,0 +1,19 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
const slideover = useSlideover()
|
||||||
|
|
||||||
|
defineProps<{
|
||||||
|
count: number
|
||||||
|
}>()
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<USlideover :description="`This slideover was opened programmatically ${count} times`">
|
||||||
|
<template #body>
|
||||||
|
<Placeholder class="h-full" />
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<template #footer>
|
||||||
|
<UButton color="gray" label="Close" @click="slideover.close()" />
|
||||||
|
</template>
|
||||||
|
</USlideover>
|
||||||
|
</template>
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
const open = ref(false)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<USlideover v-model:open="open" title="Slideover with footer" description="This is useful when you want a form in a Slideover." :ui="{ footer: 'justify-end' }">
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" />
|
||||||
|
|
||||||
|
<template #body>
|
||||||
|
<Placeholder class="h-full" />
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<template #footer>
|
||||||
|
<UButton label="Cancel" color="gray" variant="outline" @click="open = false" />
|
||||||
|
<UButton label="Submit" color="gray" />
|
||||||
|
</template>
|
||||||
|
</USlideover>
|
||||||
|
</template>
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
const first = ref(false)
|
||||||
|
const second = ref(false)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<USlideover v-model:open="first" title="First slideover" :ui="{ footer: 'justify-end' }">
|
||||||
|
<UButton color="gray" variant="subtle" label="Open" />
|
||||||
|
|
||||||
|
<template #body>
|
||||||
|
<Placeholder class="h-full" />
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<template #footer>
|
||||||
|
<UButton label="Close" color="gray" variant="outline" @click="first = false" />
|
||||||
|
|
||||||
|
<USlideover v-model:open="second" title="Second slideover" :ui="{ footer: 'justify-end' }">
|
||||||
|
<UButton label="Open second" color="gray" />
|
||||||
|
|
||||||
|
<template #body>
|
||||||
|
<Placeholder class="h-full" />
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<template #footer>
|
||||||
|
<UButton label="Close" color="gray" variant="outline" @click="second = false" />
|
||||||
|
</template>
|
||||||
|
</USlideover>
|
||||||
|
</template>
|
||||||
|
</USlideover>
|
||||||
|
</template>
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
const open = ref(false)
|
||||||
|
|
||||||
|
defineShortcuts({
|
||||||
|
o: () => open.value = !open.value
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<USlideover v-model:open="open">
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" />
|
||||||
|
|
||||||
|
<template #content>
|
||||||
|
<Placeholder class="h-full m-4" />
|
||||||
|
</template>
|
||||||
|
</USlideover>
|
||||||
|
</template>
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
<script setup lang="ts">
|
||||||
|
import { LazySlideoverExample } from '#components'
|
||||||
|
|
||||||
|
const count = ref(0)
|
||||||
|
|
||||||
|
const slideover = useSlideover()
|
||||||
|
|
||||||
|
function open() {
|
||||||
|
count.value++
|
||||||
|
|
||||||
|
slideover.open(LazySlideoverExample, {
|
||||||
|
title: 'Slideover',
|
||||||
|
count: count.value
|
||||||
|
})
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" @click="open" />
|
||||||
|
</template>
|
||||||
@@ -205,7 +205,7 @@ class: 'justify-center'
|
|||||||
|
|
||||||
### With command palette
|
### With command palette
|
||||||
|
|
||||||
You can use the [CommandPalette](/components/command-palette) component inside the Drawer.
|
You can use the [CommandPalette](/components/command-palette) component inside the Drawer's content.
|
||||||
|
|
||||||
::component-example
|
::component-example
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -149,7 +149,7 @@ ignore:
|
|||||||
class: 'justify-center'
|
class: 'justify-center'
|
||||||
props:
|
props:
|
||||||
overlay: false
|
overlay: false
|
||||||
title: 'Modal fullscreen'
|
title: 'Modal without overlay'
|
||||||
slots:
|
slots:
|
||||||
default: |
|
default: |
|
||||||
|
|
||||||
@@ -178,7 +178,7 @@ ignore:
|
|||||||
class: 'justify-center'
|
class: 'justify-center'
|
||||||
props:
|
props:
|
||||||
transition: false
|
transition: false
|
||||||
title: 'Modal fullscreen'
|
title: 'Modal without transition'
|
||||||
slots:
|
slots:
|
||||||
default: |
|
default: |
|
||||||
|
|
||||||
@@ -286,23 +286,12 @@ Make sure to wrap your app with the [`App`](/components/app) component that inst
|
|||||||
|
|
||||||
First, create a modal component that will be opened programatically:
|
First, create a modal component that will be opened programatically:
|
||||||
|
|
||||||
```vue [ExampleModalComponent.vue]
|
::component-example
|
||||||
<script lang="ts" setup>
|
---
|
||||||
const modal = useModal()
|
name: 'modal-example'
|
||||||
|
preview: false
|
||||||
defineProps<{
|
---
|
||||||
count: number
|
::
|
||||||
}>()
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<template>
|
|
||||||
<UModal :title="`This modal was opened programmatically ${count} times`">
|
|
||||||
<template #footer>
|
|
||||||
<UButton color="gray" label="Close" @click="modal.close()" />
|
|
||||||
</template>
|
|
||||||
</UModal>
|
|
||||||
</template>
|
|
||||||
```
|
|
||||||
|
|
||||||
Then, use it in your app:
|
Then, use it in your app:
|
||||||
|
|
||||||
@@ -341,7 +330,7 @@ class: 'justify-center'
|
|||||||
|
|
||||||
### With command palette
|
### With command palette
|
||||||
|
|
||||||
You can use the [CommandPalette](/components/command-palette) component inside the Modal.
|
You can use the [CommandPalette](/components/command-palette) component inside the Modal's content.
|
||||||
|
|
||||||
::component-example
|
::component-example
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -7,15 +7,326 @@ links:
|
|||||||
- label: GitHub
|
- label: GitHub
|
||||||
icon: i-simple-icons-github
|
icon: i-simple-icons-github
|
||||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Slideover.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Slideover.vue
|
||||||
navigation:
|
|
||||||
badge:
|
|
||||||
label: Todo
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
Use a [Button](/components/button) or any other component in the default slot of the Slideover.
|
||||||
|
|
||||||
|
Then, use the `#content` slot to add the content displayed when the Slideover is open.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
prettier: true
|
||||||
|
class: 'justify-center'
|
||||||
|
slots:
|
||||||
|
default: |
|
||||||
|
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" />
|
||||||
|
|
||||||
|
content: |
|
||||||
|
|
||||||
|
<Placeholder class="h-full m-4" />
|
||||||
|
---
|
||||||
|
|
||||||
|
:u-button{label="Open" color="gray" variant="subtle"}
|
||||||
|
|
||||||
|
#content
|
||||||
|
:placeholder{class="h-full m-4"}
|
||||||
|
::
|
||||||
|
|
||||||
|
You can also use the `#header`{lang="ts-type"}, `#body`{lang="ts-type"} and `#footer`{lang="ts-type"} slots to customize the Slideover's content.
|
||||||
|
|
||||||
|
### Title
|
||||||
|
|
||||||
|
Use the `title` prop to set the title of the Slideover's header.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
prettier: true
|
||||||
|
class: 'justify-center'
|
||||||
|
props:
|
||||||
|
title: 'Slideover with title'
|
||||||
|
slots:
|
||||||
|
default: |
|
||||||
|
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" />
|
||||||
|
|
||||||
|
body: |
|
||||||
|
|
||||||
|
<Placeholder class="h-full" />
|
||||||
|
---
|
||||||
|
|
||||||
|
:u-button{label="Open" color="gray" variant="subtle"}
|
||||||
|
|
||||||
|
#body
|
||||||
|
:placeholder{class="h-full"}
|
||||||
|
::
|
||||||
|
|
||||||
|
### Description
|
||||||
|
|
||||||
|
Use the `description` prop to set the description of the Slideover's header.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
prettier: true
|
||||||
|
class: 'justify-center'
|
||||||
|
ignore:
|
||||||
|
- title
|
||||||
|
props:
|
||||||
|
title: 'Slideover with description'
|
||||||
|
description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
|
||||||
|
slots:
|
||||||
|
default: |
|
||||||
|
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" />
|
||||||
|
|
||||||
|
body: |
|
||||||
|
|
||||||
|
<Placeholder class="h-full" />
|
||||||
|
---
|
||||||
|
|
||||||
|
:u-button{label="Open" color="gray" variant="subtle"}
|
||||||
|
|
||||||
|
#body
|
||||||
|
:placeholder{class="h-full"}
|
||||||
|
::
|
||||||
|
|
||||||
|
### Close
|
||||||
|
|
||||||
|
Use the `close` prop to customize or hide the close button displayed in the Slideover's header. You can pass all the props of the [Button](/components/button) component to customize it.
|
||||||
|
|
||||||
|
::tip
|
||||||
|
The close button is not displayed if the `#content` slot is used as it's a part of the header.
|
||||||
|
::
|
||||||
|
|
||||||
|
Use the `close-icon` prop to customize the button [Icon](/components/icon). Defaults to `i-heroicons-x-mark-20-solid`.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
prettier: true
|
||||||
|
class: 'justify-center'
|
||||||
|
ignore:
|
||||||
|
- title
|
||||||
|
- close.color
|
||||||
|
- close.variant
|
||||||
|
props:
|
||||||
|
title: 'Slideover with close button'
|
||||||
|
close:
|
||||||
|
color: primary
|
||||||
|
variant: outline
|
||||||
|
class: 'rounded-full'
|
||||||
|
closeIcon: ''
|
||||||
|
slots:
|
||||||
|
default: |
|
||||||
|
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" />
|
||||||
|
|
||||||
|
body: |
|
||||||
|
|
||||||
|
<Placeholder class="h-full" />
|
||||||
|
---
|
||||||
|
|
||||||
|
:u-button{label="Open" color="gray" variant="subtle"}
|
||||||
|
|
||||||
|
#body
|
||||||
|
:placeholder{class="h-full"}
|
||||||
|
::
|
||||||
|
|
||||||
|
::tip
|
||||||
|
You can customize this icon globally in your `app.config.ts` under `ui.icons.close` key.
|
||||||
|
::
|
||||||
|
|
||||||
|
### Side
|
||||||
|
|
||||||
|
Use the `side` prop to set the side of the screen where the Slideover will slide in from. Defaults to `right`.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
prettier: true
|
||||||
|
ignore:
|
||||||
|
- title
|
||||||
|
class: 'justify-center'
|
||||||
|
props:
|
||||||
|
side: 'left'
|
||||||
|
title: 'Slideover with side'
|
||||||
|
slots:
|
||||||
|
default: |
|
||||||
|
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" />
|
||||||
|
|
||||||
|
body: |
|
||||||
|
|
||||||
|
<Placeholder class="h-full min-h-48" />
|
||||||
|
---
|
||||||
|
|
||||||
|
:u-button{label="Open" color="gray" variant="subtle"}
|
||||||
|
|
||||||
|
#body
|
||||||
|
:placeholder{class="h-full min-h-48"}
|
||||||
|
::
|
||||||
|
|
||||||
|
### Overlay
|
||||||
|
|
||||||
|
Use the `overlay` prop to control whether the Slideover has an overlay or not. Defaults to `true`.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
prettier: true
|
||||||
|
ignore:
|
||||||
|
- title
|
||||||
|
class: 'justify-center'
|
||||||
|
props:
|
||||||
|
overlay: false
|
||||||
|
title: 'Slideover without overlay'
|
||||||
|
slots:
|
||||||
|
default: |
|
||||||
|
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" />
|
||||||
|
|
||||||
|
body: |
|
||||||
|
|
||||||
|
<Placeholder class="h-full" />
|
||||||
|
---
|
||||||
|
|
||||||
|
:u-button{label="Open" color="gray" variant="subtle"}
|
||||||
|
|
||||||
|
#body
|
||||||
|
:placeholder{class="h-full"}
|
||||||
|
::
|
||||||
|
|
||||||
|
### Transition
|
||||||
|
|
||||||
|
Use the `transition` prop to control whether the Slideover is animated or not. Defaults to `true`.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
prettier: true
|
||||||
|
ignore:
|
||||||
|
- title
|
||||||
|
class: 'justify-center'
|
||||||
|
props:
|
||||||
|
transition: false
|
||||||
|
title: 'Slideover without transition'
|
||||||
|
slots:
|
||||||
|
default: |
|
||||||
|
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" />
|
||||||
|
|
||||||
|
body: |
|
||||||
|
|
||||||
|
<Placeholder class="h-full" />
|
||||||
|
---
|
||||||
|
|
||||||
|
:u-button{label="Open" color="gray" variant="subtle"}
|
||||||
|
|
||||||
|
#body
|
||||||
|
:placeholder{class="h-full"}
|
||||||
|
::
|
||||||
|
|
||||||
|
### Prevent close
|
||||||
|
|
||||||
|
Use the `prevent-close` prop to prevent the Slideover from being closed when clicking outside of it.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
prettier: true
|
||||||
|
ignore:
|
||||||
|
- title
|
||||||
|
- preventClose
|
||||||
|
class: 'justify-center'
|
||||||
|
props:
|
||||||
|
preventClose: true
|
||||||
|
title: 'Slideover prevent close'
|
||||||
|
slots:
|
||||||
|
default: |
|
||||||
|
|
||||||
|
<UButton label="Open" color="gray" variant="subtle" />
|
||||||
|
|
||||||
|
body: |
|
||||||
|
|
||||||
|
<Placeholder class="h-full" />
|
||||||
|
---
|
||||||
|
|
||||||
|
:u-button{label="Open" color="gray" variant="subtle"}
|
||||||
|
|
||||||
|
#body
|
||||||
|
:placeholder{class="h-full"}
|
||||||
|
::
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
### Control open state
|
||||||
|
|
||||||
|
You can control the open state by using the `default-open` prop or the `v-model:open` directive.
|
||||||
|
|
||||||
|
::component-example
|
||||||
|
---
|
||||||
|
name: 'slideover-open-example'
|
||||||
|
class: 'justify-center'
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
::note
|
||||||
|
In this example, press :kbd{value="O"} to toggle the Slideover.
|
||||||
|
::
|
||||||
|
|
||||||
|
::tip
|
||||||
|
This allows you to move the trigger outside of the Slideover or remove it entirely.
|
||||||
|
::
|
||||||
|
|
||||||
|
### Control programatically
|
||||||
|
|
||||||
|
You can use the `useSlideover` composable to open a Slideover programatically.
|
||||||
|
|
||||||
|
::important
|
||||||
|
Make sure to wrap your app with the [`App`](/components/app) component that instantiates the `SlideoverProvider` component.
|
||||||
|
::
|
||||||
|
|
||||||
|
First, create a slideover component that will be opened programatically:
|
||||||
|
|
||||||
|
::component-example
|
||||||
|
---
|
||||||
|
name: 'slideover-example'
|
||||||
|
preview: false
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
Then, use it in your app:
|
||||||
|
|
||||||
|
::component-example
|
||||||
|
---
|
||||||
|
name: 'slideover-programmatic-example'
|
||||||
|
class: 'justify-center'
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
::tip
|
||||||
|
You can close the slideover within the slideover component by calling `slideover.close()`.
|
||||||
|
::
|
||||||
|
|
||||||
|
### Nested slideovers
|
||||||
|
|
||||||
|
You can nest slideovers within each other.
|
||||||
|
|
||||||
|
::component-example
|
||||||
|
---
|
||||||
|
name: 'slideover-nested-example'
|
||||||
|
class: 'justify-center'
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
### With footer slot
|
||||||
|
|
||||||
|
Use the `#footer` slot to add content after the Slideover's body.
|
||||||
|
|
||||||
|
::component-example
|
||||||
|
---
|
||||||
|
name: 'slideover-footer-slot-example'
|
||||||
|
class: 'justify-center'
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|||||||
@@ -139,6 +139,7 @@ export default defineNuxtConfig({
|
|||||||
'UProgress',
|
'UProgress',
|
||||||
'URadioGroup',
|
'URadioGroup',
|
||||||
'USlider',
|
'USlider',
|
||||||
|
'USlideover',
|
||||||
'USwitch',
|
'USwitch',
|
||||||
'UTabs',
|
'UTabs',
|
||||||
'UTextarea',
|
'UTextarea',
|
||||||
|
|||||||
Reference in New Issue
Block a user