-
-
Notifications
You must be signed in to change notification settings - Fork 150
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.
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
Add logic to allow warnings for input fields #3256
base: master
Are you sure you want to change the base?
Conversation
…arent" This reverts commit f6a29cd.
Build failing |
@FrancescoBorzi Works on my end. Can you please provide more information ? |
Thank you, but the failed test is intentional. |
ok, I will test this PR locally and let you know ;-) |
Thank you :) |
I also would like to mention, that this will NOT address any editors. The example I added for the maxLevel in creature template is just for showcasing purposes of the proposed solution. The PR aims to provide an easy framework to add form validation, not to add form validation everywhere it is needed. This needs to happen gradually, otherwise this will be a gigantic PR, considering Item Template and Creature Template have to change along with a lot of other forms. |
I don't dislike the approach but I am wondering if can be done only with: <input
keiraInputValidation
[formControlName]="'maxlevel'"
id="maxlevel"
type="number"
class="form-control form-control-sm"
/> Without requiring any other information or adding components, because may you can find a way to get the formcontrol from the input and you could spawn dynamically a component next to the without already writing a placeholder component Thanks by the way for implementing this proof of concept of warnings, it's a good job! |
Thank you for providing feedback. I will try to make it work. I also had a solution in mind that minimizes the changes required to all editors as this can introduce quite the overhead in work. I will explore possible solutions and hopefully something will work :) |
In theory I could do something like this: import { Directive, ViewContainerRef } from '@angular/core';
@Directive({
selector: '[dynamicComponentHost]',
})
export class DynamicComponentHostDirective {
constructor(public viewContainerRef: ViewContainerRef) {}
} import { Component, ComponentFactoryResolver, OnInit } from '@angular/core';
import { KeiraValidationFeedbackComponent } from './keira-validation-feedback.component';
import { DynamicComponentHostDirective } from './dynamic-component-host.directive';
@Component({
selector: 'app-dynamic-form',
template: `
<div class="form-group col-12 col-sm-6 col-md-4 col-lg-3 col-xl-2">
<label for="maxLevel">Max Level</label>
<input
[keiraInputValidation]="editorService.form.get('maxlevel')"
[formControlName]="'maxlevel'"
id="maxlevel"
type="number"
class="form-control form-control-sm"
(blur)="showValidationFeedback()"
/>
<ng-template dynamicComponentHost></ng-template>
</div>
`,
})
export class DynamicFormComponent implements OnInit {
@ViewChild(DynamicComponentHostDirective, { static: true })
dynamicHost!: DynamicComponentHostDirective;
constructor(
private resolver: ComponentFactoryResolver,
public editorService: EditorService
) {}
ngOnInit(): void {}
showValidationFeedback(): void {
const control = this.editorService.form.get('maxlevel');
if (control?.invalid && control.touched) {
const viewContainerRef = this.dynamicHost.viewContainerRef;
viewContainerRef.clear(); // Clear any existing components
const componentFactory =
this.resolver.resolveComponentFactory(KeiraValidationFeedbackComponent);
const componentRef = viewContainerRef.createComponent(componentFactory);
componentRef.instance.control = control; // Pass the control to the component
}
}
} Used like this: <div class="form-group col-12 col-sm-6 col-md-4 col-lg-3 col-xl-2">
<label for="maxLevel">Max Level</label>
<input
[keiraInputValidation]="editorService.form.get('maxlevel')"
[formControlName]="'maxlevel'"
id="maxlevel"
type="number"
class="form-control form-control-sm"
(blur)="showValidationFeedback()"
/>
<ng-template dynamicComponentHost></ng-template>
</div> But personally, I think this is a lot of boilerplate code and super convoluted too, for a worse outcome in terms of readability and most likely maintainability too. If you have a better solution or something I should check out, please let me know :) |
I was convinced that everything can be implemented inside the directive attribute making it agnostic and generic for all inputs without requiring any input information. import { Directive, ElementRef, inject, OnInit, Renderer2 } from '@angular/core';
import { AbstractControl, NgControl } from '@angular/forms';
import { SubscriptionHandler } from '@keira/shared/utils';
@Directive({
selector: '[keiraInputValidation]',
standalone: true,
})
export class InputValidationDirective extends SubscriptionHandler implements OnInit {
private readonly el: ElementRef = inject(ElementRef);
private readonly renderer: Renderer2 = inject(Renderer2);
private readonly ngControl: NgControl = inject(NgControl);
private errorDiv: HTMLElement | null = null;
ngOnInit(): void {
const control = this.ngControl.control;
if (!control) {
return;
}
this.subscriptions.push(
control.statusChanges?.subscribe(() => {
this.updateErrorMessage(control);
}),
);
}
private updateErrorMessage(control: AbstractControl): void {
if (this.errorDiv) {
this.renderer.removeChild(this.el.nativeElement.parentNode, this.errorDiv);
this.errorDiv = null;
}
if (control?.touched && control?.invalid) {
const errorMessage = control?.errors?.['required'] ? 'This field is required' : 'Invalid field';
this.errorDiv = this.renderer.createElement('div');
const text = this.renderer.createText(errorMessage);
this.renderer.appendChild(this.errorDiv, text);
const parent = this.el.nativeElement.parentNode;
this.renderer.appendChild(parent, this.errorDiv);
}
}
} <div class="form-group col-12 col-sm-6 col-md-4 col-lg-3 col-xl-2">
<label for="maxLevel">Max Level</label>
<input keiraInputValidation [formControlName]="'maxlevel'" id="maxlevel" type="number" class="form-control form-control-sm" />
</div> This will allow us to add the directive You can find the commit here 7021a3a EDIT: this code is a draft based on your code, you can re-use it improving it if possible, we could continue the implementation in this branch/PR |
@Helias |
Co-Authored-By: Stefano Borzì <[email protected]>
@Helias Additionally, if we add the validation, we are just one step shy of adding a subject that the keira edit button can subscribe to, to disable them if validation fails. |
I noticed that, if we remove the control.touched contidion it should work on the first time too, I am not sure if it's 100% correct but we could remove it and then think if we really need that condition or not. About the validation, that's a good idea actually 🚀 |
I added a workaround, by adding markedAsTouched() when the field is invalid. But maybe thats not as good as a solution as it can be? |
it could be in this case, let's keep it |
Does address but does not close #3236.
Tests are failing, because I dont want to fix them before this idea is either accepted or denied.
Right now, this is only working for the creature template max level field.
Feedback is welcome