Modal updates

- Add options for removing backdrop and preventing closing
- Add close button
- Style tweaks
This commit is contained in:
James Lyne 2021-09-01 01:00:42 +01:00
parent 1e4c8a080f
commit 21cb8da32f
6 changed files with 91 additions and 18 deletions

View File

@ -141,6 +141,8 @@
logoutTitle: 'Logout', logoutTitle: 'Logout',
logoutErrorUnknown: 'Unexpected error while logging out', logoutErrorUnknown: 'Unexpected error while logging out',
logoutSuccess: 'Logged out successfully', logoutSuccess: 'Logged out successfully',
closeTitle: 'Close',
}, },
ui: { ui: {

View File

@ -15,8 +15,15 @@
--> -->
<template> <template>
<div :class="{'modal': true, 'modal--visible': visible}" role="dialog" :id="`modal--${id}`" <div :class="{'modal': true, 'modal--visible': visible, 'modal--backdrop': backdrop}"
:aria-labelledby="`${id}__heading`" aria-modal="true" @click="onClick" ref="modal"> role="dialog" :id="`modal--${id}`" :aria-labelledby="`${id}__heading`" aria-modal="true"
@click="onBackdropClick" ref="modal">
<div class="modal__header">
<slot name="header"></slot>
<button v-if="closeable" class="modal__close" type="button" @click="close" :aria-label="messageClose">
<SvgIcon name="cross"></SvgIcon>
</button>
</div>
<div class="modal__content"> <div class="modal__content">
<slot></slot> <slot></slot>
</div> </div>
@ -29,44 +36,59 @@ import {useStore} from "@/store";
import {MutationTypes} from "@/store/mutation-types"; import {MutationTypes} from "@/store/mutation-types";
import {LiveAtlasUIModal} from "@/index"; import {LiveAtlasUIModal} from "@/index";
import {computed, ref} from "vue"; import {computed, ref} from "vue";
import SvgIcon from "@/components/SvgIcon.vue";
export default defineComponent({ export default defineComponent({
components: {SvgIcon},
props: { props: {
id: { id: {
required: true, required: true,
type: String, type: String,
},
closeable: {
default: true,
type: Boolean,
},
backdrop: {
default: true,
type: Boolean,
} }
}, },
setup(props) { setup(props) {
const store = useStore(), const store = useStore(),
modal = ref<HTMLElement | null>(null), modal = ref<HTMLElement | null>(null),
messageClose = computed(() => store.state.messages.closeTitle),
visible = computed(() => store.state.ui.visibleModal === props.id); visible = computed(() => store.state.ui.visibleModal === props.id);
const onKeydown = (e: KeyboardEvent) => { const onKeydown = (e: KeyboardEvent) => {
if(visible.value && e.key === 'Escape') { if(props.closeable && visible.value && e.key === 'Escape') {
store.commit(MutationTypes.HIDE_UI_MODAL, props.id as LiveAtlasUIModal); close();
e.preventDefault(); e.preventDefault();
e.stopImmediatePropagation(); e.stopImmediatePropagation();
} }
}; };
const onClick = (e: MouseEvent) => { const onBackdropClick = (e: MouseEvent) => {
if(e.target === modal.value) { if(props.closeable && e.target === modal.value) {
store.commit(MutationTypes.HIDE_UI_MODAL, props.id as LiveAtlasUIModal); close();
} }
}; };
const close = () => props.closeable && store.commit(MutationTypes.HIDE_UI_MODAL, props.id as LiveAtlasUIModal);
onMounted(() => { onMounted(() => {
window.addEventListener('keydown', onKeydown); window.addEventListener('keydown', onKeydown);
}); });
onUnmounted(() => { onUnmounted(() => {
window.addEventListener('keydown', onKeydown); window.removeEventListener('keydown', onKeydown);
}); });
return { return {
visible, visible,
modal, modal,
onClick, onBackdropClick,
close,
messageClose
} }
} }
}); });
@ -83,20 +105,61 @@ export default defineComponent({
bottom: 0; bottom: 0;
left: 0; left: 0;
display: none; display: none;
align-items: flex-start; align-items: center;
justify-content: center; flex-direction: column;
justify-content: flex-start;
padding: 10vh 1rem; padding: 10vh 1rem;
background-color: rgba(0, 0, 0, 0.8);
overflow: auto; overflow: auto;
pointer-events: none;
cursor: default;
&.modal--backdrop {
pointer-events: auto;
background-color: rgba(0, 0, 0, 0.8);
}
&.modal--visible { &.modal--visible {
display: flex; display: flex;
} }
.modal__header,
.modal__content { .modal__content {
@extend %panel; @extend %panel;
max-width: 80rem; max-width: 80rem;
box-sizing: border-box;
width: 100%; width: 100%;
padding: 2rem;
pointer-events: auto;
}
.modal__header {
border-bottom-left-radius: 0;
border-bottom-right-radius: 0;
position: relative;
padding: 2rem 3rem 0;
text-align: center;
}
.modal__close {
position: absolute;
top: 0;
right: 0;
padding: 1rem;
width: 3.5rem;
height: 3.5rem;
display: block;
border-top-left-radius: 0;
border-bottom-right-radius: 0;
.svg-icon {
width: 1.5rem !important;
height: 1.5rem !important;
}
}
.modal__content {
border-top-left-radius: 0;
border-top-right-radius: 0;
} }
} }
</style> </style>

View File

@ -15,9 +15,10 @@
--> -->
<template> <template>
<Modal id="login"> <Modal id="login" :closeable="!required" :backdrop="!required">
<h2 id="login__heading">{{ heading }}</h2> <template v-slot:header>
<h2 id="login__heading">{{ heading }}</h2>
</template>
<LoginForm></LoginForm> <LoginForm></LoginForm>
<RegisterForm></RegisterForm> <RegisterForm></RegisterForm>
</Modal> </Modal>
@ -33,6 +34,12 @@ import Modal from "@/components/Modal.vue";
export default defineComponent({ export default defineComponent({
components: {Modal, RegisterForm, LoginForm}, components: {Modal, RegisterForm, LoginForm},
props: {
required: {
default: false,
type: Boolean,
}
},
setup() { setup() {
const store = useStore(), const store = useStore(),
heading = computed(() => store.state.messages.loginTitle); heading = computed(() => store.state.messages.loginTitle);
@ -54,7 +61,6 @@ export default defineComponent({
justify-content: space-between; justify-content: space-between;
} }
#login__heading,
#login__error { #login__error {
width: 100%; width: 100%;
text-align: center; text-align: center;
@ -62,8 +68,7 @@ export default defineComponent({
} }
.form { .form {
width: 50%; width: calc(50% - 1.5rem);
padding: 1rem;
box-sizing: border-box; box-sizing: border-box;
} }
} }

1
src/index.d.ts vendored
View File

@ -121,6 +121,7 @@ interface LiveAtlasGlobalMessageConfig {
logoutTitle: string; logoutTitle: string;
logoutErrorUnknown: string; logoutErrorUnknown: string;
logoutSuccess: string; logoutSuccess: string;
closeTitle: string;
} }
// Messages defined by dynmap configuration responses and can vary per server // Messages defined by dynmap configuration responses and can vary per server

View File

@ -158,6 +158,7 @@ export const mutations: MutationTree<State> & Mutations = {
logoutTitle: messageConfig.logoutTitle || '', logoutTitle: messageConfig.logoutTitle || '',
logoutErrorUnknown: messageConfig.logoutErrorUnknown || '', logoutErrorUnknown: messageConfig.logoutErrorUnknown || '',
logoutSuccess: messageConfig.logoutSuccess || '', logoutSuccess: messageConfig.logoutSuccess || '',
closeTitle: messageConfig.closeTitle || '',
} }
state.messages = Object.assign(state.messages, messages); state.messages = Object.assign(state.messages, messages);

View File

@ -166,6 +166,7 @@ export const state: State = {
logoutTitle: '', logoutTitle: '',
logoutErrorUnknown: '', logoutErrorUnknown: '',
logoutSuccess: '', logoutSuccess: '',
closeTitle: '',
}, },
loggedIn: false, loggedIn: false,