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

Add responsiveColumn option to type of EuiDescriptionList #2166

Merged
merged 5 commits into from
Jul 26, 2019
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- Added `tall`, `fullWidth`, and `isInvalid` props to `EuiFilePicker` ([#2145](https://github.com/elastic/eui/pull/2145))
- Added exports for `react-beautiful-dnd` interfaces used by EUI components ([#2173](https://github.com/elastic/eui/pull/2173))
- Added `isDisabled` prop & styles to `EuiSuperDatePicker` ([#2139](https://github.com/elastic/eui/pull/2139))
- Added `responsiveColumn` option to `type` prop of `EuiDescriptionList` ([#2166](https://github.com/elastic/eui/pull/2166))

**Bug fixes**

Expand Down
36 changes: 29 additions & 7 deletions src-docs/src/views/description_list/description_list_column.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import React from 'react';
import React, { Fragment } from 'react';

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

const favoriteVideoGames = [
{
Expand All @@ -18,9 +22,27 @@ const favoriteVideoGames = [
},
];
export default () => (
<EuiDescriptionList
type="column"
listItems={favoriteVideoGames}
style={{ maxWidth: '400px' }}
/>
<Fragment>
<EuiDescriptionList
type="column"
listItems={favoriteVideoGames}
style={{ maxWidth: '400px' }}
/>

<EuiSpacer size="xl" />

<EuiTitle size="s">
<h3>
The following list will become the typical row format on small screens
</h3>
</EuiTitle>

<EuiSpacer />

<EuiDescriptionList
type="responsiveColumn"
listItems={favoriteVideoGames}
style={{ maxWidth: '400px' }}
/>
</Fragment>
);
17 changes: 12 additions & 5 deletions src-docs/src/views/description_list/description_list_example.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React from 'react';
import React, { Fragment } from 'react';

import { renderToHtml } from '../../services';

Expand Down Expand Up @@ -108,10 +108,17 @@ export const DescriptionListExample = {
},
],
text: (
<p>
Using a prop <EuiCode>type</EuiCode> set to <EuiCode>column</EuiCode>{' '}
description lists can be presented in an inline, column format.
</p>
<Fragment>
<p>
Using the prop <EuiCode>type</EuiCode> set to{' '}
<EuiCode>column</EuiCode> description lists can be presented in an
inline, column format.
</p>
<p>
To return to the typical row format on smaller screens set{' '}
<EuiCode>type</EuiCode> to <EuiCode>responsiveColumn</EuiCode>.
</p>
</Fragment>
),
demo: <DescriptionListColumn />,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,12 @@ exports[`EuiDescriptionList props type inline is rendered 1`] = `
/>
`;

exports[`EuiDescriptionList props type responsiveColumn is rendered 1`] = `
<dl
class="euiDescriptionList euiDescriptionList--responsiveColumn"
/>
`;

exports[`EuiDescriptionList props type row is rendered 1`] = `
<dl
class="euiDescriptionList euiDescriptionList--row"
Expand Down
43 changes: 36 additions & 7 deletions src/components/description_list/_description_list.scss
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@
text-align: center;
}

&.euiDescriptionList--right {
text-align: right;
}

// Reversed makes the description larger than the title
&.euiDescriptionList--reverse {
.euiDescriptionList__title {
Expand Down Expand Up @@ -66,7 +62,8 @@
}


&.euiDescriptionList--column {
&.euiDescriptionList--column,
&.euiDescriptionList--responsiveColumn {
display: flex;
align-items: stretch;
flex-wrap: wrap;
Expand Down Expand Up @@ -96,7 +93,6 @@

// Align the title to smush against the description.
&.euiDescriptionList--center {

.euiDescriptionList__title {
text-align: right;
}
Expand All @@ -115,7 +111,6 @@
}

&.euiDescriptionList--compressed {

.euiDescriptionList__title {
@include euiTitle('xxs');
line-height: $euiLineHeight;
Expand All @@ -139,6 +134,40 @@
}
}

&.euiDescriptionList--responsiveColumn {
@include euiBreakpoint('xs', 's') {
display: block;

.euiDescriptionList__title,
.euiDescriptionList__description {
width: 100%;
padding: 0;
}

.euiDescriptionList__description {
@include euiFontSizeS;
margin-top: 0;
}

&.euiDescriptionList--center {
.euiDescriptionList__title,
.euiDescriptionList__description {
text-align: center;
}
}

&.euiDescriptionList--reverse {
.euiDescriptionList__title {
@include euiFontSizeS;
}

.euiDescriptionList__description {
@include euiTitle('xs');
}
}
}
}

&.euiDescriptionList--inline {

.euiDescriptionList__title {
Expand Down
3 changes: 2 additions & 1 deletion src/components/description_list/description_list.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ export interface EuiDescriptionListProps {

const typesToClassNameMap = {
row: 'euiDescriptionList--row',
column: 'euiDescriptionList--column',
inline: 'euiDescriptionList--inline',
column: 'euiDescriptionList--column',
responsiveColumn: 'euiDescriptionList--responsiveColumn',
};

export const TYPES = keysOf(typesToClassNameMap);
Expand Down