Skip to content

Combo/SimpleCombo/DatePicker aria-required properties addition - 20.0.x #16047

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

Open
wants to merge 19 commits into
base: 20.0.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
aa36463
fix(combo): Sync aria required with required state
Jun 26, 2025
926d79a
chore(combo): Remove fdescribe
Jun 27, 2025
fe93e9b
Merge branch '20.0.x' into ikitanov/fix-16000-20.0.x
ChronosSF Jul 11, 2025
00e96dc
fix(combo): bypassing require logic applied by igxInput
ChronosSF Jul 14, 2025
d43439d
Merge branch '20.0.x' into sstoychev/bypassing-input-required-logic-20
ChronosSF Jul 22, 2025
5aaa468
feat(*): adding external validator logic for input
ChronosSF Jul 24, 2025
23ab3e0
fix(*): adding required props for input
ChronosSF Jul 24, 2025
e92971c
Merge branch '20.0.x' into sstoychev/bypassing-input-required-logic-20
ChronosSF Jul 24, 2025
ff47e75
feat(*): aria-required date-picker and simple combo
ChronosSF Jul 25, 2025
04b6db8
Merge branch 'sstoychev/bypassing-input-required-logic-20' of https:/…
ChronosSF Jul 25, 2025
534e68f
fix(tests): making the check working
ChronosSF Jul 25, 2025
992af7f
Merge branch '20.0.x' into sstoychev/bypassing-input-required-logic-20
ChronosSF Jul 25, 2025
e0c1c52
Merge branch '20.0.x' into sstoychev/bypassing-input-required-logic-20
ChronosSF Jul 28, 2025
e1ee3c4
refactor(inputs): removing aria-required as it's redundant
ChronosSF Aug 6, 2025
dca922d
chore(*): further changes to input req attrs
ChronosSF Aug 7, 2025
ef903c3
chore(*): adding logic to get external validate required
ChronosSF Aug 7, 2025
a0d67c5
chore(*): try req logic like this
ChronosSF Aug 7, 2025
76be349
Merge branch '20.0.x' into sstoychev/bypassing-input-required-logic-20
ChronosSF Aug 11, 2025
9028e1b
test(*): final fixes for new option
ChronosSF Aug 11, 2025
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
5 changes: 5 additions & 0 deletions projects/igniteui-angular/src/lib/combo/combo.common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1300,6 +1300,11 @@ export abstract class IgxComboBaseDirective implements IgxComboBase, AfterViewCh
this.manageRequiredAsterisk();
};

/** @hidden @internal */
protected externalValidate(): IgxInputState {
return this._valid;
}

