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

Steps are styled #208

Merged
merged 15 commits into from
Dec 15, 2017
Merged
Show file tree
Hide file tree
Changes from 14 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: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [`master`](https://github.com/elastic/eui/tree/master)

- Added `EuiSteps` component
- Added `EuiSteps` component ([(#202)](https://github.com/elastic/eui/pull/202), [(#208)](https://github.com/elastic/eui/pull/208))
- Added `EuiHealth` components for status checks [(#158)](https://github.com/elastic/eui/pull/158)
- Cleaned up styling for checkboxes, switches, and radios [(#158)](https://github.com/elastic/eui/pull/158)
- Form `disabled` states are now more consistant [(#158)](https://github.com/elastic/eui/pull/158)
Expand Down
11 changes: 8 additions & 3 deletions src-docs/src/views/steps/heading_element_steps.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,23 @@ import React from 'react';

import {
EuiSteps,
EuiTitle,
EuiSpacer
} from '../../../../src/components';

const steps = [
{
title: 'inspect me',
children: <h3>Did you notice the step title is inside a Heading 2 element?</h3>
title: 'Inspect me',
children: <EuiTitle size="s"><h3>Did you notice the step title is inside a Heading 2 element?</h3></EuiTitle>
}
];

export default () => (
<div>
<h1>Heading 1</h1>
<EuiTitle size="l"><h1>Heading 1</h1></EuiTitle>

<EuiSpacer size="xl" />

<EuiSteps
steps={steps}
headingElement="h2"
Expand Down
12 changes: 6 additions & 6 deletions src-docs/src/views/steps/steps.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,30 @@ import {

const firstSetOfSteps = [
{
title: 'step 1',
title: 'Step 1',
children: <p>Do this first</p>
},
{
title: 'step 2',
title: 'Step 2',
children: <p>Then this</p>
},
{
title: 'step 3',
title: 'Step 3',
children: <p>And finally, do this</p>
},
];

const nextSetOfSteps = [
{
title: 'good step',
title: 'Good step',
children: <p>Do this first</p>
},
{
title: 'better step',
title: 'Better step',
children: <p>Then this</p>
},
{
title: 'best step',
title: 'Best step',
children: <p>And finally, do this</p>
},
];
Expand Down
20 changes: 16 additions & 4 deletions src-docs/src/views/steps/steps_example.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ import {
GuideSectionTypes,
} from '../../components';

import {
EuiCode,
} from '../../../../src/components';

import Steps from './steps';
const stepsSource = require('!!raw-loader!./steps');
const stepsHtml = renderToHtml(Steps);
Expand Down Expand Up @@ -33,7 +37,7 @@ export const StepsExample = {
demo: <Steps />,
},
{
title: 'Heading Element Steps',
title: 'Heading Elements',
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we use sentence case?

source: [{
type: GuideSectionTypes.JS,
code: headingElementStepsSource,
Expand All @@ -42,9 +46,17 @@ export const StepsExample = {
code: headingElementStepsHtml,
}],
text: (
<p>
something something better accessibility
</p>
<div>
<p>
To aide with accessibility and hierachical headings,
Copy link
Contributor

Choose a reason for hiding this comment

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

I think aide (noun) should be spelled "aid" (verb).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah... you might find that you catch a good amount spelling errors with me... I'm trying to be beter...

Copy link
Contributor

Choose a reason for hiding this comment

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

s/beter/better 😹

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh and "hierachical" should be "hierarchical"

you can and should pass in a heading element to use for each step title.
The example below shows that the logical heading element should be an <EuiCode>h2</EuiCode>
and therefore adds <EuiCode>headingElement=&quot;h2&quot;</EuiCode> to the EuiSteps component.
</p>
<p>
The style of the title will <strong>not</strong> be affected.
</p>
</div>
),
demo: <HeadingElementSteps />,
}],
Expand Down
25 changes: 12 additions & 13 deletions src/components/steps/__snapshots__/step.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,19 @@ exports[`EuiStep is rendered 1`] = `
class="euiStep testClass1 testClass2"
data-test-subj="test subject string"
>
<div>
<div
class="euiStepNumber"
>
1
</div>
<h3
class="euiTitle euiStepTitle"
>
First step
</h3>
</div>
<span
class="euiScreenReaderOnly"
>
Step
</span>
<h3
class="euiTitle euiStep__title"
data-step-num="1"
>
First step
</h3>
<div
class="euiStepContent"
class="euiStep__content"
>
<p>
Do this
Expand Down
Loading