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

Improve screen-reader-accessibility of Accordion, ButtonIcon, and Popover #103

Merged
merged 1 commit into from
Nov 2, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs/src/views/accordion/accordion.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
export default () => (
<div>
<EuiAccordion
id="accordion1"
buttonContent="Click me to toggle open / close"
>
<EuiText>
Expand All @@ -21,6 +22,7 @@ export default () => (
<EuiSpacer size="l" />

<EuiAccordion
id="accordion2"
buttonContent="You can click me as well"
>
<EuiText>
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/accordion/accordion_extra.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {

export default () => (
<EuiAccordion
id="accordionExtra"
buttonContent="Click to open"
extraAction={<EuiButton size="s">Extra action!</EuiButton>}
>
Expand Down
17 changes: 16 additions & 1 deletion docs/src/views/accordion/accordion_form.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,16 @@ const repeatableForm = (
<EuiFieldText icon="user" placeholder="John" />
</EuiFormRow>
</EuiFlexItem>

<EuiFlexItem>
<EuiFormRow label="Password" id={makeId()} helpText="Must include one number and one symbol">
<EuiFieldPassword icon="lock" />
</EuiFormRow>
</EuiFlexItem>
</EuiFlexGroup>

<EuiSpacer size="m" />

<EuiFormRow label="Body" id={makeId()}>
<EuiTextArea placeholder="I am a textarea, put some content in me!" />
</EuiFormRow>
Expand All @@ -48,12 +51,14 @@ const buttonContent = (
<EuiFlexItem grow={false}>
<EuiIcon type="logoWebhook" size="m" />
</EuiFlexItem>

<EuiFlexItem>
<EuiTitle size="s" className="euiAccordionForm__title">
<h6>Webhook</h6>
</EuiTitle>
</EuiFlexItem>
</EuiFlexGroup>

<EuiText size="s">
<p>
<EuiTextColor color="subdued">
Expand All @@ -65,16 +70,24 @@ const buttonContent = (
);

const extraAction = (
<EuiButtonIcon iconType="cross" color="danger" className="euiAccordionForm__extraAction" />
<EuiButtonIcon
iconType="cross"
color="danger"
className="euiAccordionForm__extraAction"
aria-label="Delete"
/>
);

export default () => (
<div>
<EuiTitle size="s">
<h3>I am a complicated, highly styled, repeatable form!</h3>
</EuiTitle>

<EuiSpacer size="l" />

<EuiAccordion
id="accordionForm1"
className="euiAccordionForm"
buttonClassName="euiAccordionForm__button"
buttonContent={buttonContent}
Expand All @@ -84,7 +97,9 @@ export default () => (
{repeatableForm}
</div>
</EuiAccordion>

<EuiAccordion
id="accordionForm2"
className="euiAccordionForm"
buttonClassName="euiAccordionForm__button"
buttonContent={buttonContent}
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/button/button_ghost.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export default () => (
color="ghost"
iconType="user"
onClick={() => window.alert('Button clicked')}
aria-label="Your account"
/>
</div>
);
3 changes: 3 additions & 0 deletions docs/src/views/button/button_icon.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,23 @@ export default () => (
<EuiButtonIcon
onClick={() => window.alert('Button clicked')}
iconType="arrowRight"
aria-label="Next"
/>

<EuiButtonIcon
size="s"
color="danger"
onClick={() => window.alert('Button clicked')}
iconType="arrowRight"
aria-label="Next"
/>

<EuiButtonIcon
size="s"
color="disabled"
onClick={() => window.alert('Button clicked')}
iconType="arrowRight"
aria-label="Next"
/>
</div>
);
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/context_menu/context_menu.js
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ export default class extends Component {

return (
<EuiPopover
id="contextMenu"
button={button}
isOpen={this.state.isPopoverOpen}
closePopover={this.closePopover}
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/context_menu/single_panel.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ export default class extends Component {

return (
<EuiPopover
id="singlePanel"
button={button}
isOpen={this.state.isPopoverOpen}
closePopover={this.closePopover}
Expand Down
18 changes: 13 additions & 5 deletions docs/src/views/form/form_example.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,19 @@ export default props => (
code: formControlsHtml,
}]}
text={
<p>
These are the base inputs without their labels. If you need labels
then use the <EuiCode>FormRow</EuiCode> wrapper as explained
in the next example.
</p>
<div>
<p>
These are the base inputs without their labels. If you need labels
then use the <EuiCode>FormRow</EuiCode> wrapper as explained
in the next example.
</p>
<p>
Never forget to label every input element. You can either
use a <EuiCode>label</EuiCode> element with a <EuiCode>for</EuiCode> attribute
referencing the <EuiCode>id</EuiCode> of the input field, wrap the <EuiCode>input</EuiCode> field
within the <EuiCode>label</EuiCode> element or use <EuiCode>aria-label</EuiCode> or <EuiCode>aria-labelledby</EuiCode>.
</p>
</div>
}
demo={
<FormControls />
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/form/form_popover.js
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ export default class extends Component {
return (
<div>
<EuiPopover
id="formPopover"
ownFocus
button={button}
isOpen={this.state.isPopoverOpen}
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/form/inline_form_popover.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ export default class extends Component {

return (
<EuiPopover
id="inlineFormPopover"
ownFocus
button={button}
isOpen={this.state.isPopoverOpen}
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/header/header_app_menu.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export default class extends Component {

return (
<EuiPopover
id="headerAppMenu"
ownFocus
button={button}
isOpen={this.state.isOpen}
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/header/header_user_menu.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export default class extends Component {

return (
<EuiPopover
id="headerUserMenu"
ownFocus
button={button}
isOpen={this.state.isOpen}
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/kibana/watches.js
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ export default class extends Component {

return (
<EuiPopover
id="watches"
button={button}
isOpen={this.state.isPopoverOpen}
closePopover={this.closePopover}
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/pagination/customizable_pagination.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ export default class extends Component {
<EuiFlexGroup justifyContent="spaceBetween" alignItems="center">
<EuiFlexItem grow={false}>
<EuiPopover
id="customizablePagination"
button={button}
isOpen={this.state.isPopoverOpen}
closePopover={this.closePopover.bind(this)}
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/popover/popover.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export default class extends Component {

return (
<EuiPopover
id="popover"
ownFocus
button={button}
isOpen={this.state.isPopoverOpen}
Expand Down
20 changes: 20 additions & 0 deletions docs/src/views/popover/popover_anchor_position.js
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ export default class extends Component {
<EuiFlexGroup>
<EuiFlexItem grow={false}>
<EuiPopover
id="downLeft"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick1.bind(this)}>
Expand All @@ -189,8 +190,10 @@ export default class extends Component {
Popover content
</EuiPopover>
</EuiFlexItem>

<EuiFlexItem grow={false}>
<EuiPopover
id="downCenter"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick2.bind(this)}>
Expand All @@ -204,8 +207,10 @@ export default class extends Component {
Popover content
</EuiPopover>
</EuiFlexItem>

<EuiFlexItem grow={false}>
<EuiPopover
id="downRight"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick3.bind(this)}>
Expand All @@ -226,6 +231,7 @@ export default class extends Component {
<EuiFlexGroup>
<EuiFlexItem grow={false}>
<EuiPopover
id="upLeft"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick4.bind(this)}>
Expand All @@ -239,8 +245,10 @@ export default class extends Component {
Popover content
</EuiPopover>
</EuiFlexItem>

<EuiFlexItem grow={false}>
<EuiPopover
id="upCenter"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick5.bind(this)}>
Expand All @@ -254,8 +262,10 @@ export default class extends Component {
Popover content
</EuiPopover>
</EuiFlexItem>

<EuiFlexItem grow={false}>
<EuiPopover
id="upRight"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick6.bind(this)}>
Expand All @@ -276,6 +286,7 @@ export default class extends Component {
<EuiFlexGroup>
<EuiFlexItem grow={false}>
<EuiPopover
id="leftUp"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick7.bind(this)}>
Expand All @@ -294,8 +305,10 @@ export default class extends Component {
</EuiText>
</EuiPopover>
</EuiFlexItem>

<EuiFlexItem grow={false}>
<EuiPopover
id="leftCenter"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick8.bind(this)}>
Expand All @@ -309,8 +322,10 @@ export default class extends Component {
Popover content
</EuiPopover>
</EuiFlexItem>

<EuiFlexItem grow={false}>
<EuiPopover
id="leftDown"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick9.bind(this)}>
Expand All @@ -336,6 +351,7 @@ export default class extends Component {
<EuiFlexGroup>
<EuiFlexItem grow={false}>
<EuiPopover
id="rightUp"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick10.bind(this)}>
Expand All @@ -354,8 +370,10 @@ export default class extends Component {
</EuiText>
</EuiPopover>
</EuiFlexItem>

<EuiFlexItem grow={false}>
<EuiPopover
id="rightCenter"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick11.bind(this)}>
Expand All @@ -369,8 +387,10 @@ export default class extends Component {
Popover content
</EuiPopover>
</EuiFlexItem>

<EuiFlexItem grow={false}>
<EuiPopover
id="rightDown"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick12.bind(this)}>
Expand Down
1 change: 1 addition & 0 deletions docs/src/views/popover/popover_panel_class_name.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export default class extends Component {
render() {
return (
<EuiPopover
id="popoverPanelClassName"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick.bind(this)}>
Expand Down
5 changes: 5 additions & 0 deletions docs/src/views/popover/popover_with_title.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ export default class extends Component {
<EuiFlexGroup>
<EuiFlexItem grow={false}>
<EuiPopover
id="downCenterWithTitle"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick1.bind(this)}>
Expand All @@ -83,8 +84,10 @@ export default class extends Component {
</div>
</EuiPopover>
</EuiFlexItem>

<EuiFlexItem grow={false}>
<EuiPopover
id="upCenterWithTitle"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick2.bind(this)}>
Expand All @@ -107,8 +110,10 @@ export default class extends Component {
</div>
</EuiPopover>
</EuiFlexItem>

<EuiFlexItem grow={false}>
<EuiPopover
id="rightUpWithTitle"
ownFocus
button={(
<EuiButton iconType="arrowDown" iconSide="right" onClick={this.onButtonClick3.bind(this)}>
Expand Down
Loading