Files
mixtape/zero.Web.UI/App/components/forms/form.vue
T

472 lines
11 KiB
Vue

<template>
<form class="ui-form" @keydown="onKeydown" @submit.prevent="onSubmit" @change="onChange">
<slot v-if="loadingState === 'default'" v-bind="slotProps" />
<div v-if="loadingState == 'loading'" class="ui-form-loading">
<i class="ui-form-loading-progress"></i>
</div>
<ui-error-view v-if="loadingState === 'error'" :error="loadingError" />
</form>
</template>
<script>
import Overlay from 'zero/services/overlay.js'
import Notification from 'zero/services/notification.js'
import { isArray as _isArray, filter as _filter, groupBy as _groupBy, each as _each, difference as _difference } from 'underscore'
export default {
name: 'uiForm',
props: {
errorComponents: {
type: Array,
default: () => [ 'uiError' ]
},
inputComponents: {
type: Array,
default: () => [ 'uiProperty' ]
},
route: {
type: [String, Object],
default: null
}
},
data: () => ({
dirty: false,
loadingState: 'default',
loadingError: null,
state: 'default',
errors: [],
canEdit: true,
isShared: false,
slotProps: {
state: null,
isShared: false
},
submitBlocked: false
}),
watch: {
'$route': function ()
{
this.$emit('load', this);
},
state(val)
{
this.slotProps.state = val;
},
isShared(val)
{
this.slotProps.isShared = val;
},
canEdit(val)
{
this.$nextTick(() =>
{
this.setCanEdit(val);
});
}
},
created()
{
this.slotProps.state = this.state;
this.$emit('load', this);
},
methods: {
// shows a confirmation dialog for dirty forms when the route tries to change
// it only works when this method is attached to the route component
beforeRouteLeave(to, from, next)
{
if (this.dirty)
{
Overlay.confirm({
title: '@unsavedchanges.title',
text: '@unsavedchanges.text',
confirmLabel: '@unsavedchanges.confirm',
closeLabel: '@unsavedchanges.close'
}).then(
() => next(false),
() => next()
);
}
else
{
next()
}
},
// loads data on creation of the form
load(promise)
{
this.loadingState = 'loading';
return new Promise((resolve, reject) =>
{
promise
.then(
response =>
{
this.loadingState = 'default';
if (typeof response.meta.canEdit === 'boolean')
{
this.canEdit = response.meta.canEdit;
if (response.entity)
{
if (!response.entity.id && this.$route.params.scope === zero.sharedAppId)
{
response.entity.appId = zero.sharedAppId;
}
this.isShared = response.entity.appId === zero.sharedAppId; // || !response.entity.appId;
}
}
resolve(response);
},
(error) =>
{
this.loadingState = 'error';
this.loadingError = error;
reject(error);
}
)
.catch(exception =>
{
this.loadingState = 'error';
this.loadingError = exception;
});
});
},
// handles a promise as result of the form submission
handle(promise, isCreate)
{
this.setState('loading');
let handleError = (errors, reject) =>
{
this.setState('error');
this.setErrors(errors);
reject(errors);
};
return new Promise((resolve, reject) =>
{
promise
.then(
response =>
{
this.clearErrors();
if (response.success)
{
this.setState('success');
this.setDirty(false);
resolve(response);
if (response.model && this.route && this.$route.name !== this.route)
{
let routeObj = typeof this.route === 'object' ? this.route : { name: this.route };
routeObj.params = routeObj.params || {};
routeObj.params.id = response.model.id;
this.$router.replace(routeObj);
}
}
else
{
handleError(response.errors, reject);
}
},
errors =>
{
handleError(errors, reject);
}
)
.catch(exception =>
{
this.setState('error');
// TODO should we throw here, probably show an error overlay
throw exception;
});
});
},
// submits the form
onSubmit(e)
{
if (!this.submitBlocked)
{
this.$emit('submit', this, e);
}
},
// set the form to dirty when one of the fields changes
onChange(e)
{
this.dirty = true;
},
// handle delete event
onDelete(promise)
{
Overlay.confirmDelete().then(opts =>
{
opts.state('loading');
promise().then(response =>
{
if (response.success)
{
opts.state('success');
opts.hide();
this.$router.go(-1);
Notification.success('@deleteoverlay.success', '@deleteoverlay.success_text');
}
else
{
opts.errors(response.errors);
}
});
});
},
// prevent submission of form on enter key press
onKeydown(e)
{
if (e.keyCode === 13)
{
this.submitBlocked = true;
clearTimeout(this.submitBlockedTimeout);
this.submitBlockedTimeout = setTimeout(() => this.submitBlocked = false, 300);
}
},
// set dirty status
setDirty(dirty)
{
this.dirty = dirty;
},
// set state for this component and all child components which attached it's state from the slot props
setState(state)
{
this.state = state;
},
// clears all errors from the form
clearErrors()
{
this.getErrorComponents().forEach(component =>
{
component.clearErrors();
if (component.tab)
{
component.tab.clearErrors();
}
});
},
// tries to find matching fields for the given errors and displays them
setErrors(errors)
{
if (typeof errors === 'undefined' || !errors)
{
this.errors = [];
}
else
{
this.errors = !_isArray(errors) ? [errors] : errors;
}
// get all components + grouped errors
let errorComponents = this.getErrorComponents();
let errorGroups = _groupBy(this.errors, 'property');
let handledGroups = [];
// set errors
errorComponents.forEach(component =>
{
let field = component.field;
if (field && errorGroups[field])
{
handledGroups.push(field);
component.setErrors(errorGroups[field]);
if (component.tab)
{
component.tab.setErrors(true);
}
}
});
// fill leftovers
_each(errorGroups, (errorGroup, field) =>
{
if (handledGroups.indexOf(field) < 0)
{
errorComponents.forEach(component =>
{
if (component.catchRemaining || component.catchAll)
{
component.setErrors(errorGroup, true);
if (component.tab)
{
component.tab.setErrors(true);
}
}
});
}
});
},
// find all error components in form
getErrorComponents()
{
let errorComponents = [];
// find components which can output errors
let traverseChildren = (parent, tab) =>
{
parent.$children.forEach(component =>
{
if (this.errorComponents.indexOf(component.$options.name) > -1)
{
errorComponents.push({
name: component.$options.name,
field: component.field,
catchAll: component.catchAll,
catchRemaining: component.catchRemaining,
component: component,
setErrors: component.setErrors,
clearErrors: component.clearErrors,
tab: tab
});
}
else
{
traverseChildren(component, tab || (component.$options.name === 'uiTab' ? component : null));
}
});
};
traverseChildren(this);
return errorComponents;
},
// sets the form editing ability
setCanEdit(canEdit)
{
// find components which can output errors
//let traverseChildren = parent =>
//{
// parent.$children.forEach(component =>
// {
// const isValidComponent = this.inputComponents.indexOf(component.$options.name) > -1;
// //const field = component.field;
// if (typeof component._props.disabled === 'boolean')
// {
// component.$emit('update:disabled', canEdit);
// }
// else
// {
// traverseChildren(component);
// }
// //if (isErrorComponent)
// //{
// // errorComponents.push(component);
// //}
// //if (isErrorComponent && field)
// //{
// // let errorGroup = errorGroups[field];
// // if (errorGroup)
// // {
// // handledGroups.push(field);
// // component.set(errorGroup);
// // }
// //}
// //else
// //{
// // traverseChildren(component);
// //}
// });
//};
//traverseChildren(this);
//console.info('done');
}
}
}
</script>
<style lang="scss">
.ui-form
{
min-height: 100%;
font-size: var(--font-size);
}
.ui-form-loading
{
display: flex;
width: 100%;
height: 100vh;
align-items: center;
justify-content: center;
}
.ui-form-loading-progress
{
width: 32px;
height: 32px;
z-index: 2;
border-radius: 40px;
border: 2px solid var(--color-bg-shade-3);
border-left-color: var(--color-text);
opacity: 1;
will-change: transform;
animation: rotating .5s linear infinite;
transition: opacity .25s ease;
}
@keyframes rotating
{
from
{
-webkit-transform: rotate(0);
transform: rotate(0)
}
to
{
-webkit-transform: rotate(1turn);
transform: rotate(1turn)
}
}
</style>