Skip to content
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

Lectures: Disable submit button on invalid form and add tooltip #9846

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from
Open

Lectures: Disable submit button on invalid form and add tooltip #9846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4f615af
Added varying tooltip to submit button
laxerhd Nov 21, 2024
4ee592e
Refactor: Moved logic from html to ts component
laxerhd Nov 24, 2024
2cdecd8
Enable tooltip on whole button
laxerhd Nov 24, 2024
37b88d4
Remove duplicate file to big message
laxerhd Nov 24, 2024
008dc3f
Added combined error message to lectureUnit translation
laxerhd Nov 24, 2024
14bbaad
Usage of strict equality for consistency in condition
laxerhd Nov 24, 2024
694dffe
Fix grammar mistake in comment
laxerhd Dec 6, 2024
565a910
Add name signal and refactor tooltipText
laxerhd Dec 6, 2024
326fc94
Tracking of new language signal to compute new tooltip for different …
laxerhd Dec 6, 2024
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
19 changes: 10 additions & 9 deletions ...ure-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="col-12">
<form [formGroup]="form" (ngSubmit)="submitForm()">
<div class="form-group">
<label for="name">{{ 'artemisApp.attachmentUnit.createAttachmentUnit.name' | artemisTranslate }} *</label>
<label for="name">{{ 'artemisApp.attachmentUnit.createAttachmentUnit.name' | artemisTranslate }}*</label>
<input
type="text"
class="form-control"
Expand Down Expand Up @@ -63,7 +63,6 @@
@if (isFileTooBig()) {
<div class="alert alert-danger">
{{ 'artemisApp.attachmentUnit.createAttachmentUnit.fileTooBig' | artemisTranslate }}
{{ 'artemisApp.attachmentUnit.createAttachmentUnit.fileLimitation' | artemisTranslate }}
</div>
}
@if (!fileName() && fileInputTouched) {
Expand Down Expand Up @@ -105,14 +104,16 @@
</div>
<div class="row">
<div class="col-12">
<button id="submitButton" class="btn btn-primary" type="submit" [disabled]="!isFormValid()">
<span jhiTranslate="entity.action.submit"></span>
</button>
@if (hasCancelButton()) {
<button type="button" (click)="cancelForm()" class="btn btn-default">
<fa-icon [icon]="faTimes" />&nbsp;<span jhiTranslate="entity.action.cancel"></span>
<span [ngbTooltip]="tooltipText()" container="body" class="d-inline-block">
<button id="submitButton" class="btn btn-primary" type="submit" [disabled]="!isFormValid()">
<span jhiTranslate="entity.action.submit"></span>
</button>
}
@if (hasCancelButton()) {
<button type="button" (click)="cancelForm()" class="btn btn-default">
<fa-icon [icon]="faTimes" />&nbsp;<span jhiTranslate="entity.action.cancel"></span>
</button>
}
</span>
</div>
</div>
</form>
Expand Down
27 changes: 23 additions & 4 deletions ...cture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ import { ACCEPTED_FILE_EXTENSIONS_FILE_BROWSER, ALLOWED_FILE_EXTENSIONS_HUMAN_RE
import { CompetencyLectureUnitLink } from 'app/entities/competency.model';
import { MAX_FILE_SIZE } from 'app/shared/constants/input.constants';
import { toSignal } from '@angular/core/rxjs-interop';
import { map, of } from 'rxjs';
import { FormDateTimePickerComponent } from 'app/shared/date-time-picker/date-time-picker.component';
import { TranslateService } from '@ngx-translate/core';

export interface AttachmentUnitFormData {
formProperties: FormProperties;
Expand Down Expand Up @@ -50,7 +52,7 @@ export class AttachmentUnitFormComponent implements OnChanges {

datePickerComponent = viewChild(FormDateTimePickerComponent);

// have to handle the file input as a special case at is not part of the reactive form
// have to handle the file input as a special case, as it is not part of the reactive form
@ViewChild('fileInput', { static: false })
fileInput: ElementRef;
file: File;
Expand All @@ -59,6 +61,7 @@ export class AttachmentUnitFormComponent implements OnChanges {
fileName = signal<string | undefined>(undefined);
isFileTooBig = signal<boolean>(false);

private readonly translateService = inject(TranslateService);
private readonly formBuilder = inject(FormBuilder);
form: FormGroup = this.formBuilder.group({
name: [undefined as string | undefined, [Validators.required, Validators.maxLength(255)]],
Expand All @@ -69,9 +72,9 @@ export class AttachmentUnitFormComponent implements OnChanges {
competencyLinks: [undefined as CompetencyLectureUnitLink[] | undefined],
});
private readonly statusChanges = toSignal(this.form.statusChanges ?? 'INVALID');

private readonly name = toSignal(this.nameControl?.valueChanges ?? of(''));
isFormValid = computed(() => {
return (this.statusChanges() === 'VALID' || this.fileName()) && !this.isFileTooBig() && this.datePickerComponent()?.isValid();
return this.statusChanges() === 'VALID' && !this.isFileTooBig() && this.name() && this.fileName();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the reason for changing the semantics here?

Copy link
Contributor Author

@laxerhd laxerhd Dec 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(this.statusChanges() === 'VALID' || this.fileName()) --> this.statusChanges() === 'VALID' && this.fileName():

  • statusChanges() evaluates to 'VALID' when I type in a valid name even without an uploaded file
  • the rest of the statement would also be true and thus the button activated
  • (instead of checking here whether the fileName has been set, I could also include it in the form: FormGroup and include it implicitly in statusChanges())

this.name() was added:

  • I wanted to make sure that undefined or the empty string would definetly stop formValid from being true
  • This is probably not needed bc of the statusChanges, so I could also remove that, but bc I also added this check to the toolTip this made things more consistent

this.datePickerComponent()?.isValid():

  • I didn't intend to delete that, happend when rebasing on your PR, thanks will add it back

});

ngOnChanges(): void {
Expand All @@ -80,6 +83,8 @@ export class AttachmentUnitFormComponent implements OnChanges {
}
}

private readonly currentLanguage = toSignal(this.translateService.onLangChange.pipe(map((event) => event.lang)));

onFileChange(event: Event): void {
const input = event.target as HTMLInputElement;
if (!input.files?.length) {
Expand All @@ -88,7 +93,7 @@ export class AttachmentUnitFormComponent implements OnChanges {
this.file = input.files[0];
this.fileName.set(this.file.name);
// automatically set the name in case it is not yet specified
if (this.form && (this.nameControl?.value == undefined || this.nameControl?.value == '')) {
if (this.form && !this.name()) {
this.form.patchValue({
// without extension
name: this.file.name.replace(/\.[^/.]+$/, ''),
Expand All @@ -97,6 +102,20 @@ export class AttachmentUnitFormComponent implements OnChanges {
this.isFileTooBig.set(this.file.size > MAX_FILE_SIZE);
}

tooltipText = computed(() => {
this.currentLanguage();
if (!this.fileName() && !this.name()) {
return this.translateService.instant('artemisApp.attachmentUnit.createAttachmentUnit.nameAndFileRequiredValidationError');
}
if (!this.fileName()) {
return this.translateService.instant('artemisApp.attachmentUnit.createAttachmentUnit.fileRequiredValidationError');
}
if (!this.name()) {
return this.translateService.instant('artemisApp.attachmentUnit.createAttachmentUnit.nameRequiredValidationError');
}
return undefined;
});

get nameControl() {
return this.form.get('name');
}
Expand Down
1 change: 1 addition & 0 deletions src/main/webapp/i18n/de/lectureUnit.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@
"file": "Datei",
"version": "Version",
"fileRequiredValidationError": "Du musst eine Datei zum Uploaden auswählen.",
"nameAndFileRequiredValidationError": "Der Name ist ein Pflichtfeld. Du musst eine Datei zum Uploaden auswählen.",
"chooseFile": "Datei auswählen",
"fileTooBig": "Die Datei ist zu groß! Die maximale Dateigröße beträgt 20 MB.",
"fileLimitation": "(max. Größe 20 MB)",
Expand Down
1 change: 1 addition & 0 deletions src/main/webapp/i18n/en/lectureUnit.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@
"file": "File",
"version": "Version",
"fileRequiredValidationError": "You must select a file to upload.",
"nameAndFileRequiredValidationError": "Name is required. You must select a file to upload.",
"chooseFile": "Choose File",
"fileTooBig": "File is too big! The maximum file size is 20 MB.",
"fileLimitation": "(max. size 20 MB)",
Expand Down
Loading