private updateValidity() {
if (this.ngControl && this.ngControl.invalid) {
this.valid = IgxInputState.INVALID;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<ng-content select="igx-hint, [igxHint]"></ng-content>
</ng-container>
<input igxInput #comboInput name="comboInput" type="text" [value]="displayValue" readonly
[required]="required" [externalValidate]="externalValidate"
[attr.placeholder]="placeholder" [disabled]="disabled"
role="combobox" aria-haspopup="listbox"
[attr.aria-expanded]="!dropdown.collapsed" [attr.aria-controls]="dropdown.listId"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3436,8 +3436,10 @@ describe('igxCombo', () => {
it('should add/remove asterisk when setting validators dynamically', () => {
let inputGroupIsRequiredClass = fixture.debugElement.query(By.css('.' + CSS_CLASS_INPUTGROUP_REQUIRED));
let asterisk = window.getComputedStyle(fixture.debugElement.query(By.css('.' + CSS_CLASS_INPUTGROUP_LABEL)).nativeElement, ':after').content;
input = fixture.debugElement.query(By.css(`.${CSS_CLASS_COMBO_INPUTGROUP}`));
expect(asterisk).toBe('"*"');
expect(inputGroupIsRequiredClass).toBeDefined();
expect(input.nativeElement.getAttribute('required')).not.toBeNull();

fixture.componentInstance.reactiveForm.controls.townCombo.clearValidators();
fixture.componentInstance.reactiveForm.controls.townCombo.updateValueAndValidity();
Expand All @@ -3446,6 +3448,7 @@ describe('igxCombo', () => {
asterisk = window.getComputedStyle(fixture.debugElement.query(By.css('.' + CSS_CLASS_INPUTGROUP_LABEL)).nativeElement, ':after').content;
expect(asterisk).toBe('none');
expect(inputGroupIsRequiredClass).toBeNull();
expect(input.nativeElement.getAttribute('required')).toBeNull();

fixture.componentInstance.reactiveForm.controls.townCombo.setValidators(Validators.required);
fixture.componentInstance.reactiveForm.controls.townCombo.updateValueAndValidity();
Expand All @@ -3454,6 +3457,7 @@ describe('igxCombo', () => {
asterisk = window.getComputedStyle(fixture.debugElement.query(By.css('.' + CSS_CLASS_INPUTGROUP_LABEL)).nativeElement, ':after').content;
expect(asterisk).toBe('"*"');
expect(inputGroupIsRequiredClass).toBeDefined();
expect(input.nativeElement.getAttribute('required')).not.toBeNull();
});

it('Should update validity state when programmatically setting errors on reactive form controls', fakeAsync(() => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
}

<input class="igx-date-picker__input-date" [displayValuePipe]="formatter ? displayValue : null" igxInput
[igxDateTimeEditor]="inputFormat" [displayFormat]="displayFormat"
[required]="required" [igxDateTimeEditor]="inputFormat" [displayFormat]="displayFormat"
[minValue]="minValue" [maxValue]="maxValue" [spinDelta]="spinDelta" [spinLoop]="spinLoop"
[disabled]="disabled" [placeholder]="placeholder" [readonly]="!isDropdown || readOnly"
[igxTextSelection]="isDropdown && !readOnly" [locale]="locale" [attr.aria-expanded]="!collapsed"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,18 +231,22 @@ describe('IgxDatePicker', () => {

expect(datePicker).toBeDefined();
expect(inputGroup.isRequired).toBeTruthy();
expect((datePicker as any).inputDirective.nativeElement.getAttribute('required')).not.toBeNull();
});

it('should update inputGroup isRequired correctly', () => {
const inputGroup = (datePicker as any).inputGroup;
const inputEl = (datePicker as any).inputDirective.nativeElement;

expect(datePicker).toBeDefined();
expect(inputGroup.isRequired).toBeTruthy();
expect(inputEl.getAttribute('required')).not.toBeNull();

(fixture.componentInstance as IgxDatePickerNgModelComponent).isRequired = false;
fixture.detectChanges();

expect(inputGroup.isRequired).toBeFalsy();
expect(inputEl.getAttribute('required')).toBeNull();
});

it('should set validity to initial when the form is reset', fakeAsync(() => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -702,7 +702,7 @@ describe('IgxInput', () => {
let asterisk = window.getComputedStyle(dom.query(By.css('.' + CSS_CLASS_INPUT_GROUP_LABEL)).nativeElement, ':after').content;
expect(asterisk).toBe('"*"');
expect(inputGroup.classList.contains(INPUT_GROUP_REQUIRED_CSS_CLASS)).toBe(true);
expect(input.nativeElement.attributes.getNamedItem('aria-required').nodeValue).toEqual('true');
expect(input.nativeElement.getAttribute('required')).not.toBeNull();

// 2) check that input group's --invalid class is NOT applied
expect(inputGroup.classList.contains(INPUT_GROUP_INVALID_CSS_CLASS)).toBe(false);
Expand All @@ -718,10 +718,13 @@ describe('IgxInput', () => {

expect(inputGroup.classList.contains(INPUT_GROUP_INVALID_CSS_CLASS)).toBe(true);
expect(inputGroup.classList.contains(INPUT_GROUP_REQUIRED_CSS_CLASS)).toBe(true);
expect(input.nativeElement.attributes.getNamedItem('aria-required').nodeValue).toEqual('true');
expect(input.nativeElement.getAttribute('required')).not.toBeNull();

// 3) Check if the input group's --invalid and --required classes are removed when validator is dynamically cleared
fix.componentInstance.removeValidators(formGroup);
// the component cannot both take required on the input and validators. If validators write required, their removal
// cannot cause required to be removed as it may have been part of the initial setup
input.nativeElement.removeAttribute('required');
fix.detectChanges();
tick();

Expand All @@ -731,7 +734,7 @@ describe('IgxInput', () => {
expect(formReference).toBeDefined();
expect(input).toBeDefined();
expect(input.nativeElement.value).toEqual('');
expect(input.nativeElement.attributes.getNamedItem('aria-required').nodeValue).toEqual('false');
expect(input.nativeElement.getAttribute('required')).toBeNull();
expect(inputGroup.classList.contains(INPUT_GROUP_REQUIRED_CSS_CLASS)).toEqual(false);
expect(asterisk).toBe('none');
expect(input.valid).toEqual(IgxInputState.INITIAL);
Expand All @@ -751,7 +754,7 @@ describe('IgxInput', () => {
// interaction test - expect actual asterisk
asterisk = window.getComputedStyle(dom.query(By.css('.' + CSS_CLASS_INPUT_GROUP_LABEL)).nativeElement, ':after').content;
expect(asterisk).toBe('"*"');
expect(input.nativeElement.attributes.getNamedItem('aria-required').nodeValue).toEqual('true');
expect(input.nativeElement.getAttribute('required')).not.toBeNull();
}));

it('should not hold old file input value in form after clearing the input', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@ export class IgxInputDirective implements AfterViewInit, OnDestroy {
private _valueChanges$: Subscription;
private _fileNames: string;
private _disabled = false;
private _defaultRequired: boolean = null;
private _externalValidate: () => IgxInputState = null;

constructor(
public inputGroup: IgxInputGroupBase,
Expand Down Expand Up @@ -181,35 +183,52 @@ export class IgxInputDirective implements AfterViewInit, OnDestroy {
}

/**
* Sets the `required` property.
*
* @example
* ```html
* <input-group>
* <input igxInput #igxInput required>
* </input-group>
* ```
*/
@Input({ transform: booleanAttribute })
public set required(value: boolean) {
this.nativeElement.required = this.inputGroup.isRequired = value;
* @hidden @internal
* Sets a function to validate the input externally.
* This function should return an `IgxInputState` value.
*/
@Input()
public set externalValidate(fn: () => IgxInputState) {
this._externalValidate = fn;
}

public get externalValidate(): () => IgxInputState {
return this._externalValidate;
}

/**
* Gets whether the igxInput is required.
* Gets/Sets whether the igxInput is required.
*
* @example
* ```typescript
* let isRequired = this.igxInput.required;
* <input-group>
* <input igxInput #igxInput required>
* </input-group>
* ```
*/
@Input({ transform: booleanAttribute })
public get required() {
let validation;
if (this.ngControl && (this.ngControl.control.validator || this.ngControl.control.asyncValidator)) {
validation = this.ngControl.control.validator({} as AbstractControl);
}
return validation && validation.required || this.nativeElement.hasAttribute('required');
let required;
if (validation && validation.required !== undefined) {
required = validation.required;
} else {
required = this.nativeElement.required;
}
return required;
}
public set required(value: boolean) {
this.nativeElement.required = this.inputGroup.isRequired = value;
}

@HostBinding('attr.required')
public get hostBindingRequired(): string {
return this.required ? '' : null;
}

/**
* @hidden
* @internal
Expand Down Expand Up @@ -293,8 +312,6 @@ export class IgxInputDirective implements AfterViewInit, OnDestroy {
this.inputGroup.isRequired = this.required;
}

this.renderer.setAttribute(this.nativeElement, 'aria-required', this.required.toString());

const elTag = this.nativeElement.tagName.toLowerCase();
if (elTag === 'textarea') {
this.isTextArea = true;
Expand Down Expand Up @@ -367,7 +384,9 @@ export class IgxInputDirective implements AfterViewInit, OnDestroy {
* @internal
*/
protected updateValidityState() {
if (this.ngControl) {
if (this._externalValidate) {
this._valid = this._externalValidate();
} else if (this.ngControl) {
if (!this.disabled && this.isTouchedOrDirty) {
if (this.hasValidators) {
// Run the validation with empty object to check if required is enabled.
Expand All @@ -386,7 +405,6 @@ export class IgxInputDirective implements AfterViewInit, OnDestroy {
} else {
this._valid = IgxInputState.INITIAL;
}
this.renderer.setAttribute(this.nativeElement, 'aria-required', this.required.toString());
const ariaInvalid = this.valid === IgxInputState.INVALID;
this.renderer.setAttribute(this.nativeElement, 'aria-invalid', ariaInvalid.toString());
} else {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
</ng-container>

<input #comboInput igxInput [value]="displayValue" role="combobox"
[required]="required" [externalValidate]="externalValidate"
aria-haspopup="listbox" aria-autocomplete="list" aria-readonly="false"
[attr.aria-expanded]="!this.dropdown.collapsed" [attr.aria-controls]="this.dropdown.listId"
[attr.aria-labelledby]="this.ariaLabelledBy || this.label?.id || this.placeholder"
Expand Down
Loading