feat(modal-property): additional exit functionality (#169)

fix(accessibility): aria-label the close button for screenreaders
docs: adds an example and escapable info section to documentation
This commit is contained in:
Nick Adams
2023-07-15 02:56:15 -06:00
committed by GitHub
parent 7569ca63be
commit 10be366d17
4 changed files with 65 additions and 5 deletions

View File

@@ -4,14 +4,19 @@
<div
tabindex="-1"
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"
v-on="escapable ? { click: closeModal } : {}"
>
<div class="relative p-4 w-full h-full md:h-auto" :class="`${modalSizeClasses[size]}`">
<div
@click.stop
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 flex justify-between items-center" :class="$slots.header ? 'border-b border-gray-200 dark:border-gray-600' : ''">
<slot name="header" />
<button @click="closeModal" 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">
<button v-if="escapable" @click="closeModal" aria-label="close" 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">
<slot name="close-icon">
<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>
@@ -34,7 +39,7 @@
import type { PropType } from 'vue'
import type { ModalSize, ModalPosition } from './types'
defineProps({
const props = defineProps({
children: {
type: Array,
default() {
@@ -53,6 +58,10 @@ defineProps({
type: String as PropType<ModalSize>,
default: '2xl',
},
escapable: {
type: Boolean,
default: true
},
})
const emit = defineEmits(['close'])
const modalSizeClasses = {
@@ -72,4 +81,12 @@ const modalSizeClasses = {
function closeModal() {
emit('close')
}
addEventListener("keyup", function(e) {
if (props.escapable) {
if (e.key === "Escape") {
closeModal();
}
}
})
</script>