Skip to content

refactor: add typed dialog form helpers #9315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

refactor: add typed dialog form helpers #9315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 46 additions & 29 deletions src/app/shared/dialogs/dialogs-form.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
import { Component, Inject } from '@angular/core';
import {
MatLegacyDialog as MatDialog, MatLegacyDialogRef as MatDialogRef, MAT_LEGACY_DIALOG_DATA as MAT_DIALOG_DATA
MatLegacyDialog as MatDialog,
MatLegacyDialogRef as MatDialogRef,
MAT_LEGACY_DIALOG_DATA as MAT_DIALOG_DATA
} from '@angular/material/legacy-dialog';
import { UntypedFormGroup, UntypedFormBuilder } from '@angular/forms';
import { FormArray, FormBuilder, FormGroup } from '@angular/forms';
import { DialogsLoadingService } from './dialogs-loading.service';
import { DialogsListService } from './dialogs-list.service';
import { DialogsListComponent } from './dialogs-list.component';
import { UserService } from '../user.service';
import {
DialogField,
DialogFormControls,
DialogFormGroup,
DialogFormGroupConfig,
DialogFormValueMap,
DialogsFormData
} from './dialogs-form.service';

@Component({
templateUrl: './dialogs-form.component.html',
Expand All @@ -27,36 +37,40 @@ import { UserService } from '../user.service';
export class DialogsFormComponent {

public title: string;
public fields: any;
public modalForm: UntypedFormGroup;
passwordVisibility = new Map();
public fields: DialogField[];
public modalForm: DialogFormGroup;
passwordVisibility = new Map<string, boolean>();
isSpinnerOk = true;
errorMessage = '';
dialogListRef: MatDialogRef<DialogsListComponent>;
disableIfInvalid = false;

private markFormAsTouched (formGroup: UntypedFormGroup) {
(<any>Object).values(formGroup.controls).forEach(control => {
control.markAsTouched();
if (control.controls) {
this.markFormAsTouched(control);
private markFormAsTouched(control: DialogFormGroup | FormArray<unknown>) {
const controls = control instanceof FormGroup ? Object.values(control.controls) : control.controls;
controls.forEach(innerControl => {
innerControl.markAsTouched();
if (innerControl instanceof FormGroup || innerControl instanceof FormArray) {
this.markFormAsTouched(innerControl);
}
});
}

constructor(
public dialogRef: MatDialogRef<DialogsFormComponent>,
private dialog: MatDialog,
private fb: UntypedFormBuilder,
@Inject(MAT_DIALOG_DATA) public data,
private fb: FormBuilder,
@Inject(MAT_DIALOG_DATA) public data: DialogsFormData,
private dialogsLoadingService: DialogsLoadingService,
private dialogsListService: DialogsListService,
private userService: UserService
) {
if (this.data && this.data.formGroup) {
this.modalForm = this.data.formGroup instanceof UntypedFormGroup ?
this.data.formGroup :
this.fb.group(this.data.formGroup, this.data.formOptions || {});
this.modalForm = this.data.formGroup instanceof FormGroup ?
this.data.formGroup as DialogFormGroup :
this.fb.group<DialogFormControls<DialogFormValueMap>>(
this.data.formGroup as DialogFormGroupConfig<DialogFormValueMap>,
this.data.formOptions || {}
);
this.title = this.data.title;
this.fields = this.data.fields.filter(field => !field.planetBeta || this.userService.isBetaEnabled());
this.isSpinnerOk = false;
Expand All @@ -69,41 +83,44 @@ export class DialogsFormComponent {
}
}

onSubmit(mForm, dialog) {
onSubmit(mForm: DialogFormGroup, dialog: MatDialogRef<DialogsFormComponent>) {
if (!mForm.valid) {
this.markFormAsTouched(mForm);
return;
}
if (this.data && this.data.onSubmit) {
this.dialogsLoadingService.start();
this.data.onSubmit(mForm.value, mForm);
this.data.onSubmit(mForm.value as DialogFormValueMap, mForm);
}
if (!this.data || this.data.closeOnSubmit === true) {
this.dialogsLoadingService.stop();
dialog.close(mForm.value);
}
}

togglePasswordVisibility(fieldName) {
togglePasswordVisibility(fieldName: string) {
const visibility = this.passwordVisibility.get(fieldName) || false;
this.passwordVisibility.set(fieldName, !visibility);
}

openDialog(field) {
const initialSelection = this.modalForm.controls[field.name].value.map((value: any) => value._id);
openDialog(field: DialogField) {
const control = this.modalForm.controls[field.name];
const currentValue = control.value as Array<{ _id: string }> | null;
const initialSelection = (currentValue || []).map((value) => value._id);
this.dialogsLoadingService.start();
this.dialogsListService.attachDocsData(field.db, 'title', this.dialogOkClick(field).bind(this), initialSelection).subscribe((data) => {
this.dialogsLoadingService.stop();
this.dialogListRef = this.dialog.open(DialogsListComponent, {
data: data,
maxHeight: '500px',
width: '600px',
autoFocus: false
this.dialogsListService.attachDocsData(field.db, 'title', this.dialogOkClick(field).bind(this), initialSelection)
.subscribe((data) => {
this.dialogsLoadingService.stop();
this.dialogListRef = this.dialog.open(DialogsListComponent, {
data: data,
maxHeight: '500px',
width: '600px',
autoFocus: false
});
});
});
}

dialogOkClick(field) {
dialogOkClick(field: DialogField) {
return (selection) => {
this.modalForm.controls[field.name].setValue(selection);
this.dialogListRef.close();
Expand Down
107 changes: 99 additions & 8 deletions src/app/shared/dialogs/dialogs-form.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,125 @@ import { DialogsFormComponent } from './dialogs-form.component';
import { MatLegacyDialogRef as MatDialogRef, MatLegacyDialog as MatDialog } from '@angular/material/legacy-dialog';
import { Injectable } from '@angular/core';
import {
UntypedFormBuilder,
UntypedFormGroup
AbstractControlOptions,
AsyncValidatorFn,
FormArray,
FormBuilder,
FormControl,
FormControlState,
FormGroup,
ValidatorFn
} from '@angular/forms';

export type DialogFieldType =
| 'checkbox'
| 'textbox'
| 'password'
| 'selectbox'
| 'radio'
| 'rating'
| 'textarea'
| 'markdown'
| 'dialog'
| 'date'
| 'time'
| 'toggle';

export interface DialogField<TName extends string = string> {
name: TName;
type: DialogFieldType;
placeholder?: string;
label?: string;
required?: boolean;
disabled?: boolean;
multiple?: boolean;
options?: Array<{ name: string; value?: unknown } | string>;
planetBeta?: boolean;
tooltip?: string;
reset?: boolean;
text?: string;
authorizedRoles?: string | string[];
imageGroup?: unknown;
db?: string;
[key: string]: unknown;
}

export interface DialogFormValueMap {
[key: string]: unknown;
}

type DialogControlConfig<TValue> =
| TValue
| FormControlState<TValue>
| FormControl<TValue>
| FormGroup<any>
| FormArray<any>
| [TValue | FormControlState<TValue>, (ValidatorFn | ValidatorFn[] | null)?, (AsyncValidatorFn | AsyncValidatorFn[] | null)?];

export type DialogFormGroupConfig<T extends DialogFormValueMap> = {
[K in keyof T]: DialogControlConfig<T[K]>;
};

export type DialogFormControls<T extends DialogFormValueMap> = {
[K in keyof T]: FormControl<T[K]> | FormGroup<any> | FormArray<any>;
};

export type DialogFormGroup<T extends DialogFormValueMap = DialogFormValueMap> = FormGroup<DialogFormControls<T>>;

export type DialogFormGroupInput<T extends DialogFormValueMap> =
| DialogFormGroup<T>
| DialogFormGroupConfig<T>;

export interface DialogsFormOptions<T extends DialogFormValueMap> {
autoFocus?: boolean;
disableIfInvalid?: boolean;
onSubmit?: (value: T, form: DialogFormGroup<T>) => void;
formOptions?: AbstractControlOptions;
closeOnSubmit?: boolean;
[key: string]: unknown;
}

export interface DialogsFormData<T extends DialogFormValueMap = DialogFormValueMap>
extends DialogsFormOptions<T> {
title: string;
fields: DialogField[];
formGroup: DialogFormGroupInput<T>;
}

@Injectable()
export class DialogsFormService {

private dialogRef: MatDialogRef<DialogsFormComponent>;

constructor(private dialog: MatDialog, private fb: UntypedFormBuilder) { }
constructor(private dialog: MatDialog, private fb: FormBuilder) { }

public confirm(title: string, fields: any, formGroup: any, autoFocus = false): Observable<boolean> {
public confirm<T extends DialogFormValueMap>(
title: string,
fields: DialogField[],
formGroup: DialogFormGroupInput<T>,
autoFocus = false
): Observable<T | undefined> {
let dialogRef: MatDialogRef<DialogsFormComponent>;
dialogRef = this.dialog.open(DialogsFormComponent, {
width: '600px',
autoFocus: autoFocus
});
if (formGroup instanceof UntypedFormGroup) {
if (formGroup instanceof FormGroup) {
dialogRef.componentInstance.modalForm = formGroup;
} else {
dialogRef.componentInstance.modalForm = this.fb.group(formGroup);
dialogRef.componentInstance.modalForm = this.fb.group<DialogFormControls<T>>(formGroup);
}
dialogRef.componentInstance.title = title;
dialogRef.componentInstance.fields = fields;
return dialogRef.afterClosed();
return dialogRef.afterClosed() as Observable<T | undefined>;
}

openDialogsForm(title: string, fields: any[], formGroup: any, options: any) {
openDialogsForm<T extends DialogFormValueMap>(
title: string,
fields: DialogField[],
formGroup: DialogFormGroupInput<T>,
options: DialogsFormOptions<T> = {}
) {
this.dialogRef = this.dialog.open(DialogsFormComponent, {
width: '600px',
autoFocus: options.autoFocus,
Expand Down
Loading