Skip to content

Add search box props for clear button aria attributes #3946

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

Merged
manishgarg1 merged 9 commits into from
Feb 14, 2018
Merged

Add search box props for clear button aria attributes #3946

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
755960a
Add props to search box to allow setting aria-label and aria-descript…
hoovercj Feb 12, 2018
2c70faf
Add change file
hoovercj Feb 12, 2018
81abef9
Move clear button props to property bag
hoovercj Feb 13, 2018
da36176
remove unnecessary prop
hoovercj Feb 13, 2018
3dc342e
Merge branch 'master' of https://github.com/OfficeDev/office-ui-fabri…
hoovercj Feb 13, 2018
85c9a53
remove accidentally added files
hoovercj Feb 13, 2018
ba1045a
Use the object spread operator for cleaner code and easier updates in…
hoovercj Feb 13, 2018
583d68f
Use IButtonProps to allow all button props to be passed to clear button
hoovercj Feb 14, 2018
9f554d6
Merge branch 'master' of https://github.com/OfficeDev/office-ui-fabri…
hoovercj Feb 14, 2018
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
9 changes: 9 additions & 0 deletions ...ce-ui-fabric-react/bugs-3858-clear-search-arialabel-ariadescription_2018-02-12-10-52.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"changes": [{
"packageName": "office-ui-fabric-react",
"comment": "Add clearButtonProps prop to SearchBox.types.ts with ariaLabel and ariaDescription. These are passed to the icon button in SearchBox.base.tsx",
"type": "minor"
}],
"packageName": "office-ui-fabric-react",
"email": "cohoov@microsoft.com"
}
10 changes: 8 additions & 2 deletions packages/office-ui-fabric-react/src/components/SearchBox/SearchBox.base.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export class SearchBoxBase extends BaseComponent<ISearchBoxProps, ISearchBoxStat
}

public render() {
let { labelText, className, disabled, underlined, getStyles, theme } = this.props;
let { labelText, className, disabled, underlined, getStyles, theme, clearButtonProps } = this.props;
let { value, hasFocus, id } = this.state;

const classNames = getClassNames(getStyles!, {
Expand Down Expand Up @@ -89,7 +89,13 @@ export class SearchBoxBase extends BaseComponent<ISearchBoxProps, ISearchBoxStat
/>
{ value!.length > 0 &&
<div className={ classNames.clearButton }>
<IconButton styles={ { root: { height: 'auto' }, icon: { fontSize: '12px' } } } onClick={ this._onClearClick } iconProps={ { iconName: 'Clear' } } />
<IconButton
styles={ { root: { height: 'auto' }, icon: { fontSize: '12px' } } }
onClick={ this._onClearClick }
iconProps={ { iconName: 'Clear' } }
ariaLabel={ clearButtonProps && clearButtonProps.ariaLabel }
ariaDescription={ clearButtonProps && clearButtonProps.ariaDescription }
/>
</div>
}
</div>
Expand Down
15 changes: 15 additions & 0 deletions packages/office-ui-fabric-react/src/components/SearchBox/SearchBox.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,16 @@ export interface ISearchBoxProps extends React.InputHTMLAttributes<HTMLInputElem
*/
ariaLabel?: string;

/**
* The aria label of the clear button for the SearchBox for the benefit of screen readers.
*/
clearButtonAriaLabel?: string;

@manishgarg1 manishgarg1 Feb 13, 2018

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

we need to remove this. right ?

@hoovercj hoovercj Feb 13, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.

/**
* The props for the clear button.
*/
clearButtonProps?: ISearchBoxClearButtonProps;

@dzearing dzearing Feb 14, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This should just be IButtonProps which should support whatever a button supports. That allows the caller to do things like put a data-automation-id on it.

@hoovercj hoovercj Feb 14, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I'd considered that but thought I'd start with the conservative approach of whitelisting properties. Is this the last blocking issue?

@hoovercj hoovercj Feb 14, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

To clarify: I will change this to ibuttonprops tomorrow, I'm just asking if there are other changes needed as well.

@hoovercj hoovercj Feb 14, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done.


/**
* Whether or not the SearchBox is underlined.
* @default false
Expand Down Expand Up @@ -96,4 +106,9 @@ export interface ISearchBoxStyles {
icon?: IStyle;
field?: IStyle;
clearButton?: IStyle;
}

export interface ISearchBoxClearButtonProps {
ariaLabel?: string;
ariaDescription?: string;
}