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

Adds a11y docs #2357

Merged
merged 15 commits into from
Nov 25, 2019
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## [`master`](https://github.com/elastic/eui/tree/master)

- Added accessibility docs ([#2357](https://github.com/elastic/eui/pull/2357))
myasonik marked this conversation as resolved.
Show resolved Hide resolved
- Added `heading` prop to `EuiCallOut` to allow for variance in the title tag ([#2357](https://github.com/elastic/eui/pull/2357))
- Added `badge` prop and new styles `EuiHeaderAlert` ([#2506](https://github.com/elastic/eui/pull/2506))
- Added new keyboard shortcuts for the data grid component: `Home` (same row, first column), `End` (same row, last column), `Ctrl+Home` (first row, first column), `Ctrl+End` (last row, last column), `Page Up` (next page) and `Page Down` (previous page) ([#2519](https://github.com/elastic/eui/pull/2519))
- Added `disabled` prop to the `EuiCheckboxGroup` definition ([#2545](https://github.com/elastic/eui/pull/2545))
Expand Down
4 changes: 2 additions & 2 deletions src-docs/src/components/guide_page/guide_page_chrome.js
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ export class GuidePageChrome extends Component {
href,
onClick: this.onClickRoute.bind(this),
items: this.renderSubSections(href, sections, searchTerm),
isSelected: name === this.props.currentRouteName,
isSelected: item === this.props.currentRoute,
forceOpen: !!(searchTerm && hasMatchingSubItem),
};
});
Expand Down Expand Up @@ -331,7 +331,7 @@ export class GuidePageChrome extends Component {
}

GuidePageChrome.propTypes = {
currentRouteName: PropTypes.string,
currentRoute: PropTypes.object.isRequired,
onToggleTheme: PropTypes.func.isRequired,
selectedTheme: PropTypes.string.isRequired,
onToggleLocale: PropTypes.func.isRequired,
Expand Down
5 changes: 5 additions & 0 deletions src-docs/src/components/guide_rule/_guide_rule_example.scss
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@
}
}

pre {
margin-bottom: 0;
padding: 0;
}

.guideRule__caption {
@include euiFontSizeS;
max-height: $euiFontSizeS * $euiLineHeight; /* 1 */
Expand Down
16 changes: 14 additions & 2 deletions src-docs/src/components/guide_rule/guide_rule_example.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ export const GuideRuleExample = ({
text,
panel,
frame,
minHeight,
style,
panelStyles,
...rest
}) => {
const classes = classNames(
Expand All @@ -33,9 +36,17 @@ export const GuideRuleExample = ({

const ChildrenComponent = panel ? EuiPanel : 'div';

const styles = { ...style, minHeight };

return (
<EuiFlexItem component="figure" className={classes} {...rest}>
<ChildrenComponent className="guideRule__example__panel">
<EuiFlexItem
component="figure"
className={classes}
style={styles}
{...rest}>
<ChildrenComponent
className="guideRule__example__panel"
style={panelStyles}>
{children}
</ChildrenComponent>
<figcaption className="guideRule__caption">
Expand All @@ -51,6 +62,7 @@ GuideRuleExample.propTypes = {
type: PropTypes.string.isRequired,
text: PropTypes.string,
panel: PropTypes.bool,
minHeight: PropTypes.number,
};

GuideRuleExample.defaultProps = {
Expand Down
27 changes: 18 additions & 9 deletions src-docs/src/components/guide_section/guide_section.js
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,14 @@ export class GuideSection extends Component {
this.componentNames = Object.keys(props.props);
const hasSnippet = 'snippet' in props;

this.tabs = [
{
this.tabs = [];

if (props.demo) {
this.tabs.push({
name: 'demo',
displayName: 'Demo',
},
];
});
}

if (props.source) {
this.tabs.push(
Expand Down Expand Up @@ -130,7 +132,7 @@ export class GuideSection extends Component {
}

this.state = {
selectedTab: this.tabs[0],
selectedTab: this.tabs.length > 0 ? this.tabs[0] : undefined,
};
}

Expand Down Expand Up @@ -281,7 +283,7 @@ export class GuideSection extends Component {
<EuiText>
<p>{markup(description)}</p>
</EuiText>
<EuiSpacer size="m" key={`propsSpacer-${componentName}`} />
<EuiSpacer size="m" id={`propsSpacer-${componentName}`} />
</div>
);
}
Expand Down Expand Up @@ -354,9 +356,12 @@ export class GuideSection extends Component {
{this.renderText()}
</div>

<EuiSpacer size="m" />

<EuiTabs>{this.renderTabs()}</EuiTabs>
{this.tabs.length > 0 && (
<>
<EuiSpacer size="m" />
<EuiTabs>{this.renderTabs()}</EuiTabs>
</>
)}
</div>
);
}
Expand Down Expand Up @@ -389,6 +394,10 @@ export class GuideSection extends Component {
}

renderContent() {
if (typeof this.state.selectedTab === 'undefined') {
return;
}

if (this.state.selectedTab.name === 'snippet') {
return <EuiErrorBoundary>{this.renderSnippet()}</EuiErrorBoundary>;
}
Expand Down
3 changes: 3 additions & 0 deletions src-docs/src/routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import { EuiErrorBoundary } from '../../src/components';

// Guidelines

import AccessibilityGuidelines from './views/guidelines/accessibility';

import ButtonGuidelines from './views/guidelines/button';

import ColorGuidelines from './views/guidelines/colors';
Expand Down Expand Up @@ -259,6 +261,7 @@ const navigation = [
{
name: 'Guidelines',
items: [
createExample(AccessibilityGuidelines),
{
name: 'Buttons',
component: ButtonGuidelines,
Expand Down
2 changes: 1 addition & 1 deletion src-docs/src/views/app_view.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export class AppView extends Component {
<EuiPageBody>
<EuiErrorBoundary>
<GuidePageChrome
currentRouteName={currentRoute.name}
currentRoute={currentRoute}
onToggleTheme={toggleTheme}
selectedTheme={theme}
onToggleLocale={toggleLocale}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ export const FormCompressedExample = {
This is an example of how to combine compressed form controls with
from rows, labels, prepend and appends in a column layout.
</p>
<EuiCallOut color="warning" title="Accessiblity in compressed forms">
<EuiCallOut color="warning" title="Accessibility in compressed forms">
<p>
Pay close attention to the patterns of using{' '}
<EuiCode>htmlFor</EuiCode> and <EuiCode>aria-label</EuiCode>. For
Expand Down
Loading