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.

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

Combo Box - Adding title and Improved aria-activedescendant for accessibility #3738

Merged
merged 13 commits into from
Jan 26, 2018
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"packageName": "office-ui-fabric-react",
"comment": "Combox box: added accessibility changes added a title and changed activedescendant to use focused element",
"type": "patch"
}
],
"packageName": "office-ui-fabric-react",
"email": "chiechan@microsoft.com"
}
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@ export class ComboBox extends BaseComponent<IComboBoxProps, IComboBoxState> {
buttonIconProps,
styles: customStyles,
theme,
title
} = this.props;
let { isOpen, selectedIndex, focused, suggestedDisplayValue } = this.state;
this._currentVisibleValue = this._getVisibleValue();
Expand All @@ -295,7 +296,7 @@ export class ComboBox extends BaseComponent<IComboBoxProps, IComboBoxState> {
return (
<div {...divProps } ref='root' className={ this._classNames.container }>
{ label && (
<Label id={ id + '-label' } disabled={ disabled } required={ required } htmlFor={ id } className={ this._classNames.label }>{ label }</Label>
<Label id={ id + '-label' } disabled={ disabled } required={ required } htmlFor={ id + '-input' } className={ this._classNames.label }>{ label }</Label>
) }
<div
ref={ this._resolveRef('_comboBoxWrapper') }
Expand All @@ -315,21 +316,22 @@ export class ComboBox extends BaseComponent<IComboBoxProps, IComboBoxState> {
onClick={ this._onBaseAutofillClick }
onInputValueChange={ this._onInputChange }
aria-expanded={ isOpen }
aria-autocomplete={ (!disabled && autoComplete === 'on') }
aria-autocomplete={ this._getAriaAutoCompleteValue() }
role='combobox'
aria-readonly={ ((allowFreeform || disabled) ? null : 'true') }
readOnly={ disabled || !allowFreeform }
aria-labelledby={ (label && (id + '-label')) }
aria-label={ ((ariaLabel && !label) && ariaLabel) }
aria-describedby={ (id + '-option') }
aria-activedescendant={ (isOpen && (selectedIndex as number) >= 0 ? (id + '-list' + selectedIndex) : null) }
aria-activedescendant={ this._getAriaActiveDescentValue() }
aria-disabled={ disabled }
aria-owns={ (id + '-list') }
spellCheck={ false }
defaultVisibleValue={ this._currentVisibleValue }
suggestedDisplayValue={ suggestedDisplayValue }
updateValueInWillReceiveProps={ this._onUpdateValueInAutoFillWillReceiveProps }
shouldSelectFullInputValueInComponentDidUpdate={ this._onShouldSelectFullInputValueInAutoFillComponentDidUpdate }
title={ title }
/>
<IconButton
className={ 'ms-ComboBox-CaretDown-button' }
Expand Down Expand Up @@ -1540,4 +1542,26 @@ export class ComboBox extends BaseComponent<IComboBoxProps, IComboBoxState> {

return getOptionStyles(this.props.theme!, customStylesForAllOptions, customStylesForCurrentOption);
}

/**
* Get the aria-activedescendant value for the comboxbox.
* @returns the id of the current focused combo item, otherwise the id of the currently selected element, null otherwise
*/
private _getAriaActiveDescentValue(): string | null {
let descendantText = (this.state.isOpen && (this.state.selectedIndex as number) >= 0 ? (this._id + '-list' + this.state.selectedIndex) : null);
if (this.state.isOpen && this.state.focused && this.state.currentPendingValueValidIndex !== -1) {
descendantText = (this._id + '-list' + this.state.currentPendingValueValidIndex);
}
return descendantText;
}

/**
* Get the aria autocomplete value for the Combobox
* @returns 'inline' if auto-complete automatically dynamic, 'both' if we have a list of possible values to pick from and can
* dynamically populate input, and 'none' if auto-complete is not enabled as we can't give user inputs.
*/
private _getAriaAutoCompleteValue(): string {
let autoComplete = !this.props.disabled && this.props.autoComplete === 'on';
return autoComplete ? (this.props.allowFreeform ? 'inline' : 'both') : 'none';
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ exports[`ComboBox Renders ComboBox correctly 1`] = `
>
<input
aria-activedescendant={null}
aria-autocomplete={true}
aria-autocomplete="both"
aria-describedby="ComboBox0-option"
aria-disabled={undefined}
aria-expanded={false}
Expand Down Expand Up @@ -112,6 +112,7 @@ exports[`ComboBox Renders ComboBox correctly 1`] = `
readOnly={true}
role="combobox"
spellCheck={false}
title={undefined}
type="text"
value=""
/>
Expand Down