jaro/flowbite-vue
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add basic modal component

Browse Source
This commit is contained in:
Dmitri
2022-08-31 10:14:18 -07:00
parent fd177ef3e6
commit 8ef6526fa7
4 changed files with 97 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/.vitepress/config.ts
View File

@@ -42,6 +42,7 @@ function getComponents() {
{ text: 'Tabs', link: '/components/tabs/tabs.md' }, { text: 'Tabs', link: '/components/tabs/tabs.md' },
{ text: 'ListGroup', link: 'components/listGroup/listGroup.md' }, { text: 'ListGroup', link: 'components/listGroup/listGroup.md' },
{ text: 'Toast', link: 'components/toast/toast.md' }, { text: 'Toast', link: 'components/toast/toast.md' },
{ text: 'Modal', link: 'components/modal/modal.md' },
{ text: '- Accordion', link: 'components/accordion/accordion.md' }, { text: '- Accordion', link: 'components/accordion/accordion.md' },
{ text: '- Avatar', link: 'components/avatar/avatar.md' }, { text: '- Avatar', link: 'components/avatar/avatar.md' },
@@ -50,7 +51,6 @@ function getComponents() {
{ text: '- Card', link: 'components/card/card.md' }, { text: '- Card', link: 'components/card/card.md' },
{ text: '- Carousel', link: 'components/carousel/carousel.md' }, { text: '- Carousel', link: 'components/carousel/carousel.md' },
{ text: '- Footer', link: 'components/footer/footer.md' }, { text: '- Footer', link: 'components/footer/footer.md' },
{ text: '- Modal', link: 'components/modal/modal.md' },
{ text: '- Navbar', link: 'components/navbar/navbar.md' }, { text: '- Navbar', link: 'components/navbar/navbar.md' },
{ text: '- Pagination', link: 'components/pagination/pagination.md' }, { text: '- Pagination', link: 'components/pagination/pagination.md' },
{ text: '- Progress', link: 'components/progress/progress.md' }, { text: '- Progress', link: 'components/progress/progress.md' },

25
docs/components/modal/examples/ModalExample.vue
View File

@@ -1,6 +1,29 @@
<template> <template>
<div class="vp-raw flex flex-col"> <div class="vp-raw flex flex-col">
<Modal></Modal> <Modal>
<template #trigger="props">
<button @click="props.show()" type="button" class="mt-5 text-white bg-blue-700 hover:bg-blue-800 focus:ring-4 focus:outline-none focus:ring-blue-300 font-medium rounded-lg text-sm px-5 py-2.5 text-center dark:bg-blue-600 dark:hover:bg-blue-700 dark:focus:ring-blue-800">
Show Modal
</button>
</template>
<template v-slot:title>Terms of Service</template>
<template v-slot:body>
<p class="text-base leading-relaxed text-gray-500 dark:text-gray-400">
With less than a month to go before the European Union enacts new consumer privacy laws for its citizens, companies around the world are updating their terms of service agreements to comply.
</p>
<p class="text-base leading-relaxed text-gray-500 dark:text-gray-400">
The European Union’s General Data Protection Regulation (G.D.P.R.) goes into effect on May 25 and is meant to ensure a common set of data rights in the European Union. It requires organizations to notify users as soon as possible of high-risk data breaches that could personally affect them.
</p>
</template>
<template #footer="props">
<button @click="props.hide()" type="button" class="text-white bg-blue-700 hover:bg-blue-800 focus:ring-4 focus:outline-none focus:ring-blue-300 font-medium rounded-lg text-sm px-5 py-2.5 text-center dark:bg-blue-600 dark:hover:bg-blue-700 dark:focus:ring-blue-800">
I accept
</button>
<button @click="props.hide()" type="button" class="text-gray-500 bg-white hover:bg-gray-100 focus:ring-4 focus:outline-none focus:ring-blue-300 rounded-lg border border-gray-200 text-sm font-medium px-5 py-2.5 hover:text-gray-900 focus:z-10 dark:bg-gray-700 dark:text-gray-300 dark:border-gray-500 dark:hover:text-white dark:hover:bg-gray-600 dark:focus:ring-gray-600">
Decline
</button>
</template>
</Modal>
</div> </div>
</template> </template>
<script setup> <script setup>

36
docs/components/modal/modal.md
View File

@@ -3,13 +3,45 @@ import ModalExample from './examples/ModalExample.vue'
</script> </script>
# Modal # Modal
### Demo
<ModalExample />
```vue ```vue
<script setup> <script setup>
import { Modal } from 'flowbite-vue' import { Modal } from 'flowbite-vue'
</script> </script>
<template> <template>
<Modal></Modal> <Modal>
<template #trigger="props">
<button @click="props.show()" type="button" class="mt-5 text-white bg-blue-700 hover:bg-blue-800 focus:ring-4 focus:outline-none focus:ring-blue-300 font-medium rounded-lg text-sm px-5 py-2.5 text-center dark:bg-blue-600 dark:hover:bg-blue-700 dark:focus:ring-blue-800">
Show Modal
</button>
</template>
<template v-slot:title>Terms of Service</template>
<template v-slot:body>
<p class="text-base leading-relaxed text-gray-500 dark:text-gray-400">
With less than a month to go before the European Union enacts new consumer privacy laws for its citizens, companies around the world are updating their terms of service agreements to comply.
</p>
<p class="text-base leading-relaxed text-gray-500 dark:text-gray-400">
The European Union’s General Data Protection Regulation (G.D.P.R.) goes into effect on May 25 and is meant to ensure a common set of data rights in the European Union. It requires organizations to notify users as soon as possible of high-risk data breaches that could personally affect them.
</p>
</template>
<template #footer="props">
<button @click="props.hide()" type="button" class="text-white bg-blue-700 hover:bg-blue-800 focus:ring-4 focus:outline-none focus:ring-blue-300 font-medium rounded-lg text-sm px-5 py-2.5 text-center dark:bg-blue-600 dark:hover:bg-blue-700 dark:focus:ring-blue-800">
I accept
</button>
<button @click="props.hide()" type="button" class="text-gray-500 bg-white hover:bg-gray-100 focus:ring-4 focus:outline-none focus:ring-blue-300 rounded-lg border border-gray-200 text-sm font-medium px-5 py-2.5 hover:text-gray-900 focus:z-10 dark:bg-gray-700 dark:text-gray-300 dark:border-gray-500 dark:hover:text-white dark:hover:bg-gray-600 dark:focus:ring-gray-600">
Decline
</button>
</template>
</Modal>
</template> </template>
``` ```
<ModalExample /> ### Slot Properties
Modal slots recieve the following functions to interact with the modal:
1. `show` = show the modal
2. `hide` = hide the modal
3. `toggle` = toggles the modal from current state (e.g. if shown, then hide)

65
src/components/Modal/Modal.vue
View File

@@ -1,37 +1,36 @@
<template> <template>
<div id="defaultModal" tabindex="-1" aria-hidden="true" class="hidden overflow-y-auto overflow-x-hidden fixed top-0 right-0 left-0 z-50 w-full md:inset-0 h-modal md:h-full"> <div>
<div class="relative p-4 w-full max-w-2xl h-full md:h-auto"> <slot name="trigger" :show="showModal" :hide="hideModal" :toggle="toggleModal"></slot>
<!-- Modal content --> <div v-if="!isHidden" class="bg-gray-900 bg-opacity-50 dark:bg-opacity-80 fixed inset-0 z-40"></div>
<div class="relative bg-white rounded-lg shadow dark:bg-gray-700"> <div v-if="!isHidden" id="defaultModal" tabindex="-1" :aria-hidden="isHidden ? 'true' : 'false'" class="overflow-y-auto overflow-x-hidden fixed top-0 right-0 left-0 z-50 w-full md:inset-0 h-modal md:h-full justify-center items-center flex">
<!-- Modal header --> <div class="relative p-4 w-full max-w-2xl h-full md:h-auto">
<div class="flex justify-between items-start p-4 rounded-t border-b dark:border-gray-600"> <!-- Modal content -->
<h3 class="text-xl font-semibold text-gray-900 dark:text-white"> <div class="relative bg-white rounded-lg shadow dark:bg-gray-700">
Terms of Service <!-- Modal header -->
</h3> <div class="flex justify-between items-start p-4 rounded-t border-b dark:border-gray-600">
<button type="button" class="text-gray-400 bg-transparent hover:bg-gray-200 hover:text-gray-900 rounded-lg text-sm p-1.5 ml-auto inline-flex items-center dark:hover:bg-gray-600 dark:hover:text-white" data-modal-toggle="defaultModal"> <h3 class="text-xl font-semibold text-gray-900 dark:text-white">
<svg class="w-5 h-5" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path></svg> <slot name="title"></slot>
</button> </h3>
</div> <button @click="hideModal" type="button" class="text-gray-400 bg-transparent hover:bg-gray-200 hover:text-gray-900 rounded-lg text-sm p-1.5 ml-auto inline-flex items-center dark:hover:bg-gray-600 dark:hover:text-white">
<!-- Modal body --> <svg class="w-5 h-5" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path></svg>
<div class="p-6 space-y-6"> </button>
<p class="text-base leading-relaxed text-gray-500 dark:text-gray-400"> </div>
With less than a month to go before the European Union enacts new consumer privacy laws for its citizens, companies around the world are updating their terms of service agreements to comply. <!-- Modal body -->
</p> <div class="p-6 space-y-6">
<p class="text-base leading-relaxed text-gray-500 dark:text-gray-400"> <slot name="body" :show="showModal" :hide="hideModal" :toggle="toggleModal"></slot>
The European Union’s General Data Protection Regulation (G.D.P.R.) goes into effect on May 25 and is meant to ensure a common set of data rights in the European Union. It requires organizations to notify users as soon as possible of high-risk data breaches that could personally affect them. </div>
</p> <!-- Modal footer -->
</div> <div class="flex items-center p-6 space-x-2 rounded-b border-t border-gray-200 dark:border-gray-600">
<!-- Modal footer --> <slot name="footer" :show="showModal" :hide="hideModal" :toggle="toggleModal"/>
<div class="flex items-center p-6 space-x-2 rounded-b border-t border-gray-200 dark:border-gray-600"> </div>
<button data-modal-toggle="defaultModal" type="button" class="text-white bg-blue-700 hover:bg-blue-800 focus:ring-4 focus:outline-none focus:ring-blue-300 font-medium rounded-lg text-sm px-5 py-2.5 text-center dark:bg-blue-600 dark:hover:bg-blue-700 dark:focus:ring-blue-800">I accept</button>
<button data-modal-toggle="defaultModal" type="button" class="text-gray-500 bg-white hover:bg-gray-100 focus:ring-4 focus:outline-none focus:ring-blue-300 rounded-lg border border-gray-200 text-sm font-medium px-5 py-2.5 hover:text-gray-900 focus:z-10 dark:bg-gray-700 dark:text-gray-300 dark:border-gray-500 dark:hover:text-white dark:hover:bg-gray-600 dark:focus:ring-gray-600">Decline</button>
</div> </div>
</div> </div>
</div> </div>
</div> </div>
</template> </template>
<script lang="ts" setup> <script lang="ts" setup>
import type { PropType } from 'vue' import { ref } from 'vue'
import type { Ref } from 'vue'
const props = defineProps({ const props = defineProps({
children: { children: {
@@ -58,4 +57,16 @@ const props = defineProps({
}, },
}) })
const isHidden: Ref<boolean> = ref(!props.show)
function toggleModal() {
isHidden.value = !isHidden.value
}
function hideModal() {
isHidden.value = !isHidden.value
}
function showModal() {
isHidden.value = !isHidden.value
}
</script> </script>