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

Allow DataGrid's columns popover to optionally not allow hiding and/or reordering #2993

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 @@ -10,6 +10,7 @@
- Added RGB format support to `EuiColorPicker` and `EuiColorStops` ([#2850](https://github.com/elastic/eui/pull/2850))
- Added alpha channel (opacity) support to `EuiColorPicker` and `EuiColorStops` ([#2850](https://github.com/elastic/eui/pull/2850))
- Added `useResizeObserver` hook ([#2991](https://github.com/elastic/eui/pull/2991))
- Added `showColumnSelector.allowHide` and `showColumnSelector.allowReorder` props to `EuiDataGrid` UI configuration ([#2993](https://github.com/elastic/eui/pull/2993))

**Bug Fixes**

Expand Down
2 changes: 2 additions & 0 deletions src-docs/src/views/datagrid/datagrid_example.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import {
DataGridColumnVisibility,
DataGridPopoverContent,
DataGridControlColumn,
DataGridToolBarVisibilityColumnSelectorOptions,
} from './props';

const gridSnippet = `
Expand Down Expand Up @@ -351,6 +352,7 @@ export const DataGridExample = {
EuiDataGridSchemaDetector: DataGridSchemaDetector,
EuiDataGridStyle: DataGridStyle,
EuiDataGridToolbarVisibilityOptions: DataGridToolbarVisibilityOptions,
EuiDataGridToolBarVisibilityColumnSelectorOptions: DataGridToolBarVisibilityColumnSelectorOptions,
EuiDataGridPopoverContent: DataGridPopoverContent,
},
demo: (
Expand Down
3 changes: 2 additions & 1 deletion src-docs/src/views/datagrid/datagrid_styling_example.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,11 @@ const gridSnippet = `<EuiDataGrid
]}
// This can work as a shape.
toolbarVisibility={{
showColumnSelector: false
showStyleSelector: false
showSortSelector: false
showFullScreenSelector: false
// showColumnSelector also takes an object, check the prop docs.
showColumnSelector: false
additionalControls: (
<Fragment>
<EuiButtonEmpty
Expand Down
5 changes: 5 additions & 0 deletions src-docs/src/views/datagrid/props.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
EuiDataGridColumnVisibility,
EuiDataGridPopoverContentProps,
EuiDataGridControlColumn,
EuiDataGridToolBarVisibilityColumnSelectorOptions,
} from '../../../../src/components/datagrid/data_grid_types';
import { EuiDataGridCellValueElementProps } from '../../../../src/components/datagrid/data_grid_cell';
import { EuiDataGridSchemaDetector } from '../../../../src/components/datagrid/data_grid_schema';
Expand Down Expand Up @@ -54,3 +55,7 @@ export const DataGridPopoverContent: FunctionComponent<
export const DataGridControlColumn: FunctionComponent<
EuiDataGridControlColumn
> = () => <div />;

export const DataGridToolBarVisibilityColumnSelectorOptions: FunctionComponent<
EuiDataGridToolBarVisibilityColumnSelectorOptions
> = () => <div />;
108 changes: 93 additions & 15 deletions src-docs/src/views/datagrid/styling.js
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,28 @@ export default class DataGrid extends Component {
},
];

this.allowHideColumnsOptions = [
{
id: 'true',
label: 'True',
},
{
id: 'false',
label: 'False',
},
];

this.allowOrderingColumnsOptions = [
{
id: 'true',
label: 'True',
},
{
id: 'false',
label: 'False',
},
];

this.showFullScreenSelectorOptions = [
{
id: 'true',
Expand Down Expand Up @@ -212,6 +234,8 @@ export default class DataGrid extends Component {
showSortSelector: true,
showStyleSelector: true,
showColumnSelector: true,
allowHideColumns: true,
allowOrderingColumns: true,
showFullScreenSelector: true,
showToolbar: true,
toolbarPropTypeIsBoolean: true,
Expand Down Expand Up @@ -279,6 +303,18 @@ export default class DataGrid extends Component {
});
};

onAllowHideColumnsChange = optionId => {
this.setState({
allowHideColumns: optionId === 'true',
});
};

onAllowOrderingColumnsChange = optionId => {
this.setState({
allowOrderingColumns: optionId === 'true',
});
};

onShowFullScreenSelectorChange = optionId => {
this.setState({
showFullScreenSelector: optionId === 'true',
Expand Down Expand Up @@ -356,8 +392,20 @@ export default class DataGrid extends Component {
</EuiButton>
);

let showColumnSelector = this.state.showColumnSelector;
if (
this.state.showColumnSelector === true &&
(this.state.allowHideColumns === false ||
this.state.allowOrderingColumns === false)
) {
showColumnSelector = {
allowHide: this.state.allowHideColumns,
allowReorder: this.state.allowOrderingColumns,
};
}

const toolbarVisibilityOptions = {
showColumnSelector: this.state.showColumnSelector,
showColumnSelector: showColumnSelector,
showStyleSelector: this.state.showStyleSelector,
showSortSelector: this.state.showSortSelector,
showFullScreenSelector: this.state.showFullScreenSelector,
Expand Down Expand Up @@ -459,7 +507,7 @@ export default class DataGrid extends Component {
anchorPosition="rightUp"
zIndex={2}
closePopover={this.closeToolbarPopover.bind(this)}>
<div style={{ width: 300 }}>
<div style={{ width: 400 }}>
<EuiFormRow
display="columnCompressed"
label="toolbarVisibility prop">
Expand All @@ -474,19 +522,6 @@ export default class DataGrid extends Component {
</EuiFormRow>
{this.state.toolbarPropTypeIsBoolean === false ? (
<Fragment>
<EuiFormRow
display="columnCompressed"
label="Show column selector">
<EuiButtonGroup
isFullWidth
buttonSize="compressed"
legend="Border"
options={this.showColumnSelectorOptions}
idSelected={this.state.showColumnSelector.toString()}
onChange={this.onShowColumnSelectorChange}
/>
</EuiFormRow>

<EuiFormRow
display="columnCompressed"
label="Show style selector">
Expand Down Expand Up @@ -525,6 +560,49 @@ export default class DataGrid extends Component {
onChange={this.onShowFullScreenSelectorChange}
/>
</EuiFormRow>

<EuiFormRow
display="columnCompressed"
label="Show column selector">
<EuiButtonGroup
isFullWidth
buttonSize="compressed"
legend="Border"
options={this.showColumnSelectorOptions}
idSelected={this.state.showColumnSelector.toString()}
onChange={this.onShowColumnSelectorChange}
/>
</EuiFormRow>
{this.state.showColumnSelector && (
<>
<EuiFormRow
display="columnCompressed"
label="Allow hiding columns"
style={{ marginLeft: 32 }}>
<EuiButtonGroup
isFullWidth
buttonSize="compressed"
legend="Border"
options={this.allowHideColumnsOptions}
idSelected={this.state.allowHideColumns.toString()}
onChange={this.onAllowHideColumnsChange}
/>
</EuiFormRow>
<EuiFormRow
display="columnCompressed"
label="Allow ordering columns"
style={{ marginLeft: 32 }}>
<EuiButtonGroup
isFullWidth
buttonSize="compressed"
legend="Border"
options={this.allowOrderingColumnsOptions}
idSelected={this.state.allowOrderingColumns.toString()}
onChange={this.onAllowOrderingColumnsChange}
/>
</EuiFormRow>
</>
)}
</Fragment>
) : (
<EuiFormRow display="columnCompressed" label="Show toolbar">
Expand Down
16 changes: 8 additions & 8 deletions src/components/datagrid/__snapshots__/data_grid.test.tsx.snap
Original file line number Diff line number Diff line change
Expand Up @@ -191,12 +191,12 @@ Array [
<div
aria-hidden="true"
class="euiButtonEmpty__icon"
data-euiicon-type="eyeClosed"
data-euiicon-type="listAdd"
/>
<span
class="euiButtonEmpty__text"
>
Hide fields
Columns
</span>
</span>
</button>
Expand Down Expand Up @@ -713,12 +713,12 @@ Array [
<div
aria-hidden="true"
class="euiButtonEmpty__icon"
data-euiicon-type="eyeClosed"
data-euiicon-type="listAdd"
/>
<span
class="euiButtonEmpty__text"
>
Hide fields
Columns
</span>
</span>
</button>
Expand Down Expand Up @@ -1430,12 +1430,12 @@ Array [
<div
aria-hidden="true"
class="euiButtonEmpty__icon"
data-euiicon-type="eyeClosed"
data-euiicon-type="listAdd"
/>
<span
class="euiButtonEmpty__text"
>
Hide fields
Columns
</span>
</span>
</button>
Expand Down Expand Up @@ -1951,12 +1951,12 @@ Array [
<div
aria-hidden="true"
class="euiButtonEmpty__icon"
data-euiicon-type="eyeClosed"
data-euiicon-type="listAdd"
/>
<span
class="euiButtonEmpty__text"
>
Hide fields
Columns
</span>
</span>
</button>
Expand Down
4 changes: 4 additions & 0 deletions src/components/datagrid/_data_grid_column_selector.scss
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
margin: 0 (-$euiSizeS);
}

.euiDataGridColumnSelector__itemLabel {
@include euiFontSizeXS;
}

.euiDataGridColumnSelectorPopover {
// Hack because the fixed positions of drag and drop don't work inside of transformed elements
// sass-lint:disable-block no-important
Expand Down
Loading