Merge pull request #78 from Dmitri-2/add-modal-component
Add basic modal component (Issue #56)
This commit is contained in:
Ilya Artamonov
GitHub
@@ -46,11 +46,11 @@ function getComponents() {
|
||||
{ text: 'Tabs', link: '/components/tabs/tabs.md' },
|
||||
{ text: 'ListGroup', link: 'components/listGroup/listGroup.md' },
|
||||
{ text: 'Toast', link: 'components/toast/toast.md' },
|
||||
{ text: 'Modal', link: 'components/modal/modal.md' },
|
||||
|
||||
{ text: '- Accordion', link: 'components/accordion/accordion.md' },
|
||||
{ text: '- Carousel', link: 'components/carousel/carousel.md' },
|
||||
{ text: '- Footer', link: 'components/footer/footer.md' },
|
||||
{ text: '- Modal', link: 'components/modal/modal.md' },
|
||||
{ text: '- Navbar', link: 'components/navbar/navbar.md' },
|
||||
{ text: '- Pagination', link: 'components/pagination/pagination.md' },
|
||||
{ text: '- Progress', link: 'components/progress/progress.md' },
|
||||
|
||||
@@ -1,8 +1,74 @@
|
||||
<template>
|
||||
<div class="vp-raw flex flex-col">
|
||||
<Modal></Modal>
|
||||
<Modal :size="size">
|
||||
<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">
|
||||
{{triggerText}}
|
||||
</button>
|
||||
</template>
|
||||
<template #header="props">
|
||||
<div class="flex justify-between">
|
||||
<div class="flex items-center text-lg">
|
||||
Terms of Service
|
||||
</div>
|
||||
<div>
|
||||
<button @click="props.hide()" 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">
|
||||
<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>
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</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">
|
||||
<div class="flex justify-between">
|
||||
<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>
|
||||
<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>
|
||||
</div>
|
||||
</template>
|
||||
</Modal>
|
||||
</div>
|
||||
</template>
|
||||
<script setup>
|
||||
<script lang="ts" setup>
|
||||
import { Modal } from '../../../../src/index'
|
||||
import type { PropType } from 'vue'
|
||||
import type { ModalSize, ModalPosition } from '../../../../src/components/Modal/types'
|
||||
const props = defineProps({
|
||||
children: {
|
||||
type: Array,
|
||||
default() {
|
||||
return []
|
||||
},
|
||||
},
|
||||
popup: {
|
||||
type: Boolean,
|
||||
default: false,
|
||||
},
|
||||
position: {
|
||||
type: String as PropType<ModalPosition>,
|
||||
default: 'center',
|
||||
},
|
||||
show: {
|
||||
type: Boolean,
|
||||
default: false,
|
||||
},
|
||||
size: {
|
||||
type: String as PropType<ModalSize>,
|
||||
default: '2xl',
|
||||
},
|
||||
triggerText: {
|
||||
type: String,
|
||||
default: 'Demo Modal',
|
||||
},
|
||||
})
|
||||
</script>
|
||||
|
||||
19
docs/components/modal/examples/ModalSizeExample.vue
Normal file
19
docs/components/modal/examples/ModalSizeExample.vue
Normal file
@@ -0,0 +1,19 @@
|
||||
<template>
|
||||
<div class="vp-raw flex justify-between">
|
||||
<span>
|
||||
<ModalExample size="xs" trigger-text="XS Modal" />
|
||||
</span>
|
||||
<span>
|
||||
<ModalExample size="md" trigger-text="MD Modal" />
|
||||
</span>
|
||||
<span>
|
||||
<ModalExample size="xl" trigger-text="XL Modal" />
|
||||
</span>
|
||||
<span>
|
||||
<ModalExample size="5xl" trigger-text="5XL Modal" />
|
||||
</span>
|
||||
</div>
|
||||
</template>
|
||||
<script setup>
|
||||
import ModalExample from './ModalExample.vue'
|
||||
</script>
|
||||
@@ -1,15 +1,87 @@
|
||||
<script setup>
|
||||
import ModalExample from './examples/ModalExample.vue'
|
||||
import ModalExample from './examples/ModalExample.vue';
|
||||
import ModalSizeExample from './examples/ModalSizeExample.vue';
|
||||
</script>
|
||||
# Vue Modal Component - Flowbite
|
||||
|
||||
## Demo
|
||||
|
||||
<ModalExample />
|
||||
|
||||
```vue
|
||||
<script setup>
|
||||
import { Modal } from 'flowbite-vue'
|
||||
</script>
|
||||
<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 #header="props">
|
||||
<div class="flex justify-between">
|
||||
<div class="flex items-center text-lg">
|
||||
Terms of Service
|
||||
</div>
|
||||
<div>
|
||||
<button @click="props.hide()" 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">
|
||||
<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>
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</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">
|
||||
<div class="flex justify-between">
|
||||
<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>
|
||||
<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>
|
||||
</div>
|
||||
</template>
|
||||
</Modal>
|
||||
</template>
|
||||
```
|
||||
|
||||
<ModalExample />
|
||||
## Slot Properties
|
||||
|
||||
Modal slots receive 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)
|
||||
|
||||
These properties allow your code to set the open/closed state of the modal easily.
|
||||
|
||||
## Sizes
|
||||
|
||||
The modal can come in the following sizes (based on TailwindCSS classes).
|
||||
|
||||
`xs`, `sm`, `md`, `lg`, `xl`, `2xl`, `3xl`, `4xl`, `5xl`, `6xl`, `7xl`
|
||||
|
||||
The default value is: `2xl`
|
||||
|
||||
Demo:
|
||||
|
||||
<ModalSizeExample/>
|
||||
|
||||
```vue
|
||||
<script setup>
|
||||
import { Modal } from 'flowbite-vue'
|
||||
</script>
|
||||
<template>
|
||||
<Modal size="xs" />
|
||||
<Modal size="md" />
|
||||
<Modal size="xl" />
|
||||
<Modal size="5xl" />
|
||||
</template>
|
||||
```
|
||||
@@ -1,37 +1,35 @@
|
||||
<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 class="relative p-4 w-full max-w-2xl h-full md:h-auto">
|
||||
<!-- Modal content -->
|
||||
<div class="relative bg-white rounded-lg shadow dark:bg-gray-700">
|
||||
<!-- Modal header -->
|
||||
<div class="flex justify-between items-start p-4 rounded-t border-b dark:border-gray-600">
|
||||
<h3 class="text-xl font-semibold text-gray-900 dark:text-white">
|
||||
Terms of Service
|
||||
</h3>
|
||||
<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">
|
||||
<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>
|
||||
</button>
|
||||
</div>
|
||||
<!-- Modal body -->
|
||||
<div class="p-6 space-y-6">
|
||||
<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>
|
||||
</div>
|
||||
<!-- Modal footer -->
|
||||
<div class="flex items-center p-6 space-x-2 rounded-b border-t border-gray-200 dark:border-gray-600">
|
||||
<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>
|
||||
<slot name="trigger" :show="showModal" :hide="hideModal" :toggle="toggleModal"/>
|
||||
<div v-if="!isHidden" class="bg-gray-900 bg-opacity-50 dark:bg-opacity-80 fixed inset-0 z-40"/>
|
||||
<div v-if="!isHidden" 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">
|
||||
<div class="relative p-4 w-full h-full md:h-auto"
|
||||
:class="`${modalSizeClasses[size]}`">
|
||||
<!-- Modal content -->
|
||||
<div class="relative bg-white rounded-lg shadow dark:bg-gray-700">
|
||||
<!-- Modal header -->
|
||||
<div class="p-4 rounded-t"
|
||||
:class="$slots.header ? 'border-b' : ''">
|
||||
<slot name="header" :show="showModal" :hide="hideModal" :toggle="toggleModal"/>
|
||||
</div>
|
||||
<!-- Modal body -->
|
||||
<div class="p-6" :class="$slots.header ? '' : 'pt-0'">
|
||||
<slot name="body" :show="showModal" :hide="hideModal" :toggle="toggleModal"/>
|
||||
</div>
|
||||
<!-- Modal footer -->
|
||||
<div v-if="$slots.footer" class="p-6 rounded-b border-gray-200">
|
||||
<slot name="footer" :show="showModal" :hide="hideModal" :toggle="toggleModal"/>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
<script lang="ts" setup>
|
||||
import type { PropType } from 'vue'
|
||||
import { ref } from 'vue'
|
||||
import type { PropType, Ref } from 'vue'
|
||||
import type { ModalSize, ModalPosition } from './types'
|
||||
|
||||
const props = defineProps({
|
||||
children: {
|
||||
@@ -45,7 +43,7 @@ const props = defineProps({
|
||||
default: false,
|
||||
},
|
||||
position: {
|
||||
type: String, // 'bottom-left' | 'bottom-right' | 'bottom-center' | 'top-left' | 'top-center' | 'top-right' | 'center-left' | 'center' | 'center-right'
|
||||
type: String as PropType<ModalPosition>,
|
||||
default: 'center',
|
||||
},
|
||||
show: {
|
||||
@@ -53,9 +51,37 @@ const props = defineProps({
|
||||
default: false,
|
||||
},
|
||||
size: {
|
||||
type: String, // 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | '6xl' | '7xl'
|
||||
type: String as PropType<ModalSize>,
|
||||
default: '2xl',
|
||||
},
|
||||
})
|
||||
|
||||
const modalSizeClasses = {
|
||||
xs: 'max-w-xs',
|
||||
sm: 'max-w-sm',
|
||||
md: 'max-w-md',
|
||||
lg: 'max-w-lg',
|
||||
xl: 'max-w-xl',
|
||||
'2xl': 'max-w-2xl',
|
||||
'3xl': 'max-w-3xl',
|
||||
'4xl': 'max-w-4xl',
|
||||
'5xl': 'max-w-5xl',
|
||||
'6xl': 'max-w-6xl',
|
||||
'7xl': 'max-w-7xl',
|
||||
}
|
||||
|
||||
const isHidden: Ref<boolean> = ref(!props.show)
|
||||
|
||||
function toggleModal() {
|
||||
isHidden.value = !isHidden.value
|
||||
}
|
||||
|
||||
function hideModal() {
|
||||
isHidden.value = true
|
||||
}
|
||||
|
||||
function showModal() {
|
||||
isHidden.value = false
|
||||
}
|
||||
|
||||
</script>
|
||||
|
||||
2
src/components/Modal/types.ts
Normal file
2
src/components/Modal/types.ts
Normal file
@@ -0,0 +1,2 @@
|
||||
export type ModalPosition = 'bottom-left' | 'bottom-right' | 'bottom-center' | 'top-left' | 'top-center' | 'top-right' | 'center-left' | 'center' | 'center-right';
|
||||
export type ModalSize = 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl' | '5xl' | '6xl' | '7xl';
|
||||
Reference in New Issue
Block a